jira-ruby 2.2.0 → 3.0.0.beta1

data/lib/jira/resource/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class UserFactory < JIRA::BaseFactory # :nodoc:
@@ -13,7 +15,7 @@ module JIRA
       MAX_RESULTS = 1000
 
       def self.singular_path(client, key, prefix = '/')
-        collection_path(client, prefix) + '?username=' + key
+        "#{collection_path(client, prefix)}?accountId=#{key}"
       end
 
       # Cannot retrieve more than 1,000 users through the api, please see: https://jira.atlassian.com/browse/JRASERVER-65089

data/lib/jira/resource/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class VersionFactory < JIRA::BaseFactory # :nodoc:

data/lib/jira/resource/watcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WatcherFactory < JIRA::BaseFactory # :nodoc:
@@ -29,7 +31,6 @@ module JIRA
         response = client.post(path, user_id.to_json)
         true
       end
-
     end
   end
 end

data/lib/jira/resource/webhook.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WebhookFactory < JIRA::BaseFactory # :nodoc:
     end
 
     class Webhook < JIRA::Base
-      REST_BASE_PATH = '/rest/webhooks/1.0'.freeze
+      REST_BASE_PATH = '/rest/webhooks/1.0'
 
       def self.endpoint_name
         'webhook'
@@ -22,7 +24,7 @@ module JIRA
         response = client.get(collection_path(client))
         json = parse_json(response.body)
         json.map do |attrs|
-          new(client, { attrs: attrs }.merge(options))
+          new(client, { attrs: }.merge(options))
         end
       end
 

data/lib/jira/resource/worklog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
   module Resource
     class WorklogFactory < JIRA::BaseFactory # :nodoc:
@@ -5,8 +7,7 @@ module JIRA
 
     class Worklog < JIRA::Base
       has_one :author, class: JIRA::Resource::User
-      has_one :update_author, class: JIRA::Resource::User,
-                              attribute_key: 'updateAuthor'
+      has_one :update_author, class: JIRA::Resource::User, attribute_key: 'updateAuthor'
       belongs_to :issue
       nested_collections true
     end

data/lib/jira/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JIRA
-  VERSION = '2.2.0'.freeze
+  VERSION = '3.0.0.beta1'
 end

data/lib/jira-ruby.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << __dir__
 
 require 'active_support'
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
-  inflector.singular /status$/, 'status'
+  inflector.singular(/status$/, 'status')
 end
 
 require 'jira/base'
@@ -18,6 +20,7 @@ require 'jira/resource/component'
 require 'jira/resource/issuetype'
 require 'jira/resource/version'
 require 'jira/resource/status'
+require 'jira/resource/status_category'
 require 'jira/resource/transition'
 require 'jira/resource/project'
 require 'jira/resource/priority'
@@ -31,12 +34,11 @@ require 'jira/resource/issue_picker_suggestions_issue'
 require 'jira/resource/issue_picker_suggestions'
 require 'jira/resource/remotelink'
 require 'jira/resource/sprint'
-require 'jira/resource/sprint_report'
+require 'jira/resource/resolution'
 require 'jira/resource/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
 require 'jira/resource/rapidview'
-require 'jira/resource/resolution'
 require 'jira/resource/serverinfo'
 require 'jira/resource/createmeta'
 require 'jira/resource/webhook'

data/lib/tasks/generate.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 namespace :jira do
@@ -10,8 +12,8 @@ namespace :jira do
   desc 'Run the system call to generate a RSA public certificate'
   task :generate_public_cert do
     puts "Executing 'openssl req -x509 -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem'"
-    system('openssl req -x509 -subj "/C=US/ST=New York/L=New York/O=SUMO Heavy Industries/CN=www.sumoheavy.com" -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem')
-    puts "Done. The RSA-SHA1 private keyfile is in the current directory: \'rsakey.pem\'."
+    system('openssl req -x509 -subj "/C=US/ST=New York/L=New York/O=SUMO Heavy Industries/CN=www.sumoheavy.com" -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem') # rubocop:disable Layout/LineLength
+    puts "Done. The RSA-SHA1 private keyfile is in the current directory: 'rsakey.pem'."
     puts 'You will need to copy the following certificate into your application link configuration in Jira:'
     system('cat rsacert.pem')
   end

data/spec/data/files/short.txt

@@ -0,0 +1 @@
+short text

data/spec/integration/attachment_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Attachment do
 
     let(:key) { '10000' }
 
-    let(:target) { JIRA::Resource::Attachment.new(client, attrs: { 'id' => '99999' }, issue_id: '10002') }
+    let(:target) { described_class.new(client, attrs: { 'id' => '99999' }, issue_id: '10002') }
 
     let(:expected_attributes) do
       {
@@ -26,7 +26,7 @@ describe JIRA::Resource::Attachment do
                                 })
     end
 
-    it_should_behave_like 'a resource with a singular GET endpoint'
-    it_should_behave_like 'a resource with a DELETE endpoint'
+    it_behaves_like 'a resource with a singular GET endpoint'
+    it_behaves_like 'a resource with a DELETE endpoint'
   end
 end

data/spec/integration/comment_spec.rb

@@ -7,7 +7,7 @@ describe JIRA::Resource::Comment do
 
     let(:key) { '10000' }
 
