jira-ruby-dmg 0.1.10 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07448f99963fb48aa853b5306c3b282c7d07ee1
-  data.tar.gz: c8ddbf9b54cf03c5cf523104c60a6f67054a8f7b
+  metadata.gz: 5091836e1cd94b8d437b8b90ffd30f240cd9075a
+  data.tar.gz: c2335e7bdc26a6aecdad5494a87587fbf54c1089
 SHA512:
-  metadata.gz: 3c8b513fc02ee7eafa30543e9222f5fff2698886e197e069aadb978d888d79da127a219d74b79eba5db2e5d5cecbdbbb646a7aab3479f051257e559be4cc114f
-  data.tar.gz: 51fc2db5eca63cc660a731f4f0006ffe2267e321db94fa9d58b068f1877b858a5c7119508a2d02fa9c895b6dcf2997eeae2a01c0fc9f73e96ff157567892fad2
+  metadata.gz: 1b4188f3c85f548a907dfd59e01c282f681ea6fba9d0a0dafbd5776e0afa3de63d1289d711c122ae2fc874a2d411678d0263c246550cc7024a72ac8622e25c33
+  data.tar.gz: cb4b9f8dea064c7a36abadc57a5477ebdd76fe77618d15b7cddabfb0972f926627ae02445719b527b8f55465818549e26bec4a2648113ee9648ba16099620f88

data/.gitignore

