arusarka-mingle4r 0.2.5 → 0.2.7

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/gempackagetask'
+
+namespace :gem do
+  desc "Builds the gem"
+  task :build do
+    file_name = "#{File.dirname(__FILE__)}/mingle4r.gemspec"
+    spec = Gem::Specification.load(file_name)
+    Gem::Builder.new(spec).build
+    file = FileList["#{File.dirname(__FILE__)}/mingle4r*.gem"]
+    mv file.to_a, "#{File.dirname(__FILE__)}/pkg"
+  end
+end
+
+# task : run specs
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/TODO.txt

@@ -0,0 +1,4 @@
+Write documentation
+Test the new methods in card class
+test wiki, property definitions api extensively
+subversion configuration api

data/lib/mingle4r.rb

@@ -0,0 +1,23 @@
+$:.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/user'
+require 'mingle4r/card'
+require 'mingle4r/project'
+require 'mingle4r/property_definition'
+require 'mingle4r/wiki'
+require 'mingle4r/mingle_client'

data/lib/mingle4r/card.rb

@@ -0,0 +1,139 @@
+require 'mingle4r/card/attachment'
+
+module Mingle4r
+  class Card
+    module ClassMethods
+      def find_without_pagination(*args)
+        scope = args.slice!(0)
+        options = args.slice!(0) || {}
+        options[:params] ||= {}
+        options[:params].merge!({:page => 'all'})
+
+        # call ActiveResource::Base::find with proper options
+        find(scope, options)
+      end
+      
+      # applies an mql filter on card types. Look at https://mingle05.thoughtworks.com/help/mql_reference.html
+      # for reference
+      def apply_filter(filter_string)
+        find_without_pagination(:all, :params => {'filters[mql]'.to_sym => filter_string})
+      end
+    end
+    
+    module InstanceMethods
+      def attachments(refresh = false)
+        return @attachments if(!refresh && @attachments_cached)
+        attachment_site = File.join(self.class.site.to_s, "cards/#{self.number()}").to_s
+        Mingle4r::Card::Attachment.site = attachment_site
+        Mingle4r::Card::Attachment.user = self.class.user
+        Mingle4r::Card::Attachment.password = self.class.password
+        attachment_class = Mingle4r::Card::Attachment.send(:create_resource_class)
+        @attachments = attachment_class.find(:all)
+        @attachments_cached = true
+        @attachments
+      end
+
+      def upload_attachment(file_path)
+        attachment_uri = URI.parse(File.join(self.class.site.to_s, "cards/#{self.number()}/attachments.xml"))
+        
+        http             = Net::HTTP.new(attachment_uri.host, attachment_uri.port)
+        http.use_ssl     = attachment_uri.is_a?(URI::HTTPS)
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
+        
+        basic_encode = 'Basic ' + ["#{self.class.user}:#{self.class.password}"].pack('m').delete("\r\n")
+        
+        post_headers = {
+          'Authorization' => basic_encode,
+          'Content-Type'  => 'multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1'
+        }
+        
+        file_content = IO.read(file_path)
+
+        post_body = <<EOS
+------------XnJLe9ZIbbGUYtzPQJ16u1\r
+Content-Disposition: form-data; name="file"; filename="#{File.basename(file_path)}"\r
+Content-Type: application/octet-stream\r
+Content-Length: #{file_content.size}\r
+\r
+#{file_content}\r
+------------XnJLe9ZIbbGUYtzPQJ16u1--\r
+EOS
+        
+        http.post(attachment_uri.path, post_body, post_headers)
+      end
+      
+      # returns back the version of the card given. If an invalid version is given, the latest
+      # version is returned, takes a number or :next or :before
+      def at_version(version_no)
+        version_2_find = 0
+        case version_no
+        when :before
+          version_2_find = self.version.to_i - 1
+        when :next
+          version_2_find = self.version.to_i + 1
+        else
+          version_2_find = version_no.to_i
+        end
+        self.class.find(self.number, :params => {:version => version_2_find})
+      end
+
+      # adds a comment to a card.
+      def add_comment(comment)
+        comment_uri = URI.parse(File.join(self.class.site.to_s, "cards/add_comment?card_id=#{self.id}"))
+        
+        http             = Net::HTTP.new(comment_uri.host, comment_uri.port)
+        http.use_ssl     = comment_uri.is_a?(URI::HTTPS)
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
+        
+        basic_encode = 'Basic ' + ["#{self.class.user}:#{self.class.password}"].pack('m').delete("\r\n")
+        
+        post_headers = {
+          'Authorization' => basic_encode,
+          'Content-Type'  => 'application/x-www-form-urlencoded; charset=UTF-8'
+        }
+        
+        post_body = "comment=#{comment}&card_id=#{self.id}"
+        
+        http.post(comment_uri.path, post_body, post_headers)
+      end
+      
+      # TODO - Check if working with https
+      # Executes the given transition on the card.
+      # Example :
+      # defect_card.execute_transition(:transition_name => 'Close Defect', :Owner => nil, :Status => 'Closed', :transition_comment => comment)
+      # transition_comment is mandatory if the transition is set that way.
+      # after transition 'Owner' would have value 'Not Set' and 'Status' would be 'Closed' for defect card
+      def execute_transition(args_hash)
+        project_id = File.basename(self.class.site.to_s)
+        transition_name = args_hash.delete(:transition_name)
+        raise 'Transition name for given' unless transition_name
+        transition_uri = URI.parse(File.join(self.class.site.to_s, 'transition_executions.xml'))
+        
+        # create the form data
+        form_data = {
+          'transition_execution[transition]' => transition_name,
+          'transition_execution[card]' => self.number.to_s
+        }
+        comment = args_hash.delete(:transition_comment)
+        form_data['transition_execution[comment]'] = Helpers.encode2html(comment) if comment
+        args_hash.each do |key, value|
+          form_data['transition_execution[properties][][name]'] = Helpers.encode2html(key.to_s)
+          form_data['transition_execution[properties][][value]'] = Helpers.encode2html(value.to_s)
+        end
+        
+        req = Net::HTTP::Post.new(transition_uri.path)
+        req.basic_auth self.class.user, self.class.password
+        req.set_form_data(form_data)
+        
+        Net::HTTP.new(transition_uri.host, transition_uri.port).start { |http| http.request(req) }
+      end
+      
+      private
+      def boundary
+        '----------XnJLe9ZIbbGUYtzPQJ16u1'
+      end
+    end
+
+    extend Mingle4r::CommonClassMethods
+  end
+end

