Merge pull request #15 from Podnapisi-NET/publish-preparations

Publish preparations

Author: MasterMind2k

README.rst

@@ -100,9 +100,25 @@ fetch\_
 Returns a list. If defining your own functions, do not use OFFSET and LIMIT, it will
 be appended by the extension.
 
+has\_
++++++
+
+Returns a bool, true or false. Query must return a single value!
+
+Common keyword arguments
+------------------------
+
+With all prepared queries, you may use cache (True/False) and cache_ttl arguments to control
+result caching. TTL is specified in seconds.
+
 List of functions
 -----------------
 
+get_autologin(key)
+++++++++++++++++++
+
+Gets autologin information. Used by session integration.
+
 get_session(session_id)
 +++++++++++++++++++++++
 
@@ -120,6 +136,26 @@ Use string named interpolation format (the psycopg one) to specify kwargs of a f
 Do not forget to use {TABLE_PREFIX} variable, to add specific table prefix. (First, the
 python variables from config get evaluated, and then psycopg variables).
 
+has_membership(user_id, group_id)
++++++++++++++++++++++++++++++++++
+
+Checks if user belongs to a group.
+
+has_membership_resolve(user_id, group_name)
++++++++++++++++++++++++++++++++++++++++++++
+
+Same as has_membership, only it works with group name.
+
+fetch_acl_options()
++++++++++++++++++++
+
+Fetches ACL data. Used by session integration.
+
+get_unread_notifications_count(user_id)
++++++++++++++++++++
+
+Retrieves user's unread notifications count. Used by session integration.
+
 Sessions integration
 --------------------
 
@@ -137,6 +173,13 @@ And you can use session's **is_authenticated** property to test if user is authe
   if session.is_authenticated:
     print 'User is authenticated!'
 
+Available is also the following API:
+  * is_member(group) - group may be id of the group or name
+  * has_privilege(option, forum_id=0) - tests if user has specified privilege
+  * has_privileges(*options, forum_id=0) - same as has_privilege, but for multiple privileges
+  * get_link_hash(link) - calculates hash
+  * num_unread_notifications - number of unread notifications for session user
+
 Caching
 -------
 

flask_phpbb3/extension.py

@@ -124,20 +124,42 @@ def _backend(self):
 
     def get_autologin(self, key, cache=False, cache_ttl=None):
         # type: (str, bool, typing.Optional[int]) -> typing.Optional[dict]
-        output = self._backend.execute('get_autologin', key=key)\
-            # type: typing.Optional[dict]
+        output = self._backend.execute(
+            'get_autologin',
+            key=key,
+            cache=cache,
+            cache_ttl=cache_ttl,
+        )  # type: typing.Optional[dict]
         return output
 
     def get_session(self, session_id, cache=False, cache_ttl=None):
         # type: (str, bool, typing.Optional[int]) -> typing.Optional[dict]
-        output = self._backend.execute('get_session', session_id=session_id)\
-            # type: typing.Optional[dict]
+        output = self._backend.execute(
+            'get_session',
+            session_id=session_id,
+            cache=cache,
+            cache_ttl=cache_ttl,
+        )  # type: typing.Optional[dict]
         return output
 
     def get_user(self, user_id, cache=False, cache_ttl=None):
         # type: (int, bool, typing.Optional[int]) -> typing.Optional[dict]
-        output = self._backend.execute('get_user', user_id=user_id)\
-            # type: typing.Optional[dict]
+        output = self._backend.execute(
+            'get_user',
+            user_id=user_id,
+            cache=cache,
+            cache_ttl=cache_ttl,
+        )  # type: typing.Optional[dict]
+        return output
+
+    def get_user_profile(self, user_id, cache=False, cache_ttl=None):
+        # type: (int, bool, typing.Optional[int]) -> typing.Optional[dict]
+        output = self._backend.execute(
+            'get_user_profile',
+            user_id=user_id,
+            cache=cache,
+            cache_ttl=cache_ttl,
+        )  # type: typing.Optional[dict]
         return output
 
     def has_membership(
@@ -210,6 +232,22 @@ def get_user_acl(self, raw_user_permissions):
         # type: (str) -> flask_phpbb3.backends.base.UserAcl
         return self._backend.get_user_acl(raw_user_permissions)
 
+    def execute_custom(
+        self,
+        command,  # type: str
+        cache=False,  # type: bool
+        cache_ttl=None,  # type: typing.Optional[int]
+        **kwargs  # type: typing.Any
+    ):
+        # type: (...) -> typing.Any
+        output = self._backend.execute(
+            command,
+            cache=cache,
+            cache_ttl=cache_ttl,
+            **kwargs
+        )  # type: typing.Any
+        return output
+
     def teardown(self, exception):
         # type: (typing.Any) -> None
         ctx = flask._app_ctx_stack.top

setup.cfg

@@ -18,7 +18,7 @@ classifier =
   Topic :: Software Development :: Libraries :: Python Modules
 
 [files]
-modules = flask_phpbb3
+packages = flask_phpbb3
 
 [wheel]
 universal = 1