esi-sdk 1.2.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32e80c8b57db70012c9002de31f5533508fc5144d6d416b5d5f3c1dd588805df
-  data.tar.gz: 1f20d6ef7531035b260c4b5d936ff4bed4f6ac1d9e3222a771c7717c4b8f236c
+  metadata.gz: a7c874338d7aa0d467285e375390a6b185c184d9e5882a7f2ca519411b76e6df
+  data.tar.gz: 80b17cc143a6e5479005498a6351adccec57a997ac405138677beeb6dc10789e
 SHA512:
-  metadata.gz: d2d30b0b42a5b16e4756f30fd5ed490e5129db9caa7e67ccac5bbc26ae17cb316589d38ce466daea8cb3b2eb4b2553a4385e8d780a1d786b56ce2cf61422d26b
-  data.tar.gz: 40b27c822b0356183a25b88aa6ddad08b975c152b772beae0ee2c047a4579483a9c8333879371db5e21c954bfffa75244e812df529331fe7d712bcf105943ecb
+  metadata.gz: f50b8969549d4f8a8cb866725f46e058cd761072da6024a781469d95123e5a84bdcd981f77d4fe636b575ec333c08cfe6db95c78b5374c44df8a58a1db96bd9f
+  data.tar.gz: d8ca8eeba8e76b7c7915edd7703ca4a57046ccb54fa520384239331dc7a26ee2dd8c0604659acad2b184348589a9650d7e2be5e35eb8ff6227532bac7d25ea09

