code: added deprecation warnings

.travis.yml

@@ -39,7 +39,7 @@ script:
   - python setup.py develop
   - if [ -n "$BCRYPT" ]; then pip install bcrypt; fi
   - if [ -n "$PYBCRYPT" ]; then pip install py-bcrypt; fi
-  - py.test ziggurat_foundations/tests.py
+  - py.test ziggurat_foundations/tests/tests.py
 
   # flake8 and rstcheck
   - if [ -n "$RSTCHECK" ]; then ./test.sh; fi

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+testpaths = ziggurat_foundations/tests
+python_files = *.py

setup.py

@@ -31,5 +31,6 @@
         "paginate",
         "paginate_sqlalchemy",
         "alembic",
+        'zope.deprecation >= 3.5.0',
         "six"]
 )

ziggurat_foundations/models/base.py

@@ -27,7 +27,7 @@ def get_dict(self, exclude_keys=None, include_keys=None):
         include_keys_list = include_keys or []
         for k in self._get_keys():
             if k not in exclude_keys_list and \
-                (k in include_keys_list or not include_keys):
+                    (k in include_keys_list or not include_keys):
                 d[k] = getattr(self, k)
         return d
 
@@ -55,7 +55,7 @@ def populate_obj(self, appstruct, exclude_keys=None, include_keys=None):
         include_keys_list = include_keys or []
         for k in self._get_keys():
             if k in appstruct and k not in exclude_keys_list and \
