esi-sdk 1.1.2 → 2.1.0

data/lib/esi/client/wars.rb

@@ -12,7 +12,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param war_id [Integer,String] ID for a war
+      # @param war_id [Integer] ID for a war
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -24,11 +24,35 @@ module ESI
       # @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)
+      def get_war(war_id:, headers: {}, params: {})
+        get_war_raw(war_id: war_id, headers: headers, params: params).json
       end
       alias get_wars_war_id get_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] 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_raw(war_id:, headers: {}, params: {})
+        get("/wars/#{war_id}/", headers: headers, params: params)
+      end
+
       # Return a list of kills related to a war.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -37,7 +61,7 @@ module ESI
       # @esi_version legacy
       # @esi_version v1
       #
-      # @param war_id [Integer,String] A valid war ID
+      # @param war_id [Integer] A valid war ID
       # @param params [Hash] Additional query string parameters
       # @param headers [Hash] Additional headers
       #
@@ -49,11 +73,59 @@ module ESI
       # @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)
+      def get_war_killmails(war_id:, headers: {}, params: {})
+        responses = get_war_killmails_raw(war_id: war_id, headers: headers, params: params)
+        responses.map(&:json).reduce([], :concat)
       end
       alias get_wars_war_id_killmails get_war_killmails
 
+      # 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] 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_raw(war_id:, headers: {}, params: {})
+        get("/wars/#{war_id}/killmails/", headers: headers, params: params)
+      end
+
+      # 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: nil, headers: {}, params: {})
+        get_wars_raw(max_war_id: max_war_id, headers: headers, params: params).json
+      end
+
       # Return a list of wars.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -73,9 +145,9 @@ module ESI
       # @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)
+      def get_wars_raw(max_war_id: nil, headers: {}, params: {})
+        params.merge!("max_war_id" => max_war_id)
+        get("/wars/", headers: headers, params: params)
       end
     end
   end

data/lib/esi/client.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "faraday-http-cache"
-require "faraday_middleware"
+require "httpx"
 require "timeout"
 
 require_relative "./errors"
@@ -91,135 +89,129 @@ module ESI
       520 => ESI::Errors::EveServerError
     }.freeze
 
-    attr_reader :base_url, :cache, :user_agent, :version
+    attr_reader :base_url, :cache, :instrumentation, :logger, :user_agent, :version
 
     # 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`)
-    def initialize(user_agent:, base_url: DEFAULT_BASE_URL, version: DEFAULT_VERSION, cache: {})
+    # @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
       @base_url = base_url
       @cache = cache
+      @instrumentation = instrumentation
       @user_agent = user_agent
       @version = version
+      @logger = logger
     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
+      session.authentication 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
+      params.delete_if { |_, v| v.nil? }
+      response = session.delete("/#{version}#{path}", params: params, headers: headers)
+      response.raise_for_status
+      response
+    rescue HTTPX::Error
+      raise_error(response)
     end
 
     def get(path, params: {}, headers: {})
-      response = make_get_request(path, params: params, headers: headers)
+      params.delete_if { |_, v| v.nil? }
+      response = session.get("/#{version}#{path}", params: params, headers: headers)
+      response.raise_for_status
 
-      return paginate(response, params, headers) if paginated?(response)
+      return paginate(response, "/#{version}#{path}", params, headers) if paginated?(response)
 
-      response.body
+      response
+    rescue HTTPX::Error
+      raise_error(response)
     end
 
-    def post(path, payload: {}, headers: {})
-      response = make_post_request(path, payload: payload, headers: headers)
-      response.body
+    def post(path, payload: {}, params: {}, headers: {})
+      params.delete_if { |_, v| v.nil? }
+      response = session.post("/#{version}#{path}",
+                              params: params,
+                              headers: headers,
+                              json: payload)
+      response.raise_for_status
+      response
+    rescue HTTPX::Error
+      raise_error(response)
     end
 
