mingle_events 0.0.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'nokogiri'
+gem 'activesupport'

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2011 ThoughtWorks, Inc., authored by David J. Rice (david.rice at gmail dot com)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.textile

@@ -0,0 +1,117 @@
+h1. Mingle Events
+
+h3. Overview
+
+Mingle 3.3 introduced a new Events API in the form of an "Atom feed":http://www.thoughtworks-studios.com/mingle/3.3/help/mingle_api_events.html. The Mingle team and ThoughtWorks Studios are big believers in the use of Atom for exposing events. Atom is a widely used standard, and this event API style puts the issue of robust event delivery in the hands of the consumer, where it belongs. In fact, we'd argue this is the only feasible means of robust, scalable event delivery, short of spending hundreds of thousands or millions of dollars on enterprise buses and such. Atom-delivered events are cheap, scalable, standards-based, and robust.
+
+However, we do accept that asking integrators wishing to consume events to implement polling is not ideal. Writing polling consumers can be tedious. And this tedium gets in the way of writing sweet Mingle integrations. We are addressing this by publishing libraries such as this, which if effective, fully hide the mechanics of event polling from the consumer. The consumer only need worry about the processing of events. Said processing is modeled in the style of 'pipes and filters.'
+
+h3. Installation
+
+<pre>
+gem install mingle_events
+</pre>
+
+h3. Source
+
+"Hosted on github":https://github.com/ThoughtWorksStudios/mingle_events
+
+<pre>
+git clone git://github.com/ThoughtWorksStudios/mingle_events.git
+</pre>
+  
+h2. Quick example
+
+<pre>
+# configure access to mingle
+mingle_access = MingleEvents::MingleBasicAuthAccess.new('https://localhost:7071', 'david', 'p')
+
+# assemble processing pipeline
+post_comments_to_another_service = MingleEvents::Processors::Pipeline.new([
+  MingleEvents::Processors::CategoryFilter.new([MingleEvents::Feed::Category::COMMENT_ADDITION]),
+  MingleEvents::Processors::HttpPostPublisher.new('http://localhost:4567/')
+])
+
+# poll once
+MingleEvents::Poller.new(mingle_access, {'test_project' => [post_comments_to_another_service]}).run_once  
+</pre>
+
+h2. High level design
+
+This library pumps the stream of a Mingle project's events through a pipeline of processors that you specify. The processors can do things such as "filter out any events that are not sourced from a Story" or "post an event to an HTTP end-point." 
+
+!http://thoughtworksstudios.github.com/mingle_events_design.png!
+
+As stated in the opening paragraph, the aim of this library is to hide the mechanics of event polling, making the user's focus solely the definition of the processing pipeline. This library supplies fundamental event processors, such as card type filters, atom category filters, and http publishers. This library should also make it easy for you to write custom processors.
+
+h2. Events and entries
+
+You might get confused looking at the source code as to what's an Atom entry and what's a Mingle event. We're still trying to clean that up a bit, but for all intents and purposes, they are the same thing. The Atom feed represents Mingle events in the form of Atom entries. For the most part we try to use the word 'entry' in the context of the feed and 'event' in the context of processing.
+
+h2. Processors, filters, and pipelines
+
+Processors, filters, and pipelines are all processors with the same interface. The fundamental model for pipes and filters, or pipelining, is that there is a single, common interface for processing input and returning output. In this context of Mingle event processing, the interface is basically "events in, events out" where "events in" is the list of unprocessed events and "events out" are the processed events.  Processed events might be enriched, filtered, untouched but emailed, etc. 
+
+This library ships the following processors:
+* MingleEvents::Processors::CardData -- loads data for each card that sourced an event in the current stream. This processor requires some special handling (see next section).
+* MingleEvents::Processors::CardTypeFilter -- filters events to those sourced by cards of specific card type(s)
+* MingleEvents::Processors::CategoryFilter -- filters events to those with specified Atom categories. Mingle's Atom Categories are specified in MingleEvents::Category
+* MingleEvents::Processors::HttpPostPublisher -- posts event's raw XML to an HTTP endpoint
+* MingleEvents::Processors::Pipeline -- manages to processing of events by a sequence of processors
+
+h2. Card Data
+
+CardData is a special processor in that it implements a second interface, beyond event processing. This interface is one that allows the lookup of data for the card that sourced the event (if the event was actually sourced by a card). As looking up card data requires accessing additional Mingle server resources, you want to take special care that you don't make repeated requests for the same resources. If you have multiple processors requiring CardData, be sure to use a single instance of CardData across your entire pipeline.
+
+<pre>
+card_data = MingleEvents::Processors::CardData.new(mingle_access, 'test_project')
+    
+post_commenting_on_high_priority_bugs_and_stories = MingleEvents::Processors::Pipeline.new([
+   MingleEvents::Processors::CardTypeFilter.new(['story', 'bug'], card_data),
+   MingleEvents::Processors::CustomPropertyFilter.new('Priority', 'High', card_data),
+   MingleEvents::Processors::CategoryFilter.new([MingleEvents::Category::COMMENT_ADDITION]),
+   MingleEvents::Processors::HttpPostPublisher.new('http://otherissuetracker.example.com/comments')
+])
+</pre>
+
+Note that CardData will provide data for the version of the card that was created by the event you are processing and *not* the current version of the card.  
+
+(For users familiar with earlier versions of this library, you will notice that the bulk loading of card data is currently not being taken advantage of. This is because I needed to change some internals of event broadcasting such that processing a big project's entire history did not cause OOM issues. I will very soon restore the bulk loading optimization for when the poller is simply reading the last handful of events. CardData still works, you just might see your client making a few more calls to Mingle.)
+
+h2. Writing your own processor
+
+In ruby code, the processing interface is a single method named 'process_events' that has a single parameter, the list of unprocessed events' and returns a list of the processed events. 
+
+Here's a processor that simply logs events:
+
+<pre>
+class MyPutsProcessor
+  def process_events(events)
+    events.each do |event|
+      puts event
+    end
+  end
+end
+</pre>
+  
+Here's a filtering processor that removes any event without an Atom category term of 'foo':
+
+<pre>
+class MyFooFilter
+  def process_events(events)
+    events.select do |event|
+      event.categories.any?{|category| category.term == 'foo'}
+    end
+  end
+end
+</pre>
+  
+Be absolutely sure that any processor you write returns a list of events. If you fail to do this, any pipeline using this processor will not function correctly. 
+
+Each event that is passed to the processor is an instance of type MingleEvents::Entry which is a Ruby wrapper around an Atom event. The Entry class makes it easy to access information such as author, Atom categories, whether the event was sourced by a card, etc. As the model is not yet complete, the Entry class also exposes the raw XML of the entry.
+
+(If you are wondering why the interface for processing is for a list of events rather than a single event, it is because of the above mentioned bulk loading of card data. This may change in the future. CardData may get its own special interface to perform a pre-processing bulk load, and the event processing interface will move to a single event at a time.)
+
+h2. Retry & Error handling
+
+As of now, retry is not implemented. If an error occurs during event processing, the error will be logged and processing will stop. The next run will re-start at the point of the last error.

data/lib/mingle_events.rb

@@ -0,0 +1,26 @@
+require 'fileutils'
+require 'net/https'
+require 'yaml'
+require 'time'
+require 'logger'
+
+require 'rubygems'
+require 'nokogiri'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'feed'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'http_error'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'poller'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'mingle_basic_auth_access'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'mingle_oauth_access'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'processors'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'project_custom_properties'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'mingle_events', 'project_event_fetcher'))
+
+module MingleEvents
+  
+  attr_accessor :log
+  module_function :log, :log=
+  self.log = Logger.new(STDOUT)
+  self.log.level = Logger::INFO
+
+end

data/lib/mingle_events/feed.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'feed', 'element_support'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'feed', 'author'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'feed', 'category'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'feed', 'entry'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'feed', 'page'))

data/lib/mingle_events/feed/author.rb

@@ -0,0 +1,28 @@
+module MingleEvents  
+  module Feed
+    
+    # The user who's Mingle activity triggered this event
+    class Author
+    
+      include ElementSupport
+  
+      # The name of the author
+      attr_reader :name
+      # The email address of the author
+      attr_reader :email
+      # The URI identifying the author as well as location of his profile data
+      attr_reader :uri
+      # The URI for the author's icon
+      attr_reader :icon_uri
+  
+      def initialize(author_element)
+        @name = element_text(author_element, 'name')
+        @email = element_text(author_element, 'email', true)
+        @uri = element_text(author_element, 'uri', true)
+        @icon_uri = element_text(author_element, 'mingle:icon', true)
+      end
+    
+    end
+    
+  end
+end

data/lib/mingle_events/feed/category.rb

@@ -0,0 +1,75 @@
+module MingleEvents
+  module Feed
+    
+    # An Atom category, with a term and a scheme. Note that an Atom
+    # event can have any number of categories, including zero.
+    # All current Mingle categories are also defined here, as constants.
+    class Category
+    
+      # The category's term
+      attr_reader :term
+      # The category's scheme
+      attr_reader :scheme
+    
+      def initialize(term, scheme)
+        @term = term
+        @scheme = scheme
+      end
+    
+      def ==(other)
+        other.is_a?(Category) && other.term == self.term && other.scheme == self.scheme    
+      end
+    
+      def hash
+        term.hash ^ scheme.hash
+      end
+    
+      def eql?(other)
+        self == other
+      end
+    
+      # The Atom category scheme for all Mingle categories
+      MINGLE_SCHEME = 'http://www.thoughtworks-studios.com/ns/mingle#categories'
+    
+      # Category for any event sourced by a card
+      CARD = Category.new('card', MINGLE_SCHEME)
+      # Category for any event that is the creation of a new card
+      CARD_CREATION = Category.new('card-creation', MINGLE_SCHEME)
+      # Category for any event that is the deletion of a card
+      CARD_DELETION = Category.new('card-deletion', MINGLE_SCHEME)
+      # Category for any event that includes the change of a card's property value
+      PROPERTY_CHANGE = Category.new('property-change', MINGLE_SCHEME)
+      # Category for any event that includes the change of a card's type
+      CARD_TYPE_CHANGE = Category.new('card-type-change', MINGLE_SCHEME)
+      # Category for any event that includes the commenting on a card
+      COMMENT_ADDITION = Category.new('comment-addition', MINGLE_SCHEME)
+      # Category for any event that incldues the Mingle server's adding a comment to a card
+      SYSTEM_COMMENT_ADDITION = Category.new('system-comment-addition', MINGLE_SCHEME)
+   
+      # Category for any event sourced by a wiki page
+      PAGE = Category.new('page', MINGLE_SCHEME)
+      # Category for any event that is the creation of a new wiki page
+      PAGE_CREATION = Category.new('page-creation', MINGLE_SCHEME)
+   
+      # Category for any event that includes a card or page name change
+      NAME_CHANGE = Category.new('name-change', MINGLE_SCHEME)
+      # Category for any event that includes a card or page description/content change
+      DESCRIPTION_CHANGE = Category.new('description-change', MINGLE_SCHEME)
+      # Category for any event that includes the tagging of a card or page
+      TAG_ADDITION = Category.new('tag-addition', MINGLE_SCHEME)
+      # Category for any event that includes the removal of a tag from a card or page
+      TAG_REMOVAL = Category.new('tag-removal', MINGLE_SCHEME)
+      # Category for any event that includes the addition of an attachment to a card or page
+      ATTACHMENT_ADDITION = Category.new('attachment-addition', MINGLE_SCHEME)
+      # Category for any event that includes the removal of an attachment from a card or page
+      ATTACHMENT_REMOVAL = Category.new('attachment-removal', MINGLE_SCHEME)
+      # Category for any event that includes the replacement of an attachment on a card or page
+      ATTACHMENT_REPLACEMENT = Category.new('attachment-replacement', MINGLE_SCHEME)
+   
+      # Category for any event that is a revision or changeset commit
+      REVISION_COMMIT = Category.new('revision-commit', MINGLE_SCHEME)
+    
+    end
+    
+  end
+end