initial commit

Author: meltaxa

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dennis Mellican
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,72 @@
+# SlackMQ
+
+Enables a common Message Queue mechanism for "message locking" within Slack. 
+When a message is sent to a channel, a Slack bot can acknowledge the message 
+and “lock” it for processing. This keeps other worker bots from processing the 
+message simultaneously.
+
+SlackMQ leverages the Slack API method for pinning, reactions and starring of 
+messages, where only one is allowed per post per user (or bot) account. 
+
+A Slack worker bot can use the same API token to connect to Slack up to 16 
+times. This is a restriction imposed by Slack.
+
+SlackMQ is not a replacement for dedicated Message Brokers and Queue systems. It
+only does simple message locking and is suitable for managing low bandwidth
+tasks or applications. For those use cases, it's one less moving part and makes
+Slack do the heavy lifting.
+
+To install:
+```
+pip install SlackMQ
+```
+
+## Message Locking Anatomy
+
+A star and pin action are both used to "lock" a message. 
+
+The star is not seen in the Slack channel, as it is only visible by the user 
+creating the star.
+
+Pins and reactions are visible to everyone in the channel.
+
+To avoid race conditions, where two or more bots simultaneously star the
+same message (the Slack API says it shouldn't but it can happen), a second 
+action (the star) is invoked. An optional third action (a reaction emoji) for 
+extra protection can also be invoked.
+
+## Example: The Slack Worker Bot
+
+For high availability and scalability reasons, multiple worker bots could be 
+deployed through out a network. Using the Slackbot python library to listen and 
+respond to certain Slack posts, all the bots will receive the message, but the 
+first to acknowledge the message will be able to process it. 
+
+```
+from slackmq import slackmq
+from slackbot.bot import listen_to
+import socket
+
+API_TOKEN = 'YOUR-BOT-API-TOKEN'
+
+@listen_to('hostname')
+def myhostname(message):
+    post = slackmq(API_TOKEN,
+                   message.body['channel'], 
+                   message.body['ts'])
+    if post.ack():
+        message.send('I am running on {}.'.format(socket.gethostname()))
+        # Removes the visible pin (and hidden star) from the channel.
+        post.unack()
+```
+
+## Example: Continuous Delivery with SlackMQ
+
+Watch Continuous Delivery with SlackMQ in action, deploying a home automation
+application across several hosts. From Continuous Integration to an automated
+canary deployment. Once approved, a rolling deployment occurs with zero 
+downtime.
+
+Video has no audio:
+
+[![Continuous Delivery with SlackMQ](http://img.youtube.com/vi/YW6IdsvdxXI/0.jpg)](http://www.youtube.com/watch?v=YW6IdsvdxXI "Continuous Delivery with SlackMQ")

VERSION

@@ -0,0 +1 @@
+0.1.0

requirements

@@ -0,0 +1 @@
+Slacker

setup.cfg

@@ -0,0 +1,5 @@
+[bdist_wheel]
+universal=1
+
+[metadata]
+description-file = README.md

setup.py

@@ -0,0 +1,35 @@
+from os.path import join, dirname
+from setuptools import setup
+
+__version__ = open(join(dirname(__file__), 'VERSION')).read().strip()
+
+install_requires = (
+    'slacker>=0.9.50'
+)
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name='slackmq',
+    py_modules=['slackmq'],
+    version=__version__,
+    description='A Slack Message Queue system',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author='Dennis Mellican',
+    author_email='[email protected]',
+    url='https://github.com/meltaxa/slackmq',
+    license='MIT',
+    include_package_data=True,
+    install_requires=install_requires,
+    classifiers=['Development Status :: 4 - Beta',
+                  'License :: OSI Approved :: MIT License',
+                  'Operating System :: OS Independent',
+                  'Programming Language :: Python',
+                  'Programming Language :: Python :: 2',
+                  'Programming Language :: Python :: 2.7',
+                  'Programming Language :: Python :: 3',
+                  'Programming Language :: Python :: 3.4',
+                  'Programming Language :: Python :: 3.5',
+                  'Programming Language :: Python :: 3.6'])

slackmq.py

@@ -0,0 +1,34 @@
+from slacker import Slacker
+from time import sleep
+
+class slackmq(object):
+  def __init__(self, api_token, channel, timestamp):
+    self.api_token = api_token
+    self.channel = channel
+    self.timestamp = timestamp
+
+  def ack(self, emoji=None):
+    try:
+      slack = Slacker(self.api_token)
+      slack.stars.add(channel = self.channel, timestamp = self.timestamp)
+ 
+      if emoji != None:
+        slack.reactions.add(emoji, channel = self.channel, timestamp = self.timestamp)
+
+      slack.pins.add(channel = self.channel, timestamp = self.timestamp)
+    except:
+      return False
+
+    return True
+
+  def unack(self, emoji=None):
+    try:
+      slack = Slacker(self.api_token)
+      slack.pins.remove(channel = self.channel, timestamp = self.timestamp)
+      sleep(3)
+      if emoji != None:
+        slack.reactions.remove(emoji, channel = self.channel, timestamp = self.timestamp)
+      sleep(5)
+      slack.stars.remove(channel = self.channel, timestamp = self.timestamp)
+    except:
+      return False