jira-ruby 1.5.0 → 1.6.0

data/lib/jira/client.rb

@@ -3,7 +3,6 @@ require 'forwardable'
 require 'ostruct'
 
 module JIRA
-
   # This class is the main access point for all JIRA::Resource instances.
   #
   # The client must be initialized with an options hash containing
@@ -32,7 +31,6 @@ module JIRA
   # objects.
 
   class Client
-
     extend Forwardable
 
     # The OAuth::Consumer instance returned by the OauthClient
@@ -47,17 +45,17 @@ module JIRA
     def_delegators :@request_client, :init_access_token, :set_access_token, :set_request_token, :request_token, :access_token, :authenticated?
 
     DEFAULT_OPTIONS = {
-      :site               => 'http://localhost:2990',
-      :context_path       => '/jira',
-      :rest_base_path     => "/rest/api/2",
-      :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
-      :use_ssl            => true,
-      :use_client_cert    => false,
-      :auth_type          => :oauth,
-      :http_debug         => false
-    }
-
-    def initialize(options={})
+      site: 'http://localhost:2990',
+      context_path: '/jira',
+      rest_base_path: '/rest/api/2',
+      ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,
+      use_ssl: true,
+      use_client_cert: false,
+      auth_type: :oauth,
+      http_debug: false
+    }.freeze
+
+    def initialize(options = {})
       options = DEFAULT_OPTIONS.merge(options)
       @options = options
       @options[:rest_base_path] = @options[:context_path] + @options[:rest_base_path]
@@ -153,10 +151,22 @@ module JIRA
       JIRA::Resource::FieldFactory.new(self)
     end
 
+    def Board
+      JIRA::Resource::BoardFactory.new(self)
+    end
+
     def RapidView
       JIRA::Resource::RapidViewFactory.new(self)
     end
 
+    def Sprint
+      JIRA::Resource::SprintFactory.new(self)
+    end
+
+    def SprintReport
+      JIRA::Resource::SprintReportFactory.new(self)
+    end
+
     def ServerInfo
       JIRA::Resource::ServerInfoFactory.new(self)
     end
@@ -212,27 +222,26 @@ module JIRA
 
     # HTTP methods with a body
     def post(path, body = '', headers = {})
-      headers = {'Content-Type' => 'application/json'}.merge(headers)
+      headers = { 'Content-Type' => 'application/json' }.merge(headers)
       request(:post, path, body, merge_default_headers(headers))
     end
 
     def put(path, body = '', headers = {})
-      headers = {'Content-Type' => 'application/json'}.merge(headers)
+      headers = { 'Content-Type' => 'application/json' }.merge(headers)
       request(:put, path, body, merge_default_headers(headers))
     end
 
     # Sends the specified HTTP request to the REST API through the
     # appropriate method (oauth, basic).
-    def request(http_method, path, body = '', headers={})
+    def request(http_method, path, body = '', headers = {})
       puts "#{http_method}: #{path} - [#{body}]" if @http_debug
       @request_client.request(http_method, path, body, headers)
     end
 
     protected
 
-      def merge_default_headers(headers)
-        {'Accept' => 'application/json'}.merge(headers)
-      end
-
+    def merge_default_headers(headers)
+      { 'Accept' => 'application/json' }.merge(headers)
+    end
   end
 end

data/lib/jira/has_many_proxy.rb

@@ -7,7 +7,6 @@
 # In practice, instances of this class behave exactly like an Array.
 #
 class JIRA::HasManyProxy
-
   attr_reader :target_class, :parent
   attr_accessor :collection
 

data/lib/jira/http_client.rb

@@ -5,11 +5,10 @@ require 'uri'
 
 module JIRA
   class HttpClient < RequestClient
-
     DEFAULT_OPTIONS = {
-      :username           => '',
-      :password           => ''
-    }
+      username: '',
+      password: ''
+    }.freeze
 
     attr_reader :options
 
@@ -19,13 +18,13 @@ module JIRA
     end
 
     def make_cookie_auth_request
-      body = { :username => @options[:username], :password => @options[:password] }.to_json
+      body = { username: @options[:username], password: @options[:password] }.to_json
       @options.delete(:username)
       @options.delete(:password)
-      make_request(:post, @options[:context_path] + '/rest/auth/1/session', body, {'Content-Type' => 'application/json'})
+      make_request(:post, @options[:context_path] + '/rest/auth/1/session', body, 'Content-Type' => 'application/json')
     end
 
-    def make_request(http_method, url, body='', headers={})
+    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)
       request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
@@ -44,9 +43,9 @@ module JIRA
 
     def http_conn(uri)
       if @options[:proxy_address]
-          http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] ? @options[:proxy_port] : 80)
+        http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] || 80)
       else
-          http_class = Net::HTTP
+        http_class = Net::HTTP
       end
       http_conn = http_class.new(uri.host, uri.port)
       http_conn.use_ssl = @options[:use_ssl]
@@ -90,7 +89,7 @@ module JIRA
 
     def add_cookies(request)
       cookie_array = @cookies.values.map { |cookie| "#{cookie.name}=#{cookie.value[0]}" }
