jira-ruby 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72616e61b52a45892a4fa86713ca5c9847440c42
-  data.tar.gz: 7aae22f02bcf7c91bb0dff21e5d55aa3ba828eee
+  metadata.gz: 938fec5653ff3c6dc1d696e9fcdf9b48035d27ab
+  data.tar.gz: 2f970d1175362e3ffd53a4f7136ae23396667e5d
 SHA512:
-  metadata.gz: a9b54e4bd78bb5aef39937772720382c79c221caa7bcfa711dd7a3eddd80f047b60d51874bb61ecd4489a28030f840125bbb713c7e75aa5e75a24f6017f7b76f
-  data.tar.gz: 66bbc3c25c56c03d37a00ffa38d520c8842f50e614ae96007b8202c0050cd8954189cf97e3ba62dcbb7ca9f0a8092815d723f2dc078ec126a0aab72bba5c4a33
+  metadata.gz: 87c5a7dcd5a1a501cd00a65c4e60d52b0dcf30a176c91d35349560b9c99866db3fbea8b7c9f89fc5897564b77d049c3b38e8d09ef3eb151024d8892385e005bc
+  data.tar.gz: ffc1d13d012b554794ee562d353e5ea9b7ea4d7d366264a6ced2e0838f10443cbbb5dd689a2173fb702aad0c343bd755a118e986e4d67413ec1272271aae0452

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/README.rdoc

@@ -5,6 +5,10 @@
 
 This gem provides access to the Atlassian JIRA REST API.
 
+== Slack
+
+Join our Slack channel! You can find us here[http://jira-ruby.slack.com]
+
 == Example usage
 
   require 'rubygems'

data/example.rb

@@ -59,11 +59,12 @@ old_way = issue.customfield_12345
 new_way = issue.Special_Field
 (old_way == new_way) && puts 'much easier'
 #
-# Can also use this to specify fields to be returned in the response
-client.Issue.jql(a_normal_jql_search, fields:[:Special_Field])
-# Or you could always do it the old way - if you can remember the numbers...
-client.Issue.jql(a_normal_jql_search, fields:['customfield_12345'])
-# You can specify the maximum number of results to be returned in the response, i.e. 500
+# You can also specify fields to be returned in the response
+# This is especially useful in regards to shortening JQL query response times if performance becomes an issue
+client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :Special_field, :created])
+# Or you could always do it the old way - if you can remember the custom field numbers...
+client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :customfield_1234, :created])
+# You can also specify the maximum number of results to be returned in the response, i.e. 500
 client.Issue.jql(a_normal_jql_search, max_results: 500)
 
 # # Find a specific project by key
@@ -108,6 +109,15 @@ client.Issue.jql(a_normal_jql_search, max_results: 500)
 # issue.save({"fields"=>{"summary"=>"EVEN MOOOOOOARRR NINJAAAA!"}})
 # pp issue
 #
+# # Transition an issue
+# # -------------------
+# issue_transition = issue.transitions.build
+# issue_transition.save!('transition' => {'id' => transition_id})
+#
+# # Change assignee
+# # -------------------
+# issue.save({'fields' => {'assignee' => {'name' => person_name}}})
+#
 # # Find a user
 # # -----------
 # user = client.User.find('admin')

data/http-basic-example.rb

@@ -51,7 +51,7 @@ end
 #
 # # List issues by JQL query
 # # ------------------------
-# client.Issue.jql('PROJECT = "SAMPLEPROJECT"', [comments, summary]).each do |issue|
+# client.Issue.jql('PROJECT = "SAMPLEPROJECT"', {fields: %w(summary status)}).each do |issue|
 #   puts "#{issue.id} - #{issue.fields['summary']}"
 # end
 #

data/lib/jira/base.rb

@@ -500,8 +500,12 @@ module JIRA
     end
 
     def hash_to_query_string(query_params)
+      self.class.hash_to_query_string(query_params)
+    end
+
+    def self.hash_to_query_string(query_params)
       query_params.map do |k,v|
-        CGI.escape(k.to_s) + "=" + CGI.escape(v.to_s)
+        CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
       end.join('&')
     end
 

data/lib/jira/resource/createmeta.rb

@@ -37,16 +37,10 @@ module JIRA
         response = params.empty? ? client.get("#{create_meta_url}") : client.get("#{create_meta_url}?#{params}")
 
         json = parse_json(response.body)