-                (k in include_keys_list or not include_keys):
+                    (k in include_keys_list or not include_keys):
                 setattr(self, k, appstruct[k])
 
     def populate_obj_from_obj(self, instance, exclude_keys=None,
@@ -75,7 +75,7 @@ def populate_obj_from_obj(self, instance, exclude_keys=None,
         include_keys_list = include_keys or []
         for k in self._get_keys():
             if hasattr(instance, k) and k not in exclude_keys_list and \
-                (k in include_keys_list or not include_keys):
+                    (k in include_keys_list or not include_keys):
                 setattr(self, k, getattr(instance, k))
 
     def get_db_session(self, session=None):

ziggurat_foundations/models/external_identity.py

@@ -1,6 +1,8 @@
 from __future__ import unicode_literals
 import sqlalchemy as sa
 from sqlalchemy.ext.declarative import declared_attr
+from zope.deprecation import deprecation
+
 from .base import BaseModel
 from .services.external_identity import ExternalIdentityService
 from .base import get_db_session
@@ -47,12 +49,16 @@ def token_secret(self):
         return sa.Column(sa.Unicode(512), default=u'')
 
     @classmethod
+    @deprecation.deprecate("ExternalIdentity.by_external_id_and_provider "
+                           "will be removed in 0.8, use service instead")
     def by_external_id_and_provider(cls, external_id, provider_name,
                                     db_session=None):
         """
         Backwards compatible alias to
         :class:`ziggurat_foundations.models.services.external_identity.ExternalIdentityService.by_external_id_and_provider`
 
+        .. deprecated:: 0.8
+
         :param external_id:
         :param provider_name:
         :param db_session:
@@ -64,12 +70,16 @@ def by_external_id_and_provider(cls, external_id, provider_name,
             db_session=db_session)
 
     @classmethod
+    @deprecation.deprecate("ExternalIdentity.user_by_external_id_and_provider "
+                           "will be removed in 0.8, use service instead")
     def user_by_external_id_and_provider(cls, external_id, provider_name,
                                          db_session=None):
         """
         Backwards compatible alias to
         :class:`ziggurat_foundations.models.services.external_identity.ExternalIdentityService.user_by_external_id_and_provider`
 
+        .. deprecated:: 0.8
+
         :param external_id:
         :param provider_name:
         :param db_session:

ziggurat_foundations/models/group.py

@@ -1,6 +1,8 @@
 from __future__ import unicode_literals
 import sqlalchemy as sa
 from sqlalchemy.ext.declarative import declared_attr
+from zope.deprecation import deprecation
+
 from .base import BaseModel
 from .services.group import GroupService
 from .base import get_db_session
@@ -110,22 +112,54 @@ def __repr__(self):
         return '<Group: %s, %s>' % (self.group_name, self.id)
 
     @classmethod
+    @deprecation.deprecate("Group.by_group_name "
+                           "will be removed in 0.8, use service instead")
     def by_group_name(cls, group_name, db_session=None):
-        """ fetch group by name"""
+        """ fetch group by name
+
+        .. deprecated:: 0.8
+
+        """
         db_session = get_db_session(db_session)
         return GroupService.by_group_name(group_name=group_name,
                                           db_session=db_session)
 
+    @deprecation.deprecate("Group.get_user_paginator "
+                           "will be removed in 0.8, use service instead")
     def get_user_paginator(self, page=1, item_count=None, items_per_page=50,
                            user_ids=None, GET_params=None, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param page:
+        :param item_count:
+        :param items_per_page:
+        :param user_ids:
+        :param GET_params:
+        :param db_session:
+        :return:
+        """
         return GroupService.get_user_paginator(
             self, page=page, item_count=item_count,
             items_per_page=items_per_page,
             user_ids=user_ids, GET_params=GET_params)
 
+    @deprecation.deprecate("Group.resources_with_possible_perms "
+                           "will be removed in 0.8, use service instead")
     def resources_with_possible_perms(self, perm_names=None, resource_ids=None,
                                       resource_types=None,
                                       db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param perm_names:
+        :param resource_ids:
+        :param resource_types:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return GroupService.resources_with_possible_perms(
             self, perm_names=perm_names, resource_ids=resource_ids,

ziggurat_foundations/models/group_permission.py

@@ -2,6 +2,8 @@
 import sqlalchemy as sa
 from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import validates
+from zope.deprecation import deprecation
+
 from .base import BaseModel
 from .services.group_permission import GroupPermissionService
 from .base import get_db_session
@@ -38,7 +40,18 @@ def __repr__(self):
         return '<GroupPermission: %s>' % self.perm_name
 
     @classmethod
+    @deprecation.deprecate("GroupPermission.by_group_and_perm "
+                           "will be removed in 0.8, use service instead")
     def by_group_and_perm(cls, group_id, perm_name, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param group_id:
+        :param perm_name:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session)
         return GroupPermissionService.by_group_and_perm(
             group_id=group_id,

ziggurat_foundations/models/resource.py

@@ -1,6 +1,8 @@
 from __future__ import unicode_literals
 import sqlalchemy as sa
 from sqlalchemy.ext.declarative import declared_attr
+from zope.deprecation import deprecation
+
 from .base import BaseModel
 from .services.resource import ResourceService
 from .base import get_db_session
@@ -103,64 +105,165 @@ def validate_permission(self, key, permission):
                 self.__possible_permissions__))
         return permission
 
+    @deprecation.deprecate("Resource.perms_for_user "
+                           "will be removed in 0.8, use service instead")
     def perms_for_user(self, user, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param user:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return ResourceService.perms_for_user(
             self, user=user, db_session=db_session)
 
+    @deprecation.deprecate("Resource.direct_perms_for_user "
+                           "will be removed in 0.8, use service instead")
     def direct_perms_for_user(self, user, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param user:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return ResourceService.direct_perms_for_user(
             self, user=user, db_session=db_session)
 
+    @deprecation.deprecate("Resource.group_perms_for_user "
+                           "will be removed in 0.8, use service instead")
     def group_perms_for_user(self, user, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param user:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return ResourceService.group_perms_for_user(
             self, user=user, db_session=db_session)
 
+    @deprecation.deprecate("Resource.users_for_perm "
+                           "will be removed in 0.8, use service instead")
     def users_for_perm(self, perm_name, user_ids=None, group_ids=None,
                        limit_group_permissions=False, skip_group_perms=False,
                        db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param perm_name:
+        :param user_ids:
+        :param group_ids:
+        :param limit_group_permissions:
+        :param skip_group_perms:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return ResourceService.users_for_perm(
             self, perm_name, user_ids=user_ids, group_ids=group_ids,
             limit_group_permissions=limit_group_permissions,
             skip_group_perms=skip_group_perms, db_session=db_session)
 
     @classmethod
+    @deprecation.deprecate("Resource.by_resource_id "
+                           "will be removed in 0.8, use service instead")
     def by_resource_id(cls, resource_id, db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param resource_id:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session)
         return ResourceService.by_resource_id(resource_id=resource_id,
                                               db_session=db_session)
-
     @classmethod
+    @deprecation.deprecate("Resource.perm_by_group_and_perm_name "
+                           "will be removed in 0.8, use service instead")
     def perm_by_group_and_perm_name(cls, res_id, group_id, perm_name,
                                     db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param res_id:
+        :param group_id:
+        :param perm_name:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session)
         return ResourceService.perm_by_group_and_perm_name(
             resource_id=res_id, group_id=group_id, perm_name=perm_name,
             db_session=db_session)
 
+    @deprecation.deprecate("Resource.groups_for_perm "
+                           "will be removed in 0.8, use service instead")
     def groups_for_perm(self, perm_name, group_ids=None,
                         limit_group_permissions=False,
                         db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param perm_name:
+        :param group_ids:
+        :param limit_group_permissions:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session, self)
         return ResourceService.groups_for_perm(
             self, perm_name=perm_name, group_ids=group_ids,
             limit_group_permissions=limit_group_permissions,
             db_session=db_session)
 
     @classmethod
+    @deprecation.deprecate("Resource.subtree_deeper "
+                           "will be removed in 0.8, use service instead")
     def subtree_deeper(cls, object_id, limit_depth=1000000, flat=True,
                        db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param object_id:
+        :param limit_depth:
+        :param flat:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session)
         return ResourceService.subtree_deeper(
             object_id=object_id, limit_depth=limit_depth, flat=flat,
             db_session=db_session)
 
     @classmethod
+    @deprecation.deprecate("Resource.path_upper "
+                           "will be removed in 0.8, use service instead")
     def path_upper(cls, object_id, limit_depth=1000000, flat=True,
                    db_session=None):
+        """
+
+        .. deprecated:: 0.8
+
+        :param object_id:
+        :param limit_depth:
+        :param flat:
+        :param db_session:
+        :return:
+        """
         db_session = get_db_session(db_session)
         return ResourceService.path_upper(
             object_id=object_id, limit_depth=limit_depth, flat=flat,