mingle4r 0.3.0

data/lib/mingle4r/common_class_methods.rb

@@ -0,0 +1,220 @@
+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.
+  
+  module CommonClassMethods
+    attr_reader :site, :user, :password
+
+    # creates an object of the class in which this module is extended
+    def new(args = {})
+      # @resource_class ||= create_resource_class() # should this be commented
+      @resource_class.new(args)
+    end
+    
+    # sets the site for the class in which this module is extended
+    def site=(site)
+      if site != self.site
+        @site = site
+        uri = URI.parse(site)
+        @user = URI.decode(uri.user) if(uri.user)
+        @password = URI.decode(uri.password) if(uri.password)
+        @resource_class = self.send(:create_resource_class)
+      end
+      @site
+    end
+
+    # sets the user for the class in which this module is extended
+    def user=(user)
+      if user != self.user
+        @user = user
+        @resource_class = self.send(:create_resource_class) if(site)
+      end
+      @user
+    end
+
+    # sets the password for the class in which this module is extended
+    def password=(password)
+      if password != self.password
+        @password = password
+        @resource_class = self.send(:create_resource_class) if(site)
+      end
+      @password
+    end
+    
+    # sets the collection name for the class in which this module is extended
+    def collection_name=(collection_name)
+      if collection_name != self.collection_name
+        @collection_name = collection_name
+      end
+      @collection_name
+    end
+    
+    # sets the elment name for the class in which this module is extended
+    def element_name=(element_name)
+      if element_name != self.element_name
+        @element_name = element_name
+      end
+      @element_name
+    end
+    
+    # collection name for the class in which this module is extended
+    def collection_name
+      @collection_name || class_name.underscore.pluralize
+    end
+    
+    # element name for the class in which this module is extended
+    def element_name
+      @element_name || class_name.underscore
+    end
+    
+    # def all_attributes_set?
+    #   site && user && password
+    # end
+    
+    # routes to active resource find
+    def find(*args)
+      scope = args.slice!(0)
+      options = args.slice!(0) || {}
+      @resource_class.find(scope, options)
+    end
+    
+    private
+    # 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
+      created_class.send(:include, Mingle4r::CommonDynClassInstanceMethods)
+
+      # 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
+      
+      created_class
+    end
+    
+    def class_name
+      self.name.split('::')[-1]
+    end
+    
+    def instance_methods_module_name
+      inst_meth_mod_name = 'InstanceMethods'
+      self.constants.detect { |const| const.split('::')[-1] =~ /#{inst_meth_mod_name}/ }
+    end
+    
+    def class_methods_module_name
+      class_meth_mod_name = 'ClassMethods'
+      self.constants.detect { |const| const.split('::')[-1] =~ /#{class_meth_mod_name}/ }
+    end
+    
+    def method_missing(meth_id, *args, &block)
+      @resource_class.send(meth_id.to_sym, *args, &block)
+    end
+  end
+end

data/lib/mingle4r/common_dyn_class_instance_methods.rb

@@ -0,0 +1,5 @@
+module Mingle4r
+  # common dynamic class instance methods
+  module CommonDynClassInstanceMethods
+  end
+end

data/lib/mingle4r/helpers.rb

@@ -0,0 +1,33 @@
+module Mingle4r
+  module Helpers
+    def Helpers.fast_token
+      values = [
+        rand(0x0010000),
+        rand(0x0010000),
+        rand(0x0010000),
+        rand(0x0010000),
+        rand(0x0010000),
+        rand(0x1000000),
+        rand(0x1000000),
+      ]
+      "%04x%04x%04x%04x%04x%06x%06x" % values
+    end
+    
+    def Helpers.encode2html(string)
+      html_char_map = {
+  	    '[' => '%5B', ']' => '%5D',
+  	    '(' => '%28', ')' => '%29',
+  	    ',' => '%2C', ' ' => '%20',
+  	    '=' => '%3D', '\'' => '%27',
+  	    '<' => '%3C', '>' => '%3E',
+  	  }
+
+  		string.strip! if string
+  		encoded_string = ''
+  		string.each_char do |char|
+  		  encoded_string << (html_char_map[char] || char)
+      end
+  		encoded_string
+    end
+  end
+end

data/lib/mingle4r/mingle_client.rb

@@ -0,0 +1,91 @@
+module Mingle4r
+  class MingleClient
+    attr_reader :site, :user, :password, :proj_id
+    
+    def initialize(site, user, password, proj_id = nil)
+      @site = site
+      @user = user
+      @password = password
+      @proj_id = proj_id
+      set_resource_attributes()
+    end
+    
+    def site=(site)
+      if site != self.site
+        @site = site
+        uri = URI.parse(site)
+        @user = URI.decode(uri.user) if(uri.user)
+        @password = URI.decode(uri.password) if(uri.password)
+        set_resource_attributes()
+      end
+      @site
+    end
+
+    def user=(user)
+      if user != self.user
+        @user = user
+        set_resource_attributes()
+      end
+      @user
+    end
+
+    def password=(password)
+      if password != self.password
+        @password = password
+        set_resource_attributes()
+      end
+      @password
+    end
+    
+    def proj_id=(proj_id)
+      if proj_id != @proj_id
+        @proj_id = proj_id
+        set_resource_attributes()
+      end
+      @proj_id
+    end
+    
+    def valid_credentials?
+      project_class = @api.project_class
+      project_class.site = @api.base_url
+      project_class.user = user
+      project_class.password = password
+      begin
+        project_class.find(:all)
+        true
+      rescue Exception => e
+        e.message
+      end
+    end
+
+    def project
+      raise 'proj_id attribute not set' unless @proj_id
+      @project = @api.project_class.find(@proj_id) unless(@project && (@proj_id == @project.identifier))
+      @project
+    end
+    
+    def projects
+      @api.project_class.find(:all)
+    end
+
+    def users
+      @api.user_class.find(:all)
+    end
+    
+    private
+    def set_resource_attributes
+      @api = API.create(@site)
+      set_attributes(@api.project_class)
+      set_attributes(@api.user_class)
+    end
+    
+    def set_attributes(klass)
+      klass.site = @api.base_url
+      klass.user = @user
+      klass.password = @password
+    end
+  end
+end
+
+# alias for the lazy ones
+MingleClient = Mingle4r::MingleClient

data/lib/mingle4r/version.rb

@@ -0,0 +1,11 @@
+module Mingle4r
+  module Version
+    Major = '0'
+    Minor = '3'
+    Tiny  = '0'
+    
+    def self.to_s
+      Major + '.' + Minor + '.' + Tiny
+    end
+  end
+end

data/lib/mingle4r.rb

@@ -0,0 +1,41 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'logger'
+require 'rubygems'
+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
+
+require 'mingle_resource'
+require 'mingle4r/version'
+require 'mingle4r/common_class_methods'
+require 'mingle4r/common_dyn_class_instance_methods'
+require 'mingle4r/helpers'
+require 'mingle4r/mingle_client'
+require 'mingle4r/api'
+
+# Version 1 of api
+require 'mingle4r/api/v1'
+require 'mingle4r/api/v1/card'
+require 'mingle4r/api/v1/card/attachment'
+require 'mingle4r/api/v1/project'
+require 'mingle4r/api/v1/property_definition'
+require 'mingle4r/api/v1/transition_execution'
+require 'mingle4r/api/v1/user'
+require 'mingle4r/api/v1/wiki'
+
+# version 2 of api
+require 'mingle4r/api/v2'
+require 'mingle4r/api/v2/card'
+require 'mingle4r/api/v2/card/attachment'
+require 'mingle4r/api/v2/card/comment'
+require 'mingle4r/api/v2/card/transition'
+require 'mingle4r/api/v2/murmur'
+require 'mingle4r/api/v2/project'
+require 'mingle4r/api/v2/property_definition'
+require 'mingle4r/api/v2/user'
+require 'mingle4r/api/v2/wiki'

data/lib/mingle_resource.rb

@@ -0,0 +1,2 @@
+# to avoid writing ActiveResource::Base
+MingleResource = ActiveResource::Base

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: mingle4r
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- asur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "  A connector wrapper for connecting to Mingle(http://studios.thoughtworks.com/mingle-agile-project-management).\n  It uses active resource to handle the restful connections to Mingle. Makes the job of connecting to Mingle a \n  lot easier. Also since it uses lazy evaluation, resources are fetched only when they are requested.\n"
+email: arusarka@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/mingle4r.rb
+- lib/mingle_resource.rb
+- lib/mingle4r/api.rb
+- lib/mingle4r/common_class_methods.rb
+- lib/mingle4r/common_dyn_class_instance_methods.rb
+- lib/mingle4r/helpers.rb
+- lib/mingle4r/mingle_client.rb
+- lib/mingle4r/version.rb
+- lib/mingle4r/api/v1.rb
+- lib/mingle4r/api/v1/card.rb
+- lib/mingle4r/api/v1/card/attachment.rb
+- lib/mingle4r/api/v1/project.rb
+- lib/mingle4r/api/v1/property_definition.rb
+- lib/mingle4r/api/v1/transition_execution.rb
+- lib/mingle4r/api/v1/user.rb
+- lib/mingle4r/api/v1/wiki.rb
+- lib/mingle4r/api/v2.rb
+- lib/mingle4r/api/v2/card.rb
+- lib/mingle4r/api/v2/card/attachment.rb
+- lib/mingle4r/api/v2/card/comment.rb
+- lib/mingle4r/api/v2/card/transition.rb
+- lib/mingle4r/api/v2/murmur.rb
+- lib/mingle4r/api/v2/project.rb
+- lib/mingle4r/api/v2/property_definition.rb
+- lib/mingle4r/api/v2/user.rb
+- lib/mingle4r/api/v2/wiki.rb
+- MIT-LICENSE
+- History.txt
+- README
+- TODO.txt
+has_rdoc: true
+homepage: http://github.com/arusarka/mingle4r/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Mingle connector using active resource
+test_files: []
+