-        self.new(client, {:attrs => json['projects']})
-      end
-
-      def self.hash_to_query_string(query_params)
-        query_params.map do |k,v|
-          CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
-        end.join('&')
+        json['projects'].map do |attrs|
+          self.new(client, {:attrs => attrs})
+        end
       end
-
     end
-
   end
 end

data/lib/jira/resource/project.rb

@@ -27,9 +27,11 @@ module JIRA
         end
       end
 
-      def users
+      def users(start_at: nil, max_results: nil)
         users_url = client.options[:rest_base_path] + '/user/assignable/search'
-        query_params = {:project => self.key_value}
+        query_params = { project: self.key_value }
+        query_params['startAt'] = start_at if start_at
+        query_params['maxResults'] = max_results if max_results
         response = client.get(url_with_query_params(users_url, query_params))
         json = self.class.parse_json(response.body)
         json.map do |jira_user|

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/spec/jira/resource/createmeta_spec.rb

@@ -13,7 +13,7 @@ describe JIRA::Resource::Createmeta do
   let(:response) {
     double(
       'response',
-      :body => '{"expand":"projects","projects":[{"self":"http://localhost:2029/rest/api/2/project/TST"}]}'
+      :body => '{"expand":"projects","projects":[{"self":"http://localhost:2029/rest/api/2/project/TST","id":"10200","key":"test_key","name":"Test Name"}]}'
     )
   }
 
@@ -33,9 +33,17 @@ describe JIRA::Resource::Createmeta do
       JIRA::Resource::Createmeta.all(client, :foo => 'bar')
     end
 
+    it 'should return an array of createmeta objects' do
+      expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta').and_return(response)
+      createmetas = JIRA::Resource::Createmeta.all(client)
+      expect(createmetas).to be_an Array
+      createmeta = createmetas.first
+      expect(createmeta.id).to eq '10200'
+      expect(createmeta.key).to eq 'test_key'
+      expect(createmeta.name).to eq 'Test Name'
+    end
   end
 
-
   describe 'projectKeys' do
     it 'should query correct url when only one `projectKeys` given as string' do
       expect(client).to receive(:get).with('/jira/rest/api/2/issue/createmeta?projectKeys=PROJECT_1').and_return(response)
@@ -250,4 +258,4 @@ describe JIRA::Resource::Createmeta do
       )
     end
   end
-end
+end

data/spec/jira/resource/project_spec.rb

@@ -67,4 +67,57 @@ describe JIRA::Resource::Project do
       end
     end
   end
+
+  describe 'users' do
+    let(:project) { JIRA::Resource::Project.new(client, attrs: { 'key' => project_key }) }
+    let(:project_key) { SecureRandom.hex }
+    let(:response) { double('response', body: '[{}]') }
+
+    context 'pagination' do
+      before(:each) do
+        user_factory = double('user factory')
+        expect(client).to receive(:User).and_return(user_factory)
+        expect(user_factory).to receive(:build).with(any_args)
+      end
+
+      it 'doesn\'t use pagination parameters by default' do
+        expect(client).to receive(:get)
+          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}")
+          .and_return(response)
+
+        project.users
+      end
+
+      it 'accepts start_at option' do
+        start_at = rand(1000)
+
+        expect(client).to receive(:get)
+          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}&startAt=#{start_at}")
+          .and_return(response)
+
+        project.users(start_at: start_at)
+      end
+
+      it 'accepts max_results option' do
+        max_results = rand(1000)
+
+        expect(client).to receive(:get)
+          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}&maxResults=#{max_results}")
+          .and_return(response)
+
+        project.users(max_results: max_results)
+      end
+
+      it 'accepts start_at and max_results options' do
+        start_at = rand(1000)
+        max_results = rand(1000)
+
+        expect(client).to receive(:get)
+          .with("/jira/rest/api/2/user/assignable/search?project=#{project_key}&startAt=#{start_at}&maxResults=#{max_results}")
+          .and_return(response)
+
+        project.users(start_at: start_at, max_results: max_results)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - SUMO Heavy Industries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -185,6 +185,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -341,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jira-ruby
-rubygems_version: 2.6.4
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for use with the Atlassian JIRA REST API