-    let(:target) { JIRA::Resource::Comment.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
+    let(:target) { described_class.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
 
     let(:expected_collection_length) { 2 }
 
@@ -23,7 +23,7 @@ describe JIRA::Resource::Comment do
     let(:expected_attributes) do
       {
         'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002/comment/10000',
-        'id'   => key,
+        'id' => key,
         'body' => 'This is a comment. Creative.'
       }
     end
@@ -42,11 +42,11 @@ describe JIRA::Resource::Comment do
       { 'id' => '10000', 'body' => 'new body' }
     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/integration/component_spec.rb

@@ -10,7 +10,7 @@ describe JIRA::Resource::Component do
     let(:expected_attributes) do
       {
         'self' => 'http://localhost:2990/jira/rest/api/2/component/10000',
-        'id'   => key,
+        'id' => key,
         'name' => 'Cheesecake'
       }
     end
@@ -29,11 +29,11 @@ describe JIRA::Resource::Component do
       { 'id' => '10000', 'name' => 'Jammy' }
     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/field_spec.rb

@@ -25,8 +25,8 @@ describe JIRA::Resource::Field 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/issue_spec.rb

@@ -9,8 +9,8 @@ describe JIRA::Resource::Issue do
 
     let(:expected_attributes) do
       {
-        'self'   => 'http://localhost:2990/jira/rest/api/2/issue/10002',
-        'key'    => 'SAMPLEPROJECT-1',
+        'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002',
+        'key' => 'SAMPLEPROJECT-1',
         'expand' => 'renderedFields,names,schema,transitions,editmeta,changelog'
       }
     end
@@ -30,8 +30,8 @@ describe JIRA::Resource::Issue do
     end
     let(:expected_collection_length) { 11 }
 
-    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 'GET all issues' do # JIRA::Resource::Issue.all uses the search endpoint
       let(:client) { client }
       let(:site_url) { site_url }
@@ -43,26 +43,29 @@ describe JIRA::Resource::Issue do
           'key' => 'SAMPLEPROJECT-13'
         }
       end
-      before(:each) do
-        stub_request(:get, site_url + '/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0')
+
+      before do
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0")
           .to_return(status: 200, body: get_mock_response('issue.json'))
 
-        stub_request(:get, site_url + '/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=11')
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=11")
           .to_return(status: 200, body: get_mock_response('empty_issues.json'))
       end
-      it_should_behave_like 'a resource with a collection GET endpoint'
+
+      it_behaves_like 'a resource with a collection GET endpoint'
     end
-    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 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'
 
     describe 'errors' do
-      before(:each) do
+      before do
         stub_request(:get,
-                     site_url + '/jira/rest/api/2/issue/10002')
+                     "#{site_url}/jira/rest/api/2/issue/10002")
           .to_return(status: 200, body: get_mock_response('issue/10002.json'))
-        stub_request(:put, site_url + '/jira/rest/api/2/issue/10002')
+        stub_request(:put, "#{site_url}/jira/rest/api/2/issue/10002")
           .with(body: '{"missing":"fields and update"}')
           .to_return(status: 400, body: get_mock_response('issue/10002.put.missing_field_update.json'))
       end
@@ -87,7 +90,8 @@ describe JIRA::Resource::Issue do
           'key' => 'SAMPLEPROJECT-13'
         }
       end
-      it_should_behave_like 'a resource with JQL inputs and a collection GET endpoint'
+
+      it_behaves_like 'a resource with JQL inputs and a collection GET endpoint'
     end
   end
 end

data/spec/integration/issuelinktype_spec.rb

@@ -19,8 +19,8 @@ describe JIRA::Resource::Issuelinktype do
 
     let(:expected_collection_length) { 3 }
 
-    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/issuetype_spec.rb

@@ -17,8 +17,8 @@ describe JIRA::Resource::Issuetype do
 
     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/priority_spec.rb

@@ -17,8 +17,8 @@ describe JIRA::Resource::Priority do
 
     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/project_spec.rb

@@ -9,21 +9,21 @@ describe JIRA::Resource::Project do
 
     let(:expected_attributes) do
       {
-        'self'   => 'http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT',
-        'key'    => key,
-        'name'   => 'Sample Project for Developing RoR RESTful API'
+        'self' => 'http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT',
+        'key' => key,
+        'name' => 'Sample Project for Developing RoR RESTful API'
       }
     end
 
     let(:expected_collection_length) { 1 }
 
-    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'
 
     describe 'issues' do
       it 'returns all the issues' do
-        stub_request(:get, site_url + '/jira/rest/api/2/search?jql=project="SAMPLEPROJECT"')
+        stub_request(:get, "#{site_url}/jira/rest/api/2/search?jql=project=\"SAMPLEPROJECT\"")
           .to_return(status: 200, body: get_mock_response('project/SAMPLEPROJECT.issues.json'))
         subject = client.Project.build('key' => key)
         issues = subject.issues

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=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=id IN(10000, 10001) AND sprint IS NOT EMPTY"
         ).to_return(
           status: 200,
           body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')

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,7 +34,7 @@ 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

data/spec/integration/user_spec.rb

@@ -5,23 +5,37 @@ 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
 
@@ -34,7 +48,7 @@ describe JIRA::Resource::User do
       it 'gets users with maxResults of 1000' do
         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)
+        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