esi-sdk 2.1.3 → 3.0.0

data/lib/esi/client/user_interface.rb

@@ -30,7 +30,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_autopilot_waypoint
       def post_ui_autopilot_waypoint(add_to_beginning:, clear_other_waypoints:, destination_id:, headers: {}, params: {})
-        post_ui_autopilot_waypoint_raw(add_to_beginning: add_to_beginning, clear_other_waypoints: clear_other_waypoints, destination_id: destination_id, headers: headers, params: params).json
+        parse_response(post_ui_autopilot_waypoint_raw(add_to_beginning: add_to_beginning, clear_other_waypoints: clear_other_waypoints, destination_id: destination_id, headers: headers, params: params))
       end
 
       # Set a solar system as autopilot waypoint.
@@ -59,8 +59,8 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_autopilot_waypoint
       def post_ui_autopilot_waypoint_raw(add_to_beginning:, clear_other_waypoints:, destination_id:, headers: {}, params: {})
-        params.merge!("add_to_beginning" => add_to_beginning, "clear_other_waypoints" => clear_other_waypoints, "destination_id" => destination_id)
-        post("/ui/autopilot/waypoint/", headers: headers, params: params)
+        params.merge!('add_to_beginning' => add_to_beginning, 'clear_other_waypoints' => clear_other_waypoints, 'destination_id' => destination_id)
+        post('/ui/autopilot/waypoint/', headers: headers, params: params)
       end
 
       # Open the contract window inside the client.
@@ -87,7 +87,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_contract
       def post_ui_openwindow_contract(contract_id:, headers: {}, params: {})
-        post_ui_openwindow_contract_raw(contract_id: contract_id, headers: headers, params: params).json
+        parse_response(post_ui_openwindow_contract_raw(contract_id: contract_id, headers: headers, params: params))
       end
 
       # Open the contract window inside the client.
@@ -114,8 +114,8 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_contract
       def post_ui_openwindow_contract_raw(contract_id:, headers: {}, params: {})
-        params.merge!("contract_id" => contract_id)
-        post("/ui/openwindow/contract/", headers: headers, params: params)
+        params.merge!('contract_id' => contract_id)
+        post('/ui/openwindow/contract/', headers: headers, params: params)
       end
 
       # Open the information window for a character, corporation or alliance inside the client.
@@ -142,7 +142,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_information
       def post_ui_openwindow_information(target_id:, headers: {}, params: {})
-        post_ui_openwindow_information_raw(target_id: target_id, headers: headers, params: params).json
+        parse_response(post_ui_openwindow_information_raw(target_id: target_id, headers: headers, params: params))
       end
 
       # Open the information window for a character, corporation or alliance inside the client.
@@ -169,8 +169,8 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_information
       def post_ui_openwindow_information_raw(target_id:, headers: {}, params: {})
-        params.merge!("target_id" => target_id)
-        post("/ui/openwindow/information/", headers: headers, params: params)
+        params.merge!('target_id' => target_id)
+        post('/ui/openwindow/information/', headers: headers, params: params)
       end
 
       # Open the market details window for a specific typeID inside the client.
@@ -197,7 +197,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_marketdetails
       def post_ui_openwindow_marketdetails(type_id:, headers: {}, params: {})
-        post_ui_openwindow_marketdetails_raw(type_id: type_id, headers: headers, params: params).json
+        parse_response(post_ui_openwindow_marketdetails_raw(type_id: type_id, headers: headers, params: params))
       end
 
       # Open the market details window for a specific typeID inside the client.
@@ -224,8 +224,8 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_marketdetails
       def post_ui_openwindow_marketdetails_raw(type_id:, headers: {}, params: {})
-        params.merge!("type_id" => type_id)
-        post("/ui/openwindow/marketdetails/", headers: headers, params: params)
+        params.merge!('type_id' => type_id)
+        post('/ui/openwindow/marketdetails/', headers: headers, params: params)
       end
 
       # Open the New Mail window, according to settings from the request if applicable.
@@ -253,7 +253,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_newmail
       def post_ui_openwindow_newmail(new_mail:, headers: {}, params: {})
-        post_ui_openwindow_newmail_raw(new_mail: new_mail, headers: headers, params: params).json
+        parse_response(post_ui_openwindow_newmail_raw(new_mail: new_mail, headers: headers, params: params))
       end
 
       # Open the New Mail window, according to settings from the request if applicable.
@@ -281,7 +281,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_newmail
       def post_ui_openwindow_newmail_raw(new_mail:, headers: {}, params: {})
-        post("/ui/openwindow/newmail/", headers: headers, params: params, payload: new_mail)
+        post('/ui/openwindow/newmail/', headers: headers, params: params, payload: new_mail)
       end
     end
   end

data/lib/esi/client/wallet.rb

