jira-ruby 1.8.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 960c900089bbe802d788f2c8daa7fcfa4b004a4674598693057117a1a1bca1c1
-  data.tar.gz: '086f550ca45271d9390498c7a55e8ba3ea281aa74641cae693c06d014ebd144c'
+  metadata.gz: 95a9c55b6f750bc29bdb34f6af24b252bbbf04317ca31ed9e76753a4c257f465
+  data.tar.gz: 56e109f946831308a8a7b30c699ebd5b6b5805c5724e3ec47ba3ac252d2df0f2
 SHA512:
-  metadata.gz: 5e8b4e34177a1a7f20b2376b949c5bc2f86ec6e14c64a1eb6ab1f332a243164a3fad933a54a079d930f732a8f986504f9c6e2386a7e6f1f87e3692d84cf5c6a9
-  data.tar.gz: e6c535fcec553bf6d74447c8e44fe5d38dcaf6248ccd76f5f554a3e52cdf4270a0fdb8d0e051a9af09fd15810cbd5759e33f6f616e1560e907135fa6b71f3b11
+  metadata.gz: ba00e2efe10f65d2804c2c556774abab8c94d1fa746ca6c681cc7a967809bbb6309000b183049cdb9f8117dc2c8f0f60e22cbd77e6973736c7ca621989977509
+  data.tar.gz: bcfad2a8bcc354211e860ef7912eaedd202f189ccbedb03679032468d85425cc134d9e69dc1f4f8f4b0b238fa761cddbe21683e256379aafe29a1ca4d9d8a743

data/.gitignore