data/lib/mingle4r/card/attachment.rb

@@ -0,0 +1,47 @@
+module Mingle4r
+  class Card
+    class Attachment
+      module InstanceMethods
+        # downloads the attachment. It an additional file path is given it saves it at the 
+        # given path. The given path should be writable
+        def download(file_name = nil)
+          collection_uri = self.class.site
+          rel_down_url = self.url
+          base_url = "#{collection_uri.scheme}://#{collection_uri.host}:#{collection_uri.port}/"
+          down_uri = URI.join(base_url, rel_down_url)
+          req = Net::HTTP::Get.new(down_uri.path)
+          req.basic_auth self.class.user, self.class.password
+          begin
+            res = Net::HTTP.start(down_uri.host, down_uri.port) { |http| http.request(req) }
+            file_name ||= self.file_name()
+            File.open(file_name, 'w') { |f| f.print(res.body) }
+          rescue Exception => e
+            e.message
+          end
+        end # download
+        
+        # alias for file_name
+        def name
+          file_name()
+        end
+        
+        # so that active resource tries to find by proper id
+        def id
+          name()
+        end
+        
+        # This method had to be overriden. 
+        # normal active resource destroy doesn't work as mingle site for deleting attachments doesn't end with .xml.
+        def destroy
+          connection = self.send(:connection)
+          # deletes the attachment by removing .xml at the end
+          connection.delete(self.send(:element_path).gsub(/\.xml\z/, ''))
+        end
+        alias_method :delete, :destroy
+      end #module InstanceMethods
+      
+      extend Mingle4r::CommonClassMethods
+      
+    end # class Attachment
+  end # class Card
+end # module Mingle4r

data/lib/mingle4r/common_class_methods.rb

@@ -0,0 +1,219 @@
+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) || {}
+      obj = @resource_class.find(scope, options)
+      obj
+    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 any of site, user or password is not set
+      raise "Please set the site for #{self} class before using create_resource_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()}"
+      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, *args, &block)
+    end
+  end
+end

data/lib/mingle4r/common_dyn_class_instance_methods.rb

