Merge pull request #2 from AdCombo/master

upd

Author: dmitrymishanov

.github/workflows/run_tests.yml

@@ -0,0 +1,75 @@
+name: Python tests and coverage
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+
+jobs:
+  unit-tests:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install the package and dependencies
+      run: python setup.py install
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Install testing dependencies
+      run: pip install pytest --upgrade
+    - name: Test with pytest and run coverage
+      run: pytest -s -vv --color=yes
+
+  coverage:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.8'
+    - name: Install the package and dependencies
+      run: python setup.py install
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Install testing and coverage dependencies
+      run: |
+        pip install coveralls coverage
+        pip install -U setuptools
+        pip install pytest --upgrade
+    - name: Test with pytest with coverage
+      run: coverage run --source flask_combo_jsonapi -m pytest
+    - name: Trigger Coveralls
+      run: coveralls --service=github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+# TODO later: add support for parallel builds
+#  (not needed right now, now python-version-specific code yet)
+# https://coveralls-python.readthedocs.io/en/latest/usage/configuration.html#github-actions-support

.travis.yml

@@ -1,5 +1,5 @@
-.. image:: https://travis-ci.org/AdCombo/flask-combo-jsonapi.svg
-    :target: https://travis-ci.org/AdCombo/flask-combo-jsonapi
+.. image:: https://github.com/AdCombo/flask-combo-jsonapi/workflows/Python%20tests%20and%20coverage/badge.svg
+    :target: https://github.com/AdCombo/flask-combo-jsonapi/actions
 .. image:: https://coveralls.io/repos/github/AdCombo/flask-combo-jsonapi/badge.svg
     :target: https://coveralls.io/github/AdCombo/flask-combo-jsonapi
 

README.rst

@@ -63,7 +63,7 @@
 # The short X.Y version.
 version = "1.0"
 # The full version, including alpha/beta/rc tags.
-release = "1.0.4"
+release = "1.0.6"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -17,7 +17,7 @@
 from flask_combo_jsonapi.schema import compute_schema, get_relationships, get_model_field
 from flask_combo_jsonapi.data_layers.base import BaseDataLayer
 from flask_combo_jsonapi.data_layers.alchemy import SqlalchemyDataLayer
-from flask_combo_jsonapi.utils import JSONEncoder, validate_model_init_params
+from flask_combo_jsonapi.utils import JSONEncoder
 
 
 class ResourceMeta(MethodViewType):
@@ -39,14 +39,6 @@ def __new__(cls, name, bases, d):
             data_layer_kwargs = d["data_layer"]
             rv._data_layer = data_layer_cls(data_layer_kwargs)
 
-            if "schema" in d and "model" in data_layer_kwargs:
-                model = data_layer_kwargs["model"]
-                schema_fields = [get_model_field(d["schema"], key) for key in d["schema"]._declared_fields.keys()]
-                invalid_params = validate_model_init_params(model=model, params_names=schema_fields)
-                if invalid_params:
-                    raise Exception(f"Construction of {name} failed. Schema '{d['schema'].__name__}' has "
-                                    f"fields={invalid_params} are not declare in {model.__name__} init parameters")
-
         rv.decorators = (check_headers,)
         if "decorators" in d:
             rv.decorators += d["decorators"]

flask_combo_jsonapi/resource.py

