mingle4r 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,7 @@
+0.4.2
+-----
+* Added functionality to get/set card type directly
+
 0.4.1
 -----
 * Added execute mql api. Now you can make arbitrary MQL queries and get their result.

data/README

@@ -38,8 +38,8 @@ the api documentation for the mingle instance(located at <mingle instance host>/
 In all the documentation below you can replace Mingle4r::MingleClient with MingleClient.
 Its an alias for easy use.
 
-A) Getting all the projects for a particular instance
------------------------------------------------------
+Getting all the projects for a particular instance
+--------------------------------------------------
 
 Suppose you want to connect to the mingle instance hosted at http://localhost:8080 where the
 username is 'testuser' and password is 'password'.
@@ -49,8 +49,8 @@ projs = m_c.projects
 
 projs is an array of active resource objects
 
-B) Getting a particular project
--------------------------------
+Getting a particular project
+----------------------------
 
 Before you access a particular project you need to set the project id for the mingle client 
 object. You can do that in two ways. Supposing you are trying to access a project with an
@@ -75,8 +75,8 @@ you are trying to access. It should be something like 'http://localhost:8080/pro
 		
 		project is a single activeresource object
 
-C) Getting cards for a particular project
------------------------------------------
+Getting cards for a particular project
+--------------------------------------
 
 Get a mingle client object initialized as in SECTION B. Then call the cards method.
 
@@ -86,8 +86,8 @@ m_c.project.cards
 
 cards will be an array of activeresoure objects.
 
-D) Getting custom properties for a card
----------------------------------------
+Getting custom properties for a card
+------------------------------------
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
@@ -96,21 +96,25 @@ card.custom_properties => returns an array of hashes, {property name => property
 
 However this gives only custom properties, not all the properties.
 
-E) Getting a particular property
---------------------------------
+Getting a particular property
+-----------------------------
 
 gets the value of a property. The property name given should be the same as seen in Mingle.
+Type, name, description and number of a card can be accessed directly. For any other custom
+property use the method below.
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
 card = m_c.project.cards[0]
 card.property_value('Status')
 
-F) Setting a particular property
---------------------------------
+Setting a particular property
+-----------------------------
 
-sets the value of the property. The property name given should be the same as in Mingle and
-the value given should be one of the values that Mingle accepts in case of a managed list
+sets the value of the property. The property name given should be the same as in Mingle.
+Type, name and description should be set directly when creating or updating a card.
+In case of a custom property use the following method. The value given should be one of 
+the values that Mingle accepts in case of a managed list
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
@@ -118,16 +122,16 @@ defect_card = m_c.project.cards.first
 defect_card.property_value('Status', 'Closed')
 defect_card.save
 
-G) Adding comment to a particular card
---------------------------------------
+Adding comment to a particular card
+-----------------------------------
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
 defect_card = m_c.project.cards[0]
 defect_card.add_comment('Not able to reproduce')
 
-H) Getting a particular version of a card
------------------------------------------
+Getting a particular version of a card
+--------------------------------------
 
 Mingle maintains the different versions of a card. It always shows the latest version
 by default. However if you want to access a different version you can do so in the
@@ -153,16 +157,16 @@ supposing the latest version of the card is 42
   
   defect_card.version(21) # returns version 21
 
-I) Getting all comments for a card
-----------------------------------
+Getting all comments for a card
+-------------------------------
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
 defect_card = m_c.project.cards.first
 defect_cards.comments
 
-J) Attachments
---------------
+Attachments
+-----------
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
 defect_card = m_c.project.cards.first
@@ -178,9 +182,9 @@ defect_card.attachments
   --------------------------
   
   defect_card.upload_attachment('page-screenshot.jpg')
-  
-K) Murmurs
-----------
+
+Murmurs
+-------
 
   1) Get the murmurs for a project
   --------------------------------
@@ -200,8 +204,8 @@ K) Murmurs
   -------------------------
   project.post_murmur('my first murmur, I am excited!')
   
-L) Get all transitions for a card
----------------------------------
+Get all transitions for a card
+------------------------------
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
@@ -209,8 +213,8 @@ defect_card = m_c.project.cards.first
 
 defect_card.transitions # array of active resource objects
 
-M) Execute a transition on a card
----------------------------------
+Execute a transition on a card
+------------------------------
 
 m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
 m_c.proj_id = 'great_mingle_project'
@@ -222,8 +226,8 @@ defect_card.execute_transition(
 if the transition requires to be set manually, multiple properties might need to be set.
 )
 
-N) MQL execution
-----------------
+MQL execution
+-------------
 
 mingle allows you to write an arbitrary MQL query and returns the results. This gem 
 allows you to do that in a simpler way. If you want to know more about MQL go to http://www.thoughtworks-studios.com/mingle/3.0/help/mql_reference.html. 

data/TODO.txt

@@ -1,4 +1,5 @@
 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
 
 refactorings
@@ -7,4 +8,6 @@ refactorings
 maybe nice to  nave
 -------------------
 
+provide a easy mechanism to link to other cards
+
 should transtions give the list of properties to be changed directly

data/lib/mingle4r/api/card.rb

@@ -32,7 +32,15 @@ module Mingle4r
         def id
           number()
         end
-
+        
+        def type
+          card_type.name
+        end
+        
+        def type=(type)
+          attributes['card_type_name'] = type
+        end
+        
         def attachments(refresh = false)
           return @attachments if(!refresh && @attachments)
           set_attributes_for(Attachment)

data/lib/mingle4r/version.rb

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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mingle4r
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - asur
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 +05:30
+date: 2010-02-25 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 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: []
@@ -41,7 +48,6 @@ files:
 - 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
@@ -64,18 +70,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mingle connector using active resource

data/lib/mingle4r/api/execute_mql.rb

@@ -1,15 +0,0 @@
-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'