esi 0.4.14 → 0.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5318ada47a8456e3ec80feb871a3998c8e760dc3ec12c2b8d975252292a04f45
-  data.tar.gz: b0adbff86424651b6c12f19f3dc1e5d0564ea20e2b46e7c3a76170a0140c5cc6
+  metadata.gz: 38abebf1504982b7b86029e5aea6b8b3fe9160f6fcde54a67f14f1c361e3da3e
+  data.tar.gz: a41d6bcc3e17481df8986e2b767a806c446f20e6236c3524160b49e72951043b
 SHA512:
-  metadata.gz: 20c417ed1f54121112a39cb8a7c1e4bc8087f88e167a75a8f06314a7ed67a418040e01f6c1583dc26f6da5cc7abb664839ab3fc74a386f0b85c68fbb47b562b5
-  data.tar.gz: e15bcb5f258699f1d3721d5f5936b0ae30c4540275369f4dd95fba537f7eddc4cd605d1881b0b35afe1b5dadc1cd294320d7f9ae446e8720e03110cdf271294c
+  metadata.gz: 287f5456f7fbefaaea7ebf854c29fa33d7022aabda913e3e06c9cc59f9c85f06bf92e9f0c92609aff681eb355fe3343a3c5b0c303fc13dc0c950ef33f871525c
+  data.tar.gz: b3a34b04669ce5b1d43ee8ab7f76ce0ec62a92c9bcf566df232ae58ae82eb0859de5767d84b424122b67fe6a3b9af6b5f7a722e07d5e891ee2b2bdca963e1459

data/lib/esi/api_error.rb

@@ -50,6 +50,58 @@ module Esi
     end
   end
 
+  # TimeoutError Class
+  # @!attribute [r] response
+  #  @return [Esi::Response] the ApiError Response
+  # @!attribute [r] key
+  #  @return [String] the response.data[:key]
+  # @!attribute [r] message
+  #  @return [String] the response error message
+  # @!attribute [r] type
+  #  @return [String] the response.data[:exceptionType]
+  # @!attribute [r] original_exception
+  #  @return [ExceptionClass|nil] the orginal raised exception
+  class TimeoutError < ApiError; end
+
+  # TemporaryServerError Class
+  # @!attribute [r] response
+  #  @return [Esi::Response] the ApiError Response
+  # @!attribute [r] key
+  #  @return [String] the response.data[:key]
+  # @!attribute [r] message
+  #  @return [String] the response error message
+  # @!attribute [r] type
+  #  @return [String] the response.data[:exceptionType]
+  # @!attribute [r] original_exception
+  #  @return [ExceptionClass|nil] the orginal raised exception
+  class TemporaryServerError < ApiError; end
+
+  # RateLimitError Class
+  # @!attribute [r] response
+  #  @return [Esi::Response] the ApiError Response
+  # @!attribute [r] key
+  #  @return [String] the response.data[:key]
+  # @!attribute [r] message
+  #  @return [String] the response error message
+  # @!attribute [r] type
+  #  @return [String] the response.data[:exceptionType]
+  # @!attribute [r] original_exception
+  #  @return [ExceptionClass|nil] the orginal raised exception
+  class RateLimitError < ApiError; end
+
+  # UnauthorizedError Class
+  # @!attribute [r] response
+  #  @return [Esi::Response] the ApiError Response
+  # @!attribute [r] key
+  #  @return [String] the response.data[:key]
+  # @!attribute [r] message
+  #  @return [String] the response error message
+  # @!attribute [r] type
+  #  @return [String] the response.data[:exceptionType]
+  # @!attribute [r] original_exception
+  #  @return [ExceptionClass|nil] the orginal raised exception
+  class UnauthorizedError < ApiError; end
+
   # ApiUnknowntError Class
   # @!attribute [r] response
   #  @return [Esi::Response] the ApiError Response

data/lib/esi/client.rb

@@ -64,7 +64,7 @@ module Esi
     #  previous client or default client
     #
     # @example Call an Esi::Client method using an instance of client
-    #  new_client = Esi::Client.new(token: 'foo', refresh_token: 'foo', expires_at: 30.minutes.from_now)
+    #  new_client = Esi::Client.new(token: 'foo', refresh_token: 'foo', exceptionxpires_at: 30.minutes.from_now)
     #  new_client.with_client do |client|
     #    client.character(1234)
     #  end
@@ -143,7 +143,7 @@ module Esi
 
     def cached_response(klass, *args, &block)
       call = klass.new(*args)
-      Esi.cache.fetch(call.cache_key, expires_in: klass.cache_duration) do
+      Esi.cache.fetch(call.cache_key, exceptionxpires_in: klass.cache_duration) do
         make_call(call, &block)
       end
     end
@@ -157,21 +157,17 @@ module Esi
         access_token: @access_token,
         refresh_token: @refresh_token,
         expires_at: @expires_at,
-        callback: lambda { |token, expires_at|
+        callback: lambda { |token, exceptionxpires_at|
           @access_token = token
           @expires_at = expires_at
-          refresh_callback.call(token, expires_at) if refresh_callback.respond_to?(:call)
+          refresh_callback.call(token, exceptionxpires_at) if refresh_callback.respond_to?(:call)
         }
       )
     end
 
     def request_paginated(call, &block)
       call.page = 1
-      response = nil
-      ActiveSupport::Notifications.instrument('esi.client.request.paginated') do
-        response = paginated_response(response, call, &block)
-      end
-      response
+      paginated_response(response, call, &block)
     end
 
     def paginated_response(response, call, &block)
@@ -183,114 +179,41 @@ module Esi
       end
     end
 