@@ -29,7 +29,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet
       def get_character_wallet(character_id:, headers: {}, params: {})
-        get_character_wallet_raw(character_id: character_id, headers: headers, params: params).json
+        parse_response(get_character_wallet_raw(character_id: character_id, headers: headers, params: params))
       end
       alias get_characters_character_id_wallet get_character_wallet
 
@@ -145,7 +145,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet_transactions
       def get_character_wallet_transactions(character_id:, from_id: nil, headers: {}, params: {})
-        get_character_wallet_transactions_raw(character_id: character_id, from_id: from_id, headers: headers, params: params).json
+        parse_response(get_character_wallet_transactions_raw(character_id: character_id, from_id: from_id, headers: headers, params: params))
       end
       alias get_characters_character_id_wallet_transactions get_character_wallet_transactions
 
@@ -176,7 +176,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet_transactions
       def get_character_wallet_transactions_raw(character_id:, from_id: nil, headers: {}, params: {})
-        params.merge!("from_id" => from_id)
+        params.merge!('from_id' => from_id)
         get("/characters/#{character_id}/wallet/transactions/", headers: headers, params: params)
       end
 
@@ -206,7 +206,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_corporations_corporation_id_wallets
       def get_corporation_wallets(corporation_id:, headers: {}, params: {})
-        get_corporation_wallets_raw(corporation_id: corporation_id, headers: headers, params: params).json
+        parse_response(get_corporation_wallets_raw(corporation_id: corporation_id, headers: headers, params: params))
       end
       alias get_corporations_corporation_id_wallets get_corporation_wallets
 
@@ -326,7 +326,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_corporations_corporation_id_wallets_division_transactions
       def get_corporation_wallets_division_transactions(corporation_id:, division:, from_id: nil, headers: {}, params: {})
-        get_corporation_wallets_division_transactions_raw(corporation_id: corporation_id, division: division, from_id: from_id, headers: headers, params: params).json
+        parse_response(get_corporation_wallets_division_transactions_raw(corporation_id: corporation_id, division: division, from_id: from_id, headers: headers, params: params))
       end
       alias get_corporations_corporation_id_wallets_division_transactions get_corporation_wallets_division_transactions
 
@@ -358,7 +358,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wallet/get_corporations_corporation_id_wallets_division_transactions
       def get_corporation_wallets_division_transactions_raw(corporation_id:, division:, from_id: nil, headers: {}, params: {})
-        params.merge!("from_id" => from_id)
+        params.merge!('from_id' => from_id)
         get("/corporations/#{corporation_id}/wallets/#{division}/transactions/", headers: headers, params: params)
       end
     end

data/lib/esi/client/wars.rb

@@ -25,7 +25,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wars/get_wars_war_id
       def get_war(war_id:, headers: {}, params: {})
-        get_war_raw(war_id: war_id, headers: headers, params: params).json
+        parse_response(get_war_raw(war_id: war_id, headers: headers, params: params))
       end
       alias get_wars_war_id get_war
 
@@ -122,7 +122,7 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wars/get_wars
       def get_wars(max_war_id: nil, headers: {}, params: {})
-        get_wars_raw(max_war_id: max_war_id, headers: headers, params: params).json
+        parse_response(get_wars_raw(max_war_id: max_war_id, headers: headers, params: params))
       end
 
       # Return a list of wars.
@@ -145,8 +145,8 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Wars/get_wars
       def get_wars_raw(max_war_id: nil, headers: {}, params: {})
-        params.merge!("max_war_id" => max_war_id)
-        get("/wars/", headers: headers, params: params)
+        params.merge!('max_war_id' => max_war_id)
+        get('/wars/', headers: headers, params: params)
       end
     end
   end

data/lib/esi/client.rb

@@ -1,41 +1,43 @@
 # frozen_string_literal: true
 
