arusarka-mingle4r 0.2.1 → 0.2.2
Sign up to get free protection for your applications and to get access to all the features.
- data/History.txt +12 -0
- data/README +30 -8
- metadata +1 -1
data/History.txt
CHANGED
@@ -1,3 +1,15 @@
|
|
1
|
+
0.2.2
|
2
|
+
-----
|
3
|
+
|
4
|
+
* added add_comment to card class. allows adding comment to a card
|
5
|
+
|
6
|
+
0.2.1
|
7
|
+
-----
|
8
|
+
|
9
|
+
* added option to relationship methods(e.g. - cards, users, attachments) to return cached or
|
10
|
+
updated results
|
11
|
+
* property_definitions is a relationship method of project instead of mingle client.
|
12
|
+
|
1
13
|
0.2.0
|
2
14
|
-----
|
3
15
|
|
data/README
CHANGED
@@ -9,6 +9,20 @@ It provides a easy way to communicate with mingle. For the library to work you n
|
|
9
9
|
enable basic authentication (not enabled by default) in Mingle. See below to enable
|
10
10
|
basic authentication in Mingle.
|
11
11
|
|
12
|
+
The speciality of this gem is that once an active resource class attribute (e.g- site,
|
13
|
+
user, password, collection_name, element_name) is set, it cannot be changed. That is even
|
14
|
+
if the attributes are changed it doesn't get reflected in the ActiveResource::Base
|
15
|
+
methods due to redefining the methods. The short story is that active resource fails to
|
16
|
+
find the resources at the location and it throws an error. There are two ways to get
|
17
|
+
around it.1) A small and effective hack (but a hack is hack!). The other way is to create
|
18
|
+
the resource classes dynamically and set the attributes properly. This library uses the
|
19
|
+
later approach. But it also provides a lot of other helper methods which makes interacting
|
20
|
+
with Mingle a lot easier.
|
21
|
+
|
22
|
+
However if you are planning to connect and work with mingle from the terminal, then there
|
23
|
+
is another gem mingle-mingle which you should look at. This library provides a very easy
|
24
|
+
api to write code to work with mingle (see the examples below) but thats it.
|
25
|
+
|
12
26
|
Enable basic authentication in Mingle
|
13
27
|
-------------------------------------
|
14
28
|
|
@@ -21,7 +35,9 @@ Enable basic authentication in Mingle
|
|
21
35
|
== FEATURES/PROBLEMS:
|
22
36
|
|
23
37
|
It gives you access to projects in the mingle instance, cards under the project and also
|
24
|
-
attachments for a particular card.
|
38
|
+
attachments for a particular card.
|
39
|
+
Presently comments on cards cannot be updated as mingle does not expose this api. It will
|
40
|
+
be supported in later version only if mingle supports it.
|
25
41
|
|
26
42
|
== SYNOPSIS:
|
27
43
|
|
@@ -48,16 +64,17 @@ WARNING : project identifier and project name are different. If you named your p
|
|
48
64
|
the identifier of a project is you should look at the url in mingle in the particular project
|
49
65
|
you are trying to access. It should be something like 'http://localhost:8080/projects/great_mingle_project'
|
50
66
|
|
51
|
-
1) Set at initialize time
|
67
|
+
1) Set at initialize time
|
52
68
|
|
53
|
-
m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password',
|
54
|
-
|
69
|
+
m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password',
|
70
|
+
'great_mingle_project')
|
71
|
+
m_c.project
|
55
72
|
|
56
|
-
2) Set an attribute later
|
73
|
+
2) Set an attribute later
|
57
74
|
|
58
|
-
m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
|
59
|
-
m_c.proj_id = 'great_mingle_project'
|
60
|
-
m_c.project
|
75
|
+
m_c = Mingle4r::MingleClient.new('http://localhost:8080', 'testuser', 'password')
|
76
|
+
m_c.proj_id = 'great_mingle_project'
|
77
|
+
m_c.project
|
61
78
|
|
62
79
|
C) Getting cards for a particular project
|
63
80
|
--------------------------------------
|
@@ -78,6 +95,11 @@ m_c.proj_id = 'great_mingle_project'
|
|
78
95
|
card = m_c.cards[0]
|
79
96
|
card.custom_properties => returns an array of hashes, {property name => property method name}
|
80
97
|
|
98
|
+
property name is the name as you see in mingle, whereas property method name is the name
|
99
|
+
of the method that you need to call on the active resource object (card in this case). The
|
100
|
+
default is for a property name 'Added in Iteration Number' the method to call is 'added_in_iteration_number'
|
101
|
+
However this gives only custom properties, not all the properties.
|
102
|
+
|
81
103
|
E) Getting a particular property
|
82
104
|
--------------------------------
|
83
105
|
|