jira-ruby 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8705a4ea4d0393dbb5868ad95f420a45f58cea68
-  data.tar.gz: c8abf36c5a0a0d7cf4b2bd7f592d8cc5b32b7f64
+SHA256:
+  metadata.gz: 5433f708b438c961d0ca07b8aa60ae7733382aecb7374d4cc3ea3af1947f0e7f
+  data.tar.gz: d6757f05e80e8c005ad0f20461fac98d5509f87f0e0bebaea025e43e7d180d3e
 SHA512:
-  metadata.gz: 65f8792ced5b13ce0d3c2e629d7600ce1802cf1479c99f2aed61fc782748819482ef3a45e19affeebff6e23c9d57a8078f86901a8d43e557ba528c05644b052f
-  data.tar.gz: 72c988b648ae5a272a93b9cb4e655e90cadc4643fb2f6d51329d2dbd7d343d82599fbde0782d7100b58555923b9313a6edbb9a3419bf68a31f30e1f1eaf20d6a
+  metadata.gz: 25f924c28544baf800585f9243d6d29622b0facab654aa03cf620bf76e4133731334b649c6af725fb0f246c68e3f5aa17bd8623eba5c2dd66303d2f2b2766dd2
+  data.tar.gz: b15c6540010df98f03acd562a50520dd90705bfa58cb2815070bc0ba3a535aea00d092c61a0f58bd3e3f23345c8ee48cf14e5d602fe324c3f7197b408d64e252

data/Gemfile

@@ -1,8 +1,14 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 group :development do
+  gem 'guard'
+  gem 'guard-rspec'
   gem 'wdm', '>= 0.1.0' if Gem.win_platform?
 end
 
+group :development, :test do
+  gem 'pry' # this was in the original Gemfile - but only needed in development & test
+end
+
 # Specify your gem's dependencies in jira_api.gemspec
 gemspec

data/Guardfile

@@ -6,7 +6,7 @@ guard 'rspec', cmd: 'bundle exec rspec --color --format doc' do
   watch(%r{^lib/(.+).rb$}) do |m|
     "spec/#{m[1]}_spec.rb"
   end
- 
+
   # watch /spec/ files
   watch(%r{^spec/(.+).rb$}) do |m|
     "spec/#{m[1]}.rb"

data/Rakefile

@@ -6,25 +6,24 @@ require 'rdoc/task'
 
 Dir.glob('lib/tasks/*.rake').each { |r| import r }
 
-task :default => [:test]
+task default: [:test]
 
-task :test => [:prepare, :spec]
+task test: %i[prepare spec]
 
 desc 'Prepare and run rspec tests'
 task :prepare do
   rsa_key = File.expand_path('rsakey.pem')
-  unless File.exists?(rsa_key)
+  unless File.exist?(rsa_key)
     raise 'rsakey.pem does not exist, tests will fail.  Run `rake jira:generate_public_cert` first'
   end
 end
 
 desc 'Run RSpec tests'
-#RSpec::Core::RakeTask.new(:spec)
+# RSpec::Core::RakeTask.new(:spec)
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ['--color', '--format', 'doc']
 end
 
-
 Rake::RDocTask.new(:doc) do |rd|
   rd.main       = 'README.rdoc'
   rd.rdoc_dir   = 'doc'

data/http-basic-example.rb

@@ -2,29 +2,30 @@ require 'rubygems'
 require 'pp'
 require 'jira-ruby'
 
-if ARGV.length == 0
+if ARGV.empty?
   # If not passed any command line arguments, prompt the
   # user for the username and password.
-  puts "Enter the username: "
+  puts 'Enter the username: '
   username = gets.strip
 
-  puts "Enter the password: "
+  puts 'Enter the password: '
   password = gets.strip
 elsif ARGV.length == 2
-  username, password = ARGV[0], ARGV[1]
+  username = ARGV[0]
+  password = ARGV[1]
 else
   # Script must be passed 0 or 2 arguments
-  raise "Usage: #{$0} [ username password ]"
+  raise "Usage: #{$PROGRAM_NAME} [ username password ]"
 end
 
 options = {
-            :username => username,
-            :password => password,
-            :site     => 'http://localhost:8080/',
-            :context_path => '',
-            :auth_type => :basic,
-            :use_ssl => false
-          }
+  username: username,
+  password: password,
+  site: 'http://localhost:8080/',
+  context_path: '',
+  auth_type: :basic,
+  use_ssl: false
+}
 
 client = JIRA::Client.new(options)
 