-require "httpx"
-require "timeout"
-
-require_relative "./errors"
-require_relative "./client/alliance"
-require_relative "./client/contacts"
-require_relative "./client/character"
-require_relative "./client/assets"
-require_relative "./client/skills"
-require_relative "./client/bookmarks"
-require_relative "./client/calendar"
-require_relative "./client/clones"
-require_relative "./client/contracts"
-require_relative "./client/fittings"
-require_relative "./client/fleets"
-require_relative "./client/faction_warfare"
-require_relative "./client/industry"
-require_relative "./client/killmails"
-require_relative "./client/location"
-require_relative "./client/loyalty"
-require_relative "./client/mail"
-require_relative "./client/opportunities"
-require_relative "./client/market"
-require_relative "./client/planetary_interaction"
-require_relative "./client/search"
-require_relative "./client/wallet"
-require_relative "./client/corporation"
-require_relative "./client/dogma"
-require_relative "./client/incursions"
-require_relative "./client/insurance"
-require_relative "./client/routes"
-require_relative "./client/sovereignty"
-require_relative "./client/status"
-require_relative "./client/user_interface"
-require_relative "./client/universe"
-require_relative "./client/wars"
+require 'typhoeus'
+require 'oj'
+require 'retriable'
+require 'timeout'
+
+require_relative './errors'
+require_relative './client/alliance'
+require_relative './client/contacts'
+require_relative './client/character'
+require_relative './client/assets'
+require_relative './client/skills'
+require_relative './client/bookmarks'
+require_relative './client/calendar'
+require_relative './client/clones'
+require_relative './client/contracts'
+require_relative './client/fittings'
+require_relative './client/fleets'
+require_relative './client/faction_warfare'
+require_relative './client/industry'
+require_relative './client/killmails'
+require_relative './client/location'
+require_relative './client/loyalty'
+require_relative './client/mail'
+require_relative './client/opportunities'
+require_relative './client/market'
+require_relative './client/planetary_interaction'
+require_relative './client/search'
+require_relative './client/wallet'
+require_relative './client/corporation'
+require_relative './client/dogma'
+require_relative './client/incursions'
+require_relative './client/insurance'
+require_relative './client/routes'
+require_relative './client/sovereignty'
+require_relative './client/status'
+require_relative './client/user_interface'
+require_relative './client/universe'
+require_relative './client/wars'
 
 module ESI
   # Client for the EVE Swagger Interface (ESI) API.
@@ -73,8 +75,8 @@ module ESI
     include ESI::Client::Universe
     include ESI::Client::War
 
-    DEFAULT_BASE_URL = "https://esi.evetech.net"
-    DEFAULT_VERSION = "latest"
+    DEFAULT_BASE_URL = 'https://esi.evetech.net'
+    DEFAULT_VERSION = 'latest'
 
     ERROR_MAPPING = {
       400 => ESI::Errors::BadRequestError,
@@ -89,38 +91,26 @@ module ESI
       520 => ESI::Errors::EveServerError
     }.freeze
 
-    attr_reader :base_url, :cache, :instrumentation, :logger, :user_agent, :version
+    attr_reader :base_url, :user_agent, :version, :authorization_token, :retries
 
     # Returns a new {ESI::Client}.
     #
-    # See the [faraday-http-cache](https://github.com/sourcelevel/faraday-http-cache) documentation for information on
-    # how to set up caching via the `cache` parameter.
-    #
     # @param user_agent [String] Value of the `User-Agent` header for HTTP calls
     # @param base_url [String] The base URL of the ESI API
     # @param version [String] The version of the ESI API
-    # @param logger [Object] The logger to use
-    # @param cache [Hash] The cache configuration to use
-    # @option cache [Object] :store The cache store (e.g. `Rails.cache`)
-    # @option cache [Object] :logger The logger (e.g. `Rails.logger`)
-    # @option cache [Object] :instrumenter The instrumenter (e.g. `ActiveSupport::Notifications`)
-    # @param instrumentation [Hash] The instrumentation configuration to use
-    # @option instrumentation [String] :name The name to use for instrumentation
-    # @option instrumentation [Object] :instrumenter The instrumenter to use (e.g. `ActiveSupport::Notifications`)
-    def initialize(user_agent:, base_url: DEFAULT_BASE_URL, version: DEFAULT_VERSION, cache: {}, instrumentation: {}, logger: nil) # rubocop:disable Layout/LineLength, Metrics/ParameterLists
+    # @param retries [Integer] Number of times to try a request before raising an error.
+    def initialize(user_agent:, base_url: DEFAULT_BASE_URL, version: DEFAULT_VERSION, retries: 10)
       @base_url = base_url
-      @cache = cache
-      @instrumentation = instrumentation
       @user_agent = user_agent
       @version = version
-      @logger = logger
+      @retries = retries
     end
 
     # Set the `Authorization` header for subsequent requests.
     #
     # @param token [String] The [EVE SSO JWT token](https://docs.esi.evetech.net/docs/sso/) to use
-    def authorize(token)
-      session.authentication token
+    def authorize(_token)
+      @authorization_token = authorization_token
     end
 
     # Make a `DELETE` request to the ESI endpoint.
@@ -163,64 +153,103 @@ module ESI
 
     private
 
