jira-ruby 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 293138e5626828e965e7862b82752fdcdc28a7f063b5e335dbcc1017f0ff371e
-  data.tar.gz: 8172bc08099f9a44bae653c69e347eab2356acbaa1df3aa001e5baa38b4e60fa
+  metadata.gz: 95a9c55b6f750bc29bdb34f6af24b252bbbf04317ca31ed9e76753a4c257f465
+  data.tar.gz: 56e109f946831308a8a7b30c699ebd5b6b5805c5724e3ec47ba3ac252d2df0f2
 SHA512:
-  metadata.gz: 699f1f8410ab65069f4f0a569bf8c2d2f4ec5903f0487ee075014be3ba48dc940efa1b0ccace8523418b9199c18c0eb3cd4d9aa1dd3c3f5d6dcf14c460583211
-  data.tar.gz: d0c35fcd9ccf3dfce329809588ae3d245447d942167097a3f5aafe28e5dc253c39eb468166bcbf53d4dca0dd2a22882b103e7114917fd80b3a5696532741a6a8
+  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

@@ -257,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

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/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '2.1.5'.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/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.5
+  version: 2.2.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 - test IO
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -208,7 +208,7 @@ dependencies:
       - !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.1.2
-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