jira-ruby 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5433f708b438c961d0ca07b8aa60ae7733382aecb7374d4cc3ea3af1947f0e7f
-  data.tar.gz: d6757f05e80e8c005ad0f20461fac98d5509f87f0e0bebaea025e43e7d180d3e
+  metadata.gz: 0e2f1a7c44350f6423550154d1dd1929e38f5c2af002ebc463eef3bfa035b404
+  data.tar.gz: 4c2eb811cb02e66ff324a062fa27edaed2cf215b87cc89856a42dde1618fb3c5
 SHA512:
-  metadata.gz: 25f924c28544baf800585f9243d6d29622b0facab654aa03cf620bf76e4133731334b649c6af725fb0f246c68e3f5aa17bd8623eba5c2dd66303d2f2b2766dd2
-  data.tar.gz: b15c6540010df98f03acd562a50520dd90705bfa58cb2815070bc0ba3a535aea00d092c61a0f58bd3e3f23345c8ee48cf14e5d602fe324c3f7197b408d64e252
+  metadata.gz: 24f0604ca0ad23f7a4204b920f4ec90ec816033c607db5686cde519a0a00668ddf13828f03769f07f0a6cd36bee51186b02164e91ed144cf0892b5cd124d5df8
+  data.tar.gz: 2c7866e454e455465103803030f1fb40708d1ff9e04c09975594423884c5f84ceb43afb7ba853209ac26e8c9e12a91d3268b80452f8fb3641eee4a1556a787a8

data/README.md

@@ -50,7 +50,7 @@ rake jira:generate_public_cert
 
 On Mac OS,
 
-* Follow the instructions under "Mac OSX Installer" here: https://developer.atlassian.com/display/DOCS/Install+the+Atlassian+SDK+on+a+Linux+or+Mac+System
+* Follow the instructions under "Mac OSX Installer" here: https://developer.atlassian.com/server/framework/atlassian-sdk/install-the-atlassian-sdk-on-a-linux-or-mac-system
 * From within the archive directory, run:
 
 ```shell
@@ -153,14 +153,18 @@ require 'jira-ruby'
 # Consider the use of :use_ssl and :ssl_verify_mode options if running locally
 # for tests.
 
+# NOTE basic auth no longer works with Jira, you must generate an API token, to do so you must have jira instance access rights. You can generate a token here: https://id.atlassian.com/manage/api-tokens
+
+# You will see JIRA::HTTPError (JIRA::HTTPError) if you attempt to use basic auth with your user's password
+
 username = "myremoteuser"
-password = "myuserspassword"
+api_token = "myApiToken"
 
 options = {
             :username => username,
-            :password => password,
-            :site     => 'http://localhost:8080/',
-            :context_path => '/myjira',
+            :password => api_token,
+            :site     => 'http://localhost:8080/', # or 'https://<your_subdomain>.atlassian.net'
+            :context_path => '/myjira', # often blank
             :auth_type => :basic,
             :read_timeout => 120
           }

data/jira-ruby.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   # Runtime Dependencies
   s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'atlassian-jwt'
   s.add_runtime_dependency 'multipart-post'
   s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
 

data/lib/jira-ruby.rb

@@ -42,6 +42,7 @@ require 'jira/resource/board'
 require 'jira/request_client'
 require 'jira/oauth_client'
 require 'jira/http_client'
+require 'jira/jwt_client'
 require 'jira/client'
 
 require 'jira/railtie' if defined?(Rails)

data/lib/jira/client.rb

@@ -25,7 +25,8 @@ module JIRA
   #   :auth_type          => :oauth,
   #   :proxy_address      => nil,
   #   :proxy_port         => nil,
-  #   :additional_cookies => nil
+  #   :additional_cookies => nil,
+  #   :default_headers    => {}
   #
   # See the JIRA::Base class methods for all of the available methods on these accessor
   # objects.
@@ -52,7 +53,8 @@ module JIRA
       use_ssl: true,
       use_client_cert: false,
       auth_type: :oauth,
-      http_debug: false
+      http_debug: false,
+      default_headers: {}
     }.freeze
 
     def initialize(options = {})
@@ -71,6 +73,8 @@ module JIRA
       when :oauth, :oauth_2legged
         @request_client = OauthClient.new(@options)
         @consumer = @request_client.consumer
+      when :jwt
+        @request_client = JwtClient.new(@options)
       when :basic
         @request_client = HttpClient.new(@options)
       when :cookie
@@ -241,7 +245,7 @@ module JIRA
     protected
 
     def merge_default_headers(headers)
-      { 'Accept' => 'application/json' }.merge(headers)
+      { 'Accept' => 'application/json' }.merge(@options[:default_headers]).merge(headers)
     end
   end
 end

data/lib/jira/jwt_client.rb

@@ -0,0 +1,32 @@
+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(url) + "?jwt=#{jwt_header(http_method, url)}"
+
+      request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
+      request.body = body unless body.nil?
+
+      response = basic_auth_http_conn.request(request)
+      @authenticated = response.is_a? Net::HTTPOK
+      store_cookies(response) if options[:use_cookies]
+      response
+    end
+
+    private
+
+    def jwt_header(http_method, url)
+      claim = Atlassian::Jwt.build_claims \
+        @options[:issuer],
+        url,
+        http_method.to_s,
+        @options[:site],
+        (Time.now - 60).to_i,
+        (Time.now + (86400)).to_i
+
+      JWT.encode claim, @options[:shared_secret]
+    end
+  end
+end

data/lib/jira/resource/board.rb

@@ -31,7 +31,7 @@ module JIRA
       end
 
       def issues(params = {})
-        path = path_base(client) + "/board/#{id}/issue?"
+        path = path_base(client) + "/board/#{id}/issue"
         response = client.get(url_with_query_params(path, params))
         json = self.class.parse_json(response.body)
         results = json['issues']

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/spec/jira/client_spec.rb

@@ -207,6 +207,54 @@ describe JIRA::Client do
     end
   end
 
+  context 'with jwt authentication' do
+    subject do
+      JIRA::Client.new(
+        issuer: 'foo',
+        base_url: 'https://host.tld',
+        shared_secret: 'shared_secret_key',
+        auth_type: :jwt
+      )
+    end
+
+    before(:each) do
+      stub_request(:get, 'https://localhost:2990/jira/rest/api/2/project')
+          .with(query: hash_including(:jwt))
+          .to_return(status: 200, body: '[]', headers: {})
+    end
+
+    include_examples 'Client Common Tests'
+    include_examples 'HttpClient tests'
+
+    specify { expect(subject.request_client).to be_a JIRA::JwtClient }
+
+    it 'sets the username and password' do
+      expect(subject.options[:shared_secret]).to eq('shared_secret_key')
+    end
+
+    context 'with a incorrect jwt key' do
+      before do
+        stub_request(:get, 'https://localhost:2990/jira/rest/api/2/project')
+            .with(query: hash_including(:jwt))
+            .to_return(status: 401, body: '[]', headers: {})
+      end
+
+      it 'is not authenticated' do
+        expect(subject.authenticated?).to be_falsey
+      end
+
+      it 'raises a JIRA::HTTPError when trying to fetch projects' do
+        expect { subject.Project.all }.to raise_error JIRA::HTTPError
+      end
+    end
+
+    it 'only returns a true for #authenticated? once we have requested some data' do
+      expect(subject.authenticated?).to be_falsey
+      expect(subject.Project.all).to be_empty
+      expect(subject.authenticated?).to be_truthy
+    end
+  end
+
   context 'oauth authentication' do
     subject { JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar') }
 

data/spec/jira/resource/board_spec.rb

@@ -89,7 +89,7 @@ eos
 
       allow(issues_response).to receive(:body).and_return(api_json_issues)
       allow(board).to receive(:id).and_return(84)
-      expect(client).to receive(:get).with('/rest/agile/1.0/board/84/issue?')
+      expect(client).to receive(:get).with('/rest/agile/1.0/board/84/issue')
                                      .and_return(issues_response)
       expect(client).to receive(:Issue).and_return(JIRA::Resource::IssueFactory.new(client))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: atlassian-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +230,7 @@ files:
 - lib/jira/has_many_proxy.rb
 - lib/jira/http_client.rb
 - lib/jira/http_error.rb
+- lib/jira/jwt_client.rb
 - lib/jira/oauth_client.rb
 - lib/jira/railtie.rb
 - lib/jira/request_client.rb
@@ -369,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jira-ruby
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API