jira-ruby 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 280f02562d113b77a58fa5716f9cf9fe39fe6641893d3aecdd250caf4acf7d33
-  data.tar.gz: f29efc88140a3381b816bcbcec7a977120610470c72b4758bf359353f69eb316
+  metadata.gz: 960c900089bbe802d788f2c8daa7fcfa4b004a4674598693057117a1a1bca1c1
+  data.tar.gz: '086f550ca45271d9390498c7a55e8ba3ea281aa74641cae693c06d014ebd144c'
 SHA512:
-  metadata.gz: '087796061f2ef0472f91c36f64de9550ecb3f7ba6028e8ba91de43b3868e898d7ec4e82733bf31cf336f4a4fd4db9f2f89db320b9ff1db0759c303b6fcbf33ca'
-  data.tar.gz: b7fff299ec8eac30ff10f00bf36c6c659a6f29b2ab90a6b62e8ce810167ad9188d497a57f29dd389c536a393a2f8aa9897283c24f37b93ed554e8a21140b1e3e
+  metadata.gz: 5e8b4e34177a1a7f20b2376b949c5bc2f86ec6e14c64a1eb6ab1f332a243164a3fad933a54a079d930f732a8f986504f9c6e2386a7e6f1f87e3692d84cf5c6a9
+  data.tar.gz: e6c535fcec553bf6d74447c8e44fe5d38dcaf6248ccd76f5f554a3e52cdf4270a0fdb8d0e051a9af09fd15810cbd5759e33f6f616e1560e907135fa6b71f3b11

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
-    - 2.3
     - 2.4
+    - 2.5
+    - 2.6
     - ruby-head
 before_script:
     - rake jira:generate_public_cert

data/lib/jira-ruby.rb

@@ -38,6 +38,7 @@ require 'jira/resource/createmeta'
 require 'jira/resource/webhook'
 require 'jira/resource/agile'
 require 'jira/resource/board'
+require 'jira/resource/board_configuration'
 
 require 'jira/request_client'
 require 'jira/oauth_client'

data/lib/jira/client.rb

@@ -19,12 +19,15 @@ module JIRA
   #   :consumer_key       => nil,
   #   :consumer_secret    => nil,
   #   :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
+  #   :ssl_version        => nil,
   #   :use_ssl            => true,
   #   :username           => nil,
   #   :password           => nil,
   #   :auth_type          => :oauth,
   #   :proxy_address      => nil,
   #   :proxy_port         => nil,
+  #   :proxy_username     => nil,
+  #   :proxy_password     => nil,
   #   :additional_cookies => nil,
   #   :default_headers    => {}
   #
@@ -159,6 +162,10 @@ module JIRA
       JIRA::Resource::BoardFactory.new(self)
     end
 
+    def BoardConfiguration
+      JIRA::Resource::BoardConfigurationFactory.new(self)
+    end
+
     def RapidView
       JIRA::Resource::RapidViewFactory.new(self)
     end
@@ -203,10 +210,6 @@ module JIRA
       JIRA::Resource::RemotelinkFactory.new(self)
     end
 
-    def Sprint
-      JIRA::Resource::SprintFactory.new(self)
-    end
-
     def Agile
       JIRA::Resource::AgileFactory.new(self)
     end

data/lib/jira/http_client.rb

@@ -6,8 +6,8 @@ require 'uri'
 module JIRA
   class HttpClient < RequestClient
     DEFAULT_OPTIONS = {
-      username: '',
-      password: ''
+      username: nil,
+      password: nil
     }.freeze
 
     attr_reader :options
@@ -18,7 +18,7 @@ module JIRA
     end
 
     def make_cookie_auth_request
-      body = { username: @options[:username], password: @options[:password] }.to_json
+      body = { username: @options[:username].to_s, password: @options[:password].to_s }.to_json
       @options.delete(:username)
       @options.delete(:password)
       make_request(:post, @options[:context_path] + '/rest/auth/1/session', body, 'Content-Type' => 'application/json')
@@ -43,7 +43,7 @@ module JIRA
 
     def http_conn(uri)
       if @options[:proxy_address]
-        http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] || 80)
+        http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] || 80, @options[:proxy_username], @options[:proxy_password])
       else
         http_class = Net::HTTP
       end
@@ -54,6 +54,7 @@ module JIRA
         http_conn.key = @options[:key]
       end
       http_conn.verify_mode = @options[:ssl_verify_mode]