@@ -21,7 +21,7 @@ def compute_schema(schema_cls, default_kwargs, qs, include):
     """
     # manage include_data parameter of the schema
     schema_kwargs = default_kwargs
-    schema_kwargs['include_data'] = tuple()
+    schema_kwargs['include_data'] = schema_kwargs.get('include_data', tuple())
 
     # collect sub-related_includes
     related_includes = {}
@@ -72,6 +72,7 @@ def compute_schema(schema_cls, default_kwargs, qs, include):
                 related_schema_kwargs['context'] = default_kwargs['context']
             if isinstance(related_schema_cls, SchemaABC):
                 related_schema_kwargs['many'] = related_schema_cls.many
+                related_schema_kwargs['include_data'] = related_schema_cls.__dict__.get('include_data')
                 related_schema_cls = related_schema_cls.__class__
             if isinstance(related_schema_cls, str):
                 related_schema_cls = class_registry.get_class(related_schema_cls)

flask_combo_jsonapi/schema.py

@@ -1,5 +1,3 @@
-import inspect
-
 import simplejson as json
 from uuid import UUID
 from datetime import datetime
@@ -19,30 +17,3 @@ def default(self, obj):
         elif isinstance(obj, UUID):
             return str(obj)
         return json.JSONEncoder.default(self, obj)
-
-
-def get_model_init_params_names(model):
-    """Retrieve all params of model init method
-
-    :param DeclarativeMeta model: an object from sqlalchemy
-    :return tuple: list of init method fields names and boolean flag that init method has kwargs
-    """
-    argnames, _, varkw = inspect.getfullargspec(model.__init__)[:3]
-    if argnames:
-        argnames.remove('self')
-    return argnames, bool(varkw)
-
-
-def validate_model_init_params(model, params_names):
-    """Retrieve invalid params of model init method if it exists
-    :param DeclarativeMeta model: an object from sqlalchemy
-    :param list params_names: parameters names to check
-    :return list: list of invalid fields or None
-    """
-    init_args, has_kwargs = get_model_init_params_names(model)
-    if has_kwargs:
-        return
-
-    invalid_params = [name for name in params_names if name not in init_args]
-    if invalid_params:
-        return invalid_params

flask_combo_jsonapi/utils.py

@@ -1,7 +1,7 @@
 import os
 from setuptools import setup, find_packages
 
-__version__ = "1.0.4"
+__version__ = "1.0.6"
 
 
 requirements_filepath = os.path.join(os.path.dirname(__name__), "requirements.txt")

setup.py

@@ -119,6 +119,7 @@ class Person(base):
         )
 
         computers_owned = relationship("Computer")
+        address = relationship("Address", backref="person", uselist=False)
 
     yield Person
 
@@ -136,17 +137,35 @@ class Computer(base):
     yield Computer
 
 
+@pytest.fixture(scope="module")
+def address_model(base):
+    class Address(base):
+
+        __tablename__ = "address"
+
+        id = Column(Integer, primary_key=True)
+        street = Column(String)
+        city = Column(String)
+        state = Column(String)
+        zip = Column(String)
+        person_id = Column(Integer, ForeignKey("person.person_id"))
+
+    yield Address
+
+
 @pytest.fixture(scope="module")
 def engine(
         person_tag_model, person_single_tag_model, person_model,
-        computer_model, string_json_attribute_person_model
+        computer_model, string_json_attribute_person_model,
+        address_model
     ):
     engine = create_engine("sqlite:///:memory:")
     person_tag_model.metadata.create_all(engine)
     person_single_tag_model.metadata.create_all(engine)
     person_model.metadata.create_all(engine)
     computer_model.metadata.create_all(engine)
     string_json_attribute_person_model.metadata.create_all(engine)
+    address_model.metadata.create_all(engine)
     return engine
 
 
@@ -189,6 +208,17 @@ def computer(session, computer_model):
     session_.commit()
 
 
+@pytest.fixture()
+def address(session, address_model):
+    address_ = address_model(state='NYC')
+    session_ = session
+    session_.add(address_)
+    session_.commit()
+    yield address_
+    session_.delete(address_)
+    session_.commit()
+
+
 @pytest.fixture(scope="module")
 def dummy_decorator():
     def deco(f):
@@ -237,6 +267,29 @@ class AddressSchema(MarshmallowSchema):
     yield AddressSchema
 
 
+@pytest.fixture(scope="module")
+def person_address_schema():
+    class PersonAddressSchema(Schema):
+        class Meta:
+            type_ = "address"
+
+        id = fields.Str(dump_only=True)
+        street = fields.String()
+        city = fields.String()
+        state = fields.String()
+        zip = fields.String()
+
+        person = Relationship(
+            related_view="api.person_detail",
+            related_view_kwargs={"person_id": "<person.person_id>"},
+            schema="PersonSchema",
+            id_field="person_id",
+            type_="person",
+        )
+
+    yield PersonAddressSchema
+
+
 @pytest.fixture(scope="module")
 def string_json_attribute_person_schema(address_schema):
     class StringJsonAttributePersonSchema(Schema):
@@ -255,7 +308,7 @@ class Meta:
 
 
 @pytest.fixture(scope="module")
-def person_schema(person_tag_schema, person_single_tag_schema):
+def person_schema(person_tag_schema, person_single_tag_schema, person_address_schema):
     class PersonSchema(Schema):
         class Meta:
             type_ = "person"
@@ -284,6 +337,11 @@ class Meta:
             many=True,
         )
 
+        address = Relationship(
+            schema="PersonAddressSchema",
+            type_="address",
+        )
+
     yield PersonSchema
 
 
@@ -920,6 +978,22 @@ def test_get_relationship_single_empty(session, client, register_routes, compute
         assert response.status_code == 200
 
 
+def test_get_include_multiple(session, client, register_routes, computer, person, address):
+    session_ = session
+    person.address = address
+    computer.person = person
+    session_.commit()
+
+    with client:
+        response = client.get(
+            "/computers/" + str(computer.id) + "?include=owner.computers,owner.address", content_type="application/vnd.api+json"
+        )
+        included = json.loads(response.data)['included']
+        types = {item['type'] for item in included}
+        assert {'person', 'computer', 'address'} == types
+        assert response.status_code == 200
+
+
 def test_issue_49(session, client, register_routes, person, person_2):
     with client:
         for p in [person, person_2]: