jira-ruby 2.3.0 → 3.2.0

data/spec/integration/properties_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Properties do
+  with_each_client do |site_url, client|
+    context 'when accessing singular resource' do
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:key) { 'xyz' }
+      let(:target) { described_class.new(client, attrs: { 'key' => 'xyz' }, issue_id: '10002') }
+      let(:belongs_to) { JIRA::Resource::Issue.new(client, attrs: { 'id' => '10002' }) }
+      let(:expected_attributes) { { 'key' => key, 'value' => 'supercalifragilistic' } }
+      let(:attributes_for_put) { { 'value' => 'expialidocious' } }
+      let(:expected_attributes_from_put) { { 'key' => key, 'value' => 'expialidocious' } }
+
+      it_behaves_like 'a resource'
+      it_behaves_like 'a resource with a singular GET endpoint'
+      it_behaves_like 'a resource with a DELETE endpoint'
+      it_behaves_like 'a resource with a PUT endpoint'
+    end
+
+    context 'when accessing collection' do
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:key) { 'xyz' }
+      let(:belongs_to) { JIRA::Resource::Issue.new(client, attrs: { 'id' => '10002' }) }
+      let(:expected_collection_length) { 2 }
+      let(:expected_attributes) { { 'key' => key, 'value' => 'supercalifragilistic' } }
+
+      before do
+        ## Since properties collections do subsequent queries on each individual properties records,
+        ## we need to additionally define stub requests for each of the individual records
+        additional_targets = [
+          described_class.new(client, attrs: { 'key' => 'foo' }, issue_id: '10002'),
+          described_class.new(client, attrs: { 'key' => 'xyz' }, issue_id: '10002')
+        ]
+        additional_targets.each do |target|
+          req_url = site_url + target.url
+          stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
+        end
+      end
+
+      it_behaves_like 'a resource with a collection GET endpoint'
+    end
+  end
+end

data/spec/integration/rapidview_spec.rb

@@ -18,7 +18,7 @@ describe JIRA::Resource::RapidView do
       }
     end
 
-    it_should_behave_like 'a resource'
+    it_behaves_like 'a resource'
     # TODO@Anton: Add json file
     # it_should_behave_like 'a resource with a singular GET endpoint'
 
@@ -26,19 +26,19 @@ describe JIRA::Resource::RapidView do
       let(:client) { client }
       let(:site_url) { site_url }
 
-      before(:each) do
-        stub_request(:get, site_url + '/jira/rest/greenhopper/1.0/rapidview')
+      before do
+        stub_request(:get, "#{site_url}/jira/rest/greenhopper/1.0/rapidview")
           .to_return(status: 200, body: get_mock_response('rapidview.json'))
       end
-      it_should_behave_like 'a resource with a collection GET endpoint'
+
+      it_behaves_like 'a resource with a collection GET endpoint'
     end
 
     describe 'issues' do
