esi 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2917822d51f6a158183715498948e66554cf2ba9
-  data.tar.gz: 3f0bfedf032f8b29c975e6c7fc0f42eb1914647d
+  metadata.gz: 4ef7c659090137fe7ff8581cdb6c6a9e9c240faa
+  data.tar.gz: 1e47ffce54eda2555fa7f64e3e841e0507162040
 SHA512:
-  metadata.gz: 462fe687f11691c7a8c8fe34deb7ad834152caffa919db850a77a1a0f99958732600d7f8bef5500d913354f912d577eb05cadb2b922de709064127ed77b4ad1f
-  data.tar.gz: e82ddb4376801d1c28fb420c93a9e383ae46c126cdae35c43a81009920245a5a705a2a383b42201871a8ac7faab8dcfd15fc1c912de3476e013dc639b10e21f5
+  metadata.gz: 3354040d05b7f3d674c072081b30815bc63b1ced681d64933e24461b039839f424e29724e2e624320120b652a5e4e43dc7253a5eca4fd3371b0a745bc6db60c1
+  data.tar.gz: 318a635d10e008cd0fc1daf06f8cfe028c677f041af49db8261a8f6d08d535862ff1a25ac758835b2397d9d96f0cbc84dce9dbecfffbbe6c5c0f3f85e366d825

data/esi.gemspec

@@ -1,26 +1,30 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'esi/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "esi"
+  spec.name          = 'esi'
   spec.version       = Esi::VERSION
-  spec.authors       = ["Danny Hiemstra"]
-  spec.email         = ["dannyhiemstra@gmail.com"]
+  spec.authors       = ['Danny Hiemstra', 'Aaron Allen']
+  spec.email         = ['dannyhiemstra@gmail.com', 'aaronmallen4@gmail.com']
 
-  spec.summary       = "EVE ESI API wrapper"
-  spec.description   = "EVE ESI API wrapper"
-  spec.homepage      = "https://github.com/dhiemstra/esi"
-  spec.license       = "MIT"
+  spec.summary       = 'EVE ESI API wrapper'
+  spec.description   = 'EVE ESI API wrapper'
+  spec.homepage      = 'https://github.com/dhiemstra/esi'
+  spec.license       = 'MIT'
 
   spec.files         = %w(LICENSE.txt README.md esi.gemspec) + Dir['lib/**/*.rb']
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "oauth2", "~> 1.4"
-  spec.add_dependency "addressable", "~> 2.3"
-  spec.add_dependency "activesupport"
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'addressable', '~> 2.3'
+  spec.add_dependency 'oauth2', '~> 1.4'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'shoulda', '~> 3.5'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/lib/esi/access_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Esi
   class AccessToken < OAuth2::AccessToken
     EXPIRES_MARGIN = 30.seconds
@@ -13,7 +15,7 @@ module Esi
     end
 
     def verify
-      Esi::Response.new(get("/oauth/verify"))
+      Esi::Response.new(get('/oauth/verify'))
     end
 
     def expired?

data/lib/esi/api_error.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Esi
+  # ApiError base 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 ApiError < OAuth2::Error
+    attr_reader :response, :key, :message, :type, :original_exception
+
+    # Create a new instance of ApiError
+    # @param [Esi::Response] response the response that generated the exception
+    # @param [ExceptionClass|nil] the orginally raised exception
+    # @return [Esi::ApiError] an instance of ApiError
+    def initialize(response, original_exception = nil)
+      super(response.original_response)
+
+      @response = response
+      @original_exception = original_exception
+      @code = response.original_response.status
+      @key = response.data[:key]
+      @message = response.data[:message].presence || response.data[:error] || original_exception.try(:message)
+      @type = response.data[:exceptionType]
+    end
+  end
+
+  # ApiRequestError Class
+  # @!attribute [r] original_exception
+  #  @return [ExceptionClass|nil] the orginal raised exception
+  class ApiRequestError < StandardError
+    attr_reader :original_exception
+
+    # Create a new instance of ApiRequestError
+    # @param [ExceptionClass|nil] the orginally raised exception
+    # @return [Esi::ApiRequestError] the instance of ApiRequestError
+    def initialize(original_exception)
+      @original_exception = original_exception
+      msg = "#{original_exception.class}: " \
+      "#{original_exception.try(:response).try(:status)}" \
+      ' - ' \
+      "#{original_exception.try(:message)}"
+      super(msg)
+    end
+  end
+
+  # ApiUnknowntError 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 ApiUnknownError < ApiError; end
+
+  # ApiBadRequestError 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 ApiBadRequestError < ApiError; end
+
+  # ApiRefreshTokenExpiredError 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 ApiRefreshTokenExpiredError < ApiError; end
+
+  # ApiInvalidAppClientKeysError 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 ApiInvalidAppClientKeysError < ApiError; end
+
+  # ApiNotFoundError 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 ApiNotFoundError < ApiError; end
+
+  # ApiForbiddenError 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 ApiForbiddenError < ApiError; end
+
+  # Error Class
+  # @see [StandardError](https://ruby-doc.org/core-2.3.2/StandardError.html)
+  class Error < StandardError; end
+end