@@ -0,0 +1,40 @@
+module Mingle4r
+  # common dynamic class instance methods
+  module CommonDynClassInstanceMethods
+    # gets the value of a property. The property name can be given in several ways.
+    # suppose we are trying to get the property 'Iteration Number' as in mingle
+    #
+    # 1) give the name as seen card.property_value('Iteration Number')
+    #
+    # 2) give the property method name i.e. in the active resource object it would
+    # become by default 'cp_iteration_number' attribute unless set differently in
+    # Mingle
+    #
+    # 3) give the method a 'space separated' / 'camelcased' method name. e.g. - 'Iteration Number'
+    # 'IterationNumber'
+    def property_value(prop_name)
+      begin
+        column_name = PropertyDefinition.column_name_for(prop_name.to_s)
+        self.send(column_name.to_sym) 
+      rescue NoMethodError
+        if self.attributes.has_key?(prop_name)
+          self.attributes[prop_name]
+        else
+          # try calling a underscorized method. eg 'Iteration Number' becomes
+          # 'iteration_number'
+          method_id = (prop_name.split(' ').map { |substring| substring.downcase }).join('_').underscore.to_sym
+          self.send(method_id)
+        end
+      end
+    end
+    
+    def custom_properties
+      custom_props = []
+      props = attributes.keys
+      PropertyDefinition.find(:all).each do |prop|
+        custom_props << {prop.name => prop.column_name} if(props.include?(prop.column_name))
+      end
+      custom_props
+    end
+  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,106 @@
+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.site = site
+      Project.user = user
+      Project.password = password
+      begin
+        Project.find(:all)
+        true
+      rescue Exception => e
+        e.message
+      end
+    end
+
+    def project
+      raise 'proj_id attribute not set' unless @proj_id
+      @project = Mingle4r::Project.find(@proj_id) unless(@project && (@proj_id == @project.identifier))
+      @project
+    end
+    
+    def projects
+      Mingle4r::Project.find(:all)
+    end
+
+    def cards
+      raise 'proj_id attribute not set' unless @proj_id
+      @project = Mingle4r::Project.find(@proj_id) unless(@project && (@proj_id == @project.identifier))
+      @project.cards
+    end
+    
+    def users
+      Mingle4r::User.find(:all)
+    end
+    
+    private
+    def set_resource_attributes
+      set_project_attributes
+      set_user_attributes
+    end
+    
+    def set_project_attributes
+      Project.site = @site
+      Project.user = @user
+      Project.password = @password
+    end
+    
+    # def set_property_definition_attributes
+    #   raise 'Project Id (proj_id attribute) not given.' unless @proj_id
+    #   properties_site = File.join(@site.to_s, "projects/#{@proj_id}")
+    #   PropertyDefinition.site = properties_site
+    #   PropertyDefinition.user = @user
+    #   PropertyDefinition.password = @password
+    # end
+    
+    def set_user_attributes
+      User.site = @site
+      User.user = user
+      User.password = @password
+    end
+  end
+end

data/lib/mingle4r/project.rb

@@ -0,0 +1,64 @@
+module Mingle4r
+  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_cached)
+        cards_site = File.join(self.class.site.to_s, "projects/#{self.identifier()}")
+        Mingle4r::Card.site = cards_site
+        Mingle4r::Card.user = self.class.user
+        Mingle4r::Card.password = self.class.password
+        card_class = Mingle4r::Card.send(:create_resource_class)
+        @cards = card_class.find_without_pagination(:all)
+        @cards_cached = true
+        @cards
+      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_cached)
+        users_site = File.join(self.class.site.to_s, "projects/#{self.identifier()}")
+        Mingle4r::User.site = users_site
+        Mingle4r::User.user = self.class.user
+        Mingle4r::User.password = self.class.password
+        Mingle4r::User.element_name = nil # reset
+        user_class = Mingle4r::User.send(:create_resource_class)
+        @users = user_class.find(:all)
+        @users_cached = true
+        @users
+      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_cached)
+        wiki_site = File.join(self.class.site.to_s, "projects/#{self.identifier()}")
+        Mingle4r::Wiki.site = wiki_site
+        Mingle4r::Wiki.user = self.class.user
+        Mingle4r::Wiki.password = self.class.password
+        wiki_class = Mingle4r::Wiki.send(:create_resource_class)
+        @wikis = wiki_class.find(:all)
+        @wikis_cached = true
+        @wikis
+      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_cached)
+        properties_site = File.join(@site.to_s, "projects/#{self.identifier}")
+        PropertyDefinition.site = properties_site
+        PropertyDefinition.user = @user
+        PropertyDefinition.password = @password
+        prop_defn_class = Mingle4r::PropertyDefinition.send(:create_resource_class)
+        @prop_definitions = prop_defn_class.find(:all)
+        @prop_definitions_cached = true
+        @prop_definitions
+      end
+    end # module InstanceMethods
+    
+    extend Mingle4r::CommonClassMethods
+  end # class Project
+end

