mingle4r 0.4.2 → 0.4.3

data/History.txt

@@ -1,3 +1,7 @@
+0.4.3
+-----
+* Lots of bug fixes
+
 0.4.2
 -----
 * Added functionality to get/set card type directly

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009 Arusarka Haldar
+Copyright (c) 2010 Arusarka Haldar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -108,6 +108,22 @@ m_c.proj_id = 'great_mingle_project'
 card = m_c.project.cards[0]
 card.property_value('Status')
 
+Creating a card
+---------------
+
+Mingle4r::API::Card is the ActiveResource class which handles interaction with cards.
+task = Mingle4r::API::Card.new
+task.name = 'set up Cruise build'
+task.type = 'task'
+task.description = 'a basic cruise build needs to be set up so that we can start working'
+task.save
+
+Do not do it like this:
+
+task = Mingle4r::API::new :name => 'set up Cruise build', :type => 'task',
+        :description => 'a basic cruise build needs to be set up so that we can start working'
+task.save => It simply won't work, there is a workaround but rather use as described above.
+
 Setting a particular property
 -----------------------------
 
@@ -242,6 +258,11 @@ m_c.project.execute_mql('SELECT name, "Added in Iteration" WHERE Type = Story')
 1) active_resource gem, it would be automatically taken care of
 during gem install.
 
+== LIMITATIONS:
+
+updating a property on the card which is a link to another card does not work. So for now
+only use it for other properties
+
 == INSTALL:
 
 since github no longer archives gems, I am hosting the gem at gemcutter. So you would need to

data/TODO.txt

@@ -1,13 +1,19 @@
-update documentation - write about executing transitions directly on the transition
-clarify in docs difference between custom properties and native properties
-write tests for project class
+will be fixed/implemented very soon
+-----------------------------------
 
-refactorings
-------------
+* fix updation of card properties
 
-maybe nice to  nave
--------------------
+will be implemented, but not very important for now
+----------------------------------------------------
 
-provide a easy mechanism to link to other cards
+* update documentation - write about executing transitions directly on the transition
+* provide a helper method to link to a card
+* write tests for project class
+* implement card_types for a project
+* mingle client should have cards method
 
-should transtions give the list of properties to be changed directly
+will be done when I've no other work
+------------------------------------
+
+* clarify in docs difference between custom properties and native properties
+* should transtions give the list of properties to be changed directly

data/lib/mingle4r.rb

@@ -6,15 +6,14 @@ require 'active_resource'
 require 'net/http'
 
 # This module should be used to interact with mingle. Look in the readme for examples.
-module Mingle4r
-  AUTHOR = 'Asur'
-end
+module Mingle4r; end
 
 require 'mingle_resource'
 require 'mingle4r/version'
 require 'mingle4r/common_class_methods'
 require 'mingle4r/helpers'
 require 'mingle4r/mingle_client'
+require 'mingle4r/card_format'
 
 require 'mingle4r/api/card'
 require 'mingle4r/api/card/attachment'

data/lib/mingle4r/api/card.rb

@@ -3,13 +3,6 @@ module Mingle4r
     class Card  
       extend Mingle4r::CommonClassMethods
       
-      # overwrite the default find in CommonClassMethods
-      def self.find(*args)
-        scope = args.slice!(0)
-        options = args.slice!(0) || {}
-        @resource_class.find_without_pagination(scope, options)
-      end
-      
       module ClassMethods
         def find_without_pagination(*args)
           scope   = args.slice!(0)
@@ -41,26 +34,22 @@ module Mingle4r
           attributes['card_type_name'] = type
         end
         
-        def attachments(refresh = false)
-          return @attachments if(!refresh && @attachments)
-          set_attributes_for(Attachment)
+        def attachments
+          set_attributes_for(Attachment) unless attachment_class_set
           @attachments = Attachment.find(:all)
         end
         
-        def comments(refresh = false)
-          return @comments if(!refresh && @comments)
-          set_attributes_for(Comment)
-          @comments = Card::Comment.find(:all)
+        def comments
+          set_attributes_for(Comment) unless comment_class_set
+          Comment.find(:all)
         end
         
-        def transitions(refresh = false)
-          return @transitions if(!refresh && @transitions)
-          set_attributes_for(Transition)
-          @transitions = Card::Transition.find(:all)
+        def transitions
+          set_attributes_for(Transition) unless transition_class_set
+          @transitions = Transition.find(:all)
         end
         