data/lib/esi/calls.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Esi
   class Calls
     class << self
@@ -29,13 +31,18 @@ module Esi
     end
 
     class Base
+      CACHE_NAMESPACE = 'esi'
+
       class_attribute :scope
       class_attribute :cache_duration
 
       attr_accessor :path, :params
 
       def cache_key
-        @cache_key ||= ActiveSupport::Cache.expand_cache_key([path, params].flatten, :esi)
+        @cache_key ||= begin
+          cache_args = [CACHE_NAMESPACE, path.gsub(%r{^\/}, ''), params.sort].flatten
+          ActiveSupport::Cache.expand_cache_key(cache_args)
+        end
       end
 
       def method
@@ -52,13 +59,13 @@ module Esi
       end
 
       def paginated?
-        !!@paginated
+        !@paginated
       end
     end
 
     class Regions < Base
       def initialize
-        @path = "/universe/regions/"
+        @path = '/universe/regions/'
       end
     end
 
@@ -70,7 +77,7 @@ module Esi
 
     class Constellations < Base
       def initialize
-        @path = "/universe/constellations/"
+        @path = '/universe/constellations/'
       end
     end
 
@@ -88,7 +95,7 @@ module Esi
 
     class SolarSystems < Base
       def initialize
-        @path = "/universe/systems/"
+        @path = '/universe/systems/'
       end
     end
 
@@ -124,7 +131,7 @@ module Esi
 
     class Structures < Base
       def initialize
-        @path = "/universe/structures/"
+        @path = '/universe/structures/'
       end
     end
 
@@ -136,7 +143,7 @@ module Esi
 
     class Types < Base
       def initialize
-        @path = "/universe/types"
+        @path = '/universe/types'
         @paginated = true
       end
     end
@@ -149,7 +156,7 @@ module Esi
 
     class DogmaAttributes < Base
       def initialize
-        @path = "/dogma/attributes/"
+        @path = '/dogma/attributes/'
       end
     end
 
@@ -161,7 +168,7 @@ module Esi
 
     class DogmaEffects < Base
       def initialize
-        @path = "/dogma/effects/"
+        @path = '/dogma/effects/'
       end
     end
 
@@ -176,7 +183,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize
-        @path = "/industry/facilities"
+        @path = '/industry/facilities'
       end
     end
 
@@ -185,7 +192,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize
-        @path = "/industry/systems"
+        @path = '/industry/systems'
       end
     end
 
@@ -194,7 +201,7 @@ module Esi
       # https://esi.tech.ccp.is/latest/characters/907452336/search/?categories=structure&datasource=tranquility&search=Kamela&strict=false&token=Fp3ThF7wjvYBIDIIrtWE_Ryjt9BhYwUP75y2EL5Eq9mHPm8tYt9I9NwgZz8o26FFQBKoUToh2DYVc-Q5Ws400g2
 
       def initialize(character_id: nil, categories:, search:, strict: false)
-        @path = (character_id ? "/characters/#{character_id}" : '') + "/search"
+        @path = (character_id ? "/characters/#{character_id}" : '') + '/search'
         @params = { categories: categories, search: search, strict: strict }
       end
     end
