mingle4r 0.4.5 → 0.4.6

data/History.txt

@@ -1,3 +1,8 @@
+0.4.6
+-----
+* new apis - find_card, filter_cards, cards, new_card for Project and MingleClient 
+* changed README to rdoc format
+
 0.4.5
 -----
 * fixed card updation

data/README.rdoc

@@ -0,0 +1,312 @@
+== mingle4r
+
+http://github.com/arusarka/mingle4r/tree/master
+
+== Description:
+
+This gem is a wrapper around active resource to access the rest api exposed by mingle
+(http://studios.thoughtworks.com/mingle-agile-project-management).It provides a easy 
+way to communicate with mingle. For the library to work you need to enable basic authentication
+(not enabled by default) in Mingle. See below to enable basic authentication in Mingle.
+The typical use-case for this gem is to help someone getting started with writing code
+to integrate with Mingle.
+
+However if you are planning to connect and work with mingle from the terminal, then there
+is another gem mingle-mingle which you should look at. This library provides a very easy
+api to write code to work with mingle (see the examples below) but thats it.
+
+=== Enable basic authentication in Mingle
+
+1. Go to Mingle DataDir
+2. Open YAML file <Mingle DataDir>/config/auth_config.yml
+3. Set 'basic_authentication_enabled' to 'true' (without the quotes) if it is not so
+
+== Features/Problems:
+
+It gives you access to projects in the mingle instance, cards under the project and also
+attachments for a particular card. 
+
+== Synopsis:
+
+This library is a wrapper around active resource to interact with Mingle easily. So before
+using this gem a good idea would be to get familiar with active resource and the mingle apis.
+If you have a mingle server running somewhere you can check the different apis at <server address>/help/mingle_api.html or goto http://www.thoughtworks-studios.com/mingle/3.0/help/mingle_api.html
+
+A lot of examples are given below to get you started.
+
+The api now supports only mingle 3. Mingle 2 is no longer supported. If you need to connect
+to both Mingle 2 and Mingle 3 then try 0.3.0 of the gem.
+
+In all the documentation below you can replace Mingle4r::MingleClient with MingleClient.
+Its an alias for easy use.
+
+=== 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'.
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  projs = m_c.projects => array of active resource objects
+
+=== 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
+identifier of 'great_mingle_project'
+
+WARNING : project identifier and project name are different. If you named your project as
+'Great Mingle Project' it's identifier is by default 'great_mingle_project'. To be sure what
+the identifier of a project is you should look at the url in mingle in the particular project
+you are trying to access. It should be something like 'http://localhost:8080/projects/great_mingle_project'
+
+  1. Set at initialize time
+      m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password',
+      		'great_mingle_project')
+      m_c.project => active resource object
+  		
+  2. Set an attribute later
+      m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+      m_c.proj_id = 'great_mingle_project'
+      project = m_c.project
+
+=== Validate credentials
+
+  m_c.valid_credentials? => returns true or false
+
+=== Getting cards for a particular project
+
+Get a mingle client object. Then call the cards method.
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  m_c.cards => array of activeresource objects
+  
+  Alternatively you can also do
+    m_c.project.cards => array of activeresource objects
+
+=== Getting a singe card
+
+  m_c.find_card(42) => card activeresource object
+    
+  Alternatively you can also do
+    m_c.project.find_card(42)
+
+=== Filtering cards
+
+Mingle allows a lighweight implementation of sql called mql through which you can filter
+cards. Look at http://www.thoughtworks-studios.com/mingle/3.0/help/mql_reference.html for
+reference. However when using this feature you should only give the condition not the
+properties you want out of mingle.
+
+  m_c.filter_cards('Type IS Story') => returns a list card objects
+      
+  Do not do this (it simply *won't work*) :
+    m_c.filter_cards('SELECT number, type WHERE Type IS Story')
+      
+  If you want to execute a generic mql look at the 'MQL Execution' section
+
+=== Getting custom properties for a card
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  card = m_c.cards.first
+  card.custom_properties => returns an array of hashes, {property name => property value}
+
+However this gives only custom properties, not all the properties.
+
+=== 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.cards.first
+  card.property_value('Status')
+
+=== Setting a particular property
+
+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'
+  defect_card = m_c.find_cards('Type IS Defect').first
+  defect_card.property_value('Status', 'Closed')
+  defect_card.save
+
+In case of properties of type 'Tree Relatioship property' or 'Card'(properties which link
+to another card) you can should set the property by giving the number of the card. For e.g.
+
+  story_card = m_c.projects.cards.find {|c| c.type == 'Story'}.first
+  story_card.property_value('Feature', 12)
+  story_card.save
+
+In case of properties of type 'Team member' you can either use the user id (not the name or
+the login id, you would have to look at the xml to get the id) or more simply the user name.
+For e.g.
+
+  story_card.property_value('Assignee', 'James Bond')
+  story_card.save
+
+=== Creating a card
+
+MingleClient provides a handy method to create a new card.
+
+  task = m_c.new_card
+  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
+  
+  Alternatively you can also do:
+    Mingle4r::API::Card.site = 'http://localhost:8080/projects/agile/'
+    Mingle4r::API::Card.user = 'foo'
+    Mingle4r::API::Card.password = 'bar'
+    
+    task = Mingle4r::API::Card.new , rest of the steps are same as above
+
+Do not do it like this:
+
+  task = m_c.new_card :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.
+
+=== 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
+following ways.
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  defect_card = m_c.find_card(20)
+  
+supposing the latest version of the card is 42
+
+  1. Get the previous version
+      defect_card.version(:previous) # return version 41
+  
+  2. Get the next version
+      defect_card.version(:next) # returns version 42 since it is the latest version
+  
+  3. Get an arbitrary version
+      defect_card.version(21) # returns version 21
+
+=== 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.find_cards('Type IS Defect').first
+  defect_cards.comments
+
+=== 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.find_card(420)
+  defect_card.add_comment('Not able to reproduce')
+
+=== Attachments
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  defect_card = m_c.find_cards('Type IS Defect').first
+  defect_card.attachments
+
+  1. Downloading a particular attachment
+      attachment = defect_card.attachments.first
+      attachment.download('page.css')
+  
+  2. Uploading an attachment
+      defect_card.upload_attachment('page-screenshot.jpg')
+
+=== Murmurs
+
+  1. Get the murmurs for a project
+      m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+      m_c.proj_id = 'great_mingle_project'
+      project = m_c.project
+      project.murmurs
+  
+  2. Get the murmurs associated with a card
+      card = m_c.cards.first
+      card.murmurs
+  
+  3. post a murmur(hooray!)
+      project.post_murmur('my first murmur, I am excited!')
+  
+=== Get all transitions for a card
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  defect_card = m_c.cards.first
+  
+  defect_card.transitions # array of active resource objects
+
+=== Execute a transition on a card
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  defect_card = m_c.find_cards('Type IS Defect').first
+  
+  defect_card.execute_transition(
+   'comment' => comment for the transition, required only if the transition requires a comment
+   'Property Name as in Mingle exactly' => 'Property value to set for the property', required only
+  if the transition requires to be set manually, multiple properties might need to be set.
+  )
+
+=== 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. 
+
+  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+  m_c.proj_id = 'great_mingle_project'
+  m_c.project.execute_mql('SELECT name, "Added in Iteration" WHERE Type = Story') 
+    => returns an array of hash
+
+== Requirements:
+
+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
+add http://gemcutter.org to your gem sources : gem sources -a 'http://gemcutter.org'. Then do
+
+gem install mingle4r
+
+== License:
+
+(The MIT License)
+
+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 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/TODO.txt

@@ -1,21 +1,31 @@
 will be fixed/implemented very soon
 -----------------------------------
 
-* write documentation about updating card properties of type 'Card', 'Tree Relationship property'
-  and 'Team member'
 * complete manual QA to ensure/prioritize what needs to be done for card object
-* performance fixes
+* fix global users and users associated with a project
 
 will be implemented, but not very important for now
 ----------------------------------------------------
 
+* make the gemspec spec to autodiscover new files in some directories
+* use a http connection class
+* test if attachment download works with https
+* get rid of active resource
 * update documentation - write about executing transitions directly on the transition
-* write tests for project class
 * implement card_types for a project
-* mingle client should have cards method
+* investigate setting custom properties at card creation time
+* provide a block to set up a new card in MingleClient::new_card
 
 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
+* should transtions give the list of properties to be changed directly
+
+What should be done regarding
+-----------------------------
+
+* performance fixes - should MingleClient::cards return all cards?
+* what is the difference between mingle client and project object? mingle client seems to be delegating a
+  lot of methods to project
+* should MingleClient::projects method reuse the class of @project?

data/VERSION

@@ -0,0 +1 @@
+0.4.6

data/lib/mingle4r/api/project.rb

@@ -4,47 +4,64 @@ module Mingle4r
       module InstanceMethods
         # returns the cards for the project.
         def cards
-          set_attributes_for(Card) unless card_class_set
+          set_attributes_for(Card)
           Card.find_without_pagination(:all)
         end
 
         # returns the users for the project.
         def users
-          set_attributes_for(User) unless user_class_set
+          set_attributes_for(User)
           User.find(:all)
         end
 
         # returns the wikis for the project.
         def wikis
-          set_attributes_for(Wiki) unless wiki_class_set
+          set_attributes_for(Wiki)
           Wiki.find(:all)
         end
 
         # returns the property definitions for the project.
         def property_definitions
-          set_attributes_for(PropertyDefinition) unless property_definition_class_set
+          set_attributes_for(PropertyDefinition)
           PropertyDefinition.find(:all)
         end
 
         # returns the murmurs for the project.
         def murmurs
-          set_attributes_for(Murmur) unless murmur_class_set
+          set_attributes_for(Murmur)
           Murmur.find(:all)
         end
 
         # posts a murmur
         def post_murmur(str)
-          set_attributes_for(Murmur) unless murmur_class_set
+          set_attributes_for(Murmur)
           murmur = Murmur.new(:body => str.to_s)
           murmur.save
         end
         
         # executes an mql
         def execute_mql(query)
-          set_attributes_for(ExecuteMql) unless execute_mql_class_set
+          set_attributes_for(ExecuteMql)
           ExecuteMql.query(query)
         end
         
+        #finds a single card
+        def find_card(number)
+          set_attributes_for(Card)
+          Card.find(number)
+        end
+        
+        #returns a filtered list of cards
+        def filter_cards(filter_str)
+          set_attributes_for(Card)
+          Card.apply_filter(filter_str)
+        end
+        
+        def new_card
+          set_attributes_for(Card)
+          Card.new
+        end
+        
         private
         def set_attributes_for(klass)
           resource_site = File.join(self.class.site.to_s, "projects/#{self.identifier}")
@@ -52,40 +69,8 @@ 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
 
       extend Mingle4r::CommonClassMethods

data/lib/mingle4r/mingle_client.rb

@@ -7,48 +7,38 @@ module Mingle4r
       @user = user
       @password = password
       @proj_id = proj_id
-      set_resource_attributes()
+      setup_project_class
     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 = site
+      user, password = decode_uri(site)
+      @user = user if user
+      @password = password if password
+      setup_project_class
       @site
     end
 
     def user=(user)
-      if user != self.user
-        @user = user
-        set_resource_attributes()
-      end
+      @user = user
+      setup_project_class
       @user
     end
 
     def password=(password)
-      if password != self.password
-        @password = password
-        set_resource_attributes()
-      end
+      @password = password
+      setup_project_class
       @password
     end
     
     def proj_id=(proj_id)
-      if proj_id != @proj_id
-        @proj_id = proj_id
-        set_resource_attributes()
-      end
+      @proj_id = proj_id
+      setup_project_class
       @proj_id
     end
     
     def valid_credentials?
-      API::Project.site = base_url
-      API::Project.user = user
-      API::Project.password = password
+      setup_project_class
       begin
         API::Project.find(:all)
         true
@@ -67,17 +57,13 @@ module Mingle4r
       API::Project.find(:all)
     end
 
-    def users
-      API::User.find(:all)
+    def method_missing(meth_id, *args, &block)
+      project.send(meth_id, *args, &block)
     end
     
     private
-    def set_resource_attributes
-      set_attributes(API::Project)
-      set_attributes(API::User)
-    end
-    
-    def set_attributes(klass)
+    def setup_project_class
+      klass = API::Project
       klass.site = base_url
       klass.user = @user
       klass.password = @password
@@ -86,6 +72,11 @@ module Mingle4r
     def base_url
       File.join(@site.to_s, '/api/v2/')
     end
+    
+    def decode_uri(site)
+      uri = URI.parse(site)
+      [uri.user, uri.password]
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mingle4r
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 4
-  - 5
-  version: 0.4.5
+  - 6
+  version: 0.4.6
 platform: ruby
 authors: 
 - asur
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-02 00:00:00 +05:30
+date: 2010-06-27 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,14 +39,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - lib/mingle4r.rb
 - lib/mingle_resource.rb
 - lib/mingle4r/common_class_methods.rb
 - 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
@@ -60,7 +59,8 @@ files:
 - lib/mingle4r/api/wiki.rb
 - MIT-LICENSE
 - History.txt
-- README
+- README.rdoc
+- VERSION
 - TODO.txt
 has_rdoc: true
 homepage: http://github.com/arusarka/mingle4r/

data/README

@@ -1,310 +0,0 @@
-== mingle4r
-
-http://github.com/arusarka/mingle4r/tree/master
-
-== DESCRIPTION:
-
-This gem is a wrapper around active resource to access the rest api exposed by mingle
-(http://studios.thoughtworks.com/mingle-agile-project-management).It provides a easy 
-way to communicate with mingle. For the library to work you need to enable basic authentication
-(not enabled by default) in Mingle. See below to enable basic authentication in Mingle.
-The typical use-case for this gem is to help someone getting started with writing code
-to integrate with Mingle.
-
-However if you are planning to connect and work with mingle from the terminal, then there
-is another gem mingle-mingle which you should look at. This library provides a very easy
-api to write code to work with mingle (see the examples below) but thats it.
-
-Enable basic authentication in Mingle
--------------------------------------
-
-1) Go to Mingle DataDir
-
-2) Open YAML file <Mingle DataDir>/config/auth_config.yml
-
-3) Set 'basic_authentication_enabled' to 'true' (without the quotes) if it is not so
-
-== FEATURES/PROBLEMS:
-
-It gives you access to projects in the mingle instance, cards under the project and also
-attachments for a particular card. 
-
-== SYNOPSIS:
-
-The api now supports only mingle 3. Mingle 2 is no longer supported. If you need to connect
-to both Mingle 2 and Mingle 3 then try 0.3.0 of the gem. To see the api for mingle 3, check
-the api documentation for the mingle instance(located at <mingle instance host>/help/index)
-
-In all the documentation below you can replace Mingle4r::MingleClient with MingleClient.
-Its an alias for easy use.
-
-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'.
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-projs = m_c.projects
-
-projs is an array of active resource objects
-
-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
-identifier of 'great_mingle_project'
-
-WARNING : project identifier and project name are different. If you named your project as
-'Great Mingle Project' it's identifier is by default 'great_mingle_project'. To be sure what
-the identifier of a project is you should look at the url in mingle in the particular project
-you are trying to access. It should be something like 'http://localhost:8080/projects/great_mingle_project'
-
-		1) Set at initialize time
-
-		m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password',
-		'great_mingle_project')
-		m_c.project
-
-		2) Set an attribute later
-
-		m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-		m_c.proj_id = 'great_mingle_project'
-		project = m_c.project
-		
-		project is a single activeresource object
-
-Getting cards for a particular project
---------------------------------------
-
-Get a mingle client object initialized as in SECTION B. Then call the cards method.
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-m_c.project.cards
-
-cards will be an array of activeresoure objects.
-
-Getting custom properties for a card
-------------------------------------
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-card = m_c.project.cards[0]
-card.custom_properties => returns an array of hashes, {property name => property value}
-
-However this gives only custom properties, not all the properties.
-
-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')
-
-Setting a particular property
------------------------------
-
-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'
-defect_card = m_c.project.cards.first
-defect_card.property_value('Status', 'Closed')
-defect_card.save
-
-In case of properties of type 'Tree Relatioship property' or 'Card'(properties which link
-to another card) you can should set the property by giving the number of the card. For e.g.
-
-story_card = m_c.projects.cards.find {|c| c.type == 'Story'}.first
-story_card.property_value('Feature', 12)
-story_card.save
-
-In case of properties of type 'Team member' you can either use the user id (not the name or
-the login id, you would have to look at the xml to get the id) or more simply the user name.
-For e.g.
-
-story_card.property_value('Assignee', 'James Bond')
-story_card.save
-
-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.
-
-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')
-
-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
-following ways.
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-defect_card = m_c.project.cards.first
-supposing the latest version of the card is 42
-
-  1) Get the previous version
-  ---------------------------
-  
-  defect_card.version(:previous) # return version 41
-  
-  2) Get the next version
-  -----------------------
-  
-  defect_card.version(:next) # returns version 42 since it is the latest version
-  
-  3) Get an arbitrary version
-  ---------------------------
-  
-  defect_card.version(21) # returns version 21
-
-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
-
-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
-defect_card.attachments
-
-  1) Downloading a particular attachment
-  --------------------------------------
-  
-  attachment = defect_card.attachments.first
-  attachment.download('page.css')
-  
-  2) Uploading an attachment
-  --------------------------
-  
-  defect_card.upload_attachment('page-screenshot.jpg')
-
-Murmurs
--------
-
-  1) Get the murmurs for a project
-  --------------------------------
-  
-  m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-  m_c.proj_id = 'great_mingle_project'
-  project = m_c.project
-  project.murmurs
-  
-  2) Get the murmurs associated with a card
-  -----------------------------------------
-  
-  card = project.cards.first
-  card.murmurs
-  
-  3) post a murmur(hooray!)
-  -------------------------
-  project.post_murmur('my first murmur, I am excited!')
-  
-Get all transitions 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_card.transitions # array of active resource objects
-
-Execute a transition on 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_card.execute_transition(
- 'comment' => comment for the transition, required only if the transition requires a comment
- 'Property Name as in Mingle exactly' => 'Property value to set for the property', required only
-if the transition requires to be set manually, multiple properties might need to be set.
-)
-
-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. 
-
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-m_c.project.execute_mql('SELECT name, "Added in Iteration" WHERE Type = Story') 
-  => returns an array of hash
-
-== REQUIREMENTS:
-
-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
-add http://gemcutter.org to your gem sources : gem sources -a 'http://gemcutter.org'. Then do
-
-gem install mingle4r
-
-== LICENSE:
-
-(The MIT License)
-
-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 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/lib/mingle4r/version.rb

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