-        def murmurs(refresh = false)
-          return @murmurs if(!refresh && @murmurs)
+        def murmurs
           set_attributes_for(Murmur)
           @murmurs = Murmur.find(:all)
         end
@@ -138,6 +127,24 @@ EOS
           klass.site     = resource_site
           klass.user     = self.class.user
           klass.password = self.class.password
+          setter_method = klass.name.demodulize.underscore + '_class_set'
+          send(setter_method, true)
+          klass
+        end
+        
+        def comment_class_set(val = nil)
+          return @comment_class_set unless val
+          @comment_class_set = val
+        end
+        
+        def attachment_class_set(val = nil)
+          return @attachment_class_set unless val
+          @attachment_class_set = val
+        end
+        
+        def transition_class_set(val = nil)
+          return @transition_class_set unless val
+          @transition_class_set = val
         end
       end
     end

data/lib/mingle4r/api/execute_mql.rb

@@ -0,0 +1,15 @@
+module Mingle4r
+  module API
+    class ExecuteMql
+      extend Mingle4r::CommonClassMethods
+      
+      def self.query(query_string)
+        @resource_class.find(:all, :params => {:mql => query_string}).
+          collect { |res| res.attributes }
+      end
+    end
+  end
+end
+
+Mingle4r::API::ExecuteMql.collection_name = 'execute_mql'
+Mingle4r::API::ExecuteMql.element_name = 'result'

data/lib/mingle4r/api/project.rb

@@ -2,56 +2,46 @@ module Mingle4r
   module API
     class Project
       module InstanceMethods
-        # returns the cards for the project. To hit the resource server without returning
-        # cached results pass true as an argument.
-        def cards(refresh = false)
-          return @cards if(!refresh && @cards)
-          set_attributes_for(Card)
-          @cards = Card.find_without_pagination(:all)
+        # returns the cards for the project.
+        def cards
+          set_attributes_for(Card) unless card_class_set
+          Card.find_without_pagination(:all)
         end
 
-        # returns the users for the project. To hit the resource server without returning
-        # cached results pass true as an argument.
-        def users(refresh = false)
-          return @users if(!refresh && @users)
-          set_attributes_for(User)
-          @users = User.find(:all)
+        # returns the users for the project.
+        def users
+          set_attributes_for(User) unless user_class_set
+          User.find(:all)
         end
 
-        # returns the wikis for the project. To hit the resource server without returning
-        # cached results pass true as an argument.
-        def wikis(refresh = false)
-          return @wikis if(!refresh && @wikis)
-          set_attributes_for(Wiki)
-          @wikis = Wiki.find(:all)
+        # returns the wikis for the project.
+        def wikis
+          set_attributes_for(Wiki) unless wiki_class_set
+          Wiki.find(:all)
         end
 
-        # returns the property definitions for the project. To hit the resource server
-        # pass true as an argument
-        def property_definitions(refresh = false)
-          return @prop_definitions if(!refresh && @prop_definitions)
-          set_attributes_for(PropertyDefinition)
-          @prop_definitions = PropertyDefinition.find(:all)
+        # returns the property definitions for the project.
+        def property_definitions
+          set_attributes_for(PropertyDefinition) unless property_definition_class_set
+          PropertyDefinition.find(:all)
         end
 
-        # returns the murmurs for the project. To hit the resource server without returning
-        # cached results pass true as an argument.
-        def murmurs(refresh = false)
-          return @murmurs if(!refresh && @murmurs)
-          set_attributes_for(Murmur)
-          @murmurs = Murmur.find(:all)
+        # returns the murmurs for the project.
+        def murmurs
+          set_attributes_for(Murmur) unless murmur_class_set
+          Murmur.find(:all)
         end
 
         # posts a murmur
         def post_murmur(str)
-          set_attributes_for(Murmur)
+          set_attributes_for(Murmur) unless murmur_class_set
           murmur = Murmur.new(:body => str.to_s)
           murmur.save
         end
         
         # executes an mql
         def execute_mql(query)
-          set_attributes_for(ExecuteMql)
+          set_attributes_for(ExecuteMql) unless execute_mql_class_set
           ExecuteMql.query(query)
         end
         
@@ -62,6 +52,39 @@ module Mingle4r
           klass.site = resource_site
           klass.user = self.class.user
           klass.password = self.class.password