@@ -210,7 +217,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize(character_ids)
-        @path = "/characters/names"
+        @path = '/characters/names'
         @params = { character_ids: character_ids.join(',') }
       end
     end
@@ -412,7 +419,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize
-        @path = "/alliances"
+        @path = '/alliances'
       end
     end
 
@@ -420,7 +427,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize(alliance_ids)
-        @path = "/alliances/names"
+        @path = '/alliances/names'
         @params = { alliance_ids: alliance_ids.join(',') }
       end
     end
@@ -437,7 +444,7 @@ module Esi
       self.cache_duration = 3600
 
       def initialize(corporation_ids)
-        @path = "/corporations/names"
+        @path = '/corporations/names'
         @params = { corporation_ids: corporation_ids.join(',') }
       end
     end
@@ -526,7 +533,7 @@ module Esi
 
     class MarketGroups < Base
       def initialize
-        @path = "/markets/groups"
+        @path = '/markets/groups'
         @paginated = true
       end
     end
@@ -539,7 +546,7 @@ module Esi
 
     class MarketPrices < Base
       def initialize
-        @path = "/markets/prices"
+        @path = '/markets/prices'
       end
     end
 
@@ -605,7 +612,7 @@ module Esi
       self.scope = 'esi-ui.open_window.v1'
 
       def initialize(type_id)
-        @path = "/ui/openwindow/marketdetails"
+        @path = '/ui/openwindow/marketdetails'
         @method = :post
         @params = { type_id: type_id }
       end

data/lib/esi/client.rb

@@ -1,17 +1,90 @@
+# frozen_string_literal: true
+
 module Esi
+  # The Esi Client class
+  # @!attribute [rw] refresh_callback
+  #  @return [#callback] the refresh_token callback method
+  # @!attribute [rw] access_token
+  #  @return [String] the esi access_token
+  # @!attribute [rw] refresh_token
+  #  @return [String] the esi refresh_token string
+  # @!attribute [rw] expires_at
+  #  @return [Time] the timestamp of the esi token expire
+  # @!attribute [r] logger
+  #  @return [Logger] the logger class for the gem
+  # @!attribute [r] oauth
+  #  @return [Esi::Oauth] the oauth instance for the client
   class Client
+    # @return [Fixnum] The max amount of request attempst Client will make
     MAX_ATTEMPTS = 2
 
     attr_accessor :refresh_callback, :access_token, :refresh_token, :expires_at
     attr_reader :logger, :oauth
 
+    # Create a new instance of Client
+    # @param [String] token the esi access_token
+    # @param [String] refresh_token the esi refresh_token
+    # @param [Time] expires_at the time stamp the esi token expires_at
     def initialize(token: nil, refresh_token: nil, expires_at: nil)
       @logger = Esi.logger
       @access_token = token
       @refresh_token = refresh_token
       @expires_at = expires_at
+      @oauth = init_oauth
+    end
+
+    # Set the current thread's Esi::Client
+    # @params [Esi::Client] the client to set
+    # @return [Esi::Client] the current thread's Esi::Client
+    def self.current=(client)
+      Thread.current[:esi_client] = client
+    end
+
+    # Get the current thread's Esi::Client
+    # @return [Esi::Client] the current thread's Esi::Client
+    def self.current
+      Thread.current[:esi_client] ||= new
+    end
+
+    # Switch to default Esi::Client (Esi::Client.new)
+    # @return [Esi::Client] the current thread's Esi::Client
+    def self.switch_to_default
+      self.current = new
+    end
+
+    # Switch current thread's client to instance of Esi::Client
+    # @return [self] the instance calling switch to
+    def switch_to
+      Esi::Client.current = self
+    end
+
+    # Yield block with instance of Esi::Client and revert to
+    #  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.with_client do |client|
+    #    client.character(1234)
+    #  end
+    #  #=> Esi::Response<#>
+    #
+    # @yieldreturn [#block] the passed block.
+    def with_client
+      initial_client = Esi::Client.current
+      switch_to
+      yield(self) if block_given?
+    ensure
+      initial_client.switch_to if initial_client
+      Esi::Client.switch_to_default unless initial_client
     end
 
