jira-ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3b955a35c969e02d6e7a043dc63c34b195260ce
-  data.tar.gz: 714f3ae42608b8f44ef0866e5de95f57d5d857ba
+  metadata.gz: d500867486cb6b1bd336052a0ecfc8d7074a91e0
+  data.tar.gz: fe5e8f0fea4235def463b9224b20d354769d1f33
 SHA512:
-  metadata.gz: 475d925af3866d18fa5c6cf1def68bed46dd84a43ac87628fbd03417993b350e25dc4db1c5b290b2fba1ed9837748a1f50bc13a847e1265c8540fac2a547da0c
-  data.tar.gz: 4217aa221d13932613d377ff4bb7bb3a1c7051efeec9dec94e55bdbb6c38548b7c484e6b786ae210a4aa13620f3642146962c694636242bb8fe4f231a4022571
+  metadata.gz: bb6a109900b2d8b7a39e5f2ce07820e4414dd3ade3e34e90054d739eb27c88b96c494ccd2c7240a777fd01dba39e7ce5ff5e3e7602b91bc586772bf42dd046d1
+  data.tar.gz: d7e408d142019a4c92dbf801caf132929750d81692fd94a05fbd3053165affc1cba6dc50785cabe8ca0450216bf77d35cffac57b90ce07fcfc0ef324550c7a67

data/example.rb

@@ -123,6 +123,11 @@ client.Issue.jql(a_normal_jql_search, max_results: 500)
 # user = client.User.find('admin')
 # pp user
 #
+# # Get all issue watchers
+# # ----------------------
+# issue = client.Issue.find("10002")
+# watchers = issue.watchers.all
+# watchers = client.Watcher.all(:issue => issue)
 # # Get all issue types
 # # -------------------
 # issuetypes = client.Issuetype.all

data/jira-ruby.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{Ruby Gem for use with the Atlassian JIRA REST API}
   s.description = %q{API for JIRA}
   s.licenses    = ['MIT']
+  s.metadata    = { 'source_code_uri' => 'https://github.com/sumoheavy/jira-ruby' }
 
   s.required_ruby_version = '>= 1.9.3'
 

data/lib/jira-ruby.rb

@@ -11,6 +11,7 @@ require 'jira/has_many_proxy'
 require 'jira/http_error'
 
 require 'jira/resource/user'
+require 'jira/resource/watcher'
 require 'jira/resource/attachment'
 require 'jira/resource/component'
 require 'jira/resource/issuetype'

data/lib/jira/base.rb

@@ -428,8 +428,8 @@ module JIRA
         end
       end
       if @attrs['self']