data/lib/mingle4r/property_definition.rb

@@ -0,0 +1,18 @@
+module Mingle4r
+  class PropertyDefinition
+    # module InstanceMethods
+    # end
+    #   
+    # module ClassMethods
+    # end
+    #   
+    extend Mingle4r::CommonClassMethods
+    
+    self.element_name = 'record'
+      
+    def self.column_name_for(prop_name)
+      property_def = @resource_class.find(:all).detect { |prop| prop.name == prop_name }
+      property_def ? property_def.column_name : nil
+    end
+  end
+end

data/lib/mingle4r/user.rb

@@ -0,0 +1,5 @@
+module Mingle4r
+  class User
+    extend Mingle4r::CommonClassMethods
+  end
+end

data/lib/mingle4r/version.rb

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

data/lib/mingle4r/wiki.rb

@@ -0,0 +1,7 @@
+module Mingle4r
+  class Wiki
+    extend Mingle4r::CommonClassMethods
+    self.collection_name = 'wiki'
+    self.element_name = 'page'
+  end
+end

data/lib/mingle_resource.rb

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

data/spec/mingle4r/card/attachment_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Mingle4r::Card::Attachment do
+  it "should be able to create a class inherited from ActiveResource::Base" do
+    attachment_class = mock(Object)
+    
+    attachment_class.should_receive(:site=).any_number_of_times
+    attachment_class.should_receive(:user=).any_number_of_times
+    attachment_class.should_receive(:password=).any_number_of_times
+    attachment_class.should_receive(:collection_name=).any_number_of_times
+    attachment_class.should_receive(:element_name=).any_number_of_times
+    attachment_class.should_receive(:include).any_number_of_times
+    Class.should_receive(:new).with(MingleResource).any_number_of_times.and_return(attachment_class)
+    
+    Mingle4r::Card::Attachment.site = ''
+    Mingle4r::Card::Attachment.user = ''
+    Mingle4r::Card::Attachment.password = ''
+    
+    Mingle4r::Card::Attachment.send(:create_resource_class).should == attachment_class
+  end
+  
+  it "should be able to download file to a location" do
+    Mingle4r::Card::Attachment.site = 'http://localhost/test'
+    Mingle4r::Card::Attachment.user = 'test'
+    Mingle4r::Card::Attachment.password = 'password'
+    
+    attachment_obj = Mingle4r::Card::Attachment.new
+    attachment_obj.should_receive(:url).and_return('/attachment')
+    attachment_obj.should_receive(:file_name).and_return('attach')
+    
+    request_obj = mock(Object)
+    request_obj.should_receive(:basic_auth)
+    
+    response_obj = mock(Object)
+    response_obj.should_receive(:body).and_return('test text')
+    
+    Net::HTTP::Get.should_receive(:new).and_return(request_obj)
+    Net::HTTP.should_receive(:start).and_return(response_obj)
+    
+    
+    attachment_obj.download()
+    
+    File.exist?('attach').should == true
+    file_contents = IO.read('attach')
+    file_contents.should == 'test text'
+    File.delete('attach')
+  end
+end

