jira-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb639c7a6da1d81ae6bb693c5891ee23ce1b1e9c
-  data.tar.gz: 331cd7e819faa9cc056045413d968793a238baa9
+  metadata.gz: d616cf8d52b0dff3a17a4381b03160eef8e15755
+  data.tar.gz: 7823abec7764565a45a94d061d6f19d1e164b227
 SHA512:
-  metadata.gz: e8e856bf2af0be3d9b40b300167117c263c6ffda85fb70001c7fd3c2c59b05eab6561ac2f684786175dcf707d6b5ab9a606b92a17a3278cde73f119fb047d4ff
-  data.tar.gz: cc19f33cb2c9455045ff0f1d8368a639963dee01c3c313a39e6e49b026d354dd8f0ef2586773b8153b78c51868466bafbd452aac77ba2641c4f697fd22e6d9d0
+  metadata.gz: 1c35b0d388f24a4e17afb24f4d7a96e21374f4548a672d007c262e3856f8f442d1d56f48fd3eee96eb1b84580022b014cff7f280143a6dd442ea58b9e3e102b5
+  data.tar.gz: 72dce2f225e83b9adc8f1e9fe3951ab464439ec90e0cd899df9f353515089c4b6600318e477006504528cbacf755d0ca556065d324ab266fc62d70c1f3242f8a

data/jira-ruby.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |s|
 
   # Rubtime Dependencies
   s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
-  s.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.0'
+  s.add_runtime_dependency 'activesupport'
 
   # Development Dependencies
-  s.add_development_dependency 'railties', '~> 4.2', '>= 4.2.0'
+  s.add_development_dependency 'railties'
   s.add_development_dependency 'webmock',  '~> 1.18', '>= 1.18.0'
   s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
   s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'

data/lib/jira/client.rb

@@ -66,8 +66,13 @@ module JIRA
         @consumer = @request_client.consumer
       when :basic
         @request_client = HttpClient.new(@options)
+      when :cookie
+        raise ArgumentError, 'Options: :use_cookies must be true for :cookie authorization type' if @options.key?(:use_cookies) && !@options[:use_cookies]
+        @options[:use_cookies] = true
+        @request_client = HttpClient.new(@options)
+        @request_client.make_cookie_auth_request
       else
-        raise ArgumentError, 'Options: ":auth_type" must be ":oauth" or ":basic"'
+        raise ArgumentError, 'Options: ":auth_type" must be ":oauth", ":cookie" or ":basic"'
       end
 
       @http_debug = @options[:http_debug]

data/lib/jira/http_client.rb

@@ -17,6 +17,11 @@ module JIRA
       @cookies = {}
     end
 
+    def make_cookie_auth_request
+      body = { :username => @options[:username], :password => @options[:password] }.to_json
+      make_request(:post, '/rest/auth/1/session', body, {'Content-Type' => 'application/json'})
+    end
+
     def make_request(http_method, path, body='', headers={})
       request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
       request.body = body unless body.nil?

data/lib/jira/railtie.rb

@@ -1,4 +1,4 @@
-require 'jira'
+require 'jira-ruby'
 require 'rails'
 
 module JIRA

data/lib/jira/resource/issue.rb

@@ -62,6 +62,9 @@ module JIRA
 
         response = client.get(url)
         json = parse_json(response.body)
+        if options[:max_results] and options[:max_results] == 0
+          return json['total']
+        end
         json['issues'].map do |issue|
           client.Issue.build(issue)
         end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/jira/client_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe JIRA::Client do
+  before(:each) do
+    stub_request(:post, "https://foo:bar@localhost:2990/rest/auth/1/session").
+      to_return(:status => 200, :body => "", :headers => {})
+  end
 
   let(:oauth_client) do
     JIRA::Client.new({ :consumer_key => 'foo', :consumer_secret => 'bar' })
@@ -10,7 +14,11 @@ describe JIRA::Client do
     JIRA::Client.new({ :username => 'foo', :password => 'bar', :auth_type => :basic })
   end
 
-  let(:clients) { [oauth_client, basic_client] }
+  let(:cookie_client) do
+    JIRA::Client.new({ :username => 'foo', :password => 'bar', :auth_type => :cookie })
+  end
+
+  let(:clients) { [oauth_client, basic_client, cookie_client] }
 
   let(:response) do
     response = double("response")
@@ -54,11 +62,13 @@ describe JIRA::Client do
     specify "that are of the correct class" do
       expect(oauth_client.request_client.class).to eq(JIRA::OauthClient)
       expect(basic_client.request_client.class).to eq(JIRA::HttpClient)
+      expect(cookie_client.request_client.class).to eq(JIRA::HttpClient)
     end
 
     specify "which have a corresponding auth type option" do
       expect(oauth_client.options[:auth_type]).to eq(:oauth)
       expect(basic_client.options[:auth_type]).to eq(:basic)
+      expect(cookie_client.options[:auth_type]).to eq(:cookie)
     end
 
     describe "like oauth" do
