arusarka-mingle4r 0.2.1 → 0.2.2

data/History.txt

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

data/README

@@ -9,6 +9,20 @@ It provides a easy way to communicate with mingle. For the library to work you n
 enable basic authentication (not enabled by default) in Mingle. See below to enable 
 basic authentication in Mingle.
 
+The speciality of this gem is that once an active resource class attribute (e.g- site,
+user, password, collection_name, element_name) is set, it cannot be changed. That is even
+if the attributes are changed it doesn't get reflected in the ActiveResource::Base
+methods due to redefining the methods. The short story is that active resource fails to
+find the resources at the location and it throws an error. There are two ways to get
+around it.1) A small and effective hack (but a hack is hack!). The other way is to create
+the resource classes dynamically and set the attributes properly. This library uses the
+later approach. But it also provides a lot of other helper methods which makes interacting
+with Mingle a lot easier.
+
+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
 -------------------------------------
 
@@ -21,7 +35,9 @@ Enable basic authentication in Mingle
 == FEATURES/PROBLEMS:
 
 It gives you access to projects in the mingle instance, cards under the project and also
-attachments for a particular card.
+attachments for a particular card. 
+Presently comments on cards cannot be updated as mingle does not expose this api. It will
+be supported in later version only if mingle supports it.
 
 == SYNOPSIS:
 
@@ -48,16 +64,17 @@ WARNING : project identifier and project name are different. If you named your p
 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
+		1) Set at initialize time
 
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password', 'great_mingle_project')
-m_c.project
+		m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password',
+		'great_mingle_project')
+		m_c.project
 
-2) Set an attribute later
+		2) Set an attribute later
 
-m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
-m_c.proj_id = 'great_mingle_project'
-m_c.project
+		m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
+		m_c.proj_id = 'great_mingle_project'
+		m_c.project
 
 C) Getting cards for a particular project
 --------------------------------------
@@ -78,6 +95,11 @@ m_c.proj_id = 'great_mingle_project'
 card = m_c.cards[0]
 card.custom_properties => returns an array of hashes, {property name => property method name}
 
+property name is the name as you see in mingle, whereas property method name is the name
+of the method that you need to call on the active resource object (card in this case). The 
+default is for a property name 'Added in Iteration Number' the method to call is 'added_in_iteration_number'
+However this gives only custom properties, not all the properties.
+
 E) Getting a particular property
 --------------------------------
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arusarka-mingle4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - asur