github_api 0.14.3 → 0.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fe5afce457fa73fed135b79c28fc1083e1d0f9d
-  data.tar.gz: fc77be5cbda3f746328797d7e1b1e9de5c5fdafb
+  metadata.gz: 4c2d3c322449a1a15a1f353db2b5c97a018d2967
+  data.tar.gz: e06e3b114460915e78d86c8a8156cd5289502329
 SHA512:
-  metadata.gz: 6c37cb56444c0a0a02546eb7960bbfdfb18308afad58a31f32da34fdf103e99cb25a7de3dc127066dd199d45e52e7703b0fd2e1b56162d40b341d53bd7e22a22
-  data.tar.gz: 9f7a7b7daabd4ff6094e2cc222522f8ad19c3403f024c071deb7880f86fb171b5ea86b5f21e73f2d47c244f949a38e29de349e41b945a26335613f313ee70875
+  metadata.gz: 6e08c74ed99c5a5120c69f900bfe7cf6ce1d7ead14a2c60ffc6fdc79bd21ec52c47fc95461f9b0d1bfb4f8fae419020d300838f7dadc70d8785dc870fd844c4a
+  data.tar.gz: e525db532cc637908073c49fadd7c4c102c0810f3eb949117fa2c863997b3b40c778a1ed8d58a4b2d385bae3c5d0717547b45f8d4efa62aa9803b9b5f6c4d385

data/README.md

@@ -77,6 +77,10 @@ gem "github_api"
 * [4. Pagination](#4-pagination)
   * [4.1 Auto pagination](#41-auto-pagination)
 * [5. Error Handling](#5-error-handling)
+  * [5.1 Client Error](#51-client-error)
+  * [5.2 Service Error](#52-service-error)
+    * [5.2.1 Data](#521-data)
+    * [5.2.2 Error Messages](#522-error-messages)
 * [6. Examples](#6-examples)
   * [6.1 Rails](#61-rails)
   * [6.2 Manipulating Files](#62-manipulating-files)
@@ -582,14 +586,15 @@ Github::Client::Repos.new.list user: '...', auto_pagination: true
 
 ## 5 Error Handling
 
-The generic error class `Github::Error::GithubError` will handle both the client (`Github::Error::ClientError`) and service (`Github::Error::ServiceError`) side errors. For instance in your code you can catch errors like
+The generic error class `Github::Error::GithubError` will handle both the client (`Github::Error::ClientError`) and service (`Github::Error::ServiceError`) side errors.
+
+For instance in your code you can catch errors like
 
 ```ruby
 begin
   # Do something with github_api gem
 rescue Github::Error::GithubError => e
   puts e.message
-
   if e.is_a? Github::Error::ServiceError
     # handle GitHub service errors such as 404
   elsif e.is_a? Github::Error::ClientError
@@ -598,6 +603,24 @@ rescue Github::Error::GithubError => e
 end
 ```
 
+### 5.1 Client Error
+
+Any time **Github** client has a problem sending request a `Github::Error::ClientError` is raised that will provide a summary of the problem and possible solutions.
+
+### 5.2 Service Error
+
+When the **Github** client receives a HTTP response from GitHub service that indicates error then `Github::Error::ServiceError` is raised.
+
+There are number of specific error types such as `Github::Error::NotAcceptable` when `406` status code is returned.
+
+#### 5.2.1 Data
+
+When `Github::Error::ServiceError` is raised you can call `data` to access it payload in JSON format.
+
+#### 5.2.2 Error messages
+
+Anytime there are error messages provided with `Github::Error::ServiceError` you can access them by calling `error_messages` helper.
+
 ## 6 Examples
 
 ### 6.1 Rails

data/lib/github_api/error.rb

@@ -11,7 +11,7 @@ module Github
 
       # Initialize a new Github error object.
       #
-      def initialize(message=$!)
+      def initialize(message = $!)
         if message.respond_to?(:backtrace)
           super(message.message)
           @response_message = message
@@ -21,7 +21,11 @@ module Github
       end
 
       def backtrace
-        @response_message ? @response_message.backtrace : super
+        if @response_message && @response_message.respond_to?(:backtrace)
+          @response_message.backtrace
+        else
+          super
+        end
       end
     end # GithubError
   end # Error

data/lib/github_api/error/service_error.rb

@@ -21,9 +21,11 @@ module Github
       # @return [Hash[Integer, Object]]
       #
       # @api public
-      def self.errors
-        @errors ||= Hash[
-          descendants.map { |klass| [klass.new({}).http_status_code, klass] }
+      def self.error_mapping
+        @error_mapping ||= Hash[
+          descendants.map do |klass|
+            [klass.new({}).http_status_code, klass]
+          end
         ]
       end
 
@@ -39,9 +41,33 @@ module Github
         @body    = response[:body]
         @status  = response[:status]
 
+        @response_headers = @headers
+        @response_message = @body
+
         super(create_message(response))
       end
 
+      # Expose response payload as JSON object if possible
+      #
+      # @return [Hash[Symbol]|String]
+      #
+      # @api public
+      def data
+        @data ||= decode_data(@body)
+      end
+
+      # Stores error message(s) returned in response body
+      #
+      # @return [Array[Hash[Symbol]]]
+      #   the array of hash error objects
+      #
+      # @api public
+      def error_messages
+        @error_messages ||= begin
+          data[:errors] ? data[:errors] : [data]
+        end
+      end
+
       private
 
       # Create full error message
@@ -58,7 +84,7 @@ module Github
 
         message = "#{response[:method].to_s.upcase} "
         message << "#{response[:url]}: "
-        message << "#{@status} - #{parse_body(@body)}"
+        message << "#{@status} - #{format_response}"
         message
       end
 
@@ -79,17 +105,19 @@ module Github
         end
       end
 
+      # Read response body and convert to human friendly format
+      #
+      # @return [String]
+      #
       # @api private
-      def parse_body(body)
-        data = decode_data(body)
-
+      def format_response
         return '' if data.nil? || data.empty?
 
         case data
         when Hash
           message = data[:message] ? data[:message] : ' '
           docs = data[:documentation_url]
-          error = create_error_summary(data)
+          error = create_error_summary
           message << error if error
           message << "\nSee: #{docs}" if docs
           message
@@ -103,9 +131,9 @@ module Github
       # @return [String]
       #
       # @api private
-      def create_error_summary(data)
+      def create_error_summary
         if data[:error]
-          return "\nError: #{data[:error]}"
+          "\nError: #{data[:error]}"
         elsif data[:errors]
           message = "\nErrors:\n"
           message << data[:errors].map do |error|

data/lib/github_api/response/raise_error.rb

@@ -5,14 +5,17 @@ require 'github_api/error'
 
 module Github
   class Response::RaiseError < Faraday::Response::Middleware
-
+    # Check if status code requires raising a ServiceError
+    #
+    # @api private
     def on_complete(env)
       status_code   = env[:status].to_i
       service_error = Github::Error::ServiceError
-      error_class = service_error.errors[status_code]
-      error_class = service_error if !error_class and (400...600) === status_code
+      error_class = service_error.error_mapping[status_code]
+      if !error_class and (400...600) === status_code
+        error_class = service_error
+      end
       raise error_class.new(env) if error_class
     end
-
   end # Response::RaiseError
 end # Github

data/lib/github_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.4
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable