jira-ruby 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541b1fe24d3e52142ac5d00e028cc7a378e396b7ae4b3fb279959d4d65ceb855
-  data.tar.gz: 2800df3cd3d0cf68e55ad789872fd6bc261a1134b44a66c796a48c5d018072a3
+  metadata.gz: 95a9c55b6f750bc29bdb34f6af24b252bbbf04317ca31ed9e76753a4c257f465
+  data.tar.gz: 56e109f946831308a8a7b30c699ebd5b6b5805c5724e3ec47ba3ac252d2df0f2
 SHA512:
-  metadata.gz: 218b645e82b788254576bb925fa2061a5f023484be5100e67622a0072edd03b6dabda04206ea394a06e630cb918f98bb74d39fc2e99245d64c71cc42b160043d
-  data.tar.gz: 88d34f8904a0f1954981ca75b2dae6475c2159d373f384b7cba32a2bd7988070cf9b9ba286975882b652d56c5fbab7b36373d8edd5633e6056a903ac54d50838
+  metadata.gz: ba00e2efe10f65d2804c2c556774abab8c94d1fa746ca6c681cc7a967809bbb6309000b183049cdb9f8117dc2c8f0f60e22cbd77e6973736c7ca621989977509
+  data.tar.gz: bcfad2a8bcc354211e860ef7912eaedd202f189ccbedb03679032468d85425cc134d9e69dc1f4f8f4b0b238fa761cddbe21683e256379aafe29a1ca4d9d8a743

data/example.rb

@@ -166,6 +166,14 @@ client.Issue.jql(a_normal_jql_search, max_results: 500)
 # # --------------------------
 # issue.comments.first.save({"body" => "an updated comment frome example.rb"})
 
+
+# # Add attachment to Issue
+# # ------------------------
+#  issue = client.Issue.find('PROJ-1')
+#  attachment = issue.attachments.build
+#  attachment.save('file': '/path/to/file')
+#
+
 # List all available link types
 # ------------------------------
 pp client.Issuelinktype.all

data/lib/jira/client.rb

@@ -6,7 +6,7 @@ module JIRA
   # This class is the main access point for all JIRA::Resource instances.
   #
   # The client must be initialized with an options hash containing
-  # configuration options.  The available options are:
+  # configuration options. The available options are:
   #
   #   :site               => 'http://localhost:2990',
   #   :context_path       => '/jira',
@@ -29,6 +29,7 @@ module JIRA
   #   :proxy_port         => nil,
   #   :proxy_username     => nil,
   #   :proxy_password     => nil,
+  #   :use_cookies        => nil,
   #   :additional_cookies => nil,
   #   :default_headers    => {},
   #   :use_client_cert    => false,
@@ -36,7 +37,9 @@ module JIRA
   #   :http_debug         => false,
   #   :shared_secret      => nil,
   #   :cert_path          => nil,
-  #   :key_path           => nil
+  #   :key_path           => nil,
+  #   :ssl_client_cert    => nil,
+  #   :ssl_client_key     => nil
   #
   # See the JIRA::Base class methods for all of the available methods on these accessor
   # objects.
@@ -77,6 +80,7 @@ module JIRA
       :proxy_port,
       :proxy_username,
       :proxy_password,
+      :use_cookies,
       :additional_cookies,
       :default_headers,
       :use_client_cert,
@@ -86,7 +90,9 @@ module JIRA
       :base_url,
       :shared_secret,
       :cert_path,