-        the_url = @attrs['self'].sub(@client.options[:site],'')
-        the_url = "/#{the_url}" if (the_url =~ /^\//).nil?
+        the_url = @attrs['self']
+        the_url = the_url.sub(@client.options[:site], '') if @client.options[:site]
         the_url
       elsif key_value
         self.class.singular_path(client, key_value.to_s, prefix)

data/lib/jira/base_factory.rb

@@ -38,7 +38,7 @@ module JIRA
     # The principle purpose of this class is to delegate methods to the corresponding
     # non-factory class and automatically prepend the client argument to the argument
     # list.
-    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues, :get_sprints, :get_sprint_issues, :get_projects, :get_projects_full
+    delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues, :get_board_issues, :get_sprints, :get_sprint_issues, :get_projects, :get_projects_full
 
     # This method needs special handling as it has a default argument value
     def build(attrs={})

data/lib/jira/client.rb

@@ -161,6 +161,10 @@ module JIRA
       JIRA::Resource::ApplicationLinkFactory.new(self)
     end
 
+    def Watcher
+      JIRA::Resource::WatcherFactory.new(self)
+    end
+
     def Webhook
       JIRA::Resource::WebhookFactory.new(self)
     end

data/lib/jira/resource/agile.rb

@@ -19,6 +19,16 @@ module JIRA
         parse_json(response.body)
       end
 
+      def self.get_board_issues(client, board_id, options = {})
+        response = client.get(path_base(client) + "/board/#{board_id}/issue?#{hash_to_query_string(options)}")
+        json = parse_json(response.body)
+        # To get Issue objects with the same structure as for Issue.all
+        issue_ids = json['issues'].map { |issue|
+          issue['id']
+        }
+        client.Issue.jql("id IN(#{issue_ids.join(', ')})")
+      end
+
       def self.get_sprints(client, board_id, options = {})
         options[:maxResults] ||= 100
         response = client.get(path_base(client) + "/board/#{board_id}/sprint?#{hash_to_query_string(options)}")

data/lib/jira/resource/issue.rb

@@ -39,6 +39,9 @@ module JIRA
 
       has_many :remotelink, :class => JIRA::Resource::Remotelink
 
+      has_many :watchers,   :attribute_key => 'watches',
+                            :nested_under => ['fields', 'watches']
+
       def self.all(client)
         url = client.options[:rest_base_path] + "/search?expand=transitions.fields"
         response = client.get(url)

data/lib/jira/resource/sprint.rb

@@ -15,8 +15,9 @@ module JIRA
 
       def self.find(client, key, options = {})
         options[:maxResults] ||= 100
+        options[:startAt] ||= 0
         fields = options[:fields].join(',') unless options[:fields].nil?
-        response = client.get("/rest/api/latest/search?jql=sprint=#{key}&fields=#{fields}&maxResults=#{options[:maxResults]}")
+        response = client.get("/rest/api/latest/search?jql=sprint=#{key}&fields=#{fields}&startAt=#{options[:startAt]}&maxResults=#{options[:maxResults]}")
         parse_json(response.body)
       end
 

data/lib/jira/resource/watcher.rb

@@ -0,0 +1,32 @@
+module JIRA
+  module Resource
+
+    class WatcherFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Watcher < JIRA::Base
+      belongs_to :issue
+
+      nested_collections true
+
+      def self.endpoint_name
+        'watchers'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        unless issue
+          raise ArgumentError.new("parent issue is required")
+        end
+
+        path = "#{issue.self}/#{endpoint_name}"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json['watchers'].map do |watcher|
+          issue.watchers.build(watcher)
+        end
+      end
+    end
+
+  end
+end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/integration/watcher_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Watcher do
+
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+
+    let(:target) { JIRA::Resource::Watcher.new(client, :attrs => {'id' => '99999'}, :issue_id => '10002') }
+
+    let(:belongs_to) {
+      JIRA::Resource::Issue.new(client, :attrs => {
+        'id' => '10002',
+        'fields' => {
+          'comment' => {'comments' => []}
+        }
+      })
+    }
+
+    let(:expected_attributes) do
+      {
+        "self" => "http://localhost:2990/jira/rest/api/2/issue/10002/watchers",
+        "isWatching": false,
+        "watchCount": 1,
+        "watchers": [
+            {
+                "self": "http://www.example.com/jira/rest/api/2/user?username=admin",
+                "name": "admin",
+                "displayName": "admin",
+                "active": false
+            }
+        ]
+      }
+    end
+
+    describe "watchers" do
+      it "should returns all the watchers" do
+
+       stub_request(:get,
+                    site_url + "/jira/rest/api/2/issue/10002").
+                    to_return(:status => 200, :body => get_mock_response('issue/10002.json'))
+
+       stub_request(:get,
+                    site_url + "/jira/rest/api/2/issue/10002/watchers").
+                    to_return(:status => 200, :body => get_mock_response('issue/10002/watchers.json'))
+
+          issue = client.Issue.find("10002")
+          watchers = client.Watcher.all(options = {:issue => issue})
+          expect(watchers.length).to eq(1)
+      end
+
+    end
+
+    it_should_behave_like "a resource"
+
+  end
+
+end

data/spec/jira/base_spec.rb

@@ -380,7 +380,6 @@ describe JIRA::Base do
     end
 
     it "returns self as the URL if set" do
-      pending("Identified bug on real jira instance")
       attrs['self'] = 'http://foo/bar'
       expect(subject.url).to eq("http://foo/bar")
     end

data/spec/jira/resource/agile_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Agile do
-  let(:client) { double(options: {rest_base_path: '/jira/rest/api/2', context_path: '/jira'}) }
+  let(:client) do
+    client = double(options: {rest_base_path: '/jira/rest/api/2', context_path: '/jira'})
+    allow(client).to receive(:Issue).and_return(JIRA::Resource::IssueFactory.new(client))
+    client
+  end
   let(:response) { double }
 
   describe '#all' do
@@ -22,6 +26,44 @@ describe JIRA::Resource::Agile do
     end
   end
 
+  describe '#get_board_issues' do
+    it 'should query correct url without parameters' do
+      expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
+
+      issues = JIRA::Resource::Agile.get_board_issues(client, 1)
+      expect(issues).to be_an(Array)
+      expect(issues.size).to eql(9)
+
+      issues.each do |issue|
+        expect(issue.class).to eq(JIRA::Resource::Issue)
+        expect(issue.expanded?).to be_falsey
+      end
+
+    end
+
+    it 'should query correct url with parameters' do
+      expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/issue?startAt=50').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
+
+      expect(client).to receive(:get).with('/jira/rest/api/2/search?jql=id+IN%2810546%2C+10547%2C+10556%2C+10557%2C+10558%2C+10559%2C+10600%2C+10601%2C+10604%29').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1_issues.json'))
+
+      issues = JIRA::Resource::Agile.get_board_issues(client, 1, startAt: 50)
+      expect(issues).to be_an(Array)
+      expect(issues.size).to eql(9)
+
+      issues.each do |issue|
+        expect(issue.class).to eq(JIRA::Resource::Issue)
+        expect(issue.expanded?).to be_falsey
+      end
+
+    end
+  end
+
   describe '#get_sprints' do
     it 'should query correct url without parameters' do
       expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=100').and_return(response)
@@ -36,6 +78,20 @@ describe JIRA::Resource::Agile do
 
       JIRA::Resource::Agile.get_sprints(client, 1, startAt: 50)
     end
+    
+    it 'should work with pagination starting at 0' do
+      expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=1&startAt=0').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
+      
+      JIRA::Resource::Agile.get_sprints(client, 1, maxResults: 1, startAt: 0)
+    end
+    
+    it 'should work with pagination not starting at 0' do
+      expect(client).to receive(:get).with('/jira/rest/agile/1.0/board/1/sprint?maxResults=1&startAt=1').and_return(response)
+      expect(response).to receive(:body).and_return(get_mock_response('board/1.json'))
+      
+      JIRA::Resource::Agile.get_sprints(client, 1, maxResults: 1, startAt: 1)
+    end
   end
 
   describe '#get_sprint_issues' do

data/spec/mock_responses/board/1_issues.json

@@ -0,0 +1,62 @@
+{
+  "expand": "schema,names",
+  "startAt": 0,
+  "maxResults": 1000,
+  "total": 9,
+  "issues": [
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10546",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10546",
+      "key": "SBT-1"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10547",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10547",
+      "key": "SBT-2"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10556",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10556",
+      "key": "SBT-11"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10557",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10557",
+      "key": "SBT-12"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10558",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10558",
+      "key": "SBT-13"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10559",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10559",
+      "key": "SBT-14"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10600",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10600",
+      "key": "SBT-16"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10601",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10601",
+      "key": "SBT-17"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10604",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10604",
+      "key": "SBT-19"
+    }
+  ]
+}

