github_api 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c509b47b9406a28c186ff6f1a0f9634b20a4ce35
-  data.tar.gz: c4a47665d1ab2f0170afd089cbf2b6e4612eb18e
+  metadata.gz: 7fe5afce457fa73fed135b79c28fc1083e1d0f9d
+  data.tar.gz: fc77be5cbda3f746328797d7e1b1e9de5c5fdafb
 SHA512:
-  metadata.gz: 5e20bca947fe37fc506743485b515e35dbcb7e6fddce356492549729055da1420a9a8f538f55bced926eed2d0bb60a0575e47f029eb974fbcd0903d5fb717768
-  data.tar.gz: 3cf563db4fe0944d9768ebb063e12b3b18d64797cc687e0fe53bf5c58b24cc70ed477db2840e3ca6968e936ce7211f6955f1f38967d224feb35f374a7ca1ab5f
+  metadata.gz: 6c37cb56444c0a0a02546eb7960bbfdfb18308afad58a31f32da34fdf103e99cb25a7de3dc127066dd199d45e52e7703b0fd2e1b56162d40b341d53bd7e22a22
+  data.tar.gz: 9f7a7b7daabd4ff6094e2cc222522f8ad19c3403f024c071deb7880f86fb171b5ea86b5f21e73f2d47c244f949a38e29de349e41b945a26335613f313ee70875

data/lib/github_api/error/client_error.rb

@@ -19,5 +19,69 @@ module Github #:nodoc
         "\nResolution:\n #{@resolution}"
       end
     end