-      cookie_array +=  Array(@options[:additional_cookies]) if @options.key?(:additional_cookies)
+      cookie_array += Array(@options[:additional_cookies]) if @options.key?(:additional_cookies)
       request.add_field('Cookie', cookie_array.join('; ')) if cookie_array.any?
       request
     end

data/lib/jira/http_error.rb

@@ -1,16 +1,14 @@
 require 'forwardable'
 module JIRA
-
   class HTTPError < StandardError
     extend Forwardable
 
-    def_instance_delegators :@response, :message, :code
-    attr_reader :response
+    def_instance_delegators :@response, :code
+    attr_reader :response, :message
 
     def initialize(response)
       @response = response
+      @message = response.try(:message) || response.try(:body)
     end
-
   end
-
 end

data/lib/jira/oauth_client.rb

@@ -4,22 +4,21 @@ require 'forwardable'
 
 module JIRA
   class OauthClient < RequestClient
-
     DEFAULT_OPTIONS = {
-      :signature_method   => 'RSA-SHA1',
-      :request_token_path => "/plugins/servlet/oauth/request-token",
-      :authorize_path     => "/plugins/servlet/oauth/authorize",
-      :access_token_path  => "/plugins/servlet/oauth/access-token",
-      :private_key_file   => "rsakey.pem",
-      :consumer_key       => nil,
-      :consumer_secret    => nil
-    }
+      signature_method: 'RSA-SHA1',
+      request_token_path: '/plugins/servlet/oauth/request-token',
+      authorize_path: '/plugins/servlet/oauth/authorize',
+      access_token_path: '/plugins/servlet/oauth/access-token',
+      private_key_file: 'rsakey.pem',
+      consumer_key: nil,
+      consumer_secret: nil
+    }.freeze
 
     # This exception is thrown when the client is used before the OAuth access token
     # has been initialized.
     class UninitializedAccessTokenError < StandardError
       def message
-        "init_access_token must be called before using the client"
+        'init_access_token must be called before using the client'
       end
     end
 
@@ -35,11 +34,11 @@ module JIRA
       @consumer = init_oauth_consumer(@options)
     end
 
-    def init_oauth_consumer(options)
+    def init_oauth_consumer(_options)
       @options[:request_token_path] = @options[:context_path] + @options[:request_token_path]
       @options[:authorize_path] = @options[:context_path] + @options[:authorize_path]
       @options[:access_token_path] = @options[:context_path] + @options[:access_token_path]
-      OAuth::Consumer.new(@options[:consumer_key],@options[:consumer_secret],@options)
+      OAuth::Consumer.new(@options[:consumer_key], @options[:consumer_secret], @options)
     end
 
     # Returns the current request token if it is set, else it creates
@@ -69,20 +68,20 @@ module JIRA
     # Returns the current access token. Raises an
     # JIRA::Client::UninitializedAccessTokenError exception if it is not set.
     def access_token
-      raise UninitializedAccessTokenError.new unless @access_token
+      raise UninitializedAccessTokenError unless @access_token
       @access_token
     end
 
-    def make_request(http_method, path, body='', headers={})
+    def make_request(http_method, path, body = '', headers = {})
       # When using oauth_2legged we need to add an empty oauth_token parameter to every request.
       if @options[:auth_type] == :oauth_2legged
-        oauth_params_str = "oauth_token="
+        oauth_params_str = 'oauth_token='
         uri = URI.parse(path)
-        if uri.query.to_s == ""
-          uri.query = oauth_params_str
-        else
-          uri.query = uri.query + "&" + oauth_params_str
-        end
+        uri.query = if uri.query.to_s == ''
+                      oauth_params_str
+                    else
+                      uri.query + '&' + oauth_params_str
+                    end
         path = uri.to_s
       end
 

data/lib/jira/request_client.rb

@@ -1,19 +1,18 @@
 require 'oauth'
 require 'json'
 require 'net/https'
-#require 'pry'
+# require 'pry'
 
 module JIRA
   class RequestClient
-
     # Returns the response if the request was successful (HTTP::2xx) and
     # raises a JIRA::HTTPError if it was not successful, with the response
     # attached.
 
     def request(*args)
       response = make_request(*args)
-      #binding.pry unless response.kind_of?(Net::HTTPSuccess)
-      raise HTTPError.new(response) unless response.kind_of?(Net::HTTPSuccess)
+      # binding.pry unless response.kind_of?(Net::HTTPSuccess)
+      raise HTTPError, response unless response.is_a?(Net::HTTPSuccess)
       response
     end
   end

data/lib/jira/resource/agile.rb

@@ -2,14 +2,16 @@ require 'cgi'
 
 module JIRA
   module Resource
-
     class AgileFactory < JIRA::BaseFactory # :nodoc:
     end
 
     class Agile < JIRA::Base
-
-      def self.all(client)
-        response = client.get(path_base(client) + '/board')
+      # @param client [JIRA::Client]
+      # @param options [Hash<Symbol, Object>]
+      # @return [Hash]
+      def self.all(client, options = {})
+        opts = options.empty? ? '' : "?#{hash_to_query_string(options)}"
+        response = client.get(path_base(client) + "/board#{opts}")
         parse_json(response.body)
       end
 
