mingle_events 0.1.7 → 0.1.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGFjZmRmMTUzNDBmYmMyMjZkOGFjZTQwNmQwZGJkYmI3ZWJkM2U3Nw==
-  data.tar.gz: !binary |-
-    Y2U5ZjVlNDQ0NDRlMTAxNjE3MGY2ZWVlYjgyNTgzODA2YzBjYWU1ZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MjYwN2U0MzZiZmNkMzk5NzljZmY0NGRmMWJkNjZiNzY2NjBlY2JiNjk1N2E5
-    NTBiNzMyYmViYThkNzA3NTUzNjE0ZWRkNTA4MjA2NDczZDFmMmNjOTc4NTk4
-    OTIxNDA0ZjE3MGRhYzc3NDYwNTBkYjZlYmI3MzVjZWQxZWI2NzQ=
-  data.tar.gz: !binary |-
-    NmFlNDE0N2ViZTQ4NmFlY2ZhZGU4ZTRkYjQzMzY4ODVmODAyMjdlNDUzMzRm
-    ODFiY2JiYzM4OTdhZDNmMTY5OWYxNTg1NmZjNzFhYzVkZjc5YjEyYjNiZGMz
-    NTc0MjMzNjJkNDAwN2VjM2RlMDE1YTRlYTUzYjZiZmRiMTI1YTc=
+SHA1:
+  metadata.gz: db8c244cc6b0a5038dcc12a40e478906098cfb7d
+  data.tar.gz: 0cebb359a4b5bd057fe2e6ea794ebe4645c3e756
+SHA512:
+  metadata.gz: b8e7269e1250643f31c4310f5f1dc37c82945ee0d0b47929a18422c0b4f5a1459cc2a4d7b51020962f4bc994a722d1d1548c79164a6a8ee21ba4f84b1a6a0967
+  data.tar.gz: 7b37839e548eefbdbd0b599a5e78ea1e3ab3485bcf84dfe6f9db3769ed2c05cdadbfb4883038862e519a3b688e7997ded85463bf7e94104efbe3c44b8d32a647

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/lib/mingle_events/feed/category.rb

@@ -1,48 +1,48 @@
 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
-    
+
       @@categories_by_mingle_term = {}
-    
+
       # The category's term
       attr_reader :term
       # The category's scheme
       attr_reader :scheme
-    
+
       def initialize(term, scheme)
         @term = term
         @scheme = scheme
         @@categories_by_mingle_term[term] = self
       end
-      
+
       # lookup a category by the text value of the term (mingle scheme is assumed)
       def self.for_mingle_term(mingle_term)
         @@categories_by_mingle_term[mingle_term]
       end
-      
+
       def to_s
         term
       end
-    
+
       def ==(other)
-        other.is_a?(Category) && other.term == self.term && other.scheme == self.scheme    
+        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
@@ -59,12 +59,25 @@ module MingleEvents
       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)