+    # Intercept Esi::Client method_missing and attempt to call an Esi::Request
+    #  with an Esi::Calls
+    # @param [Symbol|String] name the name of the method called
+    # @param [Array] *args the arguments to call the method with
+    # @param [#block] &block the block to pass to the underlying method
+    # @raise [NameError] If the Esi::Calls does not exist
+    # @return [Esi::Response] the response given for the call
     def method_missing(name, *args, &block)
       klass = nil
       ActiveSupport::Notifications.instrument('esi.client.detect_call') do
@@ -25,6 +98,9 @@ module Esi
       cached_response(klass, *args, &block)
     end
 
+    # Test if the Esi::Client has a method
+    # @param [Symbol] name the name of the method to test
+    # @return [Boolean] wether or not the method exists
     def method?(name)
       begin
         klass = Esi::Calls.const_get(method_to_class_name(name))
@@ -34,15 +110,24 @@ module Esi
       !klass.nil?
     end
 
+    # Test if the Esi::Client has a pluralized version of a method
+    # @param [Symbol] name the name of the method to test
+    # @return [Boolean] wether or not the pluralized method exists
     def plural_method?(name)
       plural = name.to_s.pluralize.to_sym
       method? plural
     end
 
+    # Log a message
+    # @param [String] message the message to log
+    # @return [void] the Logger.info method with message
     def log(message)
       logger.info message
     end
 
+    # Log a message with debug
+    # @param [String] message the message to log
+    # @return [void] the Logger.debug method with message
     def debug(message)
       logger.debug message
     end
@@ -64,46 +149,45 @@ module Esi
       name.dup.to_s.split('_').map(&:capitalize).join
     end
 
-    def oauth
+    def init_oauth
       @oauth ||= OAuth.new(
         access_token: @access_token,
         refresh_token: @refresh_token,
         expires_at: @expires_at,
-        callback: -> (token, expires_at) {
+        callback: lambda { |token, expires_at|
           @access_token = token
           @expires_at = expires_at
-          if refresh_callback.respond_to?(:call)
-            refresh_callback.call(token, expires_at)
-          end
+          refresh_callback.call(token, expires_at) if refresh_callback.respond_to?(:call)
         }
       )
     end
 
     def request_paginated(call, &block)
+      call.page = 1
       response = nil
-      page = 1
-
       ActiveSupport::Notifications.instrument('esi.client.request.paginated') do
-        loop do
-          call.page = page
-          page_response = request(call, &block)
-
-          if page_response.data.blank?
-            break
-          elsif response
-            response.merge(page_response)
-          else
-            response = page_response
-          end
-
-          page += 1
-        end
+        response = paginated_response(response, call, &block)
       end
-
       response
     end
 
+    def paginated_response(response, call, &block)
+      loop do
+        page_response = request(call, &block)
+        break response if page_response.data.blank?
+        response = response ? response.merge(page_response) : page_response
+        call.page += 1
+      end
+    end
+
     # FIXME: esi should not retry
+    # FIXME: 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
@@ -113,12 +197,12 @@ module Esi
       debug "Starting request: #{url}"
 
       ActiveSupport::Notifications.instrument('esi.client.request') do
-        1.upto(MAX_ATTEMPTS) do |try|
+        1.upto(MAX_ATTEMPTS) do |_try|
           last_ex = nil
           response = nil
 
           begin
-            response = Timeout::timeout(Esi.config.timeout) do
+            response = Timeout.timeout(Esi.config.timeout) do
               oauth.request(call.method, url, options)
             end
           rescue Faraday::SSLError, Faraday::ConnectionFailed, Timeout::Error, Net::ReadTimeout => e
@@ -136,7 +220,7 @@ module Esi
               sleep 5
               next
             when 503 # Rate Limit
-              logger.error "RateLimit error, sleeping for 5 seconds"
+              logger.error 'RateLimit error, sleeping for 5 seconds'
               sleep 5
               next
             when 404 # Not Found
@@ -166,34 +250,44 @@ module Esi
           break if response
         end
       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.new(last_ex)
+        raise Esi::ApiRequestError, last_ex
       end
 
-      debug "Request successful"
+      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| block.call(item) } if block
+        response.data.each { |item| yield(item) } if block
       end
       response
     end
 
     def debug_error(klass, url, response)
       [
-        '-'*60,
+        '-' * 60,
         "#{klass}(#{response.error})",
         "STATUS: #{response.status}",
-        "MESSAGE: #{response.respond_to?(:data) ? (response.data[:message].presence || response.data[:error]) : response.try(:body)}",
+        "MESSAGE: #{debug_message_for_response(response)}",
         "URL: #{url}",
-        '-'*60,
+        '-' * 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)
+    end
   end
 end

data/lib/esi/o_auth.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Esi
   class OAuth
     extend Forwardable
 
     attr_reader :access_token, :refresh_token, :expires_at
-    def_delegators :token, :get, :post, :delete, :patch, :put
+    def_delegators :token, :request, :get, :post, :delete, :patch, :put
 
     class << self
       def authorize_url(redirect_uri:, scopes: nil)
@@ -20,15 +22,13 @@ module Esi
       def client
         @client ||= OAuth2::Client.new(
           Esi.config.client_id, Esi.config.client_secret,
-          { site: Esi.config.oauth_host }
+          site: Esi.config.oauth_host
         )
       end
     end
 
     def initialize(access_token:, refresh_token:, expires_at:, callback: nil)
-      if callback && !callback.respond_to?(:call)
-        raise Esi::Error.new("Callback should be a callable Proc")
-      end
+      raise Esi::Error, 'Callback should be a callable Proc' if callback && !callback.respond_to?(:call)
 
       @access_token = access_token
       @refresh_token = refresh_token
@@ -36,28 +36,21 @@ module Esi
       @callback = callback if callback
     end
 
-    def request(*args)
-      token.request(*args)
-    end
-
     private
 
     def token
-      @token = Esi::AccessToken.new(OAuth.client, @access_token, {
-        refresh_token: @refresh_token, expires_at: @expires_at
-      })
+      @token = Esi::AccessToken.new(OAuth.client, @access_token,
+                                    refresh_token: @refresh_token, expires_at: @expires_at)
       refresh_access_token if @token.expired?
       @token
     end
 
     def refresh_access_token
-      Esi.logger.debug "Refreshing access token"
-
       ActiveSupport::Notifications.instrument('esi.oauth.refresh_token') do
         @token = @token.refresh!
         @access_token = @token.token
         @expires_at = @token.expires_at.integer? ? Time.at(@token.expires_at) : @token.expires_at
-        @callback.call(@access_token, @expires_at) if @callback
+        @callback&.call(@access_token, @expires_at)
       end
     end
   end

data/lib/esi/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Esi
   class Response
     extend Forwardable
@@ -6,10 +8,10 @@ module Esi
     def_delegators :original_response, :status, :body, :headers
     def_delegators :data, :each
 
-    def initialize(response, call=nil)
+    def initialize(response, call = nil)
       @original_response = response
+      @data = normalize_response_body
       @call = call
-      @data = MultiJson.load(body || {}, symbolize_keys: true, object_class: OpenStruct) # rescue OpenStruct.new
     end
 
     def merge(other_response)
@@ -29,18 +31,40 @@ module Esi
       @cached_until ||= headers[:expires] ? Time.parse(headers[:expires]) : nil
     end
 
+    def response_json
+      @response_json ||= begin
+                           MultiJson.load(body, symbolize_keys: true)
+                         rescue StandardError
+                           {}
+                         end
+    end
+
     def save
-      return if call.nil?
-      return if Esi.config.response_log_path.blank? || !Dir.exists?(Esi.config.response_log_path)
+      return unless should_log_response?
+      File.write(log_directroy.join("#{Time.now.to_i}.json"), to_json)
+    end
 