@@ -23,9 +25,10 @@ module JIRA
         response = client.get(path_base(client) + "/board/#{board_id}/issue?#{hash_to_query_string(options)}")
         json = parse_json(response.body)
         # To get Issue objects with the same structure as for Issue.all
-        issue_ids = json['issues'].map { |issue|
+        return {} if json['issues'].size.zero?
+        issue_ids = json['issues'].map do |issue|
           issue['id']
-        }
+        end
         client.Issue.jql("id IN(#{issue_ids.join(', ')})")
       end
 
@@ -41,7 +44,7 @@ module JIRA
         parse_json(response.body)
       end
 
-      def self.get_projects_full(client, board_id, options = {})
+      def self.get_projects_full(client, board_id, _options = {})
         response = client.get(path_base(client) + "/board/#{board_id}/project/full")
         parse_json(response.body)
       end
@@ -72,6 +75,5 @@ module JIRA
         self.class.path_base(client)
       end
     end
-
   end
 end

data/lib/jira/resource/applinks.rb

@@ -1,13 +1,11 @@
 module JIRA
   module Resource
-
     class ApplicationLinkFactory < JIRA::BaseFactory # :nodoc:
       delegate_to_target_class :manifest
     end
 
     class ApplicationLink < JIRA::Base
-
-      REST_BASE_PATH = '/rest/applinks/1.0'
+      REST_BASE_PATH = '/rest/applinks/1.0'.freeze
 
       def self.endpoint_name
         'listApplicationlinks'
@@ -18,7 +16,7 @@ module JIRA
       end
 
       def self.collection_path(client, prefix = '/')
-        self.full_url(client) + prefix + self.endpoint_name
+        full_url(client) + prefix + endpoint_name
       end
 
       def self.all(client, options = {})
@@ -26,17 +24,16 @@ module JIRA
         json = parse_json(response.body)
         json = json['list']
         json.map do |attrs|
-          self.new(client, {:attrs => attrs}.merge(options))
+          new(client, { attrs: attrs }.merge(options))
         end
       end
 
       def self.manifest(client)
-        url = self.full_url(client) + '/manifest'
+        url = full_url(client) + '/manifest'
         response = client.get(url)
         json = parse_json(response.body)
-        JIRA::Base.new(client, {:attrs => json})
+        JIRA::Base.new(client, attrs: json)
       end
-
     end
   end
 end

data/lib/jira/resource/attachment.rb

@@ -2,14 +2,13 @@ require 'net/http/post/multipart'
 
 module JIRA
   module Resource
-
     class AttachmentFactory < JIRA::BaseFactory # :nodoc:
       delegate_to_target_class :meta
     end
 
     class Attachment < JIRA::Base
       belongs_to :issue
-      has_one :author, :class => JIRA::Resource::User
+      has_one :author, class: JIRA::Resource::User
 
       def self.endpoint_name
         'attachments'

data/lib/jira/resource/board.rb

@@ -0,0 +1,84 @@
+require 'cgi'
+
+module JIRA
+  module Resource
+    class BoardFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Board < JIRA::Base
+      def self.all(client)
+        path = path_base(client) + '/board'
+        response = client.get(path)
+        json = parse_json(response.body)
+        results = json['values']
+
+        until json['isLast']
+          params = { 'startAt' => (json['startAt'] + json['maxResults']).to_s }
+          response = client.get(url_with_query_params(path, params))
+          json = parse_json(response.body)
+          results += json['values']
+        end
+
+        results.map do |board|
+          client.Board.build(board)
+        end
+      end
+
+      def self.find(client, key, _options = {})
+        response = client.get(path_base(client) + "/board/#{key}")
+        json = parse_json(response.body)
+        client.Board.build(json)
+      end
+
+      def issues(params = {})
+        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']
+
+        while (json['startAt'] + json['maxResults']) < json['total']
+          params['startAt'] = (json['startAt'] + json['maxResults'])
+          response = client.get(url_with_query_params(path, params))
+          json = self.class.parse_json(response.body)
+          results += json['issues']
+        end
+
+        results.map { |issue| client.Issue.build(issue) }
+      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)
+      #   - startAt ~ base index, starts at 0
+      def sprints(options = {})
+        # options.reverse_merge!(DEFAULT_OPTIONS)
+        response = client.get(path_base(client) + "/board/#{id}/sprint?#{options.to_query}")
+        json = self.class.parse_json(response.body)
+        json['values'].map do |sprint|
+          sprint['rapidview_id'] = id
+          client.Sprint.build(sprint)
+        end
+      end
+
+      def project
+        response = client.get(path_base(client) + "/board/#{id}/project")
+        json = self.class.parse_json(response.body)
+        json['values'][0]
+      end
+
+      def add_issue_to_backlog(issue)
+        client.post(path_base(client) + '/backlog/issue', { issues: [issue.id] }.to_json)
+      end
+
+      private
+
+      def self.path_base(client)
+        client.options[:context_path] + '/rest/agile/1.0'
+      end
+
+      def path_base(client)
+        self.class.path_base(client)
+      end
+    end
+  end
+end