-    # @todo esi should not retry
     # @todo make rubocop compliant
-    # rubocop:disable Lint/ShadowedException
     # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/BlockLength
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/PerceivedComplexity
     def request(call, &block)
-      response = nil
-      last_ex = nil
-      options = { timeout: Esi.config.timeout }
-      url ||= call.url
-
-      debug "Starting request: #{url}"
-
-      ActiveSupport::Notifications.instrument('esi.client.request') do
-        1.upto(MAX_ATTEMPTS) do |_try|
-          last_ex = nil
-          response = nil
-
-          begin
-            response = Timeout.timeout(Esi.config.timeout) do
-              oauth.request(call.method, url, options)
-            end
-          rescue Faraday::SSLError, Faraday::ConnectionFailed, Timeout::Error, Net::ReadTimeout => e
-            last_ex = e
-            logger.error e.to_s
-            sleep 3
-            next
-          rescue OAuth2::Error => e
-            last_ex = e
-            response = Response.new(e.response, call)
-
-            case e.response.status
-            when 502 # Temporary server error
-              logger.error "TemporaryServerError: #{response.error}"
-              sleep 5
-              next
-            when 503 # Rate Limit
-              logger.error 'RateLimit error, sleeping for 5 seconds'
-              sleep 5
-              next
-            when 404 # Not Found
-              raise Esi::ApiNotFoundError.new(Response.new(e.response, call), e)
-            when 403 # Forbidden
-              debug_error('ApiForbiddenError', url, response)
-              raise Esi::ApiForbiddenError.new(response, e)
-            when 400 # Bad Request
-              exception = Esi::ApiBadRequestError.new(response, e)
-              case exception.message
-              when 'invalid_token'
-                debug_error('ApiRefreshTokenExpiredError ', url, response)
-                raise Esi::ApiRefreshTokenExpiredError.new(response, e)
-              when 'invalid_client'
-                debug_error('ApiInvalidAppClientKeysError', url, response)
-                raise Esi::ApiInvalidAppClientKeysError.new(response, e)
-              else
-                debug_error('ApiBadRequestError', url, response)
-                raise exception
-              end
-            else
-              debug_error('ApiUnknownError', url, response)
-              raise Esi::ApiUnknownError.new(response, e)
-            end
-          end
-
-          break if response
-        end
+      response = Timeout.timeout(Esi.config.timeout) do
+        oauth.request(call.method, call.url, timeout: Esi.config.timeout)
       end
-      # rubocop:enable Lint/ShadowedException
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/BlockLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/PerceivedComplexity
-
-      if last_ex
-        logger.error "Request failed with #{last_ex.class}"
-        debug_error(last_ex.class, url, response)
-        raise Esi::ApiRequestError, last_ex
+      response = Response.new(response, call)
+      response.data.each { |item| yield(item) } if block
+      response.save
+    rescue OAuth2::Error => e
+      exception = error_class_for(e.response.status).new(Response.new(e.response, call), e)
+      raise exception.is_a?(Esi::ApiBadRequestError) ? process_bad_request_error(exception) : exception
+    rescue Faraday::SSLError, Faraday::ConnectionFailed, Timeout::Error => e
+      raise Esi::TimeoutError.new(Response.new(e.response, call), exception)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def error_class_for(status)
+      case status
+      when 400 then Esi::ApiBadRequestError
+      when 401 then Esi::UnauthorizedError
+      when 403 then Esi::ApiForbiddenError
+      when 404 then Esi::ApiNotFoundError
+      when 502 then Esi::TemporaryServerError
+      when 503 then Esi::RateLimitError
+      else Esi::ApiUnknownError
       end
-
-      debug 'Request successful'
-
-      ActiveSupport::Notifications.instrument('esi.client.response.render') do
-        response = Response.new(response, call)
-        response.save
-      end
-      ActiveSupport::Notifications.instrument('esi.client.response.callback') do
-        response.data.each { |item| yield(item) } if block
-      end
-      response
     end
 
-    def debug_error(klass, url, response)
-      [
-        '-' * 60,
-        "#{klass}(#{response.error})",
-        "STATUS: #{response.status}",
-        "MESSAGE: #{debug_message_for_response(response)}",
-        "URL: #{url}",
-        '-' * 60
-      ].each { |msg| logger.error(msg) }
-    end
-
-    def debug_message_for_response(response)
-      response.respond_to?(:data) ? (response.data[:message].presence || response.data[:error]) : response.try(:body)
+    def process_bad_request_error(exception)
+      case exception.message
+      when 'invalid_token'  then Esi::ApiRefreshTokenExpiredError.new(response, exception)
+      when 'invalid_client' then Esi::ApiInvalidAppClientKeysError.new(response, exception)
+      else exception
+      end
     end
   end
 end

data/lib/esi/response.rb

@@ -32,8 +32,8 @@ module Esi
     end
 
     def save
-      return unless should_log_response?
-      File.write(log_directroy.join("#{Time.now.to_i}.json"), to_json)
+      File.write(log_directroy.join("#{Time.now.to_i}.json"), to_json) if should_log_response?
+      self
     end
 
     def log_directory
@@ -56,7 +56,7 @@ module Esi
     private
 
     def normalize_response_body
-      MultiJson.load(body || {}, symbolize_keys: true, object_class: OpenStruct)
+      MultiJson.load(body.presence || '{}', symbolize_keys: true, object_class: OpenStruct)
     end
   end
 end

data/lib/esi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esi
-  VERSION = '0.4.14'
+  VERSION = '0.4.16'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.16
 platform: ruby
 authors:
 - Danny Hiemstra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-25 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport