update docs

docs/decorators.rst

@@ -0,0 +1,63 @@
+.. _decorators:
+
+Builtin decorators
+==================
+
+
+Allowed users::
+
+    from mattermost_bot.utils import allowed_users
+    from mattermost_bot.bot import respond_to
+
+
+    @respond_to('^is-allowed$')
+    @allowed_users('admin', 'root')
+    def access_allowed(message):
+        message.reply('Access is allowed')
+
+
+
+Direct messages::
+
+    from mattermost_bot.utils import allow_only_direct_message
+    from mattermost_bot.bot import respond_to
+
+
+    @respond_to('^direct-msg$')
+    @allow_only_direct_message()
+    def direct_msg(message):
+        message.reply('Message is direct')
+
+
+
+Real case
+---------
+
+For example we have some users on our chat. We want allow some functionality
+to some users. We can create constants with allowed users on bot settings::
+
+    ADMIN_USERS = ['admin', 'root']
+    SUPPORT_USERS = ['mike', 'nick']
+
+
+So now we can close access to some functions on plugins::
+
+    from mattermost_bot.utils import allow_only_direct_message
+    from mattermost_bot.utils import allowed_users
+    from mattermost_bot.bot import respond_to
+    from mattermost_bot import settings
+
+
+    @respond_to('^selfupdate')
+    @allow_only_direct_message()
+    @allowed_users(*settings.ADMIN_USERS)
+    def self_update(message):
+        # some code
+        message.reply('Update was done')
+
+
+    @respond_to('^smsto (.*)')
+    @allowed_users(*settings.SUPPORT_USERS)
+    def sms_to(message, name):
+        # some code
+        message.reply('Sms was sent to %s' % name)

docs/demo_installation.rst

@@ -25,7 +25,7 @@ Install stable package from PyPi::
 Create settings file `mattermost_bot_settings.py` with the following lines::
 
     DEBUG = True
-    BOT_URL = 'http://mm.example.com:8065/api/v1'
+    BOT_URL = 'http://mm.example.com:8065/api/v3'
     BOT_LOGIN = '<BOT_EMAIL>'
     BOT_PASSWORD = '<BOT_PASSWORD>'
     BOT_TEAM = '<TEAM>'

docs/index.rst

@@ -15,6 +15,7 @@ Contents
   plugins
   deploy
   use_cases
+  decorators
   demo_installation
   dev_install
   contributing

docs/installation.rst

@@ -4,12 +4,12 @@ Installation
 Compatibility
 -------------
 * Python: 2.6, 3.4+
-* Mattermost: 1.4+
+* Mattermost: 3.x+
 
 
 Recommended way to install is via pip::
 
-  pip install mattermost_bot
+  pip install -U mattermost_bot
 
 
 Check `mattermost_bot` version::

mattermost_bot/plugins/access.py

@@ -1,10 +1,12 @@
 # -*- encoding: utf-8 -*-
 
+from mattermost_bot.utils import allow_only_direct_message
 from mattermost_bot.utils import allowed_users
 from mattermost_bot.bot import respond_to
 
 
 @respond_to('^admin$')
+@allow_only_direct_message()
 @allowed_users('admin', 'root')
-def hello_react(message):
+def users_access(message):
     message.reply('Access allowed!')