mingle4r 0.3.0 → 0.4.0

data/lib/mingle4r/api/murmur.rb

@@ -0,0 +1,12 @@
+module Mingle4r
+  module API
+    class Murmur
+      extend Mingle4r::CommonClassMethods
+      module InstanceMethods
+        def to_s
+          author.name.to_s + ' - ' + body
+        end
+      end
+    end
+  end
+end

data/lib/mingle4r/api/project.rb

@@ -0,0 +1,64 @@
+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)
+        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)
+        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)
+        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)
+        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)
+        end
+
+        # posts a murmur
+        def post_murmur(str)
+          set_attributes_for(Murmur)
+          murmur = Murmur.new(:body => str.to_s)
+          murmur.save
+        end
+        
+        private
+        def set_attributes_for(klass)
+          resource_site = File.join(self.class.site.to_s, "projects/#{self.identifier}")
+          klass.site = resource_site
+          klass.user = self.class.user
+          klass.password = self.class.password
+        end
+      end # module InstanceMethods
+
+      extend Mingle4r::CommonClassMethods
+    end # class Project
+  end # class API
+end

data/lib/mingle4r/api/property_definition.rb

@@ -0,0 +1,7 @@
+module Mingle4r
+  module API
+    class PropertyDefinition
+      extend Mingle4r::CommonClassMethods
+    end
+  end
+end

data/lib/mingle4r/api/user.rb

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

data/lib/mingle4r/api/wiki.rb

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

data/lib/mingle4r/common_class_methods.rb

@@ -189,7 +189,6 @@ module Mingle4r
       # 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

data/lib/mingle4r/mingle_client.rb

@@ -3,7 +3,7 @@ module Mingle4r
     attr_reader :site, :user, :password, :proj_id
     
     def initialize(site, user, password, proj_id = nil)
-      @site = site
+      @site = site.to_s
       @user = user
       @password = password
       @proj_id = proj_id
@@ -46,44 +46,46 @@ module Mingle4r
     end
     
     def valid_credentials?
-      project_class = @api.project_class
-      project_class.site = @api.base_url
-      project_class.user = user
-      project_class.password = password
+      API::Project.site = base_url
+      API::Project.user = user
+      API::Project.password = password
       begin
-        project_class.find(:all)
+        API::Project.find(:all)
         true
       rescue Exception => e
-        e.message
+        false
       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 = API::Project.find(@proj_id) unless(@project && (@proj_id == @project.identifier))
       @project
     end
     
     def projects
-      @api.project_class.find(:all)
+      API::Project.find(:all)
     end
 
     def users
-      @api.user_class.find(:all)
+      API::User.find(:all)
     end
     
     private
     def set_resource_attributes
-      @api = API.create(@site)
-      set_attributes(@api.project_class)
-      set_attributes(@api.user_class)
+      set_attributes(API::Project)
+      set_attributes(API::User)
     end
     
     def set_attributes(klass)
-      klass.site = @api.base_url
+      klass.site = base_url
       klass.user = @user
       klass.password = @password
     end
+    
+    def base_url
+      File.join(@site.to_s, '/api/v2/')
+    end
   end
 end
 

data/lib/mingle4r/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mingle4r
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - asur
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 +05:30
+date: 2010-02-02 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,30 +33,19 @@ extra_rdoc_files:
 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
+- 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/murmur.rb
+- lib/mingle4r/api/project.rb
+- lib/mingle4r/api/property_definition.rb
+- lib/mingle4r/api/user.rb
+- lib/mingle4r/api/wiki.rb
 - MIT-LICENSE
 - History.txt
 - README

data/lib/mingle4r/api.rb

@@ -1,31 +0,0 @@
-require 'uri'
-require 'net/https'
-
-module Mingle4r
-  class API
-    class << self
-      def create(url)
-        @host_uri = URI.parse(url)
-        api_ver = mingle_version.to_i - 1
-        class_name = 'V' + api_ver.to_s
-        ver_class = send(:const_get, class_name.to_sym)
-        ver_class.new(url)
-      end
-      
-      def mingle_version
-        html  = mingle_about_page
-        match = html.match('<dd>Version</dd>\n.*<dt>([_\d]*)</dt>')
-        raise Exception, 'Not a proper mingle instance' unless match
-        @mingle_version = match[1].gsub('_','.').to_f
-      end
-
-      private
-      def mingle_about_page
-        http             = Net::HTTP.new(@host_uri.host, @host_uri.port)
-        http.use_ssl     = true if @host_uri.is_a?(URI::HTTPS)
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
-        http.get('/about').body
-      end
-    end
-  end # class API
-end

data/lib/mingle4r/api/v1.rb

@@ -1,25 +0,0 @@
-module Mingle4r
-  class API
-    class V1
-      def initialize(host_url)
-        @host_uri = URI.parse(host_url)
-      end
-      
-      def base_url
-        @host_uri.to_s
-      end
-      
-      def version
-        1
-      end
-      
-      def project_class
-        Project
-      end
-      
-      def user_class
-        User
-      end
-    end
-  end
-end

data/lib/mingle4r/api/v1/card.rb

@@ -1,173 +0,0 @@
-module Mingle4r
-  class API
-    class V1
-      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)
-            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
-            Attachment.site = attachment_site
-            Attachment.user = self.class.user
-            Attachment.password = self.class.password
-            attachment_class = 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
-      
-          # Executes the given transition on the card.
-          # Example :
-          # defect_card.execute_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 = {})
-            V1::TransitionExecution.site     = self.class.site.to_s
-            V1::TransitionExecution.user     = self.class.user
-            V1::TransitionExecution.password = self.class.password
-            
-            args.symbolize_keys!
-            trans_hash = create_transition_exec_hash(args)
-            V1::TransitionExecution.new(trans_hash).execute
-          end
-      
-          # gets the value of a property. The property name given should be the same name as
-          # the mingle property name
-          def property_value(name, val = nil)
-            set_property_definitions_attributes
-            column_name = PropertyDefinition.column_name_for(name.to_s)
-            val ? attributes[column_name] = val : attributes[column_name]
-          end
-
-          def custom_properties
-            set_property_definitions_attributes
-            custom_props = []
-            card_props = attributes.keys
-            PropertyDefinition.find(:all).each do |prop|
-              if(card_props.include?(prop.column_name))
-                custom_prop = {prop.name => attributes[prop.column_name]}
-                custom_props.push(custom_prop)
-              end
-            end
-            custom_props
-          end
-      
-          private
-          def boundary
-            '----------XnJLe9ZIbbGUYtzPQJ16u1'
-          end
-          
-          def create_transition_exec_hash(args)
-            transition_hash = {}
-            transition_hash['card'] = (args.delete(:card) || self.number).to_i
-            transition_hash['transition'] = (args.delete(:name) || args.delete(:transition))
-            
-            comment = args.delete(:comment)
-            transition_hash['comment'] = comment if comment
-            properties = []
-            args.each do |name, value|
-              property = {'name' => name.to_s, 'value' => value}
-              properties.push(property)
-            end
-            transition_hash['properties'] = properties unless properties.empty?
-            transition_hash
-          end
-          
-          def set_property_definitions_attributes
-            PropertyDefinition.site = self.class.site.to_s
-            PropertyDefinition.user = self.class.user
-            PropertyDefinition.password = self.class.password
-          end
-        end
-      end
-    end
-  end
-end