data/jira-ruby.gemspec

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'jira/version'
 
 Gem::Specification.new do |s|
@@ -7,8 +6,8 @@ Gem::Specification.new do |s|
   s.version     = JIRA::VERSION
   s.authors     = ['SUMO Heavy Industries', 'test IO']
   s.homepage    = 'http://www.sumoheavy.com'
-  s.summary     = %q{Ruby Gem for use with the Atlassian JIRA REST API}
-  s.description = %q{API for JIRA}
+  s.summary     = 'Ruby Gem for use with the Atlassian JIRA REST API'
+  s.description = 'API for JIRA'
   s.licenses    = ['MIT']
   s.metadata    = { 'source_code_uri' => 'https://github.com/sumoheavy/jira-ruby' }
 
@@ -18,20 +17,20 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
   # Runtime Dependencies
-  s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'multipart-post'
+  s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
 
   # Development Dependencies
-  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'
   s.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
   s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.5'
   s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
+  s.add_development_dependency 'railties'
+  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  s.add_development_dependency 'webmock', '~> 1.18', '>= 1.18.0'
 end

data/lib/jira-ruby.rb

@@ -1,4 +1,4 @@
-$: << File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH << __dir__
 
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
@@ -26,6 +26,8 @@ require 'jira/resource/applinks'
 require 'jira/resource/issuelinktype'
 require 'jira/resource/issuelink'
 require 'jira/resource/remotelink'
+require 'jira/resource/sprint'
+require 'jira/resource/sprint_report'
 require 'jira/resource/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
@@ -35,7 +37,8 @@ require 'jira/resource/serverinfo'
 require 'jira/resource/createmeta'
 require 'jira/resource/webhook'
 require 'jira/resource/agile'
-require 'jira/resource/sprint'
+require 'jira/resource/board'
+
 require 'jira/request_client'
 require 'jira/oauth_client'
 require 'jira/http_client'

data/lib/jira/base.rb

@@ -3,7 +3,6 @@ require 'active_support/inflector'
 require 'set'
 
 module JIRA
-
   # This class provides the basic object <-> REST mapping for all JIRA::Resource subclasses,
   # i.e. the Create, Retrieve, Update, Delete lifecycle methods.
   #
@@ -51,8 +50,8 @@ module JIRA
   #   new_comment = issue.comments.build
   #
   class Base
-    QUERY_PARAMS_FOR_SINGLE_FETCH = Set.new [:expand, :fields]
-    QUERY_PARAMS_FOR_SEARCH = Set.new [:expand, :fields, :startAt, :maxResults]
+    QUERY_PARAMS_FOR_SINGLE_FETCH = Set.new %i[expand fields]
+    QUERY_PARAMS_FOR_SEARCH = Set.new %i[expand fields startAt maxResults]
 
     # A reference to the JIRA::Client used to initialize this resource.
     attr_reader :client
@@ -67,8 +66,8 @@ module JIRA
     # representation of the JSON returned from the JIRA API
     attr_accessor :attrs
 
-    alias :expanded? :expanded
-    alias :deleted? :deleted
+    alias expanded? expanded
+    alias deleted? deleted
 
     def initialize(client, options = {})
       @client   = client
@@ -80,12 +79,12 @@ module JIRA
       # each of them must be passed in to the initializer.
       self.class.belongs_to_relationships.each do |relation|
         if options[relation]
-          instance_variable_set("@#{relation.to_s}", options[relation])
-          instance_variable_set("@#{relation.to_s}_id", options[relation].key_value)
+          instance_variable_set("@#{relation}", options[relation])
+          instance_variable_set("@#{relation}_id", options[relation].key_value)
         elsif options["#{relation}_id".to_sym]
-          instance_variable_set("@#{relation.to_s}_id", options["#{relation}_id".to_sym])
+          instance_variable_set("@#{relation}_id", options["#{relation}_id".to_sym])
         else
-          raise ArgumentError.new("Required option #{relation.inspect} missing") unless options[relation]
+          raise ArgumentError, "Required option #{relation.inspect} missing" unless options[relation]
         end
       end
     end
@@ -95,17 +94,15 @@ module JIRA
     def self.all(client, options = {})
       response = client.get(collection_path(client))
       json = parse_json(response.body)
-      if collection_attributes_are_nested
-        json = json[endpoint_name.pluralize]
-      end
+      json = json[endpoint_name.pluralize] if collection_attributes_are_nested
       json.map do |attrs|