@@ -93,8 +103,12 @@ describe JIRA::Client do
       it "sets the username and password" do
         expect(basic_client.options[:username]).to eq('foo')
         expect(basic_client.options[:password]).to eq('bar')
+
+        expect(cookie_client.options[:username]).to eq('foo')
+        expect(cookie_client.options[:password]).to eq('bar')
       end
     end
+
   end
 
   describe "has http methods" do
@@ -106,23 +120,28 @@ describe JIRA::Client do
       # stubbed response for generic client request method
       expect(oauth_client).to receive(:request).exactly(5).times.and_return(response)
       expect(basic_client).to receive(:request).exactly(5).times.and_return(response)
+      expect(cookie_client).to receive(:request).exactly(5).times.and_return(response)
 
       # response for merging headers for http methods with no body
       expect(oauth_client).to receive(:merge_default_headers).exactly(3).times.with({})
       expect(basic_client).to receive(:merge_default_headers).exactly(3).times.with({})
+      expect(cookie_client).to receive(:merge_default_headers).exactly(3).times.with({})
 
       # response for merging headers for http methods with body
       expect(oauth_client).to receive(:merge_default_headers).exactly(2).times.with(content_type_header)
       expect(basic_client).to receive(:merge_default_headers).exactly(2).times.with(content_type_header)
+      expect(cookie_client).to receive(:merge_default_headers).exactly(2).times.with(content_type_header)
 
       [:delete, :get, :head].each do |method|
         oauth_client.send(method, '/path', {})
         basic_client.send(method, '/path', {})
+        cookie_client.send(method, '/path', {})
       end
 
       [:post, :put].each do |method|
         oauth_client.send(method, '/path', '', content_type_header)
         basic_client.send(method, '/path', '', content_type_header)
+        cookie_client.send(method, '/path', '', content_type_header)
       end
     end
 
@@ -130,15 +149,19 @@ describe JIRA::Client do
       [:delete, :get, :head].each do |method|
         expect(oauth_client).to receive(:request).with(method, '/path', nil, headers).and_return(response)
         expect(basic_client).to receive(:request).with(method, '/path', nil, headers).and_return(response)
+        expect(cookie_client).to receive(:request).with(method, '/path', nil, headers).and_return(response)
         oauth_client.send(method, '/path', {})
         basic_client.send(method, '/path', {})
+        cookie_client.send(method, '/path', {})
       end
 
       [:post, :put].each do |method|
         expect(oauth_client).to receive(:request).with(method, '/path', '', merged_headers)
         expect(basic_client).to receive(:request).with(method, '/path', '', merged_headers)
+        expect(cookie_client).to receive(:request).with(method, '/path', '', merged_headers)
         oauth_client.send(method, '/path', '', {})
         basic_client.send(method, '/path', '', {})
+        cookie_client.send(method, '/path', '', {})
       end
     end
 
@@ -160,10 +183,16 @@ describe JIRA::Client do
         [:delete, :get, :head].each do |method|
           expect(basic_client.request_client).to receive(:make_request).with(method, '/path', nil, headers).and_return(response)
           basic_client.send(method, '/path', headers)
+
+          expect(cookie_client.request_client).to receive(:make_request).with(method, '/path', nil, headers).and_return(response)
+          cookie_client.send(method, '/path', headers)
         end
         [:post, :put].each do |method|
           expect(basic_client.request_client).to receive(:make_request).with(method, '/path', '', merged_headers).and_return(response)
           basic_client.send(method, '/path', '', headers)
+
+          expect(cookie_client.request_client).to receive(:make_request).with(method, '/path', '', merged_headers).and_return(response)
+          cookie_client.send(method, '/path', '', headers)
         end
       end
     end
@@ -173,16 +202,22 @@ describe JIRA::Client do
     it "gets all projects" do
       expect(JIRA::Resource::Project).to receive(:all).with(oauth_client).and_return([])
       expect(JIRA::Resource::Project).to receive(:all).with(basic_client).and_return([])
+      expect(JIRA::Resource::Project).to receive(:all).with(cookie_client).and_return([])
+
       expect(oauth_client.Project.all).to eq([])
       expect(basic_client.Project.all).to eq([])
+      expect(cookie_client.Project.all).to eq([])
     end
 
     it "finds a single project" do
       find_result = double()
       expect(JIRA::Resource::Project).to receive(:find).with(oauth_client, '123').and_return(find_result)
       expect(JIRA::Resource::Project).to receive(:find).with(basic_client, '123').and_return(find_result)
+      expect(JIRA::Resource::Project).to receive(:find).with(cookie_client, '123').and_return(find_result)
+
       expect(oauth_client.Project.find('123')).to eq(find_result)
       expect(basic_client.Project.find('123')).to eq(find_result)
+      expect(cookie_client.Project.find('123')).to eq(find_result)
     end
   end
 end

data/spec/jira/resource/field_spec.rb