data/.github/workflows/{cicd.yml → build.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Build
 
 on:
   pull_request:
@@ -168,6 +168,22 @@ jobs:
         with:
           node-version: '16'
 
+      - name: Find yarn cache location
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Yarn package cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Install yarn packages
+        run: |
+          yarn install --pure-lockfile
+
       - name: Release
         env:
           GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
@@ -177,5 +193,4 @@ jobs:
           GIT_COMMITTER_EMAIL: "shahni@bokobo.space"
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
         run: |
-          npm install -g @semantic-release/changelog @semantic-release/exec @semantic-release/git conventional-changelog-angular
-          npx semantic-release ${{ github.event_name == 'pull_request' && '--dry-run' || ' ' }}
+          yarn release ${{ github.event_name == 'pull_request' && '--dry-run' || ' ' }}

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+vendor/bundle
+node_modules/

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # ESI SDK Changelog
 
+## [2.1.2](https://github.com/bokoboshahni/esi-sdk-ruby/compare/v2.1.1...v2.1.2) (2021-10-09)
+
+## [2.1.1](https://github.com/bokoboshahni/esi-sdk-ruby/compare/v2.1.0...v2.1.1) (2021-10-09)
+
+# [2.1.0](https://github.com/bokoboshahni/esi-sdk-ruby/compare/v2.0.0...v2.1.0) (2021-10-09)
+
+
+### Features
+
+* add methods to return raw responses ([93dc308](https://github.com/bokoboshahni/esi-sdk-ruby/commit/93dc3082cf06b0b4e42e17e3de77c9e05e3345b5))
+
+# [2.0.0](https://github.com/bokoboshahni/esi-sdk-ruby/compare/v1.2.0...v2.0.0) (2021-10-08)
+
+
+### Bug Fixes
+
+* require name from esi/sdk to esi-sdk ([2e5e996](https://github.com/bokoboshahni/esi-sdk-ruby/commit/2e5e9966343baef91bd037579607bb562edce301))
+
+
+### Features
+
+* migrate to httpx ([fd6ec0d](https://github.com/bokoboshahni/esi-sdk-ruby/commit/fd6ec0d6910805215efceb80a5361dc4d72b9599))
+
+
+### BREAKING CHANGES
+
+* use httpx instead of faraday for http calls
+
 # [1.2.0](https://github.com/bokoboshahni/esi-sdk-ruby/compare/v1.1.3...v1.2.0) (2021-07-20)
 
 

data/Gemfile

@@ -7,6 +7,7 @@ ruby "3.0.2"
 gemspec
 
 gem "activesupport", "~> 6.1"
+gem "awesome_print", "~> 1.9"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.10"
 gem "rubocop", "~> 1.18"

data/Gemfile.lock

@@ -1,16 +1,14 @@
 PATH
   remote: .
   specs:
-    esi-sdk (1.2.0)
-      faraday (~> 1.5)
-      faraday-http-cache (~> 2.2)
-      faraday_middleware (~> 1.0)
-      typhoeus (~> 1.4)
+    esi-sdk (2.1.2)
+      httpx (~> 0.18)
+      retriable (~> 3.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -19,36 +17,16 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    awesome_print (1.9.2)
     concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
     docile (1.4.0)
-    ethon (0.14.0)
-      ffi (>= 1.15.0)
-    faraday (1.5.1)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-http-cache (2.2.0)
-      faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
-    ffi (1.15.3)
     hashdiff (1.0.1)
+    http-2-next (0.5.0)
+    httpx (0.18.0)
+      http-2-next (>= 0.4.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     kramdown (2.3.1)
@@ -56,16 +34,16 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     minitest (5.14.4)
-    multipart-post (2.1.1)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
+    retriable (3.1.2)
     rexml (3.2.5)
-    rouge (3.26.0)
+    rouge (3.26.1)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -79,41 +57,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.18.3)
+    rubocop (1.22.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.11.4)
+    rubocop-performance (1.11.5)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     vcr (6.0.0)
-    webmock (3.13.0)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.26)
@@ -125,6 +99,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (~> 6.1)
+  awesome_print (~> 1.9)
   esi-sdk!
   kramdown-parser-gfm (~> 1.1)
   rake (~> 13.0)

data/README.md

@@ -1,4 +1,5 @@
-![Build images](https://github.com/bokoboshahni/esi-sdk-ruby/workflows/CICD/badge.svg)
+[![Build](https://github.com/bokoboshahni/esi-sdk-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/bokoboshahni/esi-sdk-ruby/actions/workflows/build.yml)
+[![Gem Version](https://badge.fury.io/rb/esi-sdk.svg)](https://badge.fury.io/rb/esi-sdk)
 
 # EVE Swagger Interface (ESI) SDK
 
@@ -55,19 +56,6 @@ response = client.get_character(character_id: 2113024536)
 
 See the documentation for [ESI::Client](https://bokoboshahni.github.io/esi-sdk-ruby/ESI/Client.html) for detailed information on each endpoint.
 
-### Caching
-
-Caching is handled via the [faraday-http-cache](https://github.com/sourcelevel/faraday-http-cache) middleware. When instantiating an `ESI::Client` instance, cache configuration can be passed via the `cache` parameter:
-
-```ruby
-client = ESI::Client.new(
-  user_agent: 'My ESI Bot/1.0; +(https://example.com)',
-  cache: { store: Rails.cache, logger: Rails.logger, instrumenter: ActiveSupport::Notifications }
-)
-```
-
-See the [faraday-http-cache](https://github.com/sourcelevel/faraday-http-cache) documentation for more details on what configuration options are available.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -120,6 +120,7 @@ task :generate do
     module_name = tag.gsub(/ /, "_").classify
     method_definitions = operations.sort_by { |(k, _v)| k }.each_with_object([]) do |(method_name, operation), a|
       signature_params = operation[:params].map { |p| "#{p["name"]}:" }
+      raw_call_params = operation[:params].map { |p| "#{p["name"]}: #{p["name"]}" }
 
       description = "# #{operation[:description]}"
       description = "#{description}." unless description.end_with?(".")
@@ -157,6 +158,7 @@ task :generate do
           end
 
         signature_params << "#{body_name}:"
+        raw_call_params << "#{body_name}: #{body_name}"
         param_tags += ["# @param #{body_name} [#{body_type}] #{body_param["description"]}"]
       end
 
@@ -174,12 +176,16 @@ task :generate do
                   "#{p["name"]}:"
                 end
         signature_params << p_str
+        raw_call_params << "#{p["name"]}: #{p["name"]}"
         param_tags << p_tag
       end
 
       signature_params += %w[headers params].map do |p|
         "#{p}: {}"
       end
+      raw_call_params += %w[headers params].map do |p|
+        "#{p}: #{p}"
+      end
       param_tags << "# @param params [Hash] Additional query string parameters"
 
       param_tags += [
@@ -201,6 +207,7 @@ task :generate do
       description.gsub!(/^$\n/m, "")
 
       signature = "(#{signature_params.join(", ")})"
+      raw_call = "(#{raw_call_params.join(", ")})"
       path_parts = operation[:path].split("/")
       path_parts.map! do |p|
         if p =~ /\{\w+\}/
@@ -214,12 +221,13 @@ task :generate do
       http_call_params = %w[headers params].map { |p| "#{p}: #{p}" }
       http_call_params << ("payload: #{body_param["name"]}" if operation[:body])
 
-      if operation[:query].any?
-        http_call = "params.merge!(#{operation[:query].map { |q| "'#{q["name"]}' => #{q["name"]}" }.join(", ")})\n"
-        http_call += "#{operation[:method]}(\"#{path}\", #{http_call_params.join(", ")})"
-      else
-        http_call = "#{operation[:method]}(\"#{path}\", #{http_call_params.join(", ")})"
-      end
+      params_merge = if operation[:query].any?
+                       "params.merge!(#{operation[:query].map { |q| "'#{q["name"]}' => #{q["name"]}" }.join(", ")})"
+                     else
+                       ""
+                     end
+
+      http_call = "#{operation[:method]}(\"#{path}\", #{http_call_params.join(", ")})"
 
       alias_methods = if method_aliases[method_name]
                         Array(method_aliases[method_name]).sort.map do |alias_name|
@@ -231,13 +239,36 @@ task :generate do
       alias_methods << "alias_method :#{operation[:name]}, :#{method_name}" unless operation[:name] == method_name
       alias_methods = alias_methods.join("\n")
 
-      a << <<~METHOD_DEFINITION
-        #{description}
-        def #{method_name}#{signature}
-          #{http_call}
-        end
-        #{alias_methods}
-      METHOD_DEFINITION
+      if operation[:responses]["200"] && operation[:responses]["200"]["headers"] && operation[:responses]["200"]["headers"].key?("X-Pages")
+        a << <<~METHOD_DEFINITION
+          #{description}
+          def #{method_name}#{signature}
+            #{params_merge}
+            concat_responses(#{method_name}_raw#{raw_call})
+          end
+          #{alias_methods}
+
+          #{description}
+          def #{method_name}_raw#{signature}
+            #{params_merge}
+            #{http_call}
+          end
+        METHOD_DEFINITION
+      else
+        a << <<~METHOD_DEFINITION
+          #{description}
+          def #{method_name}#{signature}
+            #{method_name}_raw#{raw_call}.json
+          end
+          #{alias_methods}
+
+          #{description}
+          def #{method_name}_raw#{signature}
+            #{params_merge}
+            #{http_call}
+          end
+        METHOD_DEFINITION
+      end
     end
 
     lib_content = <<~MODULE_DEFINITION
@@ -289,12 +320,14 @@ task :generate do
 
       with_query = operation[:query].any? ? ".with(query: { #{operation[:query].map { |p| "#{p["name"]}: \"1234567890\"" }.join(", ")} })" : ""
 
+      extra_headers = success_desc["headers"] && success_desc["headers"]["X-Pages"] ? ", 'X-Pages': '1'" : ""
+
       describe = "  describe \"##{method_name}\" do\n"
       describe += "    context \"when the response is #{success_code}\" do\n"
       describe += "      let(:response) { #{success_response_body} }\n"
       describe += "\n"
       describe += "      before do\n"
-      describe += "        stub_request(:#{operation[:method]}, \"https://esi.evetech.net/latest#{success_path}\")#{with_query}.to_return(body: response.to_json)\n"
+      describe += "        stub_request(:#{operation[:method]}, \"https://esi.evetech.net/latest#{success_path}\")#{with_query}.to_return(body: response.to_json, headers: { 'Content-Type': 'application/json'#{extra_headers} })\n"
       describe += "      end\n"
       describe += "\n"
       describe += "      it \"returns the response\" do\n"
@@ -313,7 +346,7 @@ task :generate do
         context += "      let(:response) { #{error_response_body} }\n"
         context += "\n"
         context += "      before do\n"
-        context += "        stub_request(:#{operation[:method]}, \"https://esi.evetech.net/latest#{success_path}\")#{with_query}.to_return(body: response.to_json, status: #{code})\n"
+        context += "        stub_request(:#{operation[:method]}, \"https://esi.evetech.net/latest#{success_path}\")#{with_query}.to_return(body: response.to_json, status: #{code}, headers: { 'Content-Type': 'application/json' })\n"
         context += "      end\n"
         context += "\n"
         context += "      it \"raises a #{error_mapping[code.to_i]} error\" do\n"

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "esi/sdk"
+require "esi-sdk"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/esi-sdk.gemspec

@@ -26,8 +26,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 1.5"
-  spec.add_dependency "faraday-http-cache", "~> 2.2"
-  spec.add_dependency "faraday_middleware", "~> 1.0"
-  spec.add_dependency "typhoeus", "~> 1.4"
+  spec.add_dependency "httpx", "~> 0.18"
+  spec.add_dependency "retriable", "~> 3.1"
 end

data/lib/esi/client/alliance.rb

@@ -26,10 +26,35 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id
       def get_alliance(alliance_id:, headers: {}, params: {})
-        get("/alliances/#{alliance_id}/", headers: headers, params: params)
+        get_alliance_raw(alliance_id: alliance_id, headers: headers, params: params).json
       end
       alias get_alliances_alliance_id get_alliance
 
+      # Public information about an alliance.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v3
+      # @esi_version v4
+      #
+      # @param alliance_id [Integer] An EVE alliance ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::NotFoundError] Alliance not found
+      # @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/#/Alliance/get_alliances_alliance_id
+      def get_alliance_raw(alliance_id:, headers: {}, params: {})
+        get("/alliances/#{alliance_id}/", headers: headers, params: params)
+      end
+
       # List all current member corporations of an alliance.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -51,10 +76,34 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id_corporations
       def get_alliance_corporations(alliance_id:, headers: {}, params: {})
-        get("/alliances/#{alliance_id}/corporations/", headers: headers, params: params)
+        get_alliance_corporations_raw(alliance_id: alliance_id, headers: headers, params: params).json
       end
       alias get_alliances_alliance_id_corporations get_alliance_corporations
 
+      # List all current member corporations of an alliance.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      # @esi_version v2
+      #
+      # @param alliance_id [Integer] An EVE alliance 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::InternalServerError] Internal server error
+      # @raise [ESI::Errors::ServiceUnavailableError] Service unavailable
+      # @raise [ESI::Errors::GatewayTimeoutError] Gateway timeout
+      #
+      # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id_corporations
+      def get_alliance_corporations_raw(alliance_id:, headers: {}, params: {})
+        get("/alliances/#{alliance_id}/corporations/", headers: headers, params: params)
+      end
+
       # Get the icon urls for a alliance.
       #
       # @esi_version legacy
@@ -73,10 +122,31 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Alliance/get_alliances_alliance_id_icons
       def get_alliance_icons(alliance_id:, headers: {}, params: {})
-        get("/alliances/#{alliance_id}/icons/", headers: headers, params: params)
+        get_alliance_icons_raw(alliance_id: alliance_id, headers: headers, params: params).json
       end
       alias get_alliances_alliance_id_icons get_alliance_icons
 
+      # Get the icon urls for a alliance.
+      #
+      # @esi_version legacy
+      # @esi_version v1
+      #
+      # @param alliance_id [Integer] An EVE alliance ID
+      # @param params [Hash] Additional query string parameters
+      # @param headers [Hash] Additional headers
+      #
+      # @raise [ESI::Errors::BadRequestError] Bad request
+      # @raise [ESI::Errors::NotFoundError] No image server for this datasource
+      # @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/#/Alliance/get_alliances_alliance_id_icons
+      def get_alliance_icons_raw(alliance_id:, headers: {}, params: {})
+        get("/alliances/#{alliance_id}/icons/", headers: headers, params: params)
+      end
+
       # List all active player alliances.
       #
       # This endpoint is cached for up to 3600 seconds.
@@ -97,6 +167,29 @@ module ESI
       #
       # @see https://esi.evetech.net/ui/#/Alliance/get_alliances
       def get_alliances(headers: {}, params: {})
+        get_alliances_raw(headers: headers, params: params).json
+      end
+
+      # List all active player alliances.
+      #
+      # This endpoint is cached for up to 3600 seconds.
+      #
+      # @esi_version dev
+      # @esi_version legacy
+      # @esi_version v1
+      # @esi_version v2
+      #
+      # @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/#/Alliance/get_alliances
+      def get_alliances_raw(headers: {}, params: {})
         get("/alliances/", headers: headers, params: params)
       end
     end