+          setter_method = klass.name.demodulize.underscore + '_class_set'
+          send(setter_method, true)
+          klass
+        end
+        
+        def user_class_set(val = nil)
+          return @user_class_set unless val
+          @user_class_set = val
+        end
+        
+        def card_class_set(val = nil)
+          return @card_class_set unless val
+          @card_class_set = val
+        end
+        
+        def wiki_class_set(val = nil)
+          return @wiki_class_set unless val
+          @wiki_class_set = val
+        end
+        
+        def property_definition_class_set(val = nil)
+          return @property_definition_class_set unless val
+          @property_definition_class_set = val
+        end
+        
+        def murmur_class_set(val = nil)
+          return @murmur_class_set unless val
+          @murmur_class_set = val
+        end
+        
+        def execute_mql_class_set(val = nil)
+          return @execute_mql_class_set unless val
+          @execute_mql_class_set = val
         end
       end # module InstanceMethods
 

data/lib/mingle4r/card_format.rb

@@ -0,0 +1,28 @@
+module Mingle4r
+  class CardFormat
+    def extension
+      'xml'
+    end
+    
+    def mime_type
+      'application/xml'
+    end
+    
+    def decode(xml)
+      from_xml_data(Hash.from_xml(xml))
+    end
+    
+    def encode(hash, options={})
+      hash.to_xml(options)
+    end
+
+    private
+    def from_xml_data(data)
+      if data.is_a?(Hash) && data.keys.size == 1
+        data.values.first
+      else
+        data
+      end
+    end
+  end
+end

data/lib/mingle4r/common_class_methods.rb

@@ -1,92 +1,5 @@
 module Mingle4r
-  # ActiveResource makes connecting to rest resources very easy. However it has one problem 
-  # and a big one at that. If you try setting the authentication credentials or the site or
-  # collection name, element name for the class for the second time it doesn't work. E.g.
-  #
-  # class Person < ActiveResource::base
-  #   self.site = 'http://localhost:9090/'
-  # end
-  #
-  # After sometime you change it to 
-  #
-  # Person.site = 'https://org-server/my_proj/'
-  # Person.user = 'admin'
-  # Person.password = 'secret'
-  #
-  # Then you do
-  #
-  # Person.find(:all) => It bombs
-  #
-  # This module provides a mechanism by which you can get rid of this problem. Extend this
-  # class in the actual class itself. Do not extend the extended class from ActiveResource::Base.
-  # 
-  # E.g.
-  #
-  # class Person
-  #  extend CommonClassMethods
-  # end
-  #
-  # set the credentials
-  #
-  # Person.site = 'http://localhost:8080'
-  # Person.user = 'foo'
-  # Person.password = 'bar'
-  # 
-  # Thats it. Now create some objects
-  #
-  # asur = Person.new(:name => 'Asur', :job => 'fooling around', :status => 'Single and ready 2 mingle')
-  # asur.save
-  # 
-  # Now change the class attributes
-  #
-  # Person.site = 'https://org-server/mingle'
-  # Person.collection_name = 'boring_people'
-  # 
-  # Now instantiate an object
-  #
-  # rakhshas = Person.new(:name => 'Rakhshas', :job => 'eating people', :status => 'just woke up and hungry')
-  # rakhshas.save => Voila !!!!!!! it works
-  # 
-  # CUSTOMIZATIONS
-  # --------------
-  # 
-  # No amount of wrapping can provide very detailed customizations. Either you have a lot of methods
-  # that are not being used or there is hardly anything at all. To oversome this problem this module
-  # was written to provide only those methods which are common to most active resource objects.
-  # However if you want to have a little more control over your active resource objects its very easy.
-  # Here's how you would do it normally
-  # 
-  # class Person < ActiveResource::Base
-  #   def self.count
-  #     find(:all).size
-  #   end
-  #
-  #   def occupation
-  #     return job if job
-  #     'Unemployed' 
-  #   end
-  # end
-  #
-  # To do the same thing, here's how you do it using this library
-  #
-  # class Person
-  #   module ClassMethods
-  #     def count
-  #       find(:all).size
-  #     end
-  #   end
-  #
-  #   module InstanceMethods
-  #     def occupation
-  #       return job if job
-  #       'Unemployed' 
-  #     end
-  #   end
-  #   extend CommonClassMethods
-  # end
-  #
-  # The instance methods will be available as instance methods in the objects created, class methods
-  # will be available as class methods in the class of the object.
+  class ResourceNotSetup < Exception; end
   
   module CommonClassMethods
     attr_reader :site, :user, :password