@@ -8,3 +8,4 @@ pkg/*
 *.pem
 .DS_STORE
 doc
+lib/debugClient.rb

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in jira-api-dmg.gemspec
 gemspec
+
+group :development do
+  gem 'pry-debugger'
+end

data/lib/jira/base.rb

@@ -98,9 +98,8 @@ module JIRA
       if collection_attributes_are_nested
         json = json[endpoint_name.pluralize]
       end
-      json.map do |attrs|
-        self.new(client, {:attrs => attrs}.merge(options))
-      end
+      
+      self.populate(client, options, json)
     end
 
     # Finds and retrieves a resource with the given ID.
@@ -153,6 +152,12 @@ module JIRA
       :id
     end
 
+    def self.populate(client, options, json)
+      json.map do |attrs|
+        self.new(client, {:attrs => attrs}.merge(options))
+      end
+    end
+
     def self.parse_json(string) # :nodoc:
       JSON.parse(string)
     end

data/lib/jira/client.rb

@@ -125,6 +125,18 @@ module JIRA
       JIRA::Resource::FieldFactory.new(self)
     end
 
+    def Sprint # :nodoc:
+      JIRA::Resource::SprintFactory.new(self)
+    end
+
+    def Agileboard # :nodoc:
+      JIRA::Resource::AgileboardFactory.new(self)
+    end
+
+    def Velocity # :nodoc:
+      JIRA::Resource::VelocityFactory.new(self)
+    end
+
     # HTTP methods without a body
     def delete(path, headers = {})
       request(:delete, path, nil, merge_default_headers(headers))

data/lib/jira/resource/agileboard.rb

@@ -0,0 +1,74 @@
+module JIRA
+  module Resource
+
+    class AgileboardFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Agileboard < JIRA::Base
+      has_one :filter
+      has_one :boardAdmin, :class => JIRA::Resource::User
+
+      # override population for different responses from jira
+      def self.populate(client, options, json)
+        if json['views']
+          json = json['views']
+        end
+
+        super
+      end
+
+      # override collection path for different API endpoint
+      def self.collection_path(client, prefix = '/')
+         '/rest/greenhopper/1.0/rapidviews/list'
+      end
+
+      # get all issues of agile board
+      def issues
+        search_url = client.options[:site] + 
+                     '/rest/greenhopper/1.0/xboard/work/allData/?rapidViewId=' + attrs['id'].to_s
+
+        response = client.get(search_url)
+        json = self.class.parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
+      # get all sprints of agile board
+      def sprints
+        search_url = client.options[:site] + '/rest/greenhopper/1.0/sprintquery/' + attrs['id'].to_s
+        response = client.get(search_url)
+        json = self.class.parse_json(response.body)
+
+        vels = velocities
+        json['sprints'].map do |sprint|
+          velocity = vels.select { |vel| vel.sprint_id.to_s == sprint["id"].to_s }.first
+          sprint["velocity"] = velocity
+          client.Sprint.build(sprint)
+        end
+      end
+
+      # get velocities of agile board
+      def velocities
+        search_url = client.options[:site] + 
+                     '/rest/greenhopper/1.0/rapid/charts/velocity.json?rapidViewId=' + id.to_s
+
+        begin
+          response = client.get(search_url)
+        rescue
+          return []
+        end
+
+        json = self.class.parse_json(response.body)
+        json['velocityStatEntries'].map do |velocity|
+          client.Velocity.build({
+            "sprint_id" => velocity[0],
+            "estimated" => velocity[1]['estimated']['value'],
+            "completed" => velocity[1]['completed']['value']
+          })
+        end
+      end
+      
+    end
+  end
+end

data/lib/jira/resource/project.rb

@@ -26,6 +26,20 @@ module JIRA
           client.Issue.build(issue)
         end
       end
+
+      # Returns all sprints for this project
+      def sprints
+        search_url = client.options[:site] + 
+                     '/rest/greenhopper/1.0/integration/teamcalendars/sprint/list?jql=project=' + key
+
+        response = client.get(search_url)
+        json = self.class.parse_json(response.body)
+
+        json["sprints"].map do |sprint|
+          client.Sprint.build(sprint)
+        end
+      end
+
     end
   end
 end

data/lib/jira/resource/sprint.rb

@@ -0,0 +1,81 @@
+module JIRA
+  module Resource
+
+    class SprintFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Sprint < JIRA::Base
+
+      # get all issues of sprint
+      def issues
+        jql = "sprint = " + id
+        Issue.jql(client, jql)
+      end
+
+      # get rapid view id
+      def agileboard_id
+        search_url = client.options[:site] + "/secure/GHGoToBoard.jspa?sprintId=" + id.to_s
+
+        begin
+          response = client.get(search_url)
+        rescue JIRA::HTTPError => error
+          unless error.response.instance_of? Net::HTTPFound
+            return
+          end
+
+          rapid_view_match = /rapidView=(\d+)&/.match(error.response['location'])
+          if rapid_view_match != nil
+            return rapid_view_match[1]
+          end
+        end
+      end
+
+      def velocity=(velocity)
+        @attrs["velocity"] = velocity
+      end
+
+      def velocity
+        unless attrs.keys.include? "velocity"
+          @attrs["velocity"] = get_velocity
+        end
+
+        @attrs["velocity"]
+      end
+
+      private
+      def get_velocity
+        search_url = client.options[:site] + 
+                     '/rest/greenhopper/1.0/rapid/charts/velocity.json?rapidViewId=' + agileboard_id.to_s
+        begin
+          response = client.get(search_url).body
+        rescue
+          return empty_velocity
+        end
+
+        json = self.class.parse_json(response)
+        resultVelocity = json['velocityStatEntries'].select do |sprint_id|
+          sprint_id.to_i == id.to_i
+        end
+        
+        if resultVelocity.length == 0
+          return empty_velocity
+        end
+
+        client.Velocity.build({
+          "sprint_id" => id,
+          "estimated" => resultVelocity[id.to_s]['estimated']['value'],
+          "completed" => resultVelocity[id.to_s]['completed']['value']
+        })
+      end
+
+      def empty_velocity
+        client.Velocity.build({
+          "sprint_id" => id,
+          "estimated" => 0,
+          "completed" => 0
+        })
+      end
+
+    end
+  end
+end

data/lib/jira/resource/velocity.rb

@@ -0,0 +1,11 @@
+module JIRA
+  module Resource
+
+    class VelocityFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Velocity < JIRA::Base
+    end
+
+  end
+end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.10"
+  VERSION = "0.1.20"
 end

data/lib/jira.rb

@@ -17,13 +17,16 @@ require 'jira/resource/issuetype'
 require 'jira/resource/version'
 require 'jira/resource/status'
 require 'jira/resource/transition'
+require 'jira/resource/filter'
+require 'jira/resource/velocity'
+require 'jira/resource/sprint'
 require 'jira/resource/project'
 require 'jira/resource/priority'
 require 'jira/resource/comment'
 require 'jira/resource/worklog'
 require 'jira/resource/issue'
-require 'jira/resource/filter'
 require 'jira/resource/field'
+require 'jira/resource/agileboard'
 
 require 'jira/request_client'
 require 'jira/oauth_client'

data/spec/jira/resource/project_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 describe JIRA::Resource::Project do
 
   let(:client) { double("client", :options => {
-                          :rest_base_path => '/jira/rest/api/2'
+                          :rest_base_path => '/jira/rest/api/2',
+                          :site => 'https://example.com'
                         })
   }
 
@@ -67,4 +68,27 @@ describe JIRA::Resource::Project do
       end
     end
   end
+
+  describe "sprints" do
+    subject {
+      JIRA::Resource::Project.new(client, :attrs => {
+          'key'         => 'test'
+        })
+    }
+
+    it "returns sprints" do
+      response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"sprints":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"}}]}'
+      response = double("response",
+        :body => response_body)
+      sprint_factory = double("sprint factory")
+
+      client.should_receive(:get)
+        .with('https://example.com/rest/greenhopper/1.0/integration/teamcalendars/sprint/list?jql=project=test')
+        .and_return(response)
+      client.should_receive(:Sprint).and_return(sprint_factory)
+      sprint_factory.should_receive(:build)
+        .with(JSON.parse(response_body)["sprints"][0])
+      subject.sprints
+    end
+  end
 end

data/spec/jira/resource/sprint_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Sprint do
+
+  let(:client) { double("client", :options => {
+                          :rest_base_path => '/jira/rest/api/2',
+                          :site => 'https://example.com'
+                        })
+  }
+
+  describe "relationships" do
+    subject {
+      JIRA::Resource::Sprint.new(client, :attrs => {
+          'filter'        => {'foo' => 'bar'},
+          'boardAdmin'  => {'foo' =>'bar'}
+      })
+    }
+
+    it "has the correct relationships" do
+      subject.should have_one(:filter, JIRA::Resource::Filter)
+      subject.filter.foo.should == 'bar'
+
+      subject.should have_one(:boardAdmin, JIRA::Resource::User)
+      subject.boardAdmin.foo.should == "bar"
+    end
+  end
+
+ 
+  describe "collection_path" do
+    subject {
+      JIRA::Resource::Sprint
+    }
+
+    it "should have the correct collection path" do
+      collection_path = JIRA::Resource::Sprint.collection_path(client)
+      collection_path.should == '/rest/greenhopper/1.0/rapidviews/list'
+    end
+  end
+
+  describe "issues" do
+    subject {
+      JIRA::Resource::Sprint.new(client, :attrs => {
+          'id'         => '42'
+        })
+    }
+
+    it "returns issues" do
+      response_body = '{"expand":"names,schema","startAt":0,"maxResults":1,"total":299,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"865585","self":"https://thisisdmg.atlassian.net/rest/api/2/issue/865585","key":"GHPOO-2728","fields":{"summary":"Touch | Produktberater | Beim ersten Mal Verändern des Jahrgangssliders wird die Ergbnissemenge nicht korrekt gesetzt.","progress":{"progress":300,"total":300,"percent":100},"issuetype":{"self":"https://thisisdmg.atlassian.net/rest/api/2/issuetype/1","id":"1","description":"A problem which impairs or prevents the functions of the product.","iconUrl":"https://thisisdmg.atlassian.net/images/icons/issuetypes/bug.png","name":"Bug","subtask":false},"timespent":300,"reporter":{"self":"https://thisisdmg.atlassian.net/rest/api/2/user?username=heinemann_c.gewalt","name":"heinemann_c.gewalt","emailAddress":"c.gewalt@nextpilgrims.com","avatarUrls":{"16x16":"https://thisisdmg.atlassian.net/secure/useravatar?size=xsmall&avatarId=10122","24x24":"https://thisisdmg.atlassian.net/secure/useravatar?size=small&avatarId=10122","32x32":"https://thisisdmg.atlassian.net/secure/useravatar?size=medium&avatarId=10122","48x48":"https://thisisdmg.atlassian.net/secure/useravatar?avatarId=10122"},"displayName":"Christian Gewalt","active":true},"created":"2014-04-02T14:02:43.000+0200","updated":"2014-04-14T16:00:37.000+0200","description":"Beim ersten Mal Verändern des Jahrgangssliders wird die Ergbnissemenge nicht korrekt gesetzt. Danach funktioniert es dann. ","priority":{"self":"https://thisisdmg.atlassian.net/rest/api/2/priority/3","iconUrl":"https://thisisdmg.atlassian.net/images/icons/priorities/major.png","name":"Major","id":"3"},"customfield_10001":"2014-04-14 16:00:37.849","customfield_10002":null,"customfield_10003":null,"issuelinks":[],"customfield_10000":"1_*:*_1_*:*_596873640_*|*_5_*:*_1_*:*_0","subtasks":[],"customfield_10008":null,"customfield_10007":null,"status":{"self":"https://thisisdmg.atlassian.net/rest/api/2/status/6","description":"The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.","iconUrl":"https://thisisdmg.atlassian.net/images/icons/statuses/closed.png","name":"Closed","id":"6","statusCategory":{"self":"https://thisisdmg.atlassian.net/rest/api/2/statuscategory/3","id":3,"key":"done","colorName":"green","name":"Complete"}},"customfield_10006":"349","labels":["Kundenfeedback","TouchScreen"],"workratio":-1,"project":{"self":"https://thisisdmg.atlassian.net/rest/api/2/project/13600","id":"13600","key":"GHPOO","name":"Gebrüder Heinemann - DIA","avatarUrls":{"16x16":"https://thisisdmg.atlassian.net/secure/projectavatar?size=xsmall&pid=13600&avatarId=10011","24x24":"https://thisisdmg.atlassian.net/secure/projectavatar?size=small&pid=13600&avatarId=10011","32x32":"https://thisisdmg.atlassian.net/secure/projectavatar?size=medium&pid=13600&avatarId=10011","48x48":"https://thisisdmg.atlassian.net/secure/projectavatar?pid=13600&avatarId=10011"},"projectCategory":{"self":"https://thisisdmg.atlassian.net/rest/api/2/projectCategory/10100","id":"10100","description":"Hier finden sich alle Kundenprojekte","name":"Kunden Projekte"}},"environment":null,"lastViewed":null,"aggregateprogress":{"progress":300,"total":300,"percent":100},"customfield_10012":["com.atlassian.greenhopper.service.sprint.Sprint@1829488[rapidViewId=142,state=CLOSED,name=07.04 - 24.04,startDate=2014-04-07T13:55:52.263+02:00,endDate=2014-04-24T15:00:00.000+02:00,completeDate=2014-04-22T17:30:25.628+02:00,id=642]"],"components":[{"self":"https://thisisdmg.atlassian.net/rest/api/2/component/13904","id":"13904","name":"Technik"}],"customfield_10011":null,"timeoriginalestimate":null,"votes":{"self":"https://thisisdmg.atlassian.net/rest/api/2/issue/GHPOO-2728/votes","votes":0,"hasVoted":false},"resolution":{"self":"https://thisisdmg.atlassian.net/rest/api/2/resolution/5","id":"5","description":"All attempts at reproducing this issue failed, or not enough information was available to reproduce the issue. Reading the code produces no clues as to why this behavior would occur. If more information appears later, please reopen the issue.","name":"Cannot Reproduce"},"fixVersions":[{"self":"https://thisisdmg.atlassian.net/rest/api/2/version/15700","id":"15700","description":"Prototyp","name":"Prototyp","archived":false,"released":false}],"resolutiondate":"2014-04-09T11:50:37.000+0200","creator":{"self":"https://thisisdmg.atlassian.net/rest/api/2/user?username=heinemann_c.gewalt","name":"heinemann_c.gewalt","emailAddress":"c.gewalt@nextpilgrims.com","avatarUrls":{"16x16":"https://thisisdmg.atlassian.net/secure/useravatar?size=xsmall&avatarId=10122","24x24":"https://thisisdmg.atlassian.net/secure/useravatar?size=small&avatarId=10122","32x32":"https://thisisdmg.atlassian.net/secure/useravatar?size=medium&avatarId=10122","48x48":"https://thisisdmg.atlassian.net/secure/useravatar?avatarId=10122"},"displayName":"Christian Gewalt","active":true},"aggregatetimeoriginalestimate":null,"duedate":null,"customfield_10104":null,"customfield_10105":null,"watches":{"self":"https://thisisdmg.atlassian.net/rest/api/2/issue/GHPOO-2728/watchers","watchCount":2,"isWatching":false},"customfield_10103":null,"customfield_10102":null,"customfield_10600":"GHPOO-113","customfield_10101":null,"customfield_10100":null,"assignee":{"self":"https://thisisdmg.atlassian.net/rest/api/2/user?username=l.soeder","name":"l.soeder","emailAddress":"l.soeder@thisisdmg.com","avatarUrls":{"16x16":"https://thisisdmg.atlassian.net/secure/useravatar?size=xsmall&ownerId=l.soeder&avatarId=11302","24x24":"https://thisisdmg.atlassian.net/secure/useravatar?size=small&ownerId=l.soeder&avatarId=11302","32x32":"https://thisisdmg.atlassian.net/secure/useravatar?size=medium&ownerId=l.soeder&avatarId=11302","48x48":"https://thisisdmg.atlassian.net/secure/useravatar?ownerId=l.soeder&avatarId=11302"},"displayName":"Lars Söder","active":true},"aggregatetimeestimate":0,"versions":[{"self":"https://thisisdmg.atlassian.net/rest/api/2/version/15700","id":"15700","description":"Prototyp","name":"Prototyp","archived":false,"released":false},{"self":"https://thisisdmg.atlassian.net/rest/api/2/version/17100","id":"17100","description":"Labshop installation vom 21. März","name":"Prototyp 3. Abnahme","archived":false,"released":true,"releaseDate":"2014-03-21"}],"customfield_10700":null,"customfield_10400":null,"timeestimate":0,"customfield_10300":"Not Started","aggregatetimespent":300}}]}'
+      response = double("response",
+        :body => response_body)
+      issue_factory = double("issue factory")
+
+      client.should_receive(:get)
+        .with('https://example.com/rest/greenhopper/1.0/xboard/work/allData/?rapidViewId=42')
+        .and_return(response)
+      client.should_receive(:Issue).and_return(issue_factory)
+      issue_factory.should_receive(:build)
+        .with(JSON.parse(response_body)["issues"][0])
+      subject.issues
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
 require 'bundler/setup'
 require 'webmock/rspec'
+require 'pry-debugger'
 Dir["./spec/support/**/*.rb"].each {|f| require f}
 
 require 'jira'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby-dmg
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.20
 platform: ruby
 authors:
 - ThisIs! DMG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -119,6 +119,7 @@ files:
 - lib/jira/oauth_client.rb
 - lib/jira/railtie.rb
 - lib/jira/request_client.rb
+- lib/jira/resource/agileboard.rb
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
@@ -128,9 +129,11 @@ files:
 - lib/jira/resource/issuetype.rb
 - lib/jira/resource/priority.rb
 - lib/jira/resource/project.rb
+- lib/jira/resource/sprint.rb
 - lib/jira/resource/status.rb
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
+- lib/jira/resource/velocity.rb
 - lib/jira/resource/version.rb
 - lib/jira/resource/worklog.rb
 - lib/jira/tasks.rb
@@ -162,6 +165,7 @@ files:
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
+- spec/jira/resource/sprint_spec.rb
 - spec/jira/resource/worklog_spec.rb
 - spec/mock_responses/attachment/10000.json
 - spec/mock_responses/component.post.json
@@ -256,6 +260,7 @@ test_files:
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
+- spec/jira/resource/sprint_spec.rb
 - spec/jira/resource/worklog_spec.rb
 - spec/mock_responses/attachment/10000.json
 - spec/mock_responses/component.post.json