@@ -9,3 +9,5 @@ pkg/*
 .DS_STORE
 doc
 .ruby-version
+
+.rakeTasks

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
     - 2.4
     - 2.5
     - 2.6
-    - ruby-head
+    - 2.7
 before_script:
     - rake jira:generate_public_cert
 script: bundle exec rake spec

data/README.md

@@ -163,7 +163,7 @@ api_token = "myApiToken"
 options = {
             :username => username,
             :password => api_token,
-            :site     => 'http://localhost:8080/', # or 'https://<your_subdomain>.atlassian.net'
+            :site     => 'http://localhost:8080/', # or 'https://<your_subdomain>.atlassian.net/'
             :context_path => '/myjira', # often blank
             :auth_type => :basic,
             :read_timeout => 120
@@ -307,7 +307,7 @@ class App < Sinatra::Base
   # site uri, and the request token, access token, and authorize paths
   before do
     options = {
-      :site               => 'http://localhost:2990',
+      :site               => 'http://localhost:2990/',
       :context_path       => '/jira',
       :signature_method   => 'RSA-SHA1',
       :request_token_path => "/plugins/servlet/oauth/request-token",
@@ -405,7 +405,7 @@ require 'pp'
 require 'jira-ruby'
 
 options = {
-            :site               => 'http://localhost:2990',
+            :site               => 'http://localhost:2990/',
             :context_path       => '/jira',
             :signature_method   => 'RSA-SHA1',
             :private_key_file   => "rsakey.pem",

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

@@ -424,7 +424,7 @@ module JIRA
       end
       if @attrs['self']
         the_url = @attrs['self']
-        the_url = the_url.sub(@client.options[:site], '') if @client.options[:site]
+        the_url = the_url.sub(@client.options[:site].chomp('/'), '') if @client.options[:site]
         the_url
       elsif key_value
         self.class.singular_path(client, key_value.to_s, prefix)

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',
@@ -14,6 +14,7 @@ module JIRA
   #   :request_token_path => "/plugins/servlet/oauth/request-token",
   #   :authorize_path     => "/plugins/servlet/oauth/authorize",
   #   :access_token_path  => "/plugins/servlet/oauth/access-token",
+  #   :private_key        => nil,
   #   :private_key_file   => "rsakey.pem",
   #   :rest_base_path     => "/rest/api/2",
   #   :consumer_key       => nil,
@@ -28,8 +29,17 @@ module JIRA
   #   :proxy_port         => nil,
   #   :proxy_username     => nil,
   #   :proxy_password     => nil,
+  #   :use_cookies        => nil,
   #   :additional_cookies => nil,
-  #   :default_headers    => {}
+  #   :default_headers    => {},
+  #   :use_client_cert    => false,
+  #   :read_timeout       => nil,
+  #   :http_debug         => false,
+  #   :shared_secret      => nil,
+  #   :cert_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.
@@ -48,6 +58,43 @@ module JIRA
 
     def_delegators :@request_client, :init_access_token, :set_access_token, :set_request_token, :request_token, :access_token, :authenticated?
 
+    DEFINED_OPTIONS = [
+      :site,
+      :context_path,
+      :signature_method,
+      :request_token_path,
+      :authorize_path,
+      :access_token_path,
+      :private_key,
+      :private_key_file,
+      :rest_base_path,
+      :consumer_key,
+      :consumer_secret,
+      :ssl_verify_mode,
+      :ssl_version,
+      :use_ssl,
+      :username,
+      :password,
+      :auth_type,
+      :proxy_address,
+      :proxy_port,
+      :proxy_username,
+      :proxy_password,
+      :use_cookies,
+      :additional_cookies,
+      :default_headers,
+      :use_client_cert,
+      :read_timeout,
+      :http_debug,
+      :issuer,
+      :base_url,
+      :shared_secret,
+      :cert_path,
+      :key_path,
+      :ssl_client_cert,
+      :ssl_client_key
+    ].freeze
+
     DEFAULT_OPTIONS = {
       site: 'http://localhost:2990',
       context_path: '/jira',
@@ -65,11 +112,15 @@ module JIRA
       @options = options
       @options[:rest_base_path] = @options[:context_path] + @options[:rest_base_path]
 
+      unknown_options = options.keys.reject { |o| DEFINED_OPTIONS.include?(o) }
+      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]
@@ -206,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
@@ -233,6 +288,11 @@ module JIRA
       request(:post, path, body, merge_default_headers(headers))
     end
 
+    def post_multipart(path, file, headers = {})
+      puts "post multipart: #{path} - [#{file}]" if @http_debug
+      @request_client.request_multipart(path, file, headers)
+    end
+
     def put(path, body = '', headers = {})
       headers = { 'Content-Type' => 'application/json' }.merge(headers)
       request(:put, path, body, merge_default_headers(headers))
@@ -245,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

@@ -29,12 +29,15 @@ module JIRA
       path = request_path(url)
       request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
       request.body = body unless body.nil?
-      add_cookies(request) if options[:use_cookies]
-      request.basic_auth(@options[:username], @options[:password]) if @options[:username] && @options[:password]
-      response = basic_auth_http_conn.request(request)
-      @authenticated = response.is_a? Net::HTTPOK
-      store_cookies(response) if options[:use_cookies]
-      response
+
+      execute_request(request)
+    end
+
+    def make_multipart_request(url, body, headers = {})
+      path = request_path(url)
+      request = Net::HTTP::Post::Multipart.new(path, body, headers)
+
+      execute_request(request)
     end
 
     def basic_auth_http_conn
@@ -50,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]
@@ -60,7 +63,7 @@ module JIRA
     end
 
     def uri
-      uri = URI.parse(@options[:site])
+      URI.parse(@options[:site])
     end
 
     def authenticated?
@@ -69,6 +72,17 @@ module JIRA
 
     private
 
+    def execute_request(request)
+      add_cookies(request) if options[:use_cookies]
+      request.basic_auth(@options[:username], @options[:password]) if @options[:username] && @options[:password]
+
+      response = basic_auth_http_conn.request(request)
+      @authenticated = response.is_a? Net::HTTPOK
+      store_cookies(response) if options[:use_cookies]
+
+      response
+    end
+
     def request_path(url)
       parsed_uri = URI(url)
 

data/lib/jira/http_error.rb

@@ -8,7 +8,7 @@ module JIRA
 
     def initialize(response)
       @response = response
-      @message = response.try(:message) || response.try(:body)
+      @message = response.try(:message).presence || response.try(:body)
     end
   end
 end

data/lib/jira/jwt_client.rb

@@ -3,16 +3,15 @@ require 'atlassian/jwt'
 module JIRA
   class JwtClient < HttpClient
     def make_request(http_method, url, body = '', headers = {})
-      # When a proxy is enabled, Net::HTTP expects that the request path omits the domain name
-      path = request_path(http_method, url)
+      @http_method = http_method
 
-      request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
-      request.body = body unless body.nil?
+      super(http_method, url, body, headers)
+    end
+
+    def make_multipart_request(url, data, headers = {})
+      @http_method = :post
 
-      response = basic_auth_http_conn.request(request)
-      @authenticated = response.is_a? Net::HTTPOK
-      store_cookies(response) if options[:use_cookies]
-      response
+      super(url, data, headers)
     end
 
     class JwtUriBuilder
@@ -53,7 +52,9 @@ module JIRA
 
     private
 
-    def request_path(http_method, url)
+    attr_reader :http_method
+
+    def request_path(url)
       JwtUriBuilder.new(
         url,
         http_method.to_s,

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
 
@@ -72,29 +74,39 @@ module JIRA
       @access_token
     end
 
-    def make_request(http_method, path, body = '', headers = {})
+    def make_request(http_method, url, body = '', headers = {})
       # When using oauth_2legged we need to add an empty oauth_token parameter to every request.
       if @options[:auth_type] == :oauth_2legged
         oauth_params_str = 'oauth_token='
-        uri = URI.parse(path)
+        uri = URI.parse(url)
         uri.query = if uri.query.to_s == ''
                       oauth_params_str
                     else
                       uri.query + '&' + oauth_params_str
                     end
-        path = uri.to_s
+        url = uri.to_s
       end
 
       case http_method
       when :delete, :get, :head
-        response = access_token.send http_method, path, headers
+        response = access_token.send http_method, url, headers
       when :post, :put
-        response = access_token.send http_method, path, body, headers
+        response = access_token.send http_method, url, body, headers
       end
       @authenticated = true
       response
     end
 
+    def make_multipart_request(url, data, headers = {})
+      request = Net::HTTP::Post::Multipart.new url, data, headers
+
+      access_token.sign! request
+
+      response = consumer.http.request(request)
+      @authenticated = true
+      response
+    end
+
     def authenticated?
       @authenticated
     end

data/lib/jira/request_client.rb

@@ -1,7 +1,6 @@
 require 'oauth'
 require 'json'
 require 'net/https'
-# require 'pry'
 
 module JIRA
   class RequestClient
@@ -11,9 +10,22 @@ module JIRA
 
     def request(*args)
       response = make_request(*args)
-      # binding.pry unless response.kind_of?(Net::HTTPSuccess)
       raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
       response
     end
+
+    def request_multipart(*args)
+      response = make_multipart_request(*args)
+      raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
+      response
+    end
+
+    def make_request(*args)
+      raise NotImplementedError
+    end
+
+    def make_multipart_request(*args)
+      raise NotImplementedError
+    end
   end
-end
+end

data/lib/jira/resource/attachment.rb

@@ -19,27 +19,32 @@ module JIRA
         parse_json(response.body)
       end
 
-      def save!(attrs)
-        headers = { 'X-Atlassian-Token' => 'nocheck' }
-        data = { 'file' => UploadIO.new(attrs['file'], 'application/binary', attrs['file']) }
-
-        request = Net::HTTP::Post::Multipart.new url, data, headers
-        request.basic_auth(client.request_client.options[:username],
-                           client.request_client.options[:password])
+      def save!(attrs, path = url)
+        file = attrs['file'] || attrs[:file] # Keep supporting 'file' parameter as a string for backward compatibility
+        mime_type = attrs[:mimeType] || 'application/binary'
 
-        response = client.request_client.basic_auth_http_conn.request(request)
+        headers = { 'X-Atlassian-Token' => 'nocheck' }
+        data = { 'file' => UploadIO.new(file, mime_type, file) }
 
-        set_attrs(attrs, false)
-        unless response.body.nil? || response.body.length < 2
-          json = self.class.parse_json(response.body)
-          attachment = json[0]
+        response = client.post_multipart(path, data , headers)
 
-          set_attrs(attachment)
-        end
+        set_attributes(attrs, response)
 
         @expanded = false
         true
       end
+
+      private
+
+      def set_attributes(attributes, response)
+        set_attrs(attributes, false)
+        return if response.body.nil? || response.body.length < 2
+
+        json = self.class.parse_json(response.body)
+        attachment = json[0]
+
+        set_attrs(attachment)
+      end
     end
   end
 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/sprint.rb

@@ -5,7 +5,7 @@ module JIRA
 
     class Sprint < JIRA::Base
       def self.find(client, key)
-        response = client.get("#{client.options[:site]}/rest/agile/1.0/sprint/#{key}")
+        response = client.get(agile_path(client, key))
         json = parse_json(response.body)
         client.Sprint.build(json)
       end
@@ -19,7 +19,7 @@ module JIRA
 
       def add_issue(issue)
         request_body = { issues: [issue.id] }.to_json
-        response = client.post(client.options[:site] + "/rest/agile/1.0/sprint/#{id}/issue", request_body)
+        response = client.post("#{agile_path}/issue", request_body)
         true
       end
 
@@ -47,8 +47,8 @@ module JIRA
       end
 
       def get_sprint_details
-        search_url = client.options[:site] + '/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=' +
-                     rapidview_id.to_s + '&sprintId=' + id.to_s
+        search_url =
+          "#{client.options[:site]}#{client.options[:client_path]}/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=#{rapidview_id}&sprintId=#{id}"
         begin
           response = client.get(search_url)
         rescue StandardError
@@ -76,12 +76,12 @@ module JIRA
 
       def save(attrs = {}, _path = nil)
         attrs = @attrs if attrs.empty?
-        super(attrs, agile_url)
+        super(attrs, agile_path)
       end
 
       def save!(attrs = {}, _path = nil)
         attrs = @attrs if attrs.empty?
-        super(attrs, agile_url)
+        super(attrs, agile_path)
       end
 
       # WORK IN PROGRESS
@@ -93,8 +93,12 @@ module JIRA
 
       private
 
-      def agile_url
-        "#{client.options[:site]}/rest/agile/1.0/sprint/#{id}"
+      def agile_path
+        self.class.agile_path(client, id)
+      end
+
+      def self.agile_path(client, key)
+        "#{client.options[:context_path]}/rest/agile/1.0/sprint/#{key}"
       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/resource/watcher.rb

@@ -23,6 +23,13 @@ module JIRA
           issue.watchers.build(watcher)
         end
       end
+
+      def save!(user_id, path = nil)
+        path ||= new_record? ? url : patched_url
+        response = client.post(path, user_id.to_json)
+        true
+      end
+
     end
   end
 end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '1.8.0'.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