-      call_name = call.class.to_s.split('::').last.underscore
-      folder = Pathname.new(Esi.config.response_log_path).join(call_name)
-      FileUtils.mkdir_p(folder)
-      File.write(folder.join("#{Time.now.to_i.to_s}.json"), to_json)
+    def log_directory
+      call.class.to_s.split('::').last.underscore
+      dir = Pathname.new(Esi.config.response_log_path).join(call_name)
+      FileUtils.mkdir_p(dir)
+      dir
+    end
+
+    def should_log_response?
+      return false if call.nil?
+      return false if Esi.config.response_log_path.blank? || !Dir.exist?(Esi.config.response_log_path)
+      true
     end
 
     def method_missing(method, *args, &block)
       data.send(method, *args, &block)
     end
+
+    private
+
+    def normalize_response_body
+      MultiJson.load(body || {}, symbolize_keys: true, object_class: OpenStruct)
+    end
   end
 end

data/lib/esi/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Esi
-  VERSION = "0.4.5"
+  VERSION = '0.4.6'
 end

data/lib/esi.rb

@@ -1,12 +1,19 @@
-require "oauth2"
-require "forwardable"
-require "ostruct"
-require "addressable/uri"
-require "active_support/cache"
-require "active_support/notifications"
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'forwardable'
+require 'ostruct'
+require 'addressable/uri'
+require 'active_support/cache'
+require 'active_support/notifications'
 require 'active_support/core_ext/string'
-require "active_support/core_ext/class/attribute"
+require 'active_support/core_ext/class/attribute'
 
+# The main Esi Module
+# @!attribute [w] api_version
+#  @return [Symbol] the Esi Api version used by the gem
+# @!attribute [w] logger
+#  @return [Logger] the logger class for the gem
 module Esi
   autoload :VERSION,     'esi/version'
   autoload :AccessToken, 'esi/access_token'
@@ -15,6 +22,10 @@ module Esi
   autoload :Client,      'esi/client'
   autoload :Response,    'esi/response'
 
+  require_relative 'esi/api_error'
+
+  # Default ESI access scopes
+  # @return [Array<String>] the default scopes
   SCOPES = %w(
     esi-assets.read_assets.v1
     esi-bookmarks.read_character_bookmarks.v1
@@ -61,7 +72,10 @@ module Esi
     esi-universe.read_structures.v1
     esi-wallet.read_character_wallet.v1
     esi-wallet.read_corporation_wallets.v1
-  )
+  ).freeze
+
+  # The default Esi gem configuration
+  # @return [Hash{Symbol => Symbol|String|Fixnum|Object|Array}] the default configuration
   DEFAULT_CONFIG = {
     datasource: :tranquility,
     oauth_host: 'https://login.eveonline.com',
@@ -75,21 +89,27 @@ module Esi
     client_secret: nil,
     cache: ActiveSupport::Cache::MemoryStore.new,
     scopes: SCOPES
-  }
+  }.freeze
 
   class << self
     attr_writer :api_version, :config, :logger, :cache
 
+    # The Esi Configuration
+    # @return [OpenStruct] the configuration object
     def config
       @config ||= OpenStruct.new(DEFAULT_CONFIG)
     end
 
+    # The Esi logger class instance
+    # @return [MyLoggerInstance|Logger] an instance of the logger class
     def logger
       @logger ||= Esi.config.logger || Logger.new(Esi.config.log_target).tap do |l|
         l.level = Logger.const_get(Esi.config.log_level.upcase)
       end
     end
 
+    # The Esi cache class instance
+    # @return [ActiveSupport::Cache::Store] an instance of cache
     def cache
       if Esi.config.cache.nil?
         @cache ||= ActiveSupport::Cache::NullStore.new
@@ -98,54 +118,35 @@ module Esi
       end
     end
 
+    # The Esi Api version to interface with
+    # @return [Symbol] the esi api version
     def api_version
       @api_version || :latest
     end
 
-    def generate_url(path, params={})
-      path = path[1..-1] if path.start_with?('/')
-      path += "/" unless path.end_with?('/')
-
-      url = [config.api_host, config.api_version, path].join('/')
+    # Generate an Esi url for a given path
+    # @param [String] path the path to generate an esi url for
+    # @param [Hash{Symbol => String|Fixnum}] params the params for the url query
+    # @return [String] the generated url
+    def generate_url(path, params = {})
+      url = url_for_path(path)
       uri = Addressable::URI.parse(url)