data/spec/mock_responses/issue/10002/watchers.json

@@ -0,0 +1,13 @@
+{
+    "self": "http://localhost:2990/jira/rest/api/2/issue/10002/watchers",
+    "isWatching": false,
+    "watchCount": 1,
+    "watchers": [
+        {
+            "self": "http://www.example.com/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "displayName": "admin",
+            "active": false
+        }
+    ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -243,6 +243,7 @@ files:
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
 - lib/jira/resource/version.rb
+- lib/jira/resource/watcher.rb
 - lib/jira/resource/webhook.rb
 - lib/jira/resource/worklog.rb
 - lib/jira/tasks.rb
@@ -263,6 +264,7 @@ files:
 - spec/integration/transition_spec.rb
 - spec/integration/user_spec.rb
 - spec/integration/version_spec.rb
+- spec/integration/watcher_spec.rb
 - spec/integration/webhook.rb
 - spec/integration/worklog_spec.rb
 - spec/jira/base_factory_spec.rb
@@ -285,6 +287,7 @@ files:
 - spec/jira/resource/user_factory_spec.rb
 - spec/jira/resource/worklog_spec.rb
 - spec/mock_responses/board/1.json
+- spec/mock_responses/board/1_issues.json
 - spec/mock_responses/component.post.json
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
@@ -303,6 +306,7 @@ files:
 - spec/mock_responses/issue/10002/comment/10000.put.json
 - spec/mock_responses/issue/10002/transitions.json
 - spec/mock_responses/issue/10002/transitions.post.json
+- spec/mock_responses/issue/10002/watchers.json
 - spec/mock_responses/issue/10002/worklog.json
 - spec/mock_responses/issue/10002/worklog.post.json
 - spec/mock_responses/issue/10002/worklog/10000.json
@@ -343,7 +347,8 @@ files:
 homepage: http://www.sumoheavy.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/sumoheavy/jira-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -380,6 +385,7 @@ test_files:
 - spec/integration/transition_spec.rb
 - spec/integration/user_spec.rb
 - spec/integration/version_spec.rb
+- spec/integration/watcher_spec.rb
 - spec/integration/webhook.rb
 - spec/integration/worklog_spec.rb
 - spec/jira/base_factory_spec.rb
@@ -402,6 +408,7 @@ test_files:
 - spec/jira/resource/user_factory_spec.rb
 - spec/jira/resource/worklog_spec.rb
 - spec/mock_responses/board/1.json
+- spec/mock_responses/board/1_issues.json
 - spec/mock_responses/component.post.json
 - spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
@@ -420,6 +427,7 @@ test_files:
 - spec/mock_responses/issue/10002/comment/10000.put.json
 - spec/mock_responses/issue/10002/transitions.json
 - spec/mock_responses/issue/10002/transitions.post.json
+- spec/mock_responses/issue/10002/watchers.json
 - spec/mock_responses/issue/10002/worklog.json
 - spec/mock_responses/issue/10002/worklog.post.json
 - spec/mock_responses/issue/10002/worklog/10000.json