esi-sdk 1.1.1

data/lib/esi/client/user_interface.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI user interface operations.
+    module UserInterface
+      # Set a solar system as autopilot waypoint.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-ui.write_waypoint.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v2
+      #
+      # @param add_to_beginning [Boolean] Whether this solar system should be added to the beginning of all waypoints
+      # @param clear_other_waypoints [Boolean] Whether clean other waypoints beforing adding this one
+      # @param destination_id [Integer] The destination to travel to, can be solar system, station or structure's id
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @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: {})
+        query_string = URI.encode_www_form([["add_to_beginning", add_to_beginning], ["clear_other_waypoints", clear_other_waypoints], ["destination_id", destination_id]])
+        post("/ui/autopilot/waypoint/?#{query_string}", headers: headers)
+      end
+
+      # Open the contract window inside the client.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-ui.open_window.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param contract_id [Integer] The contract to open
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_contract
+      def post_ui_openwindow_contract(contract_id:, headers: {})
+        query_string = URI.encode_www_form([["contract_id", contract_id]])
+        post("/ui/openwindow/contract/?#{query_string}", headers: headers)
+      end
+
+      # Open the information window for a character, corporation or alliance inside the client.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-ui.open_window.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param target_id [Integer] The target to open
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_information
+      def post_ui_openwindow_information(target_id:, headers: {})
+        query_string = URI.encode_www_form([["target_id", target_id]])
+        post("/ui/openwindow/information/?#{query_string}", headers: headers)
+      end
+
+      # Open the market details window for a specific typeID inside the client.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-ui.open_window.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param type_id [Integer] The item type to open in market window
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_marketdetails
+      def post_ui_openwindow_marketdetails(type_id:, headers: {})
+        query_string = URI.encode_www_form([["type_id", type_id]])
+        post("/ui/openwindow/marketdetails/?#{query_string}", headers: headers)
+      end
+
+      # Open the New Mail window, according to settings from the request if applicable.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-ui.open_window.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param new_mail [Hash] The details of mail to create
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::UnprocessableEntityError] Invalid request
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/User Interface/post_ui_openwindow_newmail
+      def post_ui_openwindow_newmail(new_mail:, headers: {})
+        post("/ui/openwindow/newmail/", headers: headers, payload: new_mail)
+      end
+    end
+  end
+end

data/lib/esi/client/wallet.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI wallet operations.
+    module Wallet
+      # Returns a character's wallet balance.
+      #
+      # This endpoint is cached for up to 120 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_character_wallet.v1
+      #
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer,String] An EVE character ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet
+      def get_character_wallet(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/wallet/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_wallet get_character_wallet
+
+      # Retrieve the given character's wallet journal going 30 days back.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_character_wallet.v1
+      #
+      # @esi_version dev
+      # @esi_version v6
+      #
+      # @param character_id [Integer,String] An EVE character ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet_journal
+      def get_character_wallet_journal(character_id:, params: {}, headers: {})
+        get("/characters/#{character_id}/wallet/journal/", headers: headers, params: params)
+      end
+      alias get_characters_character_id_wallet_journal get_character_wallet_journal
+
+      # Get wallet transactions of a character.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_character_wallet.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param character_id [Integer,String] An EVE character ID
+      # @param from_id [Integer] Only show transactions happened before the one referenced by this id
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wallet/get_characters_character_id_wallet_transactions
+      def get_character_wallet_transactions(character_id:, from_id:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["from_id", from_id]])
+        get("/characters/#{character_id}/wallet/transactions/?#{query_string}", headers: headers, params: params)
+      end
+      alias get_characters_character_id_wallet_transactions get_character_wallet_transactions
+
+      # Get a corporation's wallets.
+      #
+      # This endpoint is cached for up to 300 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_corporation_wallets.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wallet/get_corporations_corporation_id_wallets
+      def get_corporation_wallets(corporation_id:, params: {}, headers: {})
+        get("/corporations/#{corporation_id}/wallets/", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_wallets get_corporation_wallets
+
+      # Retrieve the given corporation's wallet journal for the given division going 30 days back.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_corporation_wallets.v1
+      #
+      # @esi_version dev
+      # @esi_version v4
+      #
+      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param division [Integer,String] Wallet key of the division to fetch journals from
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wallet/get_corporations_corporation_id_wallets_division_journal
+      def get_corporation_wallets_division_journal(corporation_id:, division:, params: {}, headers: {})
+        get("/corporations/#{corporation_id}/wallets/#{division}/journal/", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_wallets_division_journal get_corporation_wallets_division_journal
+
+      # Get wallet transactions of a corporation.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # This endpoint requires authorization (see {ESI::Client#authorize}).
+      #
+      # @esi_scope esi-wallet.read_corporation_wallets.v1
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param corporation_id [Integer,String] An EVE corporation ID
+      # @param division [Integer,String] Wallet key of the division to fetch journals from
+      # @param from_id [Integer] Only show journal entries happened before the transaction referenced by this id
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::UnauthorizedError] Unauthorized
+      # @raise [ESI::Errors::ForbiddenError] Forbidden
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @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:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["from_id", from_id]])
+        get("/corporations/#{corporation_id}/wallets/#{division}/transactions/?#{query_string}", headers: headers, params: params)
+      end
+      alias get_corporations_corporation_id_wallets_division_transactions get_corporation_wallets_division_transactions
+    end
+  end
+end