-   
+
+      # For correction events:
+      MANAGED_PROPERTY_VALUE_CHANGE = Category.new("managed-property-value-change", MINGLE_SCHEME)
+      PROPERTY_RENAME = Category.new("property-rename", MINGLE_SCHEME)
+      TAG_RENAME = Category.new("tag-rename", MINGLE_SCHEME)
+      PROPERTY_DELETION = Category.new("property-deletion", MINGLE_SCHEME)
+      CARD_TYPE_RENAME = Category.new("card-type-rename", MINGLE_SCHEME)
+      CARD_TYPE_DELETION = Category.new("card-type-deletion", MINGLE_SCHEME)
+      CARD_TYPE_AND_PROPERTY_DISASSOCIATION = Category.new("card-type-and-property-disassociation", MINGLE_SCHEME)
+      CARD_KEYWORDS_CHANGE = Category.new("card-keywords-change", MINGLE_SCHEME)
+      NUMERIC_PRECISION_CHANGE = Category.new("numeric-precision-change", MINGLE_SCHEME)
+      REPOSITORY_SETTINGS_CHANGE = Category.new("repository-settings-change", 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
@@ -79,11 +92,11 @@ module MingleEvents
       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
+end

data/lib/mingle_events/feed/changes.rb

@@ -33,7 +33,6 @@ module MingleEvents
 
         def build(element)
           raw_hash_from_xml = element.to_hash
-
           raw_hash_from_xml[:change].merge({
             :category => @category,
             :type => @category

data/lib/mingle_events/processors/card_type_filter.rb

@@ -1,26 +1,26 @@
 module MingleEvents
   module Processors
-    
+
     # Filters events by card types. As events do not contain the type
-    # of the card, this filter requires a lookup against Mingle to 
+    # of the card, this filter requires a lookup against Mingle to
     # determine the type of the card that sourced the event. In the case
     # of the card's being deleted in the interim between the actual event
     # and this filtering, the event will be filtered as there is no means
     # to determine its type. Therefore, it's recommended to also
-    # subscribe a 'CardDeleted' processor to the same project.    
+    # subscribe a 'CardDeleted' processor to the same project.
     class CardTypeFilter < Filter
-    
+
       def initialize(card_types, card_data)
         @card_types = card_types
         @card_data = card_data
       end
-      
+
       def match?(event)
-        event.card? && 
+        event.card? &&
           @card_data.for_card_event(event) &&
           @card_types.include?(@card_data.for_card_event(event)[:card_type_name])
       end
-     
+
     end
   end
-end
+end

data/lib/mingle_events/xml.rb

@@ -28,7 +28,7 @@ module MingleEvents
 
     def inner_text(element, xpath=nil)
       return inner_text(select(element, xpath)) if xpath
-      return nil if attr(element, "nil") && attr(element, "nil") == "true"
+      return nil if attr(element, "nil") == "true"
       element.node.inner_text
     end
 
@@ -69,22 +69,28 @@ module MingleEvents
       end
     end
 
-    def to_hash(element, hash={})
-      hash_for_element = (hash[tag_name(element).to_sym] ||= {})
+    def to_hash(element)
+      { tag_name(element).to_sym  => to_hash_attributes(element) }
+    end
 
-      attributes(element).each do |name, value|
-        hash_for_element[name.to_sym] = value
+    def to_hash_attributes(element)
+      attrs = attributes(element).inject({}) do |memo, pair|
+        name, value = pair
+        memo[name.to_sym] = value
+        memo
       end
 
-      children(element).each do |child|
-        if children(child).any?
-          to_hash(child, hash_for_element)
-        else
-          hash_for_element[tag_name(child).to_sym] = inner_text(child)
+      return nil if attrs[:nil] == "true"
+
+      children = children(element)
+      if children.any?
+        return children.inject(attrs) do |memo, child|
+          memo[ tag_name(child).to_sym ] = to_hash_attributes(child)
+          memo
         end
       end
-
-      hash
+      inner_text = inner_text(element)
+      inner_text && inner_text != "" ? inner_text : attrs
     end
 
     def patching_namespaces(node)

data/lib/mingle_events/zip_directory.rb

@@ -1,6 +1,6 @@
 module MingleEvents
   class ZipDirectory
-    
+
     def initialize(name)
       FileUtils.mkdir_p(File.dirname(name))
       @root = name
@@ -10,7 +10,7 @@ module MingleEvents
 
     def write_file(path, &block)
       measure('write_file') do
-        exists = File.exists?(@root) && File.lstat(@root).size > 1024
+        exists = File.exist?(@root) && File.lstat(@root).size > 1024
         writeio = File.open(@root, exists ? 'r+b' : 'wb')
         # for a existing tar, seek to -1024 from end to skip 1024 '\0' in tar format
         writeio.seek(-1024, IO::SEEK_END) if exists
@@ -30,7 +30,7 @@ module MingleEvents
     end
 
     def exists?(path)
-      return unless File.exists?(@root)
+      return unless File.exist?(@root)
       entry_map.include?(path)
     end
 
@@ -66,16 +66,16 @@ module MingleEvents
 
     def entry_map
       return @entry_map if @entry_map
-      
+
       @entry_map = {}
       measure("entries archive loading") do
         @readio = File.open(@root, 'rb')
         loop do
           break if @readio.eof?
-        
+
           header = Archive::Tar::PosixHeader.new_from_stream(@readio)
           break if header.empty?
-          
+
           entry = ReusableEntryStream.new(header, @readio)
           size  = entry.size
           @entry_map[entry.name] = entry

data/test/mingle_events/entry_cache_test.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
 
 module MingleEvents
-  class EntryCacheTest < Test::Unit::TestCase
-    
+  class EntryCacheTest < MiniTest::Test
+
     def setup
       @entry_cache = EntryCache.new("/tmp/foo")
       @entry_cache.clear
     end
-    
+
     def test_stores_first_entry_under_root
       fetched_entry = entry(1)
       @entry_cache.write(fetched_entry, nil)
@@ -49,11 +49,11 @@ module MingleEvents
       assert_equal entry(1), enumerator.next()
       assert_equal entry(2), enumerator.next()
       assert_equal entry(3), enumerator.next()
-      assert_raise(StopIteration) { enumerator.next() }
+      assert_raises(StopIteration) { enumerator.next() }
     end
-    
+
     private
-    
+
     def entry(id)
       element_xml_text = %{
         <entry xmlns="http://www.w3.org/2005/Atom">
@@ -69,7 +69,7 @@ module MingleEvents
       }
       Feed::Entry.from_snippet(element_xml_text)
     end
-    
-    
+
+
   end
 end

data/test/mingle_events/feed/author_test.rb

@@ -2,9 +2,9 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_hel
 
 module MingleEvents
   module Feed
-    
-    class AuthorTest < Test::Unit::TestCase
-  
+
+    class AuthorTest < MiniTest::Test
+
       def test_parse_attributes
         author_xml = %{
           <author xmlns="http://www.w3.org/2005/Atom" xmlns:mingle="http://www.thoughtworks-studios.com/ns/mingle">
@@ -13,14 +13,14 @@ module MingleEvents
             <uri>https://mingle.example.com/api/v2/users/233.xml</uri>
             <mingle:icon>https://mingle.example.com/user/icon/233/profile.jpg</mingle:icon>
           </author>
-        }        
+        }
         author = Author.from_snippet(author_xml)
         assert_equal("Sammy Soso", author.name)
         assert_equal("sammy@example.com", author.email)
         assert_equal("https://mingle.example.com/api/v2/users/233.xml", author.uri)
         assert_equal("https://mingle.example.com/user/icon/233/profile.jpg", author.icon_uri)
       end
-    
+
       def test_parse_attributes_when_no_optional_fields
         author_xml = %{
           <author xmlns="http://www.w3.org/2005/Atom" xmlns:mingle="http://www.thoughtworks-studios.com/ns/mingle">
@@ -33,8 +33,8 @@ module MingleEvents
         assert_nil(author.uri)
         assert_nil(author.icon_uri)
       end
-  
+
     end
-  
+
   end
 end

data/test/mingle_events/feed/category_test.rb

@@ -2,10 +2,10 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_hel
 
 module MingleEvents
   module Feed
-    
-    class CategoryTest < Test::Unit::TestCase
-    
-      def test_equality        
+
+    class CategoryTest < MiniTest::Test
+
+      def test_equality
         assert_equal(Category::CARD, Category::CARD)
         assert_equal(Category::CARD, Category.new('card', 'http://www.thoughtworks-studios.com/ns/mingle#categories'))
         assert_not_equal(Category::CARD, Category::PAGE)
@@ -13,12 +13,12 @@ module MingleEvents
         assert_not_equal(Category::CARD, Object.new)
         assert_equal(:foo, {Category::CARD => :foo}[Category.new('card', 'http://www.thoughtworks-studios.com/ns/mingle#categories')])
       end
-      
+
       def test_can_lookup_by_mingle_term
         assert_equal(Category::CARD_CREATION, Category.for_mingle_term('card-creation'))
       end
-    
+
     end
-  
+
   end
-end
+end

data/test/mingle_events/feed/changes_test.rb

@@ -2,9 +2,9 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_hel
 
 module MingleEvents
   module Feed
-    
-    class ChangesTest < Test::Unit::TestCase
-      
+
+    class ChangesTest < MiniTest::Test
+
       def test_parse_multiple_changes
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -27,18 +27,18 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
+
         # check that all the changes are built
-        assert_equal 3, entry.changes.count        
+        assert_equal 3, entry.changes.count
         [Category::CARD_CREATION, Category::CARD_TYPE_CHANGE, Category::NAME_CHANGE].each do |change_type|
           assert entry.changes.find{|c| c[:category] == change_type}
         end
-        
+
         # check that a change's detail is built
         card_type_change = entry.changes.find{|c| c[:category] == Category::CARD_TYPE_CHANGE}
         assert_equal('Defect', card_type_change[:new_value][:card_type][:name])
       end
-            
+
       def test_parse_name_change_from_nil
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -52,14 +52,14 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
+
         change = entry.changes.first
         assert_equal(Category::NAME_CHANGE, change[:type])
         assert_equal(Category::NAME_CHANGE, change[:category])
         assert_nil change[:old_value]
         assert_equal("Basic email integration", change[:new_value])
       end
-      
+
       def test_parse_name_change
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -73,14 +73,14 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
-        change = entry.changes.first        
+
+        change = entry.changes.first
         assert_equal(Category::NAME_CHANGE, change[:type])
         assert_equal(Category::NAME_CHANGE, change[:category])
         assert_equal("Work with email", change[:old_value])
-        assert_equal("Basic email integration", change[:new_value])       
+        assert_equal("Basic email integration", change[:new_value])
       end
-      
+
       def test_parse_type_info_when_no_custom_builder_specified
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -91,11 +91,11 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
+
         assert_equal(Category::CARD_CREATION, entry.changes.first[:type])
         assert_equal(Category::CARD_CREATION, entry.changes.first[:category])
       end
-      
+
       def test_parse_card_type_change_from_nil
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -113,16 +113,16 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
+
         change = entry.changes.first
-        
+
         assert_equal(Category::CARD_TYPE_CHANGE, change[:type])
         assert_equal(Category::CARD_TYPE_CHANGE, change[:category])
         assert_nil change[:old_value]
         assert_equal("Defect", change[:new_value][:card_type][:name])
         assert_equal("https://mingle.example.com/api/v2/projects/atlas/card_types/27.xml", change[:new_value][:card_type][:url])
       end
-      
+
       def test_parse_card_type_change
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -144,7 +144,7 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-        
+
         change = entry.changes.first
         assert_equal(Category::CARD_TYPE_CHANGE, change[:type])
         assert_equal(Category::CARD_TYPE_CHANGE, change[:category])
@@ -153,7 +153,7 @@ module MingleEvents
         assert_equal("Defect", change[:new_value][:card_type][:name])
         assert_equal("https://mingle.example.com/api/v2/projects/atlas/card_types/27.xml", change[:new_value][:card_type][:url])
       end
-      
+
       def test_parse_card_type_change_to_deleted_type
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
@@ -175,7 +175,7 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-                
+
         change = entry.changes.first
         assert_equal(Category::CARD_TYPE_CHANGE, change[:type])
         assert_equal(Category::CARD_TYPE_CHANGE, change[:category])
@@ -183,15 +183,15 @@ module MingleEvents
         assert_equal("https://mingle.example.com/api/v2/projects/atlas/card_types/30.xml", change[:old_value][:card_type][:url])
         assert_equal("Card", change[:new_value][:deleted_card_type][:name])
         assert_equal(nil, change[:new_value][:deleted_card_type][:url])
-      end     
-      
+      end
+
       def test_parse_card_property_change
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
               <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
-                  <property_definition 
+                  <property_definition
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">
                     <name>Priority</name>
                     <position nil="true"></position>
@@ -205,26 +205,26 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-                
+
         change = entry.changes.first
         assert_equal(Category::PROPERTY_CHANGE, change[:type])
         assert_equal(Category::PROPERTY_CHANGE, change[:category])
         assert_equal(
-          "http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml", 
+          "http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml",
           change[:property_definition][:url]
         )
         assert_equal("Priority", change[:property_definition][:name])
         assert_equal("nice", change[:old_value])
         assert_equal("must", change[:new_value])
-      end  
-      
+      end
+
       def test_parse_card_property_change_from_nil
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
               <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
-                  <property_definition 
+                  <property_definition
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">
                     <name>Priority</name>
                     <position nil="true"></position>
@@ -238,19 +238,19 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-                
+
         change = entry.changes.first
         assert_nil(change[:old_value])
         assert_equal("must", change[:new_value])
-      end   
-      
+      end
+
       def test_parse_card_property_change_to_nil
         element_xml_text = %{
           <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
               <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
-                  <property_definition 
+                  <property_definition
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">
                     <name>Priority</name>
                     <position nil="true"></position>
@@ -264,12 +264,62 @@ module MingleEvents
             </content>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
-                
+
         change = entry.changes.first
         assert_equal("nice", change[:old_value])
         assert_nil(change[:new_value])
-      end  
-      
-    end        
+      end
+
+      def test_parse_enumeration_name_change
+        element_xml_text = %{
+          <entry xmlns="http://www.w3.org/2005/Atom">
+            <content type="application/vnd.mingle+xml">
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
+                <change type="managed-property-value-change">
+                  <property_definition url="https://mingle.mingle.thoughtworks.com/api/v2/projects/your_first_project/property_definitions/16348.xml"/>
+                  <old_value>Testing</old_value>
+                  <new_value>Verify</new_value>
+                </change>
+              </changes>
+            </content>
+          </entry>}
+        entry = Entry.from_snippet(element_xml_text)
+
+        change = entry.changes.first
+        assert_equal(Category::MANAGED_PROPERTY_VALUE_CHANGE, change[:type])
+        assert_equal(Category::MANAGED_PROPERTY_VALUE_CHANGE, change[:category])
+
+        assert_equal("https://mingle.mingle.thoughtworks.com/api/v2/projects/your_first_project/property_definitions/16348.xml", change[:property_definition][:url])
+        assert_equal('Testing', change[:old_value])
+        assert_equal("Verify", change[:new_value])
+      end
+
+      def test_parse_value_with_special_characters
+        element_xml_text = %{
+  <entry xmlns="http://www.w3.org/2005/Atom">
+    <content type="application/vnd.mingle+xml">
+      <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
+        <change type="property-change">
+          <property_definition url="https://mingle.mingle-staging.thoughtworks.com/api/v2/projects/mingle1/property_definitions/10088.xml">
+            <name>Priority</name>
+            <position nil="true"></position>
+            <data_type>string</data_type>
+            <is_numeric type="boolean">false</is_numeric>
+          </property_definition>
+          <old_value nil="true"></old_value>
+          <new_value>&#160;</new_value>
+        </change>
+      </changes>
+    </content>
+  </entry>}
+        entry = Entry.from_snippet(element_xml_text)
+
+        change = entry.changes.first
+        assert_equal("\u00A0", change[:new_value])
+        assert_equal(nil, change[:old_value])
+      end
+
+    end
+
   end
 end