+      http_conn.ssl_version = @options[:ssl_version] if @options[:ssl_version]
       http_conn.read_timeout = @options[:read_timeout]
       http_conn
     end

data/lib/jira/resource/board.rb

@@ -46,6 +46,13 @@ module JIRA
         results.map { |issue| client.Issue.build(issue) }
       end
 
+      def configuration(params = {})
+        path = path_base(client) + "/board/#{id}/configuration"
+        response = client.get(url_with_query_params(path, params))
+        json = self.class.parse_json(response.body)
+        client.BoardConfiguration.build(json)
+      end
+
       # options
       #   - state ~ future, active, closed, you can define multiple states separated by commas, e.g. state=active,closed
       #   - maxResults ~ default: 50 (JIRA API), 1000 (this library)

data/lib/jira/resource/board_configuration.rb

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

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/spec/jira/http_client_spec.rb

@@ -2,12 +2,22 @@ require 'spec_helper'
 
 describe JIRA::HttpClient do
   let(:basic_client) do
-    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+    options = JIRA::Client::DEFAULT_OPTIONS
+              .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+              .merge(basic_auth_credentials)
     JIRA::HttpClient.new(options)
   end
 
   let(:basic_cookie_client) do
-    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(use_cookies: true)
+    options = JIRA::Client::DEFAULT_OPTIONS
+              .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+              .merge(use_cookies: true)
+              .merge(basic_auth_credentials)
+    JIRA::HttpClient.new(options)
+  end
+
+  let(:custom_ssl_version_client) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(ssl_version: :TLSv1_2)
     JIRA::HttpClient.new(options)
   end
 
@@ -20,10 +30,13 @@ describe JIRA::HttpClient do
   end
 
   let(:basic_cookie_client_with_additional_cookies) do
-    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
-      use_cookies: true,
-      additional_cookies: ['sessionToken=abc123', 'internal=true']
-    )
+    options = JIRA::Client::DEFAULT_OPTIONS
+              .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+              .merge(
+                use_cookies: true,
+                additional_cookies: ['sessionToken=abc123', 'internal=true']
+              )
+              .merge(basic_auth_credentials)
     JIRA::HttpClient.new(options)
   end
 
@@ -36,6 +49,26 @@ describe JIRA::HttpClient do
     JIRA::HttpClient.new(options)
   end
 
+  let(:basic_client_with_no_auth_credentials) do
+    options = JIRA::Client::DEFAULT_OPTIONS
+              .merge(JIRA::HttpClient::DEFAULT_OPTIONS)
+    JIRA::HttpClient.new(options)
+  end
+
+  let(:basic_auth_credentials) do
+    { username: 'donaldduck', password: 'supersecret' }
+  end
+
+  let(:proxy_client) do
+    options = JIRA::Client::DEFAULT_OPTIONS.merge(JIRA::HttpClient::DEFAULT_OPTIONS).merge(
+      proxy_address: 'proxyAddress',
+      proxy_port: 42,
+      proxy_username: 'proxyUsername',
+      proxy_password: 'proxyPassword'
+    )
+    JIRA::HttpClient.new(options)
+  end
+
   let(:response) do
     response = double('response')
     allow(response).to receive(:kind_of?).with(Net::HTTPSuccess).and_return(true)
@@ -159,6 +192,19 @@ describe JIRA::HttpClient do
     basic_client.make_request(:get, 'http://mydomain.com/foo', body, headers)
   end
 
+  it 'does not try to use basic auth if the credentials are not set' do
+    body = nil
+    headers = double
+    basic_auth_http_conn = double
+    http_request = double
+    expect(Net::HTTP::Get).to receive(:new).with('/foo', headers).and_return(http_request)
+
+    expect(basic_auth_http_conn).to receive(:request).with(http_request).and_return(response)
+    expect(http_request).not_to receive(:basic_auth)
+    allow(basic_client_with_no_auth_credentials).to receive(:basic_auth_http_conn).and_return(basic_auth_http_conn)
+    basic_client_with_no_auth_credentials.make_request(:get, '/foo', body, headers)
+  end
+
   it 'returns a URI' do
     uri = URI.parse(basic_client.options[:site])
     expect(basic_client.uri).to eq(uri)
@@ -178,6 +224,51 @@ describe JIRA::HttpClient do
     expect(basic_client.http_conn(uri)).to eq(http_conn)
   end
 
