# HG changeset patch # User Thierry Florac # Date 1464876143 -7200 # Node ID 284c0976e3ff2c8a96c637f8cc1741ed3ba4ca02 First commit diff -r 000000000000 -r 284c0976e3ff .hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.hgignore Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,19 @@ + +syntax: regexp +^develop-eggs$ +syntax: regexp +^parts$ +syntax: regexp +^bin$ +syntax: regexp +^\.installed\.cfg$ +syntax: regexp +^\.settings$ +syntax: regexp +^build$ +syntax: regexp +^dist$ +syntax: regexp +^\.idea$ +syntax: regexp +.*\.pyc$ diff -r 000000000000 -r 284c0976e3ff .idea/encodings.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.idea/encodings.xml Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff .idea/misc.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.idea/misc.xml Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff .idea/modules.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.idea/modules.xml Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff .idea/pyams_notify_ws.iml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.idea/pyams_notify_ws.iml Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff .idea/workspace.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.idea/workspace.xml Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff LICENSE --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/LICENSE Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,42 @@ +Zope Public License (ZPL) Version 2.1 +===================================== + +A copyright notice accompanies this license document that identifies +the copyright holders. + +This license has been certified as open source. It has also been designated +as GPL compatible by the Free Software Foundation (FSF). + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + 1. Redistributions in source code must retain the accompanying copyright + notice, this list of conditions, and the following disclaimer. + 2. Redistributions in binary form must reproduce the accompanying copyright + notice, this list of conditions, and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Names of the copyright holders must not be used to endorse or promote + products derived from this software without prior written permission + from the copyright holders. + 4. The right to distribute this software or to use it for any purpose does + not give you the right to use Servicemarks (sm) or Trademarks (tm) of the + copyright holders. Use of them is covered by separate agreement with the + copyright holders. + 5. If any files are modified, you must cause the modified files to carry + prominent notices stating that you changed the files and the date of any + change. + + +Disclaimer +========== + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY EXPRESSED +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff -r 000000000000 -r 284c0976e3ff MANIFEST.in --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/MANIFEST.in Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,5 @@ +include *.txt +recursive-include docs * +recursive-include src * +global-exclude *.pyc +global-exclude *.*~ diff -r 000000000000 -r 284c0976e3ff bootstrap.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/bootstrap.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,178 @@ +############################################################################## +# +# Copyright (c) 2006 Zope Foundation and Contributors. +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# +############################################################################## +"""Bootstrap a buildout-based project + +Simply run this script in a directory containing a buildout.cfg. +The script accepts buildout command-line options, so you can +use the -c option to specify an alternate configuration file. +""" + +import os +import shutil +import sys +import tempfile + +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +usage = '''\ +[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] + +Bootstraps a buildout-based project. + +Simply run this script in a directory containing a buildout.cfg, using the +Python that you want bin/buildout to use. + +Note that by using --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +parser.add_option("-t", "--accept-buildout-test-releases", + dest='accept_buildout_test_releases', + action="store_true", default=False, + help=("Normally, if you do not specify a --version, the " + "bootstrap script and buildout gets the newest " + "*final* versions of zc.buildout and its recipes and " + "extensions for you. If you use this flag, " + "bootstrap and buildout will get the newest releases " + "even if they are alphas or betas.")) +parser.add_option("-c", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) +parser.add_option("--allow-site-packages", + action="store_true", default=False, + help=("Let bootstrap.py use existing site packages")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install setuptools + +try: + if options.allow_site_packages: + import setuptools + import pkg_resources + from urllib.request import urlopen +except ImportError: + from urllib2 import urlopen + +ez = {} +exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) + +if not options.allow_site_packages: + # ez_setup imports site, which adds site packages + # this will remove them from the path to ensure that incompatible versions + # of setuptools are not in the path + import site + # inside a virtualenv, there is no 'getsitepackages'. + # We can't remove these reliably + if hasattr(site, 'getsitepackages'): + for sitepackage_path in site.getsitepackages(): + sys.path[:] = [x for x in sys.path if sitepackage_path not in x] + +setup_args = dict(to_dir=tmpeggs, download_delay=0) +ez['use_setuptools'](**setup_args) +import setuptools +import pkg_resources + +# This does not (always?) update the default working set. We will +# do it. +for path in sys.path: + if path not in pkg_resources.working_set.entries: + pkg_resources.working_set.add_entry(path) + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +requirement = 'zc.buildout' +version = options.version +if version is None and not options.accept_buildout_test_releases: + # Figure out the most recent final version of zc.buildout. + import setuptools.package_index + _final_parts = '*final-', '*final' + + def _final_version(parsed_version): + for part in parsed_version: + if (part[:1] == '*') and (part not in _final_parts): + return False + return True + index = setuptools.package_index.PackageIndex( + search_path=[setuptools_path]) + if find_links: + index.add_find_links((find_links,)) + req = pkg_resources.Requirement.parse(requirement) + if index.obtain(req) is not None: + best = [] + bestv = None + for dist in index[req.project_name]: + distv = dist.parsed_version + if _final_version(distv): + if bestv is None or distv > bestv: + best = [dist] + bestv = distv + elif distv == bestv: + best.append(dist) + if best: + best.sort() + version = best[-1].version +if version: + requirement = '=='.join((requirement, version)) +cmd.append(requirement) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: + raise Exception( + "Failed to execute command:\n%s" % repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff -r 000000000000 -r 284c0976e3ff buildout.cfg --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/buildout.cfg Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,65 @@ +[buildout] +eggs-directory = /var/local/env/pyams/eggs + +socket-timeout = 3 +show-picked-versions = true +newest = false + +allow-hosts = + bitbucket.org + *.python.org + *.sourceforge.net + github.com + +#extends = http://download.ztfy.org/webapp/ztfy.webapp.dev.cfg +versions = versions +newest = false +#allow-picked-versions = false + +src = src +develop = + . + /var/local/src/pyams/ext/lingua + /var/local/src/pyams/ext/pyramid_recipe_modwsgi + +parts = + package + i18n + pyflakes + test + +[package] +recipe = zc.recipe.egg +eggs = + aiopyramid + aiohttp + gunicorn + pyams_notify_ws + pyramid + pyramid-chameleon + websockets + +[i18n] +recipe = zc.recipe.egg +eggs = + babel + lingua + +[pyflakes] +recipe = zc.recipe.egg +eggs = pyflakes +scripts = pyflakes +entry-points = pyflakes=pyflakes.scripts.pyflakes:main +initialization = if not sys.argv[1:]: sys.argv[1:] = ["${buildout:src}"] + +[pyflakesrun] +recipe = collective.recipe.cmd +on_install = true +cmds = ${buildout:develop}/bin/${pyflakes:scripts} + +[test] +recipe = zc.recipe.testrunner +eggs = pyams_notify_ws [test] + +[versions] +pyams_notify_ws = 0.1.0 diff -r 000000000000 -r 284c0976e3ff docs/HISTORY.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/HISTORY.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,6 @@ +History +======= + +0.1.0 +----- + - initial release diff -r 000000000000 -r 284c0976e3ff docs/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/README.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,13 @@ +.. contents:: + + +Introduction +============ + +pyams_notify_ws is a Pyramid/PyAMS WebSockets server package used to handle users notifications. + +Clients can connect to a given WebSockets service and subscribe to notifications; these notifications can be +general or limited to a given context. + +The WebSockets server doesn't have any "intelligence": it only references clients (including their roles) and +their subscriptions, and acts as a proxy between an application server and it's clients. diff -r 000000000000 -r 284c0976e3ff setup.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,68 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +""" +This module contains pyams_notify_ws package +""" +import os +from setuptools import setup, find_packages + +DOCS = os.path.join(os.path.dirname(__file__), + 'docs') + +README = os.path.join(DOCS, 'README.txt') +HISTORY = os.path.join(DOCS, 'HISTORY.txt') + +version = '0.1.0' +long_description = open(README).read() + '\n\n' + open(HISTORY).read() + +tests_require = [] + +setup(name='pyams_notify_ws', + version=version, + description="PyAMS notifications server management package", + long_description=long_description, + classifiers=[ + "License :: OSI Approved :: Zope Public License", + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Framework :: Pyramid", + "Topic :: Software Development :: Libraries :: Python Modules", + ], + keywords='Pyramid PyAMS', + author='Thierry Florac', + author_email='tflorac@ulthar.net', + url='http://hg.ztfy.org/pyams/pyams_notify_ws', + license='ZPL', + packages=find_packages('src'), + package_dir={'': 'src'}, + namespace_packages=[], + include_package_data=True, + package_data={'': ['*.zcml', '*.txt', '*.pt', '*.pot', '*.po', '*.mo', + '*.png', '*.gif', '*.jpeg', '*.jpg', '*.css', '*.js']}, + zip_safe=False, + # uncomment this to be able to run tests with setup.py + test_suite="pyams_notify_ws.tests.test_utilsdocs.test_suite", + tests_require=tests_require, + extras_require=dict(test=tests_require), + install_requires=[ + 'setuptools', + # -*- Extra requirements: -*- + 'aiomcache', + 'aiopyramid', + 'pyramid', + 'zope.interface' + ], + entry_points=""" + # -*- Entry points: -*- + """, + ) diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/PKG-INFO --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/PKG-INFO Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,31 @@ +Metadata-Version: 1.1 +Name: pyams-notify-ws +Version: 0.1.0 +Summary: PyAMS notifications server management package +Home-page: http://hg.ztfy.org/pyams/pyams_notify_ws +Author: Thierry Florac +Author-email: tflorac@ulthar.net +License: ZPL +Description: .. contents:: + + + Introduction + ============ + + pyams_notify_ws is a Pyramid/PyAMS WebSockets server package used to handle users notifications. + + Clients can connect to a given WebSockets service and subscribe to notifications; these notifications can be + general or limited to a given context. + + The WebSockets server doesn't have any "intelligence": it only references clients (including their roles) and + their subscriptions, and acts as a proxy between an application server and it's clients. + + + +Keywords: Pyramid PyAMS +Platform: UNKNOWN +Classifier: License :: OSI Approved :: Zope Public License +Classifier: Development Status :: 4 - Beta +Classifier: Programming Language :: Python +Classifier: Framework :: Pyramid +Classifier: Topic :: Software Development :: Libraries :: Python Modules diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/SOURCES.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/SOURCES.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,21 @@ +MANIFEST.in +setup.py +docs/HISTORY.txt +docs/README.txt +src/pyams_notify_ws/__init__.py +src/pyams_notify_ws/include.py +src/pyams_notify_ws/notify.py +src/pyams_notify_ws/subscribe.py +src/pyams_notify_ws.egg-info/PKG-INFO +src/pyams_notify_ws.egg-info/SOURCES.txt +src/pyams_notify_ws.egg-info/dependency_links.txt +src/pyams_notify_ws.egg-info/entry_points.txt +src/pyams_notify_ws.egg-info/namespace_packages.txt +src/pyams_notify_ws.egg-info/not-zip-safe +src/pyams_notify_ws.egg-info/requires.txt +src/pyams_notify_ws.egg-info/top_level.txt +src/pyams_notify_ws/doctests/README.txt +src/pyams_notify_ws/interfaces/__init__.py +src/pyams_notify_ws/tests/__init__.py +src/pyams_notify_ws/tests/test_utilsdocs.py +src/pyams_notify_ws/tests/test_utilsdocstrings.py \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/dependency_links.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/dependency_links.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/entry_points.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/entry_points.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,3 @@ + + # -*- Entry points: -*- + \ No newline at end of file diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/namespace_packages.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/namespace_packages.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/not-zip-safe --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/not-zip-safe Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/requires.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/requires.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,6 @@ +setuptools +pyramid +zope.component +zope.interface + +[test] diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws.egg-info/top_level.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws.egg-info/top_level.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,1 @@ +pyams_notify_ws diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/__init__.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,24 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +from pyramid.i18n import TranslationStringFactory +_ = TranslationStringFactory('pyams_notify_ws') + + +def includeme(config): + """Pyramid include""" + + from .include import include_package + include_package(config) diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/doctests/README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/doctests/README.txt Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,3 @@ +======================= +pyams_notify_ws package +======================= diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/include.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/include.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,37 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library + +# import interfaces + +# import packages + + +def include_package(config): + """Pyramid include""" + + # add translations + config.add_translation_dirs('pyams_notify_ws:locales') + + # load registry components + config.scan() + config.add_route('subscribe', '/subscribe') + config.add_route('notify', '/notify') + + memcached_server = config.registry.settings.get('pyams_notify_ws.memcached_server') + if memcached_server: + from .notify import init_memcached_client + init_memcached_client(memcached_server) diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/interfaces/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/interfaces/__init__.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,23 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library + +# import interfaces +from zope.interface import Interface + +# import packages + +from pyams_notify_ws import _ diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/notify.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/notify.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,82 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library +import asyncio +import collections +import json +import pickle + +# import interfaces + +# import packages +from aiomcache import Client as MemcachedClient +from aiopyramid.websocket.config.gunicorn import WebsocketMapper +from aiopyramid.websocket.view import WebsocketConnectionView +from pyams_notify_ws.subscribe import users +from pyramid.view import view_config + + +queue = collections.deque(maxlen=50) +queue_key = b'_PyAMS_notify_messages_queue_' +queue_lock = asyncio.Lock() + +memcached_client = None + + +def init_memcached_client(server): + """Initialize memcached handler""" + global memcached_client + ip, port = server.split(':') + memcached_client = MemcachedClient(ip, int(port)) + + +@view_config(route_name='notify', mapper=WebsocketMapper) +class WebsocketNotifyView(WebsocketConnectionView): + """Websocket notify view""" + + @asyncio.coroutine + def on_open(self): + pass + + @asyncio.coroutine + def on_message(self, message): + try: + message = json.loads(message) + except ValueError: + pass + else: + action = message.get('action') + if action == 'notify': + # dispatch notification to subscribers + json_message = json.dumps(message) + target = message.get('target').get('principals', ()) + for connection, subscription in users.items(): + if subscription.filter_target(target): + yield from connection.send(json_message) + # store message in memcached_queue + if memcached_client is not None: + with (yield from queue_lock): + mem_queue = yield from memcached_client.get(queue_key) + if mem_queue is None: + mem_queue = queue + else: + mem_queue = pickle.loads(mem_queue) + mem_queue.append(message) + yield from memcached_client.set(queue_key, pickle.dumps(mem_queue)) + + @asyncio.coroutine + def on_close(self): + pass diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/subscribe.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/subscribe.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,89 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +__docformat__ = 'restructuredtext' + + +# import standard library +import asyncio +import json + +# import interfaces + +# import packages +from aiopyramid.websocket.config.gunicorn import WebsocketMapper +from aiopyramid.websocket.view import WebsocketConnectionView +from pyramid.view import view_config + + +users_lock = asyncio.Lock() +users = {} + + +class WebsocketSubscription(object): + """Websocket user subscription + + A subscription is defined by: + - a principal identified by it's ID, title, authentication token and principals + - a set of contexts; each context is defined by a unique key ('*' for a global + subscription) for which we subscribe for a list of events types + """ + + def __init__(self, principal): + self.principal = principal + self.contexts = {} + + def update_contexts(self, new_contexts): + contexts = self.contexts + for ctx, events in new_contexts.items(): + contexts[ctx] = set(contexts.get(ctx, set())) | set(events) + self.contexts = contexts + + def filter_target(self, target): + if not target: + return True + return self.principal['id'] in target + + +@view_config(route_name='subscribe', mapper=WebsocketMapper) +class WebsocketSubscribeView(WebsocketConnectionView): + """Websocket subscribe view""" + + @asyncio.coroutine + def on_open(self): + pass + + @asyncio.coroutine + def on_message(self, message): + try: + message = json.loads(message) + except ValueError: + pass + else: + action = message.get('action') + if action == 'subscribe': + if not message.get('principal'): + yield from self.ws.send(json.dumps({'status': 'error', + 'message': "Missing 'principal' argument"})) + return + with (yield from users_lock): + subscription = users.get(self.ws) + if subscription is None: + subscription = WebsocketSubscription(message.get('principal')) + subscription.update_contexts(message.get('context')) + users[self.ws] = subscription + + @asyncio.coroutine + def on_close(self): + if self.ws in users: + with (yield from users_lock): + del users[self.ws] diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/tests/__init__.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/tests/__init__.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,1 @@ + diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/tests/test_utilsdocs.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/tests/test_utilsdocs.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,59 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +""" +Generic Test case for pyams_notify_ws doctest +""" +__docformat__ = 'restructuredtext' + +import unittest +import doctest +import sys +import os + + +current_dir = os.path.dirname(__file__) + +def doc_suite(test_dir, setUp=None, tearDown=None, globs=None): + """Returns a test suite, based on doctests found in /doctest.""" + suite = [] + if globs is None: + globs = globals() + + flags = (doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | + doctest.REPORT_ONLY_FIRST_FAILURE) + + package_dir = os.path.split(test_dir)[0] + if package_dir not in sys.path: + sys.path.append(package_dir) + + doctest_dir = os.path.join(package_dir, 'doctests') + + # filtering files on extension + docs = [os.path.join(doctest_dir, doc) for doc in + os.listdir(doctest_dir) if doc.endswith('.txt')] + + for test in docs: + suite.append(doctest.DocFileSuite(test, optionflags=flags, + globs=globs, setUp=setUp, + tearDown=tearDown, + module_relative=False)) + + return unittest.TestSuite(suite) + +def test_suite(): + """returns the test suite""" + return doc_suite(current_dir) + +if __name__ == '__main__': + unittest.main(defaultTest='test_suite') + diff -r 000000000000 -r 284c0976e3ff src/pyams_notify_ws/tests/test_utilsdocstrings.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/pyams_notify_ws/tests/test_utilsdocstrings.py Thu Jun 02 16:02:23 2016 +0200 @@ -0,0 +1,62 @@ +# +# Copyright (c) 2008-2015 Thierry Florac +# All Rights Reserved. +# +# This software is subject to the provisions of the Zope Public License, +# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. +# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED +# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS +# FOR A PARTICULAR PURPOSE. +# + +""" +Generic Test case for pyams_notify_ws doc strings +""" +__docformat__ = 'restructuredtext' + +import unittest +import doctest +import sys +import os + + +current_dir = os.path.abspath(os.path.dirname(__file__)) + +def doc_suite(test_dir, globs=None): + """Returns a test suite, based on doc tests strings found in /*.py""" + suite = [] + if globs is None: + globs = globals() + + flags = (doctest.ELLIPSIS | doctest.NORMALIZE_WHITESPACE | + doctest.REPORT_ONLY_FIRST_FAILURE) + + package_dir = os.path.split(test_dir)[0] + if package_dir not in sys.path: + sys.path.append(package_dir) + + # filtering files on extension + docs = [doc for doc in + os.listdir(package_dir) if doc.endswith('.py')] + docs = [doc for doc in docs if not doc.startswith('__')] + + for test in docs: + fd = open(os.path.join(package_dir, test)) + content = fd.read() + fd.close() + if '>>> ' not in content: + continue + test = test.replace('.py', '') + location = 'pyams_notify_ws.%s' % test + suite.append(doctest.DocTestSuite(location, optionflags=flags, + globs=globs)) + + return unittest.TestSuite(suite) + +def test_suite(): + """returns the test suite""" + return doc_suite(current_dir) + +if __name__ == '__main__': + unittest.main(defaultTest='test_suite')