@@ -13,7 +13,7 @@ describe JIRA::Resource::Field do
     allow(client.Field).to receive(:all).and_return([
       JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10666", "name" => "Priority",   "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10666]","Priority"],         "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10666}}),
       JIRA::Resource::Field.new(client, :attrs => {'id' =>"issuekey",          "name" => "Key",        "custom" => false, "orderable" => false, "navigable" => true, "searchable" => false, "clauseNames" => ["id","issue","issuekey","key"]}),
-      JIRA::Resource::Field.new(client, :attrs => {"id" =>"priority",          "name" => "Priority",   "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["priority"],                     "schema" =>{"type" => "priority",  "system" => "priority"}}),
+      JIRA::Resource::Field.new(client, :attrs => {'id' =>"priority",          "name" => "Priority",   "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["priority"],                     "schema" =>{"type" => "priority",  "system" => "priority"}}),
       JIRA::Resource::Field.new(client, :attrs => {'id' =>"summary",           "name" => "Summary",    "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["summary"],                      "schema" =>{"type" => "string",    "system" => "summary"}}),
       JIRA::Resource::Field.new(client, :attrs => {'id' =>"issuetype",         "name" => "Issue Type", "custom" => false, "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["issuetype","type"],             "schema" =>{"type" => "issuetype", "system" => "issuetype"}}),
       JIRA::Resource::Field.new(client, :attrs => {'id' =>"customfield_10111", "name" => "SingleWord", "custom" => true,  "orderable" => true,  "navigable" => true, "searchable" => true,  "clauseNames" => ["cf[10111]","SingleWord"],       "schema" =>{"type" => "string",    "custom" => "com.atlassian.jira.plugin.system.customfieldtypes:select","customId" => 10111}}),
@@ -70,10 +70,6 @@ describe JIRA::Resource::Field do
         expect(subject.customfield_10111).to eq('data_in_custom_field')
       end
 
-      it "cannot find a mapped field before mapping and raises error" do
-        expect{subject.SingleWork}.to raise_error(NoMethodError)
-      end
-
       it "is not confused by common attribute keys and raises error" do
         expect{subject.name}.to raise_error(NoMethodError)
         expect{subject.custom}.to raise_error(NoMethodError)
@@ -83,12 +79,6 @@ describe JIRA::Resource::Field do
 
     context "after fields are mapped" do
 
-      before do
-        silence_stream(STDERR) do
-          expect(client.Field.map_fields.class).to eq(Hash)
-        end
-      end
-
       include_context "mapped or not"
 
       it "warns of duplicate fields" do
@@ -96,37 +86,6 @@ describe JIRA::Resource::Field do
         expect{client.Field.map_fields}.to output(/renaming as SingleWord_10444/).to_stderr
       end
 
-      it "can find a mapped field after mapping and returns results" do
-        expect{subject.SingleWord}.to_not raise_error
-        expect(subject.SingleWord).to eq subject.customfield_10111
-      end
-
-      it "handles duplicate names in a safe fashion" do
-        expect{subject.Multi_Word}.to_not raise_error
-        expect(subject.Multi_Word).to eq subject.customfield_10222
-      end
-
-      it "handles special characters in a safe fashion" do
-        expect{subject.Why_N_t}.to_not raise_error
-        expect(subject.Why_N_t).to eq subject.customfield_10333
-      end
-
-      it "handles duplicates in custom names" do
-        expect{subject.SingleWord_10444}.to_not raise_error
-        expect(subject.SingleWord_10444).to eq subject.customfield_10444
-      end
-
-      it "keeps custom names from overwriting system names" do
-        #expect(client.Field.map_fields.class).to eq(Hash)
-        expect{subject.Priority_10666}.to_not raise_error
-        expect(subject.Priority_10666).to eq subject.customfield_10666
-      end
-
-      it "can find a standard field by an expanded name" do
-        #expect(client.Field.map_fields.class).to eq(Hash)
-        expect(subject.priority).to eq(1)
-        expect(subject.Priority).to eq(1)
-      end
     end
   end
 end

data/spec/jira/resource/issue_spec.rb

@@ -105,6 +105,18 @@ describe JIRA::Resource::Issue do
     expect(JIRA::Resource::Issue.jql(client,'foo bar', start_at: 1, max_results: 3)).to eq([''])
   end
 
+  it "should search an issue with a jql query string and maxResults equals zero and should return the count of tickets" do
+    response = double()
+    issue = double()
+
+    allow(response).to receive(:body).and_return('{"total": 1, "issues": []}')
+    expect(client).to receive(:get)
+      .with('/jira/rest/api/2/search?jql=foo+bar&maxResults=0')
+      .and_return(response)
+
+    expect(JIRA::Resource::Issue.jql(client,'foo bar', max_results: 0)).to eq(1)
+  end
+
   it "should search an issue with a jql query string and string expand" do
     response = double()
     issue = double()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -34,42 +34,30 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -353,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jira-ruby
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API