-    def make_request(method, path, params: {}, headers: {}, payload: nil)
+    RETRIABLE_ERRORS = [
+      ESI::Errors::ErrorLimitedError,
+      ESI::Errors::InternalServerError,
+      ESI::Errors::ServiceUnavailableError,
+      ESI::Errors::GatewayTimeoutError,
+      ESI::Errors::EveServerError
+    ].freeze
+
+    def make_request(method, path, params: {}, headers: {}, payload: nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      headers.merge!(Authorization: "Bearer #{authorization_token}") if authorization_token
       versioned_path = "/#{version}#{path}"
-      response = session.request(method, versioned_path, params: params, headers: headers, json: payload)
-      response.raise_for_status
+      url = "#{base_url}#{versioned_path}"
+      json = payload ? Oj.dump(payload) : nil
+      request = Typhoeus::Request.new(url, method: method, params: params, headers: headers, body: json)
+      request.on_complete { |response| raise_error(response) unless response.success? }
+
+      hydra.queue(request)
+
+      with_retries(on_retry: ->(*_) { hydra.queue(request) }) { hydra.run }
 
-      return paginate(response, versioned_path, params, headers) if paginated?(response)
+      response = request.response
+
+      return paginate(response, url, params, headers) if paginated?(response)
 
       response
-    rescue HTTPX::Error
-      raise_error(response)
     end
 
-    def paginate(response, path, params, headers) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      response_headers = normalize_headers(response.headers)
-      page_count = response_headers["x-pages"].to_i
-
-      requests = (2..page_count).map do |n|
-        session.build_request(:get, path, params: params.merge(page: n), headers: headers)
+    def paginate(orig_response, url, params, headers) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      response_headers = normalize_headers(orig_response.headers)
+      page_count = response_headers['x-pages'].to_i
+      pages = [orig_response]
+
+      return pages if page_count == 1
+
+      pending_pages = page_count.times.to_a.map { |n| n + 1 }[1..]
+
+      with_retries do
+        while pending_pages.any?
+          pending_pages.each do |page|
+            request = Typhoeus::Request.new(url, params: params.merge(page: page), headers: headers)
+            request.on_complete do |response|
+              raise_error(response) unless response.success?
+
+              pages << response
+              pending_pages.delete(page)
+            end
+            hydra.queue(request)
+          end
+          hydra.run
+        end
       end
-      responses = requests.any? ? Array(session.request(*requests)) : []
-      responses.unshift(response)
 
-      if responses.any?(&:error)
-        raise ESI::Errors::PaginationError.new("Error paginating request", responses: responses)
-      end
+      pages.sort_by { |response| response.request.options[:params][:page].to_i }
+    end
 
-      responses
+    def parse_response(response)
+      Oj.load(response.body, bigdecimal_load: :float)
     end
 
     def paginated?(response)
       headers = normalize_headers(response.headers)
-      headers.key?("x-pages")
+      headers.key?('x-pages')
     end
 
     def concat_responses(responses)
-      responses.map(&:json).reduce([], :concat)
+      responses.map { |r| parse_response(r) }.reduce([], :concat)
     end
 
     def normalize_headers(headers)
       headers.to_h.transform_keys(&:downcase)
     end
 
-    def raise_error(res)
-      raise (ERROR_MAPPING[res.status] || ESI::Errors::ClientError).new("(#{res.status}) #{res.json["error"]}",
-                                                                        response: res)
+    def with_retries(opts = {}, &block)
+      Retriable.retriable(retry_options.merge(opts), &block)
+    end
+
+    def retry_options
+      { on: RETRIABLE_ERRORS, tries: retries }
     end
 
-    def session
-      @session ||= HTTPX.with(origin: base_url)
-                        .with_headers(default_headers)
-                        .plugin(:authentication)
-                        .plugin(:persistent)
-                        .plugin(:response_cache)
-                        .plugin(:retries)
+    def raise_error(res)
+      json = begin
+        Oj.load(res.body)
+      rescue StandardError
+        res.body
+      end
+
+      raise (ERROR_MAPPING[res.code] || ESI::Errors::ClientError).new("(#{res.code}) #{json['error']}",
+                                                                      response: res)
     end
 
     def default_headers
-      { "User-Agent": user_agent, Accept: "application/json" }
+      { 'User-Agent': user_agent, Accept: 'application/json' }
+    end
+
+    def hydra
+      @hydra ||= Typhoeus::Hydra.new
     end
   end
 end

data/lib/esi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ESI
-  VERSION = "2.1.3"
+  VERSION = "3.0.0"
 end

data/lib/esi-sdk.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "./esi/client"
-require_relative "./esi/version"
+require_relative './esi/client'
+require_relative './esi/version'
 
 # Namespace for the EVE Swagger Interface (ESI) SDK.
 module ESI

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: esi-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Bokobo Shahni
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpx
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: retriable
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: ESI SDK is a Ruby API client for the EVE Swagger Interface (ESI), the
   official API for the EVE Online MMORPG.
 email:
@@ -122,7 +136,7 @@ metadata:
   homepage_uri: https://github.com/bokoboshahni/esi-sdk
   source_code_uri: https://github.com/bokoboshahni/esi-sdk
   changelog_uri: https://github.com/bokoboshahni/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: API client for the EVE Swagger Interface (ESI)
 test_files: []