Merge pull request #7 from AdCombo/rename-flask_rest_jsonapi-to-flask_combo_jsonapi

Rename use of flask_rest_jsonapi to flask_combo_jsonapi

Author: mahenzon

.travis.yml

@@ -1,9 +1,8 @@
-dist: trusty
 language: python
 python:
   - '3.6'
   - '3.7'
-  - 'pypy'
+  - '3.8'
 install:
   - pip install -r requirements.txt
   - pip install coveralls coverage

CHANGELOG.rst

@@ -1,6 +1,16 @@
 Changelog
 *********
 
+
+**1.0.0**
+=========
+
+Changes
+=======
+
+* Rename Flask-REST-JSONAPI to Flask-COMBO-JSONAPI #- `@mahenzon`_
+
+
 **0.1.1**
 =========
 
@@ -21,14 +31,14 @@ Bug Fixes
 * Fix sorting in plugin `PostgreSqlJSONB`_ #- `@Znbiz`_
 * Improved model fields check for options(load_only) in `Permission`_ #- `@Znbiz`_
 * Implement disable_global_decorators, minor refactor and upgrade events, update docs in plugin
-  `EventPlugin`_  #- `@Suren Khorenyan`_
+  `EventPlugin`_  #- `@mahenzon`_
 * typo permission_for_path -> permission_for_patch and create get_decorators_for_resource
-  in plugin `Permission`_ #- `@Suren Khorenyan`_
-* Create status util #- `@Suren Khorenyan`_
-* Refactor api spec params for get in plugin `ApiSpecPlugin`_ #- `@Suren Khorenyan`_
-* Fix permission plugin initialization #- `@Suren Khorenyan`_
-* Constant splitter for filters, sorts and includes #- `@Suren Khorenyan`_
-* Configure setup, update .gitignore #- `@Suren Khorenyan`_
+  in plugin `Permission`_ #- `@mahenzon`_
+* Create status util #- `@mahenzon`_
+* Refactor api spec params for get in plugin `ApiSpecPlugin`_ #- `@mahenzon`_
+* Fix permission plugin initialization #- `@mahenzon`_
+* Constant splitter for filters, sorts and includes #- `@mahenzon`_
+* Configure setup, update .gitignore #- `@mahenzon`_
 
 **0.1.0**
 =========
@@ -49,6 +59,6 @@ Enhancements
 .. _`ApiSpecPlugin`: https://github.com/AdCombo/ComboJSONAPI/docs/api_spec_plugin.rst
 .. _`Permission`: https://github.com/AdCombo/ComboJSONAPI/docs/permission_plugin.rst
 
-.. _`@Suren Khorenyan`: https://github.com/mahenzon
+.. _`@mahenzon`: https://github.com/mahenzon
 .. _`@Znbiz`: https://github.com/znbiz
 .. _`@Yakov Shapovalov`: https://github.com/photovirus

README.rst

@@ -1,3 +1,8 @@
+.. image:: https://travis-ci.org/AdCombo/combojsonapi.svg?branch=develop
+    :target: https://travis-ci.org/AdCombo/combojsonapi
+.. image:: https://coveralls.io/repos/github/AdCombo/combojsonapi/badge.svg?branch=develop
+    :target: https://coveralls.io/github/AdCombo/combojsonapi?branch=develop
+
 ComboJSONAPI
 ============
 ComboJSONAPI is a set of plugins made for `Flask-JSONAPI <https://github.com/AdCombo/flask-jsonapi>`_ module.

combojsonapi/event/__init__.py

@@ -1,6 +1,6 @@
 from combojsonapi.event.plugin import EventSchema, EventPlugin
 
 __all__ = [
-    'EventSchema',
-    'EventPlugin',
+    "EventSchema",
+    "EventPlugin",
 ]

combojsonapi/event/plugin.py

@@ -3,10 +3,10 @@
 
 from marshmallow import Schema
 
-from flask_rest_jsonapi.plugin import BasePlugin
-from flask_rest_jsonapi.resource import Resource
-from flask_rest_jsonapi.utils import SPLIT_REL
-from flask_rest_jsonapi.exceptions import PluginMethodNotImplementedError
+from flask_combo_jsonapi.plugin import BasePlugin
+from flask_combo_jsonapi.resource import Resource
+from flask_combo_jsonapi.utils import SPLIT_REL
+from flask_combo_jsonapi.exceptions import PluginMethodNotImplementedError
 
 from combojsonapi.utils import get_decorators_for_resource
 
@@ -16,7 +16,6 @@ class EventSchema(Schema):
 
 
 class EventPlugin(BasePlugin):
