jira_client 1.0.0 → 1.0.1

data/lib/jira_client/comment.rb

@@ -8,5 +8,9 @@ module JiraClient
     convert :update_author, JiraClient::User
     convert :created, lambda {|value| DateTime.parse(value)}
     convert :updated, lambda {|value| DateTime.parse(value)}
+
+    def to_s
+      body
+    end
   end
 end

data/lib/jira_client/issue.rb

@@ -2,16 +2,21 @@ require "jira_client/status"
 require "jira_client/timetracking"
 require "jira_client/project"
 require "jira_client/worklog"
+require "jira_client/issue_type"
 
 module JiraClient
   class Issue < JiraClient::Base
-    attr_reader :key, :description, :summary, :status, :timetracking, :project, :worklog, :comment
+    attr_reader :key, :description, :summary, :status, :timetracking, :project, :worklog, :comment, :issuetype, :subtasks
 
     convert :status, JiraClient::Status
     convert :timetracking, JiraClient::Timetracking
-    convert :comment, JiraClient::Comment
+    convert :comment, lambda {|response| response[:comments].map {|comment| JiraClient::Comment.from_response(comment) } }
     convert :project, JiraClient::Project
     convert :worklog, JiraClient::Worklog
+    convert :issuetype, JiraClient::IssueType
+    convert :subtasks, JiraClient::Issue
+
+    alias :comments :comment
 
     class << self
 
@@ -22,5 +27,10 @@ module JiraClient
       end
 
     end
+
+    def to_s
+      "#{key} #{summary}"
+    end
+
   end
 end

data/lib/jira_client/issue_type.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  class IssueType < JiraClient::Base
+    attr_reader :description, :name, :subtask
+  end
+end

data/lib/jira_client/project.rb

@@ -1,5 +1,9 @@
 module JiraClient
   class Project < JiraClient::Base
     attr_reader :name, :key
+
+    def to_s
+      name
+    end
   end
 end

data/lib/jira_client/server_info.rb

@@ -7,5 +7,9 @@ module JiraClient
 
     convert :server_time, lambda {|value| Time.parse(value)}
     convert :build_date, lambda {|value| Time.parse(value)}
+
+    def to_s
+      "#{base_url} (#{version})"
+    end
   end
 end

data/lib/jira_client/status.rb

@@ -3,5 +3,9 @@ module JiraClient
     OPEN = 1; CLOSE = 2; START_PROGRESS = 4; REOPEN = 3; RESOLVE = 5;
 
     attr_reader :id, :name, :description
+
+    def to_s
+      name
+    end
   end
 end

data/lib/jira_client/user.rb

@@ -6,5 +6,9 @@ module JiraClient
       @attrs[:active] == true
     end
 
+    def to_s
+      display_name
+    end
+
   end
 end

data/lib/jira_client/version.rb

@@ -1,3 +1,3 @@
 module JiraClient
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/fixtures/issue_with_comments.json