-      :key_path
+      :key_path,
+      :ssl_client_cert,
+      :ssl_client_key
     ].freeze
 
     DEFAULT_OPTIONS = {
@@ -110,10 +116,11 @@ module JIRA
       raise ArgumentError, "Unknown option(s) given: #{unknown_options}" unless unknown_options.empty?
 
       if options[:use_client_cert]
-        raise ArgumentError, 'Options: :cert_path must be set when :use_client_cert is true' unless @options[:cert_path]
-        raise ArgumentError, 'Options: :key_path must be set when :use_client_cert is true' unless @options[:key_path]
-        @options[:cert] = OpenSSL::X509::Certificate.new(File.read(@options[:cert_path]))
-        @options[:key] = OpenSSL::PKey::RSA.new(File.read(@options[:key_path]))
+        @options[:ssl_client_cert] = OpenSSL::X509::Certificate.new(File.read(@options[:cert_path])) if @options[:cert_path]
+        @options[:ssl_client_key] = OpenSSL::PKey::RSA.new(File.read(@options[:key_path])) if @options[:key_path]
+
+        raise ArgumentError, 'Options: :cert_path or :ssl_client_cert must be set when :use_client_cert is true' unless @options[:ssl_client_cert]
+        raise ArgumentError, 'Options: :key_path or :ssl_client_key must be set when :use_client_cert is true' unless @options[:ssl_client_key]
       end
 
       case options[:auth_type]
@@ -250,6 +257,10 @@ module JIRA
       JIRA::Resource::IssuelinktypeFactory.new(self)
     end
 
+    def IssuePickerSuggestions
+      JIRA::Resource::IssuePickerSuggestionsFactory.new(self)
+    end
+
     def Remotelink
       JIRA::Resource::RemotelinkFactory.new(self)
     end
@@ -294,6 +305,11 @@ module JIRA
       @request_client.request(http_method, path, body, headers)
     end
 
+    # Stops sensitive client information from being displayed in logs
+    def inspect
+      "#<JIRA::Client:#{object_id}>"
+    end
+
     protected
 
     def merge_default_headers(headers)

data/lib/jira/http_client.rb

@@ -53,8 +53,8 @@ module JIRA
       http_conn = http_class.new(uri.host, uri.port)
       http_conn.use_ssl = @options[:use_ssl]
       if @options[:use_client_cert]
-        http_conn.cert = @options[:cert]
-        http_conn.key = @options[:key]
+        http_conn.cert = @options[:ssl_client_cert]
+        http_conn.key = @options[:ssl_client_key]
       end
       http_conn.verify_mode = @options[:ssl_verify_mode]
       http_conn.ssl_version = @options[:ssl_version] if @options[:ssl_version]

data/lib/jira/oauth_client.rb

@@ -38,6 +38,8 @@ module JIRA
       @options[:request_token_path] = @options[:context_path] + @options[:request_token_path]
       @options[:authorize_path] = @options[:context_path] + @options[:authorize_path]
       @options[:access_token_path] = @options[:context_path] + @options[:access_token_path]
+      # proxy_address does not exist in oauth's gem context but proxy does
+      @options[:proxy] = @options[:proxy_address] if @options[:proxy_address]
       OAuth::Consumer.new(@options[:consumer_key], @options[:consumer_secret], @options)
     end
 

data/lib/jira/resource/issue_picker_suggestions.rb

@@ -0,0 +1,24 @@
+module JIRA
+  module Resource
+    class IssuePickerSuggestionsFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class IssuePickerSuggestions < JIRA::Base
+      has_many :sections, class: JIRA::Resource::IssuePickerSuggestionsIssue
+
+      def self.all(client, query = '', options = { current_jql: nil, current_issue_key: nil, current_project_id: nil, show_sub_tasks: nil, show_sub_tasks_parent: nil })
+        url = client.options[:rest_base_path] + "/issue/picker?query=#{CGI.escape(query)}"
+
+        url << "&currentJQL=#{CGI.escape(options[:current_jql])}" if options[:current_jql]
+        url << "&currentIssueKey=#{CGI.escape(options[:current_issue_key])}" if options[:current_issue_key]
+        url << "&currentProjectId=#{CGI.escape(options[:current_project_id])}" if options[:current_project_id]
+        url << "&showSubTasks=#{options[:show_sub_tasks]}" if options[:show_sub_tasks]
+        url << "&showSubTaskParent=#{options[:show_sub_task_parent]}" if options[:show_sub_task_parent]
+
+        response = client.get(url)
+        json = parse_json(response.body)
+        client.IssuePickerSuggestions.build(json)
+      end
+    end
+  end
+end

data/lib/jira/resource/issue_picker_suggestions_issue.rb

@@ -0,0 +1,10 @@
+module JIRA
+  module Resource
+    class IssuePickerSuggestionsIssueFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class IssuePickerSuggestionsIssue < JIRA::Base
+      has_many :issues, class: JIRA::Resource::SuggestedIssue
+    end
+  end
+end

data/lib/jira/resource/suggested_issue.rb

@@ -0,0 +1,9 @@
+module JIRA
+  module Resource
+    class SuggestedIssueFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class SuggestedIssue < JIRA::Base
+    end
+  end
+end

data/lib/jira/resource/user.rb

@@ -18,7 +18,7 @@ module JIRA
 
       # Cannot retrieve more than 1,000 users through the api, please see: https://jira.atlassian.com/browse/JRASERVER-65089
       def self.all(client)
-        response  = client.get("/rest/api/2/user/search?username=_&maxResults=#{MAX_RESULTS}")
+        response  = client.get("/rest/api/2/users/search?username=_&maxResults=#{MAX_RESULTS}")
         all_users = JSON.parse(response.body)
 
         all_users.flatten.uniq.map do |user|

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/jira-ruby.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH << __dir__
 
+require 'active_support'
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
   inflector.singular /status$/, 'status'
@@ -25,6 +26,9 @@ require 'jira/resource/worklog'
 require 'jira/resource/applinks'
 require 'jira/resource/issuelinktype'
 require 'jira/resource/issuelink'
+require 'jira/resource/suggested_issue'
+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'

data/spec/integration/user_spec.rb

@@ -21,18 +21,18 @@ describe JIRA::Resource::User do
     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/user/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
         allow(client).to receive(:get)
-          .with('/rest/api/2/user/search?username=_&maxResults=1000') { OpenStruct.new(body: '["User1"]') }
+          .with('/rest/api/2/users/search?username=_&maxResults=1000') { OpenStruct.new(body: '["User1"]') }
         allow(client).to receive_message_chain(:User, :build).with('users') { [] }
       end
 
       it 'gets users with maxResults of 1000' do
-        expect(client).to receive(:get).with('/rest/api/2/user/search?username=_&maxResults=1000')
+        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)
       end