data/spec/mingle4r/card_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Mingle4r::Card do
+  it "should be able to call active resource find method with proper params" do
+    Mingle4r::Card.site = 'http://localhost/projects/test'
+    Mingle4r::Card.user = 'user'
+    Mingle4r::Card.password = 'password'
+    
+    card_class = Mingle4r::Card.send(:create_resource_class)
+    card_class.should_receive(:find).with(:all, :params => {:page => 'all'})
+    card_class.find_without_pagination(:all)
+  end
+  
+  it "should set attributes in attachment class properly" do
+    Mingle4r::Card.site = 'http://localhost/projects/test'
+    Mingle4r::Card.user = 'user'
+    Mingle4r::Card.password = 'password'
+    
+    card_obj = Mingle4r::Card.new
+    card_obj.should_receive(:number).and_return(10)
+    
+    attachment_class_mock = mock(Class)
+    Mingle4r::Card::Attachment.should_receive(:create_resource_class).any_number_of_times.and_return(attachment_class_mock)
+    
+    attachment_class_mock.should_receive(:find)
+    card_obj.attachments
+    
+    Mingle4r::Card::Attachment.site.should == 'http://localhost/projects/test/cards/10'
+    Mingle4r::Card::Attachment.user.should == 'user'
+    Mingle4r::Card::Attachment.password.should == 'password'
+  end
+  
+  it "should return the http body boundary" do
+    Mingle4r::Card.site = 'http://localhost/projects/test'
+    Mingle4r::Card.user = 'user'
+    Mingle4r::Card.password = 'password'
+    
+    Mingle4r::Card.new.send(:boundary).should == '----------XnJLe9ZIbbGUYtzPQJ16u1'
+  end
+end

data/spec/mingle4r/common_class_methods_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+class DummyClass
+  module InstanceMethods
+  end
+  
+  # module ClassMethods
+  # end
+  extend Mingle4r::CommonClassMethods
+end
+
+describe DummyClass do
+  it "should be able to set the site properly" do
+    url = 'http://localhost/test'
+    DummyClass.site = url
+    DummyClass.site.should == url
+  end
+  
+  it "should be able to set the user properly" do
+    user = 'testuser'
+    DummyClass.user = user
+    DummyClass.user.should == user
+  end
+  
+  it "should be able to set the password properly" do
+    password = 'password'
+    DummyClass.password = password
+    DummyClass.password.should == password
+  end
+  
+  xit "should understand that the attributes have been set" do
+    DummyClass.site = 'http://localhost:8080'
+    DummyClass.user = 'test'
+    DummyClass.password = 'password'
+    assert DummyClass.all_attributes_set?
+  end
+  
+  it "should be able to create an instance" do
+    dummy_obj = DummyClass.new
+    dummy_obj.should_not == nil
+  end
+  
+  it "should be able to create a class inherited from ActiveResource::Base" do
+    dummy_obj = DummyClass.new
+    dummy_obj.class.superclass.should == ActiveResource::Base
+  end
+  
+  it "should create same class when site is not changed" do
+    class DummyClass
+      class << self
+        attr_reader :resource_class
+      end
+    end
+    site = 'http://localhost/foo'
+    DummyClass.site = site
+    DummyClass.user = 'test'
+    DummyClass.password = 'password'
+    class1 = DummyClass.resource_class
+    DummyClass.site = site
+    class2 = DummyClass.resource_class
+    class1.should == class2
+  end
+  
+  it "should create different classes when site is changed" do
+    class DummyClass
+      class << self
+        attr_reader :resource_class
+      end
+    end
+    site1 = 'http://localhost/foo'
+    site2 = 'http://localhost/bar'
+    DummyClass.site = site1
+    DummyClass.user = 'test'
+    DummyClass.password = 'password'
+    class1 = DummyClass.resource_class
+    DummyClass.site = site2
+    class2 = DummyClass.resource_class
+    class1.should_not == class2
+  end
+  
+  it "should be able to find the instance methods module in the class" do
+    DummyClass.send(:instance_methods_module_name).should == 'InstanceMethods'
+  end
+  
+  it "should not be able to find class methods module in the class" do
+    DummyClass.send(:class_methods_module_name).should be_nil
+  end
+  
+  it "should return the class name only without nesting of namespaces" do
+    DummyClass.send(:class_name).should == 'DummyClass'
+  end
+  
+  it "should call find with proper params" do
+    # open access to @resource var
+    class << DummyClass
+      attr_writer :resource_class
+    end
+    
+    mock_class = mock(Class)
+    DummyClass.resource_class = mock_class
+    mock_class.should_receive(:find).with(:all, :from => 'http://localhost/test', :params => {:foo => 'bar'})
+    DummyClass.find(:all, :from => 'http://localhost/test', :params => {:foo => 'bar'})
+  end
+end