+
+    # Raised when invalid options are passed to a request body
+    class InvalidOptions < ClientError
+      def initialize(invalid, valid)
+        super(
+          generate_message(
+            problem: "Invalid option #{invalid.keys.join(', ')} provided for this request.",
+            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            resolution: "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+
+    # Raised when invalid options are passed to a request body
+    class RequiredParams < ClientError
+      def initialize(provided, required)
+        super(
+          generate_message(
+            problem: "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
+            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            resolution: "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+
+    # Raised when invalid options are passed to a request body
+    class UnknownMedia < ClientError
+      def initialize(file)
+        super(
+          generate_message(
+            problem: "Unknown content type for: '#{file}' provided for this request.",
+            summary: "Github gem infers the content type of the resource by calling the mime-types gem type inference.",
+            resolution: "Please install mime-types gem to infer the resource content type."
+          )
+        )
+      end
+    end
+
+    # Raised when invalid options are passed to a request body
+    class UnknownValue < ClientError
+      def initialize(key, value, permitted)
+        super(
+          generate_message(
+            problem: "Wrong value of '#{value}' for the parameter: #{key} provided for this request.",
+            summary: "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and fails fast.",
+            resolution: "Permitted values are: #{permitted}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+
+    class Validations < ClientError
+      def initialize(errors)
+        super(
+          generate_message(
+            problem: "Attempted to send request with nil arguments for #{errors.keys.join(', ')}.",
+            summary: 'Each request expects certain number of required arguments.',
+            resolution: 'Double check that the provided arguments are set to some value that is neither nil nor empty string.'
+          )
+        )
+      end
+    end
   end # Error
 end # Github

data/lib/github_api/error/service_error.rb

@@ -6,56 +6,183 @@ module Github
   # Raised when GitHub returns any of the HTTP status codes
   module Error
     class ServiceError < GithubError
-      attr_reader :http_headers, :body, :status
+      # Add http status code method to error type
+      #
+      # @param [Integer] code
+      #   the status code
+      #
+      # @api public
+      def self.http_status_code(code)
+        define_method(:http_status_code) { code }
+      end
+
+      # A mapping of status codes and error types
+      #
+      # @return [Hash[Integer, Object]]
+      #
+      # @api public
+      def self.errors
+        @errors ||= Hash[
+          descendants.map { |klass| [klass.new({}).http_status_code, klass] }
+        ]
+      end
 
       MIN_BODY_LENGTH = 2
 
+      # Crate a ServiceError
+      #
+      # @param [Hash[Symbol]] response
+      #
+      # @api public
       def initialize(response)
-        @http_headers = response[:response_headers]
-        @body         = parse_body(response[:body])
-        @status       = response[:status]
+        @headers = response[:response_headers]
+        @body    = response[:body]
+        @status  = response[:status]
 
         super(create_message(response))
       end
 
+      private
+
+      # Create full error message
+      #
+      # @param [Hash[Symbol]] response
+      #   the http response
+      #
+      # @return [String]
+      #   the error message
+      #
+      # @api private
       def create_message(response)
-        "#{response[:method].to_s.upcase} #{response[:url]}: #{@status} #{@body}"
+        return if response.nil?
+
+        message = "#{response[:method].to_s.upcase} "
+        message << "#{response[:url]}: "
+        message << "#{@status} - #{parse_body(@body)}"
+        message
       end
 
-      def decode_body(body)
-        if body.respond_to?(:to_str) && body.length >= MIN_BODY_LENGTH
+      # Decode body information if in JSON format
+      #
+      # @param [String] body
+      #   the response body
+      #
+      # @api private
+      def decode_data(body)
+        if body.respond_to?(:to_str) &&
+           body.length >= MIN_BODY_LENGTH &&
+           @headers[:content_type] =~ /json/
+
           JSON.parse(body, symbolize_names: true)
         else
           body
         end
       end
 
+      # @api private
       def parse_body(body)
-        body = decode_body(body)
+        data = decode_data(body)
 
-        return '' if body.nil? || body.empty?
+        return '' if data.nil? || data.empty?
 
-        if body[:error]
-          body[:error]
-        elsif body[:errors]
-          error = Array(body[:errors]).first
-          error.is_a?(Hash) ? error[:message] : error
-        elsif body[:message]
-          body[:message]
-        else
-          ''
+        case data
+        when Hash
+          message = data[:message] ? data[:message] : ' '
+          docs = data[:documentation_url]
+          error = create_error_summary(data)
+          message << error if error
+          message << "\nSee: #{docs}" if docs
+          message
+        when String
+          data
         end
       end
 
-      def self.http_status_code(code)
-        define_method(:http_status_code) { code }
-      end
-
-      def self.errors
-        @errors ||= Hash[
-          descendants.map { |klass| [klass.new({}).http_status_code, klass] }
-        ]
+      # Create error summary from response body
+      #
+      # @return [String]
+      #
+      # @api private
+      def create_error_summary(data)
+        if data[:error]
+          return "\nError: #{data[:error]}"
+        elsif data[:errors]
+          message = "\nErrors:\n"
+          message << data[:errors].map do |error|
+            "Error: #{error.map { |k, v| "#{k}: #{v}" }.join(', ')}"
+          end.join("\n")
+        end
       end
     end # ServiceError
+
+    # Raised when Github returns the HTTP status code 400
+    class BadRequest < ServiceError
+      http_status_code 400
+    end
+
+    # Raised when GitHub returns the HTTP status code 401
+    class Unauthorized < ServiceError
+      http_status_code 401
+    end
+
+    # Raised when Github returns the HTTP status code 403
+    class Forbidden < ServiceError
+      http_status_code 403
+    end
+
+    # Raised when Github returns the HTTP status code 404
+    class NotFound < ServiceError
+      http_status_code 404
+    end
+
+    # Raised when Github returns the HTTP status code 405
+    class MethodNotAllowed < ServiceError
+      http_status_code 405
+    end
+
+    # Raised when Github returns the HTTP status code 406
+    class NotAcceptable < ServiceError
+      http_status_code 406
+    end
+
+    # Raised when GitHub returns the HTTP status code 409
+    class Conflict < ServiceError
+      http_status_code 409
+    end
+
+    # Raised when GitHub returns the HTTP status code 414
+    class UnsupportedMediaType < ServiceError
+      http_status_code 414
+    end
+
+    # Raised when GitHub returns the HTTP status code 422
+    class UnprocessableEntity < ServiceError
+      http_status_code 422
+    end
+
+    # Raised when GitHub returns the HTTP status code 451
+    class UnavailableForLegalReasons < ServiceError
+      http_status_code 451
+    end
+
+    # Raised when Github returns the HTTP status code 500
+    class InternalServerError < ServiceError
+      http_status_code 500
+    end
+
+    # Raised when Github returns the HTTP status code 501
+    class NotImplemented < ServiceError
+      http_status_code 501
+    end
+
+    # Raised when Github returns the HTTP status code 502
+    class BadGateway < ServiceError
+      http_status_code 502
+    end
+
+    # Raised when GitHub returns the HTTP status code 503
+    class ServiceUnavailable < ServiceError
+      http_status_code 503
+    end
   end # Error
 end # Github

data/lib/github_api/error.rb

@@ -23,15 +23,9 @@ module Github
       def backtrace
         @response_message ? @response_message.backtrace : super
       end
-
     end # GithubError
   end # Error
 end # Github
 
 require 'github_api/error/service_error'
 require 'github_api/error/client_error'
-Dir[File.dirname(__FILE__) + '/error/*.rb'].sort.each do |path|
-  filename = File.basename(path)
-  next if ['service_error.rb', 'client_error.rb'].include?(filename)
-  require "github_api/error/#{filename}"
-end

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.14.2"
+  VERSION = "0.14.3"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -62,16 +62,16 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: descendants_tracker
   requirement: !ruby/object:Gem::Requirement
@@ -204,21 +204,8 @@ files:
 - lib/github_api/core_ext/ordered_hash.rb
 - lib/github_api/deprecation.rb
 - lib/github_api/error.rb
-- lib/github_api/error/bad_request.rb
 - lib/github_api/error/client_error.rb
-- lib/github_api/error/forbidden.rb
-- lib/github_api/error/internal_server_error.rb
-- lib/github_api/error/invalid_options.rb
-- lib/github_api/error/not_acceptable.rb
-- lib/github_api/error/not_found.rb
-- lib/github_api/error/required_params.rb
 - lib/github_api/error/service_error.rb
-- lib/github_api/error/service_unavailable.rb
-- lib/github_api/error/unauthorized.rb
-- lib/github_api/error/unknown_media.rb
-- lib/github_api/error/unknown_value.rb
-- lib/github_api/error/unprocessable_entity.rb
-- lib/github_api/error/validations.rb
 - lib/github_api/ext/faraday.rb
 - lib/github_api/middleware.rb
 - lib/github_api/mime_type.rb

data/lib/github_api/error/bad_request.rb

@@ -1,14 +0,0 @@
-# encoding: utf-8
-
-module Github
-  module Error
-    # Raised when Github returns the HTTP status code 400
-    class BadRequest < ServiceError
-      http_status_code 400
-
-      def initialize(response)
-        super(response)
-      end
-    end
-  end
-end # Github

data/lib/github_api/error/forbidden.rb

@@ -1,14 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 403
-  module Error
-    class Forbidden < ServiceError
-      http_status_code 403
-
-      def initialize(response)
-        super(response)
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/internal_server_error.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 500
-  module Error
-    class InternalServerError < ServiceError
-      http_status_code 500
-
-      def initialize(response)
-        super(response)
-      end
-
-    end # InternalServerError
-  end # Error
-end # Github

data/lib/github_api/error/invalid_options.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when invalid options are passed to a request body
-  module Error
-    class InvalidOptions < ClientError
-      def initialize(invalid, valid)
-        super(
-          generate_message(
-            :problem => "Invalid option #{invalid.keys.join(', ')} provided for this request.", 
-            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
-            :resolution => "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
-          )
-        )
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/not_acceptable.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when GitHub returns the HTTP status code 406
-  module Error
-    class NotAcceptable < ServiceError
-      http_status_code 406
-
-      def initialize(response)
-        super(response)
-      end
-
-    end # NotAcceptable
-  end # Error
-end # Github

data/lib/github_api/error/not_found.rb

@@ -1,14 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 404
-  module Error
-    class NotFound < ServiceError
-      http_status_code 404
-
-      def initialize(env)
-        super(env)
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/required_params.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when invalid options are passed to a request body
-  module Error
-    class RequiredParams < ClientError
-      def initialize(provided, required)
-        super(
-          generate_message(
-            :problem => "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
-            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
-            :resolution => "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
-          )
-        )
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/service_unavailable.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 503
-  module Error
-    class ServiceUnavailable < ServiceError
-      http_status_code 503
-
-      def initialize(response)
-        super(response)
-      end
-
-    end # ServiceUnavailable
-  end # Error
-end # Github

data/lib/github_api/error/unauthorized.rb

@@ -1,15 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 401
-  module Error
-    class Unauthorized < ServiceError
-      http_status_code 401
-
-      def initialize(response)
-        super(response)
-      end
-
-    end # Unauthorized
-  end # Error
-end # Github

data/lib/github_api/error/unknown_media.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when invalid options are passed to a request body
-  module Error
-    class UnknownMedia < ClientError
-      def initialize(file)
-        super(
-          generate_message(
-            :problem => "Unknown content type for: '#{file}' provided for this request.",
-            :summary => "Github gem infers the content type of the resource by calling the mime-types gem type inference.",
-            :resolution => "Please install mime-types gem to infer the resource content type."
-          )
-        )
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/unknown_value.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when invalid options are passed to a request body
-  module Error
-    class UnknownValue < ClientError
-      def initialize(key, value, permitted)
-        super(
-          generate_message(
-            :problem => "Wrong value of '#{value}' for the parameter: #{key} provided for this request.",
-            :summary => "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and fails fast.",
-            :resolution => "Permitted values are: #{permitted}, make sure these are the ones you are using"
-          )
-        )
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/unprocessable_entity.rb

@@ -1,14 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when Github returns the HTTP status code 422
-  module Error
-    class UnprocessableEntity < ServiceError
-      http_status_code 422
-
-      def initialize(response)
-        super(response)
-      end
-    end
-  end # Error
-end # Github

data/lib/github_api/error/validations.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-module Github #:nodoc
-  # Raised when passed parameters are missing or contain wrong values.
-  module Error
-    class Validations < ClientError
-      def initialize(errors)
-        super(
-          generate_message(
-            :problem => "Attempted to send request with nil arguments for #{errors.keys.join(', ')}.",
-            :summary => 'Each request expects certain number of required arguments.',
-            :resolution => 'Double check that the provided arguments are set to some value that is neither nil nor empty string.'
-          )
-        )
-      end
-    end
-  end # Error
-end # Github