data/spec/jira/client_spec.rb

@@ -59,6 +59,19 @@ RSpec.shared_examples 'Client Common Tests' do
       expect(subject.Project.find('123')).to eq(find_result)
     end
   end
+
+  describe 'SSL client options' do
+    context 'without certificate and key' do
+      let(:options) { { use_client_cert: true } }
+      subject { JIRA::Client.new(options) }
+
+      it 'raises an ArgumentError' do
+        expect { subject }.to raise_exception(ArgumentError, 'Options: :cert_path or :ssl_client_cert must be set when :use_client_cert is true')
+        options[:ssl_client_cert] = '<cert></cert>'
+        expect { subject }.to raise_exception(ArgumentError, 'Options: :key_path or :ssl_client_key must be set when :use_client_cert is true')
+      end
+    end
+  end
 end
 
 RSpec.shared_examples 'HttpClient tests' do

data/spec/jira/http_client_spec.rb

@@ -280,8 +280,8 @@ describe JIRA::HttpClient do
     expect(http_conn).to receive(:use_ssl=).with(basic_client.options[:use_ssl])
     expect(http_conn).to receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode])
     expect(http_conn).to receive(:read_timeout=).with(basic_client.options[:read_timeout])
-    expect(http_conn).to receive(:cert=).with(basic_client_cert_client.options[:cert])
-    expect(http_conn).to receive(:key=).with(basic_client_cert_client.options[:key])
+    expect(http_conn).to receive(:cert=).with(basic_client_cert_client.options[:ssl_client_cert])
+    expect(http_conn).to receive(:key=).with(basic_client_cert_client.options[:ssl_client_key])
     expect(basic_client_cert_client.http_conn(uri)).to eq(http_conn)
   end
 