@@ -1,33 +1,131 @@
 {
   "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
-  "id": "4321",
-  "self": "https://example.jira.com/rest/api/2/issue/4321",
-  "key": "PROJECT-1234",
+  "id": "10000",
+  "self": "http://localhost:2990/jira/rest/api/2/issue/10000",
+  "key": "TEST-1",
   "fields": {
-    "comment": [
-      {
-        "self": "http://www.example.com/jira/rest/api/2.0/issue/10010/comment/10000",
-        "id": "10000",
-        "author": {
-            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
-            "name": "fred",
-            "displayName": "Fred F. User",
-            "active": false
+    "comment": {
+      "startAt": 0,
+      "maxResults": 4,
+      "total": 4,
+      "comments": [
+        {
+          "self": "http://localhost:2990/jira/rest/api/2/issue/10000/comment/10000",
+          "id": "10000",
+          "author": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "body": "Comment body",
+          "updateAuthor": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "created": "2013-05-13T22:37:56.134+0100",
+          "updated": "2013-05-13T22:37:56.134+0100"
         },
-        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
-        "updateAuthor": {
-            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
-            "name": "fred",
-            "displayName": "Fred F. User",
-            "active": false
+        {
+          "self": "http://localhost:2990/jira/rest/api/2/issue/10000/comment/10001",
+          "id": "10001",
+          "author": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "body": "Didnt fix that shit",
+          "updateAuthor": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "created": "2013-05-13T22:46:00.611+0100",
+          "updated": "2013-05-13T22:46:00.611+0100"
         },
-        "created": "2012-02-15T17:34:37.268-0600",
-        "updated": "2012-02-15T17:34:37.269-0600",
-        "visibility": {
-            "type": "role",
-            "value": "Administrators"
+        {
+          "self": "http://localhost:2990/jira/rest/api/2/issue/10000/comment/10002",
+          "id": "10002",
+          "author": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "body": "Comment body",
+          "updateAuthor": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "created": "2013-05-13T22:46:41.508+0100",
+          "updated": "2013-05-13T22:46:41.508+0100"
+        },
+        {
+          "self": "http://localhost:2990/jira/rest/api/2/issue/10000/comment/10003",
+          "id": "10003",
+          "author": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "body": "Comment body",
+          "updateAuthor": {
+            "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "emailAddress": "admin@example.com",
+            "avatarUrls": {
+              "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+              "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+            },
+            "displayName": "admin",
+            "active": true
+          },
+          "created": "2013-05-13T22:49:11.301+0100",
+          "updated": "2013-05-13T22:49:11.301+0100"
         }
-      }
-    ]
+      ]
+    }
   }
 }

data/spec/fixtures/issue_with_issuetype.json

@@ -0,0 +1,16 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "10000",
+  "self": "http://localhost:2990/jira/rest/api/2/issue/10000",
+  "key": "TEST-1",
+  "fields": {
+    "issuetype": {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/1",
+      "id": "1",
+      "description": "A problem which impairs or prevents the functions of the product.",
+      "iconUrl": "http://localhost:2990/jira/images/icons/bug.gif",
+      "name": "Bug",
+      "subtask": false
+    }
+  }
+}

data/spec/fixtures/issue_with_subtasks.json

@@ -0,0 +1,68 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "10000",
+  "self": "http://localhost:2990/jira/rest/api/2/issue/10000",
+  "key": "TEST-1",
+  "fields": {
+    "subtasks": [
+      {
+        "id": "10001",
+        "key": "TEST-2",
+        "self": "http://localhost:2990/jira/rest/api/2/issue/10001",
+        "fields": {
+          "summary": "This is a subtask",
+          "status": {
+            "self": "http://localhost:2990/jira/rest/api/2/status/1",
+            "description": "The issue is open and ready for the assignee to start work on it.",
+            "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
+            "name": "Open",
+            "id": "1"
+          },
+          "issuetype": {
+            "self": "http://localhost:2990/jira/rest/api/2/issuetype/5",
+            "id": "5",
+            "description": "The sub-task of the issue",
+            "iconUrl": "http://localhost:2990/jira/images/icons/issue_subtask.gif",
+            "name": "Sub-task",
+            "subtask": true
+          },
+          "priority": {
+            "self": "http://localhost:2990/jira/rest/api/2/priority/3",
+            "iconUrl": "http://localhost:2990/jira/images/icons/priority_major.gif",
+            "name": "Major",
+            "id": "3"
+          }
+        }
+      },
+      {
+        "id": "10002",
+        "key": "TEST-3",
+        "self": "http://localhost:2990/jira/rest/api/2/issue/10002",
+        "fields": {
+          "summary": "This is a subtask",
+          "status": {
+            "self": "http://localhost:2990/jira/rest/api/2/status/1",
+            "description": "The issue is open and ready for the assignee to start work on it.",
+            "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
+            "name": "Open",
+            "id": "1"
+          },
+          "issuetype": {
+            "self": "http://localhost:2990/jira/rest/api/2/issuetype/5",
+            "id": "5",
+            "description": "The sub-task of the issue",
+            "iconUrl": "http://localhost:2990/jira/images/icons/issue_subtask.gif",
+            "name": "Sub-task",
+            "subtask": true
+          },
+          "priority": {
+            "self": "http://localhost:2990/jira/rest/api/2/priority/3",
+            "iconUrl": "http://localhost:2990/jira/images/icons/priority_major.gif",
+            "name": "Major",
+            "id": "3"
+          }
+        }
+      }
+    ]
+  }
+}

data/spec/jira_client/api/issues_spec.rb

@@ -56,6 +56,45 @@ describe JiraClient::API::Issues do
         expect(@issue.status).to be_a_kind_of JiraClient::Status
       end
     end
+    context "with an issuetype" do
+
+      before do
+        stub_get("/issue/PROJECT-1234").with(:query => {:fields => "issuetype"}).to_return(:body => fixture("issue_with_issuetype.json"))
+        @issue = JiraClient.find_issue_by_key("PROJECT-1234", :fields => [:issuetype])
+      end
+
+      it "requests the correct resource" do
+        expect(a_get("/issue/PROJECT-1234?fields=issuetype")).to have_been_made
+      end
+      it "sets the correct values" do
+        type = @issue.issuetype
+        expect(type).to be_a_kind_of JiraClient::IssueType
+        type.name.should == "Bug"
+        type.description.should == "A problem which impairs or prevents the functions of the product."
+      end
+
+    end
+    context "with subtasks" do
+
+      before do
+        stub_get("/issue/PROJECT-1234").with(:query => {:fields => "subtasks"}).to_return(:body => fixture("issue_with_subtasks.json"))
+        @issue = JiraClient.find_issue_by_key("PROJECT-1234", :fields => [:subtasks])
+      end
+
+      it "requests the correct resource" do
+        expect(a_get("/issue/PROJECT-1234?fields=subtasks")).to have_been_made
+      end
+      it "sets the correct values" do
+        subtasks = @issue.subtasks
+        expect(subtasks).to be_a_kind_of Array
+        subtasks.each do |subtask|
+          expect(subtask).to be_a_kind_of JiraClient::Issue
+          subtask.summary.should == "This is a subtask"
+          subtask.issuetype.name.should == "Sub-task"
+        end
+      end
+
+    end
     context "with timetracking" do
 
       before do
@@ -104,6 +143,9 @@ describe JiraClient::API::Issues do
           comment.should be_a_kind_of JiraClient::Comment
         end
       end
+      it "aliases comments" do
+        @issue.comments.should == @issue.comment
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,6 +124,7 @@ files:
 - lib/jira_client/error/resource_not_found.rb
 - lib/jira_client/error/unauthorized.rb
 - lib/jira_client/issue.rb
+- lib/jira_client/issue_type.rb
 - lib/jira_client/project.rb
 - lib/jira_client/server_info.rb
 - lib/jira_client/status.rb
@@ -140,7 +141,9 @@ files:
 - spec/fixtures/invalid_jql.json
 - spec/fixtures/issue_with_comments.json
 - spec/fixtures/issue_with_description.json
+- spec/fixtures/issue_with_issuetype.json
 - spec/fixtures/issue_with_status.json
+- spec/fixtures/issue_with_subtasks.json
 - spec/fixtures/issue_with_timetracking.json
 - spec/fixtures/issue_with_worklogs.json
 - spec/fixtures/issues.json
@@ -199,7 +202,9 @@ test_files:
 - spec/fixtures/invalid_jql.json
 - spec/fixtures/issue_with_comments.json
 - spec/fixtures/issue_with_description.json
+- spec/fixtures/issue_with_issuetype.json
 - spec/fixtures/issue_with_status.json
+- spec/fixtures/issue_with_subtasks.json
 - spec/fixtures/issue_with_timetracking.json
 - spec/fixtures/issue_with_worklogs.json
 - spec/fixtures/issues.json