+  it 'sets the SSL version when one is provided' do
+    http_conn = double
+    uri = double
+    host = double
+    port = double
+    expect(uri).to receive(:host).and_return(host)
+    expect(uri).to receive(:port).and_return(port)
+    expect(Net::HTTP).to receive(:new).with(host, port).and_return(http_conn)
+    expect(http_conn).to receive(:use_ssl=).with(basic_client.options[:use_ssl]).and_return(http_conn)
+    expect(http_conn).to receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode]).and_return(http_conn)
+    expect(http_conn).to receive(:ssl_version=).with(custom_ssl_version_client.options[:ssl_version]).and_return(http_conn)
+    expect(http_conn).to receive(:read_timeout=).with(basic_client.options[:read_timeout]).and_return(http_conn)
+    expect(custom_ssl_version_client.http_conn(uri)).to eq(http_conn)
+  end
+
+  it 'sets up a non-proxied http connection by default' do
+    uri = double
+    host = double
+    port = double
+
+    expect(uri).to receive(:host).and_return(host)
+    expect(uri).to receive(:port).and_return(port)
+
+    proxy_configuration = basic_client.http_conn(uri).class
+    expect(proxy_configuration.proxy_address).to be_nil
+    expect(proxy_configuration.proxy_port).to be_nil
+    expect(proxy_configuration.proxy_user).to be_nil
+    expect(proxy_configuration.proxy_pass).to be_nil
+  end
+
+  it 'sets up a proxied http connection when using proxy options' do
+    uri = double
+    host = double
+    port = double
+
+    expect(uri).to receive(:host).and_return(host)
+    expect(uri).to receive(:port).and_return(port)
+
+    proxy_configuration = proxy_client.http_conn(uri).class
+    expect(proxy_configuration.proxy_address).to eq(proxy_client.options[:proxy_address])
+    expect(proxy_configuration.proxy_port).to eq(proxy_client.options[:proxy_port])
+    expect(proxy_configuration.proxy_user).to eq(proxy_client.options[:proxy_username])
+    expect(proxy_configuration.proxy_pass).to eq(proxy_client.options[:proxy_password])
+  end
+
   it 'can use client certificates' do
     http_conn = double
     uri = double

data/spec/jira/resource/board_spec.rb

@@ -172,4 +172,53 @@ eos
     expect(client).to receive(:Sprint).twice.and_return(JIRA::Resource::SprintFactory.new(client))
     expect(board.sprints.size).to be(2)
   end
+
+  it 'should get board configuration for a board' do
+    response = double
+
+    api_json = <<-eos
+      {
+        "id":1,
+        "name":"My Board",
+        "type":"kanban",
+        "self":"https://mycompany.atlassian.net/rest/agile/1.0/board/1/configuration",
+        "location":{
+          "type":"project",
+          "key":"MYPROJ",
+          "id":"10000",
+          "self":"https://mycompany.atlassian.net/rest/api/2/project/10000",
+          "name":"My Project"
+        },
+        "filter":{
+          "id":"10000",
+          "self":"https://mycompany.atlassian.net/rest/api/2/filter/10000"
+        },
+        "subQuery":{
+          "query":"resolution = EMPTY OR resolution != EMPTY AND resolutiondate >= -5d"
+        },
+        "columnConfig":{
+          "columns":[
+            {
+              "name":"Backlog",
+              "statuses":[
+                {
+                  "id":"10000",
+                  "self":"https://mycompany.atlassian.net/rest/api/2/status/10000"
+                }
+              ]
+            }
+          ],
+          "constraintType":"issueCount"
+        },
+        "ranking":{
+          "rankCustomFieldId":10011
+        }
+      }
+    eos
+    allow(response).to receive(:body).and_return(api_json)
+    allow(board).to receive(:id).and_return(84)
+    expect(client).to receive(:get).with('/rest/agile/1.0/board/84/configuration').and_return(response)
+    expect(client).to receive(:BoardConfiguration).and_return(JIRA::Resource::BoardConfigurationFactory.new(client))
+    expect(board.configuration).not_to be(nil)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2020-03-14 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'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,42 +171,42 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.18.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.18'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.18.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
 description: API for JIRA
 email: 
 executables: []
@@ -238,6 +238,7 @@ files:
 - lib/jira/resource/applinks.rb
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/board.rb
+- lib/jira/resource/board_configuration.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
 - lib/jira/resource/createmeta.rb
@@ -384,8 +385,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API