-      it 'should return all the issues' do
+      it 'returns all the issues' do
         stub_request(
           :get,
-          site_url +
-          '/jira/rest/greenhopper/1.0/xboard/plan/backlog/data?rapidViewId=1'
+          "#{site_url}/jira/rest/greenhopper/1.0/xboard/plan/backlog/data?rapidViewId=1"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.json')
@@ -46,7 +46,7 @@ describe JIRA::Resource::RapidView do
 
         stub_request(
           :get,
-          site_url + '/jira/rest/api/2/search?jql=id IN(10001, 10000)'
+          "#{site_url}/jira/rest/api/2/search/jql?jql=id IN(10001, 10000)"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')
@@ -54,7 +54,7 @@ describe JIRA::Resource::RapidView do
 
         stub_request(
           :get,
-          site_url + '/jira/rest/api/2/search?jql=id IN(10000, 10001) AND sprint IS NOT EMPTY'
+          "#{site_url}/jira/rest/api/2/search/jql?jql=id IN(10000, 10001) AND sprint IS NOT EMPTY"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')
@@ -66,7 +66,7 @@ describe JIRA::Resource::RapidView do
 
         issues.each do |issue|
           expect(issue.class).to eq(JIRA::Resource::Issue)
-          expect(issue.expanded?).to be_falsey
+          expect(issue).not_to be_expanded
         end
       end
     end

data/spec/integration/resolution_spec.rb

@@ -19,8 +19,8 @@ describe JIRA::Resource::Resolution do
 
     let(:expected_collection_length) { 2 }
 
-    it_should_behave_like 'a resource'
-    it_should_behave_like 'a resource with a collection GET endpoint'
-    it_should_behave_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a collection GET endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
   end
 end

data/spec/integration/status_category_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe JIRA::Resource::StatusCategory do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { 1 }
+
+    let(:expected_attributes) do
+      JSON.parse(File.read('spec/mock_responses/statuscategory/1.json'))
+    end
+
+    let(:expected_collection_length) { 4 }
+
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a collection GET endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
+  end
+end

data/spec/integration/status_spec.rb

@@ -8,17 +8,13 @@ describe JIRA::Resource::Status do
     let(:key) { '1' }
 
     let(:expected_attributes) do
-      {
-        'self' => 'http://localhost:2990/jira/rest/api/2/status/1',
-        'id' => key,
-        'name' => 'Open'
-      }
+      JSON.parse(File.read('spec/mock_responses/status/1.json'))
     end
 
     let(:expected_collection_length) { 5 }
 
-    it_should_behave_like 'a resource'
-    it_should_behave_like 'a resource with a collection GET endpoint'
-    it_should_behave_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a collection GET endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
   end
 end

data/spec/integration/transition_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Transition do
 
     let(:key) { '10000' }
 
-    let(:target) { JIRA::Resource::Transition.new(client, attrs: { 'id' => '99999' }, issue_id: '10014') }
+    let(:target) { described_class.new(client, attrs: { 'id' => '99999' }, issue_id: '10014') }
 
     let(:belongs_to) do
       JIRA::Resource::Issue.new(client, attrs: {
@@ -34,13 +34,14 @@ describe JIRA::Resource::Transition do
       }
     end
 
-    it_should_behave_like 'a resource'
+    it_behaves_like 'a resource'
 
     describe 'POST endpoint' do
       it 'saves a new resource' do
-        stub_request(:post, /#{described_class.collection_path(client, prefix)}$/)
+        req_url = build_url
+        stub_request(:post, req_url)
           .with(body: attributes_for_post.to_json)
-          .to_return(status: 200, body: get_mock_from_path(:post))
+          .to_return(status: 200, body: get_mock_from_url(:post, req_url))
         subject = build_receiver.build
         expect(subject.save(attributes_for_post)).to be_truthy
       end

data/spec/integration/user_spec.rb

@@ -5,36 +5,59 @@ describe JIRA::Resource::User do
     let(:client) { client }
     let(:site_url) { site_url }
 
-    let(:key) { 'admin' }
+    let(:key) { '1234567890abcdef01234567' }
 
     let(:expected_attributes) do
       {
-        'self' => 'http://localhost:2990/jira/rest/api/2/user?username=admin',
-        'name' => key,
-        'emailAddress' => 'admin@example.com'
+        'id' => '1234567890abcdef01234567',
+        'self' => 'http://localhost:2990/jira/rest/api/2/user?accountId=1234567890abcdef01234567',
+        '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,
+        'timeZone' => 'Pacific/Auckland',
+        'groups' => {
+          'size' => 3,
+          'items' => []
+        },
+        'expand' => 'groups'
       }
     end
 
-    it_should_behave_like 'a resource'
-    it_should_behave_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a singular GET endpoint'
 
     describe '#all' do
       let(:client) do
         client = double(options: { rest_base_path: '/jira/rest/api/2' })
-        allow(client).to receive(:get).with('/rest/api/2/users/search?username=_&maxResults=1000').and_return(JIRA::Resource::UserFactory.new(client))
+        allow(client).to receive(:get).with('/rest/api/2/users/search?username=_&maxResults=1000')
+                                      .and_return(JIRA::Resource::UserFactory.new(client))
         client
       end
 
       before do
+        user_factory = double('UserFactory')
+
         allow(client).to receive(:get)
-          .with('/rest/api/2/users/search?username=_&maxResults=1000') { OpenStruct.new(body: '["User1"]') }
-        allow(client).to receive_message_chain(:User, :build).with('users') { [] }
+          .with('/rest/api/2/users/search?username=_&maxResults=1000')
+          .and_return(double(body: '["User1"]'))
+        allow(client).to receive(:User).and_return(user_factory)
+        allow(user_factory).to receive(:build).with('users').and_return([])
       end
 
       it 'gets users with maxResults of 1000' do
+        user_factory = double('UserFactory')
+
         expect(client).to receive(:get).with('/rest/api/2/users/search?username=_&maxResults=1000')
-        expect(client).to receive_message_chain(:User, :build).with('User1')
-        JIRA::Resource::User.all(client)
+                                       .and_return(double(body: '["User1"]'))
+        expect(client).to receive(:User).and_return(user_factory)
+        expect(user_factory).to receive(:build).with('User1')
+
+        described_class.all(client)
       end
     end
   end

data/spec/integration/version_spec.rb

@@ -10,7 +10,7 @@ describe JIRA::Resource::Version do
     let(:expected_attributes) do
       {
         'self' => 'http://localhost:2990/jira/rest/api/2/version/10000',
-        'id'   => key,
+        'id' => key,
         'description' => 'Initial version'
       }
     end
@@ -29,11 +29,11 @@ describe JIRA::Resource::Version do
       { 'id' => '10000', 'name' => '2.0.0' }
     end
 
-    it_should_behave_like 'a resource'
-    it_should_behave_like 'a resource with a singular GET endpoint'
-    it_should_behave_like 'a resource with a DELETE endpoint'
-    it_should_behave_like 'a resource with a POST endpoint'
-    it_should_behave_like 'a resource with a PUT endpoint'
-    it_should_behave_like 'a resource with a PUT endpoint that rejects invalid fields'
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource with a DELETE endpoint'
+    it_behaves_like 'a resource with a POST endpoint'
+    it_behaves_like 'a resource with a PUT endpoint'
+    it_behaves_like 'a resource with a PUT endpoint that rejects invalid fields'
   end
 end

data/spec/integration/watcher_spec.rb

@@ -5,7 +5,7 @@ describe JIRA::Resource::Watcher do
     let(:client) { client }
     let(:site_url) { site_url }
 
-    let(:target) { JIRA::Resource::Watcher.new(client, attrs: { 'id' => '99999' }, issue_id: '10002') }
+    let(:target) { described_class.new(client, attrs: { 'id' => '99999' }, issue_id: '10002') }
 
     let(:belongs_to) do
       JIRA::Resource::Issue.new(client, attrs: {
@@ -19,44 +19,47 @@ describe JIRA::Resource::Watcher do
     let(:expected_attributes) do
       {
         'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002/watchers',
-        "isWatching": false,
-        "watchCount": 1,
-        "watchers": [
+        isWatching: false,
+        watchCount: 1,
+        watchers: [
           {
-            "self": 'http://www.example.com/jira/rest/api/2/user?username=admin',
-            "name": 'admin',
-            "displayName": 'admin',
-            "active": false
+            self: 'http://www.example.com/jira/rest/api/2/user?username=admin',
+            name: 'admin',
+            displayName: 'admin',
+            active: false
           }
         ]
       }
     end
 
     describe 'watchers' do
-      before(:each) do
-        stub_request(:get, site_url + '/jira/rest/api/2/issue/10002')
+      before 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')
+        stub_request(:get, "#{site_url}/jira/rest/api/2/issue/10002/watchers")
           .to_return(status: 200, body: get_mock_response('issue/10002/watchers.json'))
 
-        stub_request(:post, site_url + '/jira/rest/api/2/issue/10002/watchers')
+        stub_request(:post, "#{site_url}/jira/rest/api/2/issue/10002/watchers")
           .to_return(status: 204, body: nil)
       end
 
-      it 'should returns all the watchers' do
+      it 'returnses all the watchers' do
         issue = client.Issue.find('10002')
-        watchers = client.Watcher.all(options = { issue: issue })
+        watchers = client.Watcher.all({ issue: })
         expect(watchers.length).to eq(1)
       end
 
-      it 'should add a watcher' do
+      it 'adds a watcher' do
         issue = client.Issue.find('10002')
-        watcher = JIRA::Resource::Watcher.new(client, issue: issue)
-        user_id = "tester"
+        watcher = described_class.new(client, issue: issue)
+        user_id = 'tester'
+
         watcher.save!(user_id)
+
+        expect(WebMock).to have_requested(:post, "#{site_url}/jira/rest/api/2/issue/10002/watchers")
+          .with(body: '"tester"')
       end
     end
-
   end
 end

data/spec/integration/webhook_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Webhook do
+  ## This endpoint uses a different base path, so override this client's rest_base_path option
+  ## so this test can still use the SharedExampleGroups
+  with_each_client(rest_base_path: described_class.const_get(:REST_BASE_PATH)) do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '2' }
+
+    let(:expected_attributes) do
+      { 'name' => 'from API', 'url' => 'http://localhost:3000/webhooks/1', 'excludeBody' => false,
+        'filters' => { 'issue-related-events-section' => '' }, 'events' => [], 'enabled' => true, 'self' => 'http://localhost:2990/jira/rest/webhooks/1.0/webhook/2', 'lastUpdatedUser' => 'admin', 'lastUpdatedDisplayName' => 'admin', 'lastUpdated' => 1_453_306_520_188 }
+    end
+
+    let(:expected_collection_length) { 1 }
+
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a collection GET endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
+
+    it 'returns a collection of components' do
+      stub_request(:get, site_url + described_class.singular_path(client, key))
+        .to_return(status: 200, body: get_mock_response('webhook/2.json'))
+
+      webhook = client.Webhook.find(key)
+
+      expect(webhook).to be_a described_class
+      expect(webhook.name).to eq 'from API'
+      expect(webhook.url).to eq '/jira/rest/webhooks/1.0/webhook/2'
+      expect(webhook.enabled).to be true
+    end
+  end
+end

data/spec/integration/worklog_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Worklog do
 
     let(:key) { '10000' }
 
-    let(:target) { JIRA::Resource::Worklog.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
+    let(:target) { described_class.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
 
     let(:expected_collection_length) { 3 }
 
@@ -22,7 +22,7 @@ describe JIRA::Resource::Worklog do
     let(:expected_attributes) do
       {
         'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002/worklog/10000',
-        'id'   => key,
+        'id' => key,
         'comment' => 'Some epic work.'
       }
     end
@@ -41,11 +41,11 @@ describe JIRA::Resource::Worklog do
       { 'id' => '10001', 'timeSpent' => '4d' }
     end
 
-    it_should_behave_like 'a resource'
-    it_should_behave_like 'a resource with a collection GET endpoint'
-    it_should_behave_like 'a resource with a singular GET endpoint'
-    it_should_behave_like 'a resource with a DELETE endpoint'
-    it_should_behave_like 'a resource with a POST endpoint'
-    it_should_behave_like 'a resource with a PUT endpoint'
+    it_behaves_like 'a resource'
+    it_behaves_like 'a resource with a collection GET endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource with a DELETE endpoint'
+    it_behaves_like 'a resource with a POST endpoint'
+    it_behaves_like 'a resource with a PUT endpoint'
   end
 end

data/spec/jira/atlassian/jwt_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+# rubocop:disable RSpec/LeakyLocalVariable
+describe JIRA::Atlassian::Jwt do
+  let(:jwt_opts) do
+    {
+      algorithm: 'HS256',
+      leeway: (3600 * 24 * 365 * 10) # 10 years of leeway -- the JWT gem verifies the token expiry time
+    }
+  end
+  let(:base_url) { '' }
+
+  it 'generates claims' do
+    url = 'https://example.atlassian.com/jira/projects'
+    issuer = 'com.atlassian.test'
+
+    now = Time.now.to_i
+    qsh = Digest::SHA256.hexdigest(
+      described_class.create_canonical_request(url, 'get', base_url)
+    )
+
+    expected_claim = {
+      iss: 'com.atlassian.test',
+      iat: now,
+      exp: now + 60,
+      qsh: qsh
+    }
+
+    claim = described_class.build_claims(issuer, url, 'get', base_url, now, now + 60)
+    expect(claim).to eq expected_claim
+  end
+
+  # Offical Atlassian signed URL test data
+  json_tests = File.read(File.expand_path('../../data/files/jwt-signed-urls.json', File.dirname(__FILE__)))
+
+  test_data = JSON.parse(json_tests)
+  shared_secret = test_data['secret']
+
+  test_data['tests'].each do |test|
+    signed_url = test['signedUrl']
+    signed_uri = URI.parse(signed_url)
+    token = CGI.parse(signed_uri.query)['jwt'].first
+
+    it "#{test['name']} - Canonical URL" do
+      canonical_uri = described_class.create_canonical_request(signed_url, 'GET', base_url)
+
+      # Remote the jwt query param from the signed URL to get the original
+      expect(canonical_uri).to eq test['canonicalUrl']
+    end
+
+    it "#{test['name']} - QSH match" do
+      expected_qsh = Digest::SHA256.hexdigest(described_class.create_canonical_request(signed_url, 'GET', base_url))
+
+      decoded_token = JWT.decode(token, shared_secret, true, jwt_opts).first
+
+      expect(expected_qsh).to eq decoded_token['qsh']
+    end
+  end
+end
+# rubocop:enable RSpec/LeakyLocalVariable

data/spec/jira/base_factory_spec.rb

@@ -1,12 +1,22 @@
 require 'spec_helper'
 
 describe JIRA::BaseFactory do
-  class JIRA::Resource::FooFactory < JIRA::BaseFactory; end
-  class JIRA::Resource::Foo; end
+  module JIRA
+    module Resource
+      class FooFactory < JIRA::BaseFactory; end
+    end
+  end
+
+  module JIRA
+    module Resource
+      class Foo; end
+    end
+  end
 
-  let(:client)  { double }
   subject       { JIRA::Resource::FooFactory.new(client) }
 
+  let(:client)  { double }
+
   it 'initializes correctly' do
     expect(subject.class).to        eq(JIRA::Resource::FooFactory)
     expect(subject.client).to       eq(client)