-    def put(path, payload: {}, headers: {})
-      response = make_put_request(path, payload: payload, headers: headers)
-      response.body
+    def put(path, payload: {}, params: {}, headers: {})
+      params.delete_if { |_, v| v.nil? }
+      response = session.put("/#{version}#{path}",
+                             params: params,
+                             headers: headers,
+                             json: payload)
+      response.raise_for_status
+      response
+    rescue HTTPX::Error
+      raise_error(response)
     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?
+    private
 
-      res
-    end
+    def paginate(response, path, params, headers) # rubocop:disable Metrics/MethodLength
+      response_headers = normalize_headers(response.headers)
+      page_count = response_headers["x-pages"].to_i
 
-    def make_put_request(path, payload: {}, headers: {})
-      res = json_encoded_connection.put("/#{version}#{path}", payload, headers)
+      requests = (2..page_count).map do |n|
+        session.build_request(:get, path, params: params.merge(page: n), headers: headers)
+      end
+      responses = requests.any? ? session.request(*requests) : []
+      responses.unshift(response)
 
-      raise_error(res) unless res.success?
+      if responses.any?(&:error)
+        raise ESI::Errors::PaginationError.new("Error paginating request", responses: responses)
+      end
 
-      res
+      responses
     end
 
     def paginated?(response)
-      response.headers["X-Pages"] && response.headers["X-Pages"].to_i <= 1
+      headers = normalize_headers(response.headers)
+      headers.key?("x-pages")
     end
 
-    def raise_error(res)
-      raise (ERROR_MAPPING[res.status] || Error).new("(#{res.status}) #{res["error"]}", response: res)
+    def normalize_headers(headers)
+      headers.to_h.transform_keys(&:downcase)
     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
+    def raise_error(res)
+      raise (ERROR_MAPPING[res.status] || ESI::Errors::ClientError).new("(#{res.status}) #{res.json["error"]}",
+                                                                        response: res)
     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
+    def session
+      @session ||= HTTPX.with(origin: base_url)
+                        .with_headers(default_headers)
+                        .plugin(:authentication)
+                        .plugin(:persistent)
+                        .plugin(:response_cache)
+                        .plugin(:retries)
     end
 
     def default_headers
-      { "User-Agent": user_agent }
+      { "User-Agent": user_agent, Accept: "application/json" }
     end
   end
 end

data/lib/esi/errors.rb

@@ -9,7 +9,7 @@ module ESI
 
     # Base class for ESI client errors.
     class ClientError < Error
-      attr_reader :response
+      attr_reader :response, :responses
 
       def initialize(msg, response:)
         super(msg)
@@ -18,6 +18,17 @@ module ESI
       end
     end
 
+    # ESI pagination error.
+    class PaginationError < ClientError
+      attr_reader :responses
+
+      def initialize(msg, responses:)
+        super(msg, response: nil)
+
+        @responses = responses
+      end
+    end
+
     # ESI unauthorized error.
     class UnauthorizedError < ClientError; end
 

data/lib/esi/version.rb

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

data/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "esi-sdk",
+  "private": true,
+  "dependencies": {},
+  "version": "1.2.0",
+  "description": "API client for the EVE Swagger Interface (ESI)",
+  "repository": "https://github.com/bokoboshahni/esi-sdk-ruby.git",
+  "author": "Bokobo Shahni <shahni@bokobo.space>",
+  "license": "MIT",
+  "devDependencies": {
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/exec": "^6.0.1",
+    "@semantic-release/git": "^9.0.1",
+    "semantic-release": "^17.4.7"
+  },
+  "scripts": {
+    "release": "semantic-release"
+  }
+}

data/release.config.js

@@ -21,10 +21,10 @@ module.exports = {
       changelogTitle: '# ESI SDK Changelog'
     }],
     ['@semantic-release/exec', {
-      prepareCmd: "VERSION=${nextRelease.version} bundle exec rake set_version"
+      prepareCmd: "VERSION=${nextRelease.version} bundle exec rake set_version && bundle install"
     }],
     ['@semantic-release/git', {
-      assets: ['CHANGELOG.md', 'lib/esi/version.rb']
+      assets: ['CHANGELOG.md', 'Gemfile.lock', 'lib/esi/version.rb']
     }],
     ['@semantic-release/exec', {
       publishCmd: "bundle exec rake build release:rubygem_push"