data/lib/esi/client/wars.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ESI
+  class Client
+    # ESI wars operations.
+    module War
+      # Return details about a war.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param war_id [Integer,String] ID for a war
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::UnprocessableEntityError] War not found
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wars/get_wars_war_id
+      def get_war(war_id:, params: {}, headers: {})
+        get("/wars/#{war_id}/", headers: headers, params: params)
+      end
+      alias get_wars_war_id get_war
+
+      # Return a list of kills related to a war.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param war_id [Integer,String] A valid war ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::UnprocessableEntityError] War not found
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wars/get_wars_war_id_killmails
+      def get_war_killmails(war_id:, params: {}, headers: {})
+        get("/wars/#{war_id}/killmails/", headers: headers, params: params)
+      end
+      alias get_wars_war_id_killmails get_war_killmails
+
+      # Return a list of wars.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param max_war_id [Integer] Only return wars with ID smaller than this
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::ErrorLimitedError] Error limited
+      # @raise [ESI::Errors::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Wars/get_wars
+      def get_wars(max_war_id:, params: {}, headers: {})
+        query_string = URI.encode_www_form([["max_war_id", max_war_id]])
+        get("/wars/?#{query_string}", headers: headers, params: params)
+      end
+    end
+  end
+end

data/lib/esi/client.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday-http-cache"
+require "faraday_middleware"
+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.
+  class Client # rubocop:disable Metrics/ClassLength
+    include ESI::Client::Alliance
+    include ESI::Client::Contact
+    include ESI::Client::Character
+    include ESI::Client::Asset
+    include ESI::Client::Skill
+    include ESI::Client::Bookmark
+    include ESI::Client::Calendar
+    include ESI::Client::Clone
+    include ESI::Client::Contract
+    include ESI::Client::Fitting
+    include ESI::Client::Fleet
+    include ESI::Client::FactionWarfare
+    include ESI::Client::Industry
+    include ESI::Client::Killmail
+    include ESI::Client::Location
+    include ESI::Client::Loyalty
+    include ESI::Client::Mail
+    include ESI::Client::Opportunity
+    include ESI::Client::Market
+    include ESI::Client::PlanetaryInteraction
+    include ESI::Client::Search
+    include ESI::Client::Wallet
+    include ESI::Client::Corporation
+    include ESI::Client::Dogma
+    include ESI::Client::Incursion
+    include ESI::Client::Insurance
+    include ESI::Client::Route
+    include ESI::Client::Sovereignty
+    include ESI::Client::Status
+    include ESI::Client::UserInterface
+    include ESI::Client::Universe
+    include ESI::Client::War
+
+    DEFAULT_BASE_URL = "https://esi.evetech.net"
+    DEFAULT_VERSION = "latest"
+
+    ERROR_MAPPING = {
+      400 => ESI::Errors::BadRequestError,
+      401 => ESI::Errors::UnauthorizedError,
+      403 => ESI::Errors::ForbiddenError,
+      404 => ESI::Errors::NotFoundError,
+      420 => ESI::Errors::ErrorLimitedError,
+      422 => ESI::Errors::UnprocessableEntityError,
+      500 => ESI::Errors::InternalServerError,
+      503 => ESI::Errors::ServiceUnavailableError,
+      504 => ESI::Errors::GatewayTimeoutError,
+      520 => ESI::Errors::EveServerError
+    }.freeze
+
+    attr_reader :base_url, :cache, :user_agent, :version
+
+    # Returns a new {ESI::Client}.
+    #
+    # @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 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`)
+    def initialize(user_agent:, base_url: DEFAULT_BASE_URL, version: DEFAULT_VERSION, cache: {})
+      @base_url = base_url
+      @cache = cache
+      @user_agent = user_agent
+      @version = version
+    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)
+      url_encoded_connection.authorization :Bearer, token
+      json_encoded_connection.authorization :Bearer, token
+    end
+
+    private
+
+    ESI_RETRY_EXCEPTIONS = [Errno::ETIMEDOUT, Timeout::Error, Faraday::TimeoutError, Faraday::ConnectionFailed,
+                            Faraday::ParsingError, SocketError].freeze
+
+    def delete(path, params: {}, headers: {})
+      response = make_delete_request(path, params: params, headers: headers)
+      response.body
+    end
+
+    def get(path, params: {}, headers: {})
+      response = make_get_request(path, params: params, headers: headers)
+
+      return paginate(response, params, headers) if paginated?(response)
+
+      response.body
+    end
+
+    def post(path, payload: {}, headers: {})
+      response = make_post_request(path, payload: payload, headers: headers)
+      response.body
+    end
+
+    def put(path, payload: {}, headers: {})
+      response = make_put_request(path, payload: payload, headers: headers)
+      response.body
+    end
+
+    def paginate(response, params, headers)
+      all_items = response.body
+      page_count = response.headers["X-Pages"].to_i - 1
+      page_count.times do |n|
+        page_number = n + 1
+        params = params.merge(page: page_number)
+        page = make_get_request(path, params: params, headers: headers)
+        all_items += page.body
+      end
+
+      all_items
+    end
+
+    def make_delete_request(path, params: {}, headers: {})
+      res = url_encoded_connection.delete("/#{version}#{path}", params, headers)
+
+      raise_error(res) unless res.success?
+
+      res
+    end
+
+    def make_get_request(path, params: {}, headers: {})
+      res = url_encoded_connection.get("/#{version}#{path}", params, headers)
+
+      raise_error(res) unless res.success?
+
+      res
+    end
+
+    def make_post_request(path, payload: {}, headers: {})
+      res = json_encoded_connection.post("/#{version}#{path}", payload, headers)
+
+      raise_error(res) unless res.success?
+
+      res
+    end
+
+    def make_put_request(path, payload: {}, headers: {})
+      res = json_encoded_connection.put("/#{version}#{path}", payload, headers)
+
+      raise_error(res) unless res.success?
+
+      res
+    end
+
+    def paginated?(response)
+      response.headers["X-Pages"] && response.headers["X-Pages"].to_i <= 1
+    end
+
+    def raise_error(res)
+      raise (ERROR_MAPPING[res.status] || Error).new("(#{res.status}) #{res["error"]}", response: res)
+    end
+
+    def url_encoded_connection
+      @url_encoded_connection ||= Faraday.new(base_url, headers: default_headers) do |f|
+        f.use :http_cache, cache unless cache.empty?
+        f.request :url_encoded
+        f.request :retry, { exceptions: ESI_RETRY_EXCEPTIONS }
+        f.response :follow_redirects
+        f.response :json
+      end
+    end
+
+    def json_encoded_connection
+      @json_encoded_connection ||= Faraday.new(base_url, headers: default_headers) do |f|
+        f.use :http_cache, cache unless cache.empty?
+        f.request :json
+        f.request :retry, { exceptions: ESI_RETRY_EXCEPTIONS }
+        f.response :follow_redirects
+        f.response :json
+      end
+    end
+
+    def default_headers
+      { "User-Agent": user_agent }
+    end
+  end
+end

data/lib/esi/errors.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ESI
+  # Namespace for ESI errors.
+  module Errors
+    # Base class for ESI errors.
+    class Error < RuntimeError
+    end
+
+    # Base class for ESI client errors.
+    class ClientError < Error
+      attr_reader :response
+
+      def initialize(msg, response:)
+        super(msg)
+
+        @response = response
+      end
+    end
+
+    # ESI unauthorized error.
+    class UnauthorizedError < ClientError; end
+
+    # ESI bad request error.
+    class BadRequestError < ClientError; end
+
+    # ESI forbidden error.
+    class ForbiddenError < ClientError; end
+
+    # ESI not found error.
+    class NotFoundError < ClientError; end
+
+    # ESI unprocessable entity error.
+    class UnprocessableEntityError < ClientError; end
+
+    # ESI error limited error.
+    class ErrorLimitedError < ClientError; end
+
+    # ESI internal server error.
+    class InternalServerError < ClientError; end
+
+    # ESI service unavailable error.
+    class ServiceUnavailableError < ClientError; end
+
+    # ESI gateway timeout error.
+    class GatewayTimeoutError < ClientError; end
+
+    # ESI EVE server error.
+    class EveServerError < ClientError; end
+  end
+end