-        self.new(client, {:attrs => attrs}.merge(options))
+        new(client, { attrs: attrs }.merge(options))
       end
     end
 
     # Finds and retrieves a resource with the given ID.
     def self.find(client, key, options = {})
-      instance = self.new(client, options)
+      instance = new(client, options)
       instance.attrs[key_attribute.to_s] = key
       instance.fetch(false, query_params_for_single_fetch(options))
       instance
@@ -114,7 +111,7 @@ module JIRA
     # Builds a new instance of the resource with the given attributes.
     # These attributes will be posted to the JIRA Api if save is called.
     def self.build(client, attrs)
-      self.new(client, :attrs => attrs)
+      new(client, attrs: attrs)
     end
 
     # Returns the name of this resource for use in URL components.
@@ -122,7 +119,7 @@ module JIRA
     #   JIRA::Resource::Issue.endpoint_name
     #     # => issue
     def self.endpoint_name
-      self.name.split('::').last.downcase
+      name.split('::').last.downcase
     end
 
     # Returns the full path for a collection of this resource.
@@ -130,7 +127,7 @@ module JIRA
     #   JIRA::Resource::Issue.collection_path
     #     # => /jira/rest/api/2/issue
     def self.collection_path(client, prefix = '/')
-      client.options[:rest_base_path] + prefix + self.endpoint_name
+      client.options[:rest_base_path] + prefix + endpoint_name
     end
 
     # Returns the singular path for the resource with the given key.
@@ -200,7 +197,7 @@ module JIRA
       define_method(resource) do
         attribute = maybe_nested_attribute(attribute_key, options[:nested_under])
         return nil unless attribute
-        child_class.new(client, :attrs => attribute)
+        child_class.new(client, attrs: attribute)
       end
     end
 
@@ -248,12 +245,12 @@ module JIRA
     def self.has_many(collection, options = {})
       attribute_key = options[:attribute_key] || collection.to_s
       child_class = options[:class] || ('JIRA::Resource::' + collection.to_s.classify).constantize
-      self_class_basename = self.name.split('::').last.downcase.to_sym
+      self_class_basename = name.split('::').last.downcase.to_sym
       define_method(collection) do
-        child_class_options = {self_class_basename => self}
+        child_class_options = { self_class_basename => self }
         attribute = maybe_nested_attribute(attribute_key, options[:nested_under]) || []
         collection = attribute.map do |child_attributes|
-          child_class.new(client, child_class_options.merge(:attrs => child_attributes))
+          child_class.new(client, child_class_options.merge(attrs: child_attributes))
         end
         HasManyProxy.new(self, child_class, collection)
       end
@@ -290,8 +287,8 @@ module JIRA
     # Checks if method_name is set in the attributes hash
     # and returns true when found, otherwise proxies the
     # call to the superclass.
-    def respond_to?(method_name, include_all=false)
-      if attrs.keys.include? method_name.to_s
+    def respond_to?(method_name, _include_all = false)
+      if attrs.key?(method_name.to_s)
         true
       else
         super(method_name)
@@ -301,8 +298,8 @@ module JIRA
     # Overrides method_missing to check the attribute hash
     # for resources matching method_name and proxies the call
     # to the superclass if no match is found.
-    def method_missing(method_name, *args, &block)
-      if attrs.keys.include? method_name.to_s
+    def method_missing(method_name, *_args)
+      if attrs.key?(method_name.to_s)
         attrs[method_name.to_s]
       else
         super(method_name)
@@ -315,7 +312,7 @@ module JIRA
       @attrs[self.class.key_attribute.to_s]
     end
 
-    def collection_path(prefix = "/")
+    def collection_path(prefix = '/')
       # Just proxy this to the class method
       self.class.collection_path(client, prefix)
     end
@@ -325,9 +322,7 @@ module JIRA
     # issue it returns '/issue'
     def path_component
       path_component = "/#{self.class.endpoint_name}"
-      if key_value
-        path_component += '/' + key_value
-      end
+      path_component += '/' + key_value if key_value
       path_component
     end
 
@@ -346,9 +341,10 @@ module JIRA
     #
     # Accepts an attributes hash of the values to be saved.  Will throw a
     # JIRA::HTTPError if the request fails (response is not HTTP 2xx).
-    def save!(attrs)
+    def save!(attrs, path = nil)
+      path ||= new_record? ? url : patched_url
       http_method = new_record? ? :post : :put
-      response = client.send(http_method, new_record? ? url : patched_url, attrs.to_json)
+      response = client.send(http_method, path, attrs.to_json)
       set_attrs(attrs, false)
       set_attrs_from_response(response)
       @expanded = false
@@ -360,19 +356,18 @@ module JIRA
     #
     # Accepts an attributes hash of the values to be saved. Will return false
     # if the request fails.
-    def save(attrs)
+    def save(attrs, path = url)
       begin
-        save_status = save!(attrs)
+        save_status = save!(attrs, path)
       rescue JIRA::HTTPError => exception
         begin
           set_attrs_from_response(exception.response) # Merge error status generated by JIRA REST API
         rescue JSON::ParserError => parse_exception
-          set_attrs("exception" => {
-                        "class" => exception.response.class.name,
-                        "code" => exception.response.code,
-                        "message" => exception.response.message
-                    }
-          )
+          set_attrs('exception' => {
+                      'class' => exception.response.class.name,
+                      'code' => exception.response.code,
+                      'message' => exception.response.message
+                    })
         end
         # raise exception
         save_status = false
@@ -383,7 +378,7 @@ module JIRA
     # Sets the attributes hash from a HTTPResponse object from JIRA if it is
     # not nil or is not a json response.
     def set_attrs_from_response(response)
-      unless response.body.nil? or response.body.length < 2
+      unless response.body.nil? || (response.body.length < 2)
         json = self.class.parse_json(response.body)
         set_attrs(json)
       end
@@ -393,7 +388,7 @@ module JIRA
     # hash values will be clobbered by the new hash, otherwise the hash will
     # be deeply merged into attrs.  The target paramater is for internal use only
     # and should not be used.
-    def set_attrs(hash, clobber=true, target = nil)
+    def set_attrs(hash, clobber = true, target = nil)
       target ||= @attrs
       if clobber
         target.merge!(hash)
@@ -424,7 +419,7 @@ module JIRA
       prefix = '/'
       unless self.class.belongs_to_relationships.empty?
         prefix = self.class.belongs_to_relationships.inject(prefix) do |prefix_so_far, relationship|
-          prefix_so_far.to_s + relationship.to_s + "/" + self.send("#{relationship.to_s}_id").to_s + '/'
+          prefix_so_far.to_s + relationship.to_s + '/' + send("#{relationship}_id").to_s + '/'
         end
       end
       if @attrs['self']
@@ -494,9 +489,15 @@ module JIRA
     end
 
     def url_with_query_params(url, query_params)
-      uri = URI.parse(url)
-      uri.query = uri.query.nil? ? "#{hash_to_query_string query_params}" : "#{uri.query}&#{hash_to_query_string query_params}" unless query_params.empty?
-      uri.to_s
+      self.class.url_with_query_params(url, query_params)
+    end
+
+    def self.url_with_query_params(url, query_params)
+      if !query_params.empty?
+        "#{url}?#{hash_to_query_string query_params}"
+      else
+        url
+      end
     end
 
     def hash_to_query_string(query_params)
@@ -504,19 +505,19 @@ module JIRA
     end
 
     def self.hash_to_query_string(query_params)
-      query_params.map do |k,v|
+      query_params.map do |k, v|
         CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
       end.join('&')
     end
 
     def self.query_params_for_single_fetch(options)
-      Hash[options.select do |k,v|
+      Hash[options.select do |k, _v|
         QUERY_PARAMS_FOR_SINGLE_FETCH.include? k
       end]
     end
 
     def self.query_params_for_search(options)
-      Hash[options.select do |k,v|
+      Hash[options.select do |k, _v|
         QUERY_PARAMS_FOR_SEARCH.include? k
       end]
     end

data/lib/jira/base_factory.rb

@@ -1,8 +1,6 @@
 module JIRA
-
   # This is the base class for all the JIRA resource factory instances.
   class BaseFactory
-
     attr_reader :client
 
     def initialize(client)
@@ -41,9 +39,8 @@ module JIRA
     delegate_to_target_class :all, :find, :collection_path, :singular_path, :jql, :get_backlog_issues, :get_board_issues, :get_sprints, :get_sprint_issues, :get_projects, :get_projects_full
 
     # This method needs special handling as it has a default argument value
-    def build(attrs={})
+    def build(attrs = {})
       target_class.build(@client, attrs)
     end
-
   end
 end