data/spec/mingle4r/helpers_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Mingle4r::Helpers do
+  it "should return a token" do
+    assert Mingle4r::Helpers::fast_token
+  end
+  
+  it "should not return the same token" do
+    token1 = Mingle4r::Helpers::fast_token
+    token2 = Mingle4r::Helpers::fast_token
+    assert_not_equal(token1, token2)
+  end
+  
+  it "should return a string in proper html format" do
+    string = 'Hello(whosoever) world []'
+    html_result = Mingle4r::Helpers::encode2html(string)
+    html_expected = 'Hello%28whosoever%29%20world%20%5B%5D'
+    html_result.should == html_expected
+  end
+end

data/spec/mingle4r/project_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Mingle4r::Project do
+  it "should return the set the Card class attributes properly" do
+    Mingle4r::Project.site = 'http://localhost'
+    Mingle4r::Project.user = 'test'
+    Mingle4r::Project.password = 'password'
+    
+    proj = Mingle4r::Project.new(:identifier => 'test')
+    card_class_mock = mock(Class)
+    Mingle4r::Card.should_receive(:create_resource_class).any_number_of_times.and_return(card_class_mock)
+    card_class_mock.should_receive(:find_without_pagination).with(:all)
+    
+    proj.cards
+    
+    Mingle4r::Card.site.should == 'http://localhost/projects/test'
+    Mingle4r::Card.user.should == 'test'
+    Mingle4r::Card.password.should == 'password'
+  end
+end

data/spec/mingle4r/property_definition_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'ostruct'
+
+describe Mingle4r::PropertyDefinition do
+  before(:all) do
+    Mingle4r::PropertyDefinition.site = 'http://localhost:8080/projects/test'
+    Mingle4r::PropertyDefinition.user = 'test'
+    Mingle4r::PropertyDefinition.password = 'secret'
+  end
+  
+  it "should return the element name properly" do
+    Mingle4r::PropertyDefinition::element_name.should == 'record'
+  end
+  
+  it "should return the property value" do
+    class Mingle4r::PropertyDefinition
+      class << self
+        attr_accessor :resource_class
+      end
+    end
+    resource_class = mock(Class)
+    property_1 = { :name => 'Test Property', :column_name => 'test_property_name' }
+    property_2 = { :name => 'Added in Iteration number', :column_name => 'added_in_iteration_number'}
+    find_results = [OpenStruct.new(property_1), OpenStruct.new(property_2)]
+    Mingle4r::PropertyDefinition.resource_class = resource_class
+    resource_class.should_receive(:find).with(:all).any_number_of_times.and_return(find_results)
+    Mingle4r::PropertyDefinition.column_name_for('Test Property').should == 'test_property_name'
+    Mingle4r::PropertyDefinition.column_name_for('Added in Iteration number').should == 'added_in_iteration_number'
+  end
+end

data/spec/mingle4r/version_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Mingle4r::Version do
+  it "should return proper version" do
+    Mingle4r::Version::to_s.should == '0.2.7'
+  end
+end

data/spec/mingle4r/wiki_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Mingle4r::Wiki do
+  it "should return the collection name properly" do
+    Mingle4r::Wiki::collection_name.should == 'wiki'
+  end
+  
+  it "should return the element name properly" do
+    Mingle4r::Wiki::element_name.should == 'page'
+  end
+end

data/spec/mingle4r_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mingle4r do
+  it "should return my name" do
+    Mingle4r::AUTHOR.should == 'Asur'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/../lib/mingle4r'
+require 'test/unit'
+require 'spec/test/unit'

data/test/integration/test.rb

@@ -0,0 +1,39 @@
+require '../../lib/mingle4r'
+
+
+class Mingle4r::Project
+  class << self
+    attr_reader :resource_class
+  end
+end
+
+m_c = Mingle4r::MingleClient.new('http://localhost:9090', 'testuser', 'testuser', 'api_test')
+
+
+proj = m_c.project
+puts proj.users.size
+cards = m_c.cards
+card = cards[2]
+puts '------------------------------'
+puts Mingle4r::PropertyDefinition.site
+puts Mingle4r::PropertyDefinition.user
+puts Mingle4r::PropertyDefinition.password
+puts Mingle4r::PropertyDefinition.new.class.collection_path
+
+puts card.property_value('Name')
+puts '||||||||||||||||||||||||||||||'
+puts card.custom_properties
+puts card.number
+puts card.description
+# card.description = 'test'
+# card.save
+attachment = card.attachments[0]
+# puts attachment.url
+
+# delete attachments
+Mingle4r::Card::Attachment.site = 'http://localhost:9090/projects/api_test/cards/18'
+Mingle4r::Card::Attachment.user = 'testuser'
+Mingle4r::Card::Attachment.password = 'testuser'
+
+attachment = Mingle4r::Card::Attachment.find(:all)[0]
+# attachment.delete