-      uri.query_values = {datasource: config.datasource}.merge(params.to_h)
+      uri.query_values = { datasource: config.datasource }.merge(params.to_h)
       uri.to_s
     end
 
+    # The current Esi client
+    # @return [Esi::Client] the current client
     def client
-      @client ||= Client.new
-    end
-  end
-
-  class ApiError < OAuth2::Error
-    attr_reader :response, :key, :message, :type, :original_exception
-
-    def initialize(response, original_exception=nil)
-      super(response.original_response)
-
-      @response = response
-      @original_exception = original_exception
-      @code = response.original_response.status
-      @key = response.data[:key]
-      @message = response.data[:message].presence || response.data[:error] || original_exception.try(:message)
-      @type = response.data[:exceptionType]
+      @client ||= Client.current
     end
-  end
 
-  class ApiRequestError < StandardError
-    attr_reader :original_exception
+    private
 
-    def initialize(original_exception)
-      @original_exception = original_exception
-      super("#{original_exception.class}: #{original_exception.try(:response).try(:status)} - #{original_exception.try(:message)}")
+    def url_for_path(path)
+      path = path[1..-1] if path.start_with?('/')
+      path += '/' unless path.end_with?('/')
+      [config.api_host, config.api_version, path].join('/')
     end
   end
-
-  class ApiUnknownError < ApiError; end
-  class ApiBadRequestError < ApiError; end
-  class ApiRefreshTokenExpiredError < ApiError; end
-  class ApiInvalidAppClientKeysError < ApiError; end
-  class ApiNotFoundError < ApiError; end
-  class ApiForbiddenError < ApiError; end
-  class Error < StandardError; end
 end

data/lib/omniauth/esi.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'omniauth/strategies/esi'

data/lib/omniauth/strategies/esi.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'omniauth/strategies/oauth2'
 
 module OmniAuth
   module Strategies
     class Esi < OmniAuth::Strategies::OAuth2
       option :name, 'esi'
-      option :client_options, { site: ::Esi.config.oauth_host, verify_url: '/oauth/verify' }
-      option :authorize_options, [:scope, :callback_url]
+      option :client_options, site: ::Esi.config.oauth_host, verify_url: '/oauth/verify'
+      option :authorize_options, %i(scope callback_url)
 
       uid { extra_info[:character_id] }
 
@@ -19,11 +21,11 @@ module OmniAuth
       end
 
       credentials do
-        hash = {token: access_token.token}
-        hash.merge!(refresh_token: access_token.refresh_token) if access_token.refresh_token
-        hash.merge!(expires_at: access_token.expires_at) if access_token.expires?
-        hash.merge!(expires: access_token.expires?)
-        hash.merge!(scopes: extra_info[:scopes].split(' ')) if extra_info[:scopes]
+        hash = { token: access_token.token }
+        hash[:refresh_token] = access_token.refresh_token if access_token.refresh_token
+        hash[:expires_at] = access_token.expires_at if access_token.expires?
+        hash[:expires] = access_token.expires?
+        hash[:scopes] = extra_info[:scopes].split(' ') if extra_info[:scopes]
         hash
       end
 
@@ -32,7 +34,9 @@ module OmniAuth
       end
 
       def extra_info
-        @extra_info ||= deep_symbolize(access_token.get(options.client_options.verify_url).parsed.transform_keys!(&:underscore))
+        @extra_info ||= deep_symbolize(
+          access_token.get(options.client_options.verify_url).parsed.transform_keys!(&:underscore)
+        )
       end
 
       def authorize_params

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Danny Hiemstra
+- Aaron Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,22 +96,51 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: EVE ESI API wrapper
 email:
 - dannyhiemstra@gmail.com
+- aaronmallen4@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -106,7 +150,9 @@ files:
 - esi.gemspec
 - lib/esi.rb
 - lib/esi/access_token.rb
+- lib/esi/api_error.rb
 - lib/esi/calls.rb
+- lib/esi/calls/info.rb
 - lib/esi/client.rb
 - lib/esi/o_auth.rb
 - lib/esi/response.rb