Merge pull request #2 from mulby/gabe/event-emit

support minimal event emission

.coveragerc

+[run]
+branch = True
+omit = *mock*

.gitignore

+*.log
+*.pot
+*.pyc
+local_settings.py
+*.egg-info
+.treerc
+.coverage
+htmlcov
+.ropeproject
+*.sublime-*
+
+# Documentation
+doc/_build
+.pip_cache
+nosetests.xml
+coverage.xml
+pep8.report
+pylint.report
+diff_cover.html
+diff_quality_pep8.html
+diff_quality_pylint.html

.pep8

+[pep8]
+max-line-length=119

eventtracking/tests/test_track.py

+"""
+Test the event tracking module
+"""
+
+from datetime import datetime
+from unittest import TestCase
+
+from mock import MagicMock
+from mock import patch
+from mock import sentinel
+
+from eventtracking import track
+
+
+class TestTrack(TestCase):  # pylint: disable=missing-docstring
+
+    def setUp(self):
+        self._mock_backend = MagicMock()
+        self.addCleanup(track.BACKENDS.remove, self._mock_backend)
+        track.BACKENDS.append(self._mock_backend)
+
+        self._expected_timestamp = datetime.utcnow()
+        self._datetime_patcher = patch('eventtracking.track.datetime')
+        self.addCleanup(self._datetime_patcher.stop)
+        mock_datetime = self._datetime_patcher.start()
+        mock_datetime.utcnow.return_value = self._expected_timestamp  # pylint: disable=maybe-no-member
+
+    def test_event_simple_event_without_data(self):
+        track.event(sentinel.event_type)
+
+        self.__assert_backend_called_with(sentinel.event_type)
+
+    def __assert_backend_called_with(self, event_type, data=None, backend=None):
+        """Ensures the backend is called exactly once with the expected data."""
+        if not backend:
+            backend = self._mock_backend
+
+        backend.event.assert_called_once_with(
+            {
+                'event_type': event_type,
+                'timestamp': self._expected_timestamp,
+                'data': data or {}
+            }
+        )
+
+    def test_event_simple_event_with_data(self):
+        track.event(
+            sentinel.event_type,
+            {
+                sentinel.key: sentinel.value
+            }
+        )
+
+        self.__assert_backend_called_with(
+            sentinel.event_type,
+            {
+                sentinel.key: sentinel.value
+            }
+        )
+
+    def test_multiple_backends(self):
+        another_backend = MagicMock()
+        track.BACKENDS.append(another_backend)
+        try:
+            track.event(sentinel.event_type)
+
+            self.__assert_backend_called_with(sentinel.event_type)
+            self.__assert_backend_called_with(
+                sentinel.event_type, backend=another_backend)
+        finally:
+            track.BACKENDS.remove(another_backend)
+
+    def test_single_backend_failure(self):
+        self._mock_backend.event.side_effect = Exception
+
+        another_backend = MagicMock()
+        track.BACKENDS.append(another_backend)
+        try:
+            track.event(sentinel.event_type)
+
+            self.__assert_backend_called_with(
+                sentinel.event_type, backend=another_backend)
+        finally:
+            track.BACKENDS.remove(another_backend)

eventtracking/track.py

+"""
+Track application events.  Supports persisting events to multiple backends.
+
+Best Practices:
+* It is recommended that event types are namespaced using dot notation to
+  avoid naming collisions, similar to DNS names.  For example:
+  org.edx.video.stop, edu.mit.audio.stop
+* Avoid using event type names that may cause collisions.  The burden is
+  on the analyst to decide whether your event is equivalent to another
+  and should be grouped accordingly etc.
+* Do not emit events that you don't own.  This could negatively impact
+  the analysis of the event stream.  If you suspect your event is
+  equivalent to another, say so in your documenation, and the analyst
+  can decide whether or not to group them.
+"""
+from datetime import datetime
+import logging
+
+
+LOG = logging.getLogger(__name__)
+BACKENDS = []
+
+
+def event(event_type, data=None):
+    """
+    Emit an event annotated with the UTC time when this function was called.
+
+    :event_type: A unique identification string for an event that has already been registered.
+    :data: A dictionary mapping field names to the value to include in the event.  Note that all values provided must be serializable.
+
+    """
+    full_event = {
+        'event_type': event_type,
+        'timestamp': datetime.utcnow(),
+        'data': data or {}
+    }
+
+    for backend in BACKENDS:
+        try:
+            backend.event(full_event)
+        except Exception:  # pylint: disable=W0703
+            LOG.exception(
+                'Unable to commit event to backend: {0}'.format(backend)
+            )

pylintrc

+[MASTER]
+
+# Specify a configuration file.
+#rcfile=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Profiled execution.
+profile=no
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS, migrations
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+
+[MESSAGES CONTROL]
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time.
+#enable=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once).
+disable=
+# Never going to use these
+# I0011: Locally disabling W0232
+# W0141: Used builtin function 'map'
+# W0142: Used * or ** magic
+# R0921: Abstract class not referenced
+# R0922: Abstract class is only referenced 1 times
+    I0011,W0141,W0142,R0921,R0922,
+
+# Django makes classes that trigger these
+# W0232: Class has no __init__ method
+    W0232,
+
+# Might use these when the code is in better shape
+# C0302: Too many lines in module
+# R0201: Method could be a function
+# R0901: Too many ancestors
+# R0902: Too many instance attributes
+# R0903: Too few public methods (1/2)
+# R0904: Too many public methods
+# R0911: Too many return statements
+# R0912: Too many branches
+# R0913: Too many arguments
+# R0914: Too many local variables
+    C0302,R0201,R0901,R0902,R0903,R0904,R0911,R0912,R0913,R0914
+
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html
+output-format=text
+
+# Include message's id in output
+include-ids=yes
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (RP0004).
+comment=no
+
+
+[TYPECHECK]
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of classes names for which member attributes should not be checked
+# (useful for classes with attributes dynamically set).
+ignored-classes=SQLObject
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E0201 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+    REQUEST,
+    acl_users,
+    aq_parent,
+    objects,
+    DoesNotExist,
+    can_read,
+    can_write,
+    get_url,
+    size,
+    content,
+    status_code,
+# For factory_boy factories
+    create
+
+
+[BASIC]
+
+# Required attributes for module, separated by a comma
+required-attributes=
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,input
+
+# Regular expression which should only match correct module names
+module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+
+# Regular expression which should only match correct module level names
+const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns)$
+
+# Regular expression which should only match correct class names
+class-rgx=[A-Z_][a-zA-Z0-9]+$
+
+# Regular expression which should only match correct function names
+function-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct method names
+method-rgx=([a-z_][a-z0-9_]{2,60}|setUp|set[Uu]pClass|tearDown|tear[Dd]ownClass|assert[A-Z]\w*)$
+
+# Regular expression which should only match correct instance attribute names
+attr-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct argument names
+argument-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct variable names
+variable-rgx=[a-z_][a-z0-9_]{2,30}$
+
+# Regular expression which should only match correct list comprehension /
+# generator expression variable names
+inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=i,j,k,ex,Run,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=foo,bar,baz,toto,tutu,tata
+
+# Regular expression which should only match functions or classes name which do
+# not require a docstring
+no-docstring-rgx=__.*__|test_.*|setUp|tearDown
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,XXX,TODO
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# Maximum number of lines in a module
+max-module-lines=1000
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=_|dummy|unused|.*_unused
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method
+max-args=5
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore
+ignored-argument-names=_.*
+
+# Maximum number of locals for function / method body
+max-locals=15
+
+# Maximum number of return / yield for function / method body
+max-returns=6
+
+# Maximum number of branch for function / method body
+max-branchs=12
+
+# Maximum number of statements in function / method body
+max-statements=50
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+
+[CLASSES]
+
+# List of interface methods to ignore, separated by a comma. This is used for
+# instance to not check methods defines in Zope's Interface base class.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=Exception

requirements.txt

+# 3rd-party needs
+Django >= 1.4, < 1.5
+
+# For Tests
+mock
+
+# For docs
+sphinx