-
     def __init__(self, trailing_slash: bool = True):
         """
 
@@ -25,6 +24,7 @@ def __init__(self, trailing_slash: bool = True):
         self.trailing_slash = trailing_slash
 
     """Plugin for events routes in json_api"""
+
     @classmethod
     def _events_with_methods(cls, cls_events) -> Generator[Tuple[Any, str], None, None]:
         """
@@ -35,35 +35,39 @@ def _events_with_methods(cls, cls_events) -> Generator[Tuple[Any, str], None, No
         """
         for attr_name in dir(cls_events):
             method = None
-            if attr_name.startswith('event_get_'):
-                method = 'GET'
-            elif attr_name.startswith('event_'):
+            if attr_name.startswith("event_get_"):
+                method = "GET"
+            elif attr_name.startswith("event_"):
                 # Processing all other events. May be event_post_smth or just event_smth
-                method = 'POST'
+                method = "POST"
             if method is not None:
                 yield getattr(cls_events, attr_name), method
 
     def _create_event_resource(self, base_resource, event, method, view, urls, self_json_api, **kwargs):
         # noinspection PyTypeChecker
-        new_resource: Resource = type(event.__name__, (base_resource,), {
-            'methods': [method],
-            'schema': None,
-            method.lower(): event,
-            'event': True,
-        })
+        new_resource: Resource = type(
+            event.__name__,
+            (base_resource,),
+            {
+                "methods": [method],
+                "schema": None,
+                method.lower(): event,
+                "event": True,
+            },
+        )
 
         new_resource.decorators = get_decorators_for_resource(base_resource, self_json_api)
 
-        i_view = f'{view}_{event.__name__}'
+        i_view = f"{view}_{event.__name__}"
         view_func = new_resource.as_view(i_view)
 
-        url_rule_options = kwargs.get('url_rule_options') or {}
+        url_rule_options = kwargs.get("url_rule_options") or {}
 
         event_urls = []
         for i_url in urls:
             i_new_url = urllib.parse.urljoin(i_url, event.__name__)
-            i_new_url = i_new_url[:-1] if i_new_url[-1] == '/' else i_new_url
-            i_new_url = i_new_url + '/' if self.trailing_slash else i_new_url
+            i_new_url = i_new_url[:-1] if i_new_url[-1] == "/" else i_new_url
+            i_new_url = i_new_url + "/" if self.trailing_slash else i_new_url
             event_urls.append(i_new_url)
         event_urls = tuple(event_urls)
 
@@ -75,12 +79,14 @@ def _create_event_resource(self, base_resource, event, method, view, urls, self_
             for url in event_urls:
                 self_json_api.app.add_url_rule(url, view_func=view_func, **url_rule_options)
         else:
-            self_json_api.resources.append({
-                'resource': new_resource,
-                'view': i_view,
-                'urls': event_urls,
-                'url_rule_options': url_rule_options,
-            })
+            self_json_api.resources.append(
+                {
+                    "resource": new_resource,
+                    "view": i_view,
+                    "urls": event_urls,
+                    "url_rule_options": url_rule_options,
+                }
+            )
 
         self_json_api.resource_registry.append(new_resource)
 
@@ -106,7 +112,7 @@ def before_route(self, resource=None, view=None, urls=None, self_json_api=None,
         :param kwargs:
         :return:
         """
-        if not hasattr(resource, 'events'):
+        if not hasattr(resource, "events"):
             return
 
         for event, method in self._events_with_methods(resource.events):

combojsonapi/permission/__init__.py

@@ -1,16 +1,22 @@
-from combojsonapi.permission.permission_system import (PermissionToMapper, PermissionFields, PermissionForPatch,
-                                                       PermissionForPost, PermissionForGet, PermissionUser,
-                                                       PermissionMixin)
+from combojsonapi.permission.permission_system import (
+    PermissionToMapper,
+    PermissionFields,
+    PermissionForPatch,
+    PermissionForPost,
+    PermissionForGet,
+    PermissionUser,
+    PermissionMixin,
+)
 
 from combojsonapi.permission.permission_plugin import PermissionPlugin
 
 __all__ = [
-    'PermissionPlugin',
-    'PermissionToMapper',
-    'PermissionFields',
-    'PermissionForPatch',
-    'PermissionForPost',
-    'PermissionForGet',
-    'PermissionUser',
-    'PermissionMixin',
+    "PermissionPlugin",
+    "PermissionToMapper",
+    "PermissionFields",
+    "PermissionForPatch",
+    "PermissionForPost",
+    "PermissionForGet",
+    "PermissionUser",
+    "PermissionMixin",
 ]