@@ -168,51 +81,56 @@ module Mingle4r
     # creates an active resource class dynamically. All the attributes are set automatically. Avoid calling
     # this method directly                                                  
     def create_resource_class
-      # raise exceptions if site is not set
       raise "Please set the site for #{self} class." unless(self.site)
-      
       created_class = Class.new(MingleResource)
-      
-      # set the resource options
-      created_class.site = self.site
-      created_class.user = self.user
-      created_class.password = self.password
-      created_class.collection_name = self.collection_name
-      created_class.element_name = self.element_name
-
-      # created_class_name = "#{self}::#{class_name}#{Mingle4r::Helpers.fast_token()}"
-      created_class_name = class_name + Mingle4r::Helpers.fast_token()
-      created_class = self.const_set(created_class_name, created_class)
-      # eval "#{created_class_name} = created_class"
-
-      # includes a module called InstanceMethods in the class created dynamically
-      # if it is defined inside the wrapper class
-      inst_meth_mod_name = instance_methods_module_name()
-      created_class.send(:include, self.const_get(inst_meth_mod_name.to_sym)) if inst_meth_mod_name
-
-      # extends the class created dynamically with a module called ClassMethods if
-      # it is defined inside the wrapper class
-      class_meth_mod_name = class_methods_module_name()
-      created_class.extend(self.const_get(class_meth_mod_name)) if class_meth_mod_name
-      
+      setup_class(created_class)
       created_class
     end
     
+    def setup_class(klass)
+      set_resource_options(klass)
+      set_class_name(klass)
+      include_instance_methods(klass)
+      include_singleton_methods(klass)
+    end
+    
+    def include_singleton_methods(klass)
+      klass.extend(self.const_get(:ClassMethods)) if has_class_meths_module?
+    end
+    
+    def include_instance_methods(klass)
+      klass.send(:include, self.const_get(:InstanceMethods)) if has_inst_meths_module?
+    end
+    
+    def set_class_name(klass)
+      created_class_name = class_name + Mingle4r::Helpers.fast_token()
+      klass = self.const_set(created_class_name, klass)
+      klass
+    end
+    
+    def set_resource_options(klass)
+      klass.site = self.site
+      klass.user = self.user
+      klass.password = self.password
+      klass.collection_name = self.collection_name
+      klass.element_name = self.element_name
+      klass
+    end
+    
     def class_name
-      self.name.split('::')[-1]
+      self.name.demodulize
     end
     
-    def instance_methods_module_name
-      inst_meth_mod_name = 'InstanceMethods'
-      self.constants.detect { |const| const.split('::')[-1] =~ /#{inst_meth_mod_name}/ }
+    def has_inst_meths_module?
+      self.constants.detect { |const| const.demodulize == 'InstanceMethods' }
     end
     
-    def class_methods_module_name
-      class_meth_mod_name = 'ClassMethods'
-      self.constants.detect { |const| const.split('::')[-1] =~ /#{class_meth_mod_name}/ }
+    def has_class_meths_module?
+      self.constants.detect { |const| const.demodulize == 'ClassMethods' }
     end
     
     def method_missing(meth_id, *args, &block)
+      raise ResourceNotSetup.new("Site is not set for #{name}. Please set it.") unless @resource_class
       @resource_class.send(meth_id.to_sym, *args, &block)
     end
   end

data/lib/mingle4r/version.rb

@@ -2,7 +2,7 @@ module Mingle4r
   module Version
     Major = '0'
     Minor = '4'
-    Tiny  = '2'
+    Tiny  = '3'
     
     def self.to_s
       Major + '.' + Minor + '.' + Tiny

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mingle4r
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - asur
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-25 00:00:00 +05:30
+date: 2010-05-24 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -44,10 +47,12 @@ files:
 - lib/mingle4r/helpers.rb
 - lib/mingle4r/mingle_client.rb
 - lib/mingle4r/version.rb
+- lib/mingle4r/card_format.rb
 - lib/mingle4r/api/card.rb
 - lib/mingle4r/api/card/attachment.rb
 - lib/mingle4r/api/card/comment.rb
 - lib/mingle4r/api/card/transition.rb
+- lib/mingle4r/api/execute_mql.rb
 - lib/mingle4r/api/murmur.rb
 - lib/mingle4r/api/project.rb
 - lib/mingle4r/api/property_definition.rb
@@ -67,23 +72,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Mingle connector using active resource