data/test/integration/test_adding_comment.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+Mingle4r::Card.site = 'http://localhost:9090/projects/api_test'
+Mingle4r::Card.user = 'testuser'
+Mingle4r::Card.password = 'testuser'
+card = Mingle4r::Card.find(18)
+
+puts card.add_comment('testingcomment')

data/test/integration/test_card_filter.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+Mingle4r::Card.site = 'http://localhost:9090/projects/api_test'
+Mingle4r::Card.user = 'testuser'
+Mingle4r::Card.password = 'testuser'
+puts (Mingle4r::Card.apply_filter('Type IS Defect')).size

data/test/integration/test_card_transition.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+Mingle4r::Card.site = 'http://localhost:9090/projects/api_test'
+Mingle4r::Card.user = 'testuser'
+Mingle4r::Card.password = 'testuser'
+card = Mingle4r::Card.find(21)
+
+card.execute_transition(:transition_name => 'Close Defect')

data/test/integration/test_getting_users.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+Mingle4r::User.site = 'http://localhost:9090/projects/api_test'
+Mingle4r::User.user = 'testuser'
+Mingle4r::User.password = 'testuser'
+
+users =  Mingle4r::User.find(:all)
+
+puts users[0].user

data/test/integration/test_uploading_attachment.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+Mingle4r::Card.site = 'http://localhost:9090/projects/api_test'
+Mingle4r::Card.user = 'testuser'
+Mingle4r::Card.password = 'testuser'
+
+card = Mingle4r::Card.find(26)
+puts card.upload_attachment(File.join(File.dirname(__FILE__), '/../../README'))

data/test/integration/test_wiki.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../../lib/mingle4r'
+
+m_c = Mingle4r::MingleClient.new('http://localhost:9090', 'testuser', 'testuser', 'api_test')
+
+proj = m_c.project
+puts proj.wiki.size

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arusarka-mingle4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors: 
 - asur
@@ -31,8 +31,40 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- lib/mingle4r/card.rb
+- lib/mingle4r/card/attachment.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/project.rb
+- lib/mingle4r/property_definition.rb
+- lib/mingle4r/user.rb
+- lib/mingle4r/version.rb
+- lib/mingle4r/wiki.rb
+- lib/mingle4r.rb
+- lib/mingle_resource.rb
+- spec/mingle4r/card/attachment_spec.rb
+- spec/mingle4r/card_spec.rb
+- spec/mingle4r/common_class_methods_spec.rb
+- spec/mingle4r/helpers_spec.rb
+- spec/mingle4r/project_spec.rb
+- spec/mingle4r/property_definition_spec.rb
+- spec/mingle4r/version_spec.rb
+- spec/mingle4r/wiki_spec.rb
+- spec/mingle4r_spec.rb
+- spec/spec_helper.rb
+- test/integration/test.rb
+- test/integration/test_adding_comment.rb
+- test/integration/test_card_filter.rb
+- test/integration/test_card_transition.rb
+- test/integration/test_getting_users.rb
+- test/integration/test_uploading_attachment.rb
+- test/integration/test_wiki.rb
+- MIT-LICENSE
+- Rakefile
 - README
-- History.txt
+- TODO.txt
 has_rdoc: false
 homepage: http://github.com/arusarka/mingle4r/
 post_install_message: 

data/History.txt

@@ -1,33 +0,0 @@
-0.2.2
------
-
-* added add_comment to card class. allows adding comment to a card
-
-0.2.1
------
-
-* added option to relationship methods(e.g. - cards, users, attachments) to return cached or 
-updated results
-* property_definitions is a relationship method of project instead of mingle client.
-
-0.2.0
------
-
-* added class method apply_filter to Card class. allows an MQL filter
-* added instance method execute_transition to Card class. allows to execute a transition on a card.
-
-0.1.6
------
-
-* added instance method at_version to Card class. gets the particular version for the card
-
-0.1.5
------
-
-* Rest Api's added - wiki
-
-0.0.1
------
-
-* Rest Api's - Card, Project, User, Attachment, Property Definition
-* Mingle Client - supports getting cards, project etc.