data/spec/jira/resource/issue_picker_suggestions_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe JIRA::Resource::IssuePickerSuggestions do
+  let(:client) do
+    double('client', options: {
+      rest_base_path: '/jira/rest/api/2'
+    })
+  end
+
+  describe 'relationships' do
+    subject do
+      JIRA::Resource::IssuePickerSuggestions.new(client, attrs: {
+        'sections' => [{ 'id' => 'hs'}, { 'id' => 'cs' }]
+      })
+    end
+
+    it 'has the correct relationships' do
+      expect(subject).to have_many(:sections, JIRA::Resource::IssuePickerSuggestionsIssue)
+      expect(subject.sections.length).to eq(2)
+    end
+  end
+
+  describe '#all' do
+    let(:response) { double }
+    let(:issue_picker_suggestions) { double }
+
+    before do
+      allow(response).to receive(:body).and_return('{"sections":[{"id": "cs"}]}')
+      allow(client).to receive(:IssuePickerSuggestions).and_return(issue_picker_suggestions)
+      allow(issue_picker_suggestions).to receive(:build)
+    end
+
+    it 'should autocomplete issues' do
+      allow(response).to receive(:body).and_return('{"sections":[{"id": "cs"}]}')
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query')
+                                     .and_return(response)
+
+      expect(client).to receive(:IssuePickerSuggestions).and_return(issue_picker_suggestions)
+      expect(issue_picker_suggestions).to receive(:build).with('sections' => [{ 'id' => 'cs' }])
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query')
+    end
+
+    it 'should autocomplete issues with current jql' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentJQL=project+%3D+PR')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_jql: 'project = PR')
+    end
+
+    it 'should autocomplete issues with current issue jey' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentIssueKey=PR-42')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_issue_key: 'PR-42')
+    end
+
+    it 'should autocomplete issues with current project id' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&currentProjectId=PR')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', current_project_id: 'PR')
+    end
+
+    it 'should autocomplete issues with show sub tasks' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&showSubTasks=true')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', show_sub_tasks: true)
+    end
+
+    it 'should autocomplete issues with show sub tasks parent' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/picker?query=query&showSubTaskParent=true')
+                                     .and_return(response)
+
+      JIRA::Resource::IssuePickerSuggestions.all(client, 'query', show_sub_task_parent: true)
+    end
+  end
+end

data/spec/jira/resource/jira_picker_suggestions_issue_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe JIRA::Resource::IssuePickerSuggestionsIssue do
+  let(:client) { double('client') }
+
+  describe 'relationships' do
+    subject do
+      JIRA::Resource::IssuePickerSuggestionsIssue.new(client, attrs: {
+        'issues' => [{ 'id' => '1'}, { 'id' => '2' }]
+      })
+    end
+
+    it 'has the correct relationships' do
+      expect(subject).to have_many(:issues, JIRA::Resource::SuggestedIssue)
+      expect(subject.issues.length).to eq(2)
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,42 +57,42 @@ dependencies:
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.13.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,44 +171,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.18.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.0
 description: API for JIRA
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -245,6 +245,8 @@ files:
 - lib/jira/resource/field.rb
 - lib/jira/resource/filter.rb
 - lib/jira/resource/issue.rb
+- lib/jira/resource/issue_picker_suggestions.rb
+- lib/jira/resource/issue_picker_suggestions_issue.rb
 - lib/jira/resource/issuelink.rb
 - lib/jira/resource/issuelinktype.rb
 - lib/jira/resource/issuetype.rb
@@ -257,6 +259,7 @@ files:
 - lib/jira/resource/sprint.rb
 - lib/jira/resource/sprint_report.rb
 - lib/jira/resource/status.rb
+- lib/jira/resource/suggested_issue.rb
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
 - lib/jira/resource/version.rb
@@ -299,8 +302,10 @@ files:
 - spec/jira/resource/createmeta_spec.rb
 - spec/jira/resource/field_spec.rb
 - spec/jira/resource/filter_spec.rb
+- spec/jira/resource/issue_picker_suggestions_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/issuelink_spec.rb
+- spec/jira/resource/jira_picker_suggestions_issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/sprint_spec.rb
@@ -370,7 +375,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/sumoheavy/jira-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -385,8 +390,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API
 test_files:
@@ -423,8 +428,10 @@ test_files:
 - spec/jira/resource/createmeta_spec.rb
 - spec/jira/resource/field_spec.rb
 - spec/jira/resource/filter_spec.rb
+- spec/jira/resource/issue_picker_suggestions_spec.rb
 - spec/jira/resource/issue_spec.rb
 - spec/jira/resource/issuelink_spec.rb
+- spec/jira/resource/jira_picker_suggestions_issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/sprint_spec.rb