relic_link 0.1.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c116d6c2b0d54175c3bd00e7989271a969cda9f449e9a4ed2cf39e9680a830
-  data.tar.gz: 7fc992b307a307571689b9b882a749f98b9b704e91c33e96a1efc2ab98283148
+  metadata.gz: b0a6925bd59c93badd256bc6e31c23cf2ecd58827b93b604f2ce4fd954924ee5
+  data.tar.gz: 68e0f9f49e38f2c5d7b6e870684828c21bc88e9d4ecd56c4a7d6245e94462d43
 SHA512:
-  metadata.gz: fe144e6f63b10cf4692c796860aa35d682d4e9738aab9ac0af471465ec7415628d36825581f2f505f07b40af7013052cfd8d82e647c5113b250325b8424127e8
-  data.tar.gz: 9c84ca93917faf1262bbdcd49446ec5d6bf813df88e984bf33c19c3665a37c3b7b34b6056485e8fb9cb45c06fb71a236c2a810633eeff6d8e63cd09b30260973
+  metadata.gz: 9b6b44e95aab707016e1825eecd7f952f63bdceb299b5622fa6d61b27e8930b7559066eab6fd35f83aa4be2131713bab4c17097cb86f46abe878d7bba3228480
+  data.tar.gz: cf4eec64ecffecffb3e4d0e313c5fc0f6c66d5135103be65ddffa4c8251c9d960afbaa706c945290e5c6ce160eaeb18f39a2e4d5055db212906ce8811d1a1e08

data/.rubocop.yml

@@ -2,6 +2,9 @@ AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
 
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
 Metrics/BlockLength:
   Enabled: false
 

data/Gemfile

@@ -5,10 +5,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in relic_link.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem 'rake', '~> 13.1'
 
-gem 'rspec', '~> 3.0'
+gem 'rspec', '~> 3.13'
 
-gem 'rubocop', '~> 1.21'
+gem 'rubocop', '~> 1.61'
 
-gem 'vcr', '~> 6.1'
+gem 'vcr', '~> 6.2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    relic_link (0.1.1)
+    relic_link (1.1.0)
       faraday (~> 2.7)
       faraday-mashify (~> 0.1)
       hashie (~> 5.0)
@@ -10,63 +10,69 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    diff-lcs (1.5.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    diff-lcs (1.5.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
     faraday-mashify (0.1.1)
       faraday (~> 2.0)
       hashie
-    faraday-net_http (3.0.2)
+    faraday-net_http (3.1.0)
+      net-http
     hashie (5.0.0)
-    json (2.6.3)
-    parallel (1.23.0)
-    parser (3.2.2.1)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.50.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.61.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.1)
+      parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    unicode-display_width (2.4.2)
-    vcr (6.1.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    vcr (6.2.0)
 
 PLATFORMS
   arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.0)
+  rake (~> 13.1)
   relic_link!
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  vcr (~> 6.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.61)
+  vcr (~> 6.2)
 
 BUNDLED WITH
    2.4.7

data/README.md

@@ -1,6 +1,6 @@
 # RelicLink
 
-[![Gem Version](https://badge.fury.io/rb/relic_link.svg)](https://badge.fury.io/rb/relic_link) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/relic_link/v0.1.2)
+[![Gem Version](https://badge.fury.io/rb/relic_link.svg)](https://badge.fury.io/rb/relic_link) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/relic_link/v1.1.0)
 
 A client wrapper for Relic APIs. Currently supports the Company of Heroes 3 leaderboard, stats, and recent matches API.
 
@@ -29,7 +29,7 @@ client.recent_match_history(profile_ids: [8230])
 client.recent_match_history_by_profile_id(8230)
 client.personal_stats(profile_ids: [8230])
 ```
-Consult the [documentation](https://rubydoc.info/github/ryantaylor/relic_link/v0.1.2) for all endpoints that have been discovered and are currently queryable. Note that Relic does not publish official documentation for their endpoints, so the functionality here is based on best estimates and is subject to change without warning. Please open an issue if you are aware of endpoints that are not exposed in this library!
+Consult the [documentation](https://rubydoc.info/github/ryantaylor/relic_link/v1.1.0) for all endpoints that have been discovered and are currently queryable. Note that Relic does not publish official documentation for their endpoints, so the functionality here is based on best estimates and is subject to change without warning. Please open an issue if you are aware of endpoints that are not exposed in this library!
 
 ## Contributing
 

data/lib/relic_link/coh3/api/endpoints/leaderboards.rb

@@ -10,6 +10,9 @@ module RelicLink
         # Endpoint definitions for the CoH3 leaderboards API.
         module Leaderboards
           # List available leaderboards and associated metadata.
+          #
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
           def available_leaderboards
             get('getAvailableLeaderboards')
           end
@@ -31,13 +34,18 @@ module RelicLink
           #   Field to sort the leaderboard entries by.
           #
           # @raise [ArgumentError] if the required parameters aren't provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [Errors::NotFound] if +leaderboard_id+ does not correspond to a leaderboard.
+          # @raise [RelicLink::Errors::BadRequestError] if +start+, +count+, or +sort_by+ are outside the
+          #   limits enumerated above.
           def leaderboard(options = {})
             raise ArgumentError, 'Required argument :leaderboard_id missing' if options[:leaderboard_id].nil?
 
             get('getLeaderboard2', format_sort_key(options))
           end
 
-          private
+        private
 
           def format_sort_key(options)
             options.transform_keys do |key|

data/lib/relic_link/coh3/api/endpoints/matches.rb

@@ -22,6 +22,12 @@ module RelicLink
           #   be in the format +/steam/<ID>+ (one of required).
           #
           # @raise [ArgumentError] if none of the required parameters are provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [Errors::UnknownProfileIds] if no values in +profile_ids+ match known profile IDs.
+          # @raise [Errors::UnknownAliases] if no values in +aliases+ match known aliases.
+          # @raise [Errors::UnregisteredProfileName] if no values in +profile_names+ match known profile names.
+          # @raise [RelicLink::Errors::BadRequestError] if inputs violate type constraints.
           def recent_match_history(options = {})
             unless options.keys.intersect?(%i[profile_ids aliases profile_names])
               raise ArgumentError, 'Missing one of required arguments :profile_ids, :aliases, or :profile_names'
@@ -39,6 +45,9 @@ module RelicLink
           # @param profile_id [Integer] Internal Relic ID of player whose stats you wish to retrieve (required).
           #
           # @raise [ArgumentError] if no +profile_id+ provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [RelicLink::Errors::BadRequestError] if input violates type constraints.
           def recent_match_history_by_profile_id(profile_id)
             raise ArgumentError, 'Required argument :profile_id missing' if profile_id.nil?
 

data/lib/relic_link/coh3/api/endpoints/stats.rb

@@ -22,6 +22,12 @@ module RelicLink
           #   be in the format +/steam/<ID>+ (one of required).
           #
           # @raise [ArgumentError] if none of the required parameters are provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [Errors::UnknownProfileIds] if no values in +profile_ids+ match known profile IDs.
+          # @raise [Errors::UnknownAliases] if no values in +aliases+ match known aliases.
+          # @raise [Errors::UnregisteredProfileName] if no values in +profile_names+ match known profile names.
+          # @raise [RelicLink::Errors::BadRequestError] if inputs violate type constraints.
           def personal_stats(options = {})
             unless options.keys.intersect?(%i[profile_ids aliases profile_names])
               raise ArgumentError, 'Missing one of required params :profile_ids, :aliases, or :profile_names'

data/lib/relic_link/coh3/api/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Api
+      Error = Errors::RelicError
+    end
+  end
+end

data/lib/relic_link/coh3/api/errors/relic_error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Api
+      module Errors
+        # Base wrapper for Relic CoH3 API errors.
+        class RelicError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(message, response = nil)
+            super(message)
+            @response = response
+          end
+
+          def error
+            response.body.error
+          end
+
+          def errors
+            response.body.errors
+          end
+
+          def response_metadata
+            response.body.response_metadata
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relic_link/coh3/api/errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Api
+      # Errors specific to the Relic CoH3 API.
+      module Errors
+        # Raised when querying for a leaderboard that doesn't exist.
+        class NotFound < RelicError; end
+        # Raised when querying for aliases that don't exist.
+        class UnknownAliases < RelicError; end
+        # Raised when querying for profile IDs that don't exist.
+        class UnknownProfileIds < RelicError; end
+        # Raised when querying for profile names (such as Steam IDs) that don't exist.
+        class UnregisteredProfileName < RelicError; end
+
+        # Mapping of Relic error messages to error classes.
+        ERROR_CLASSES = {
+          'NOT_FOUND' => NotFound,
+          'UNKNOWN_ALIASES' => UnknownAliases,
+          'UNKNOWN_PROFILE_IDS' => UnknownProfileIds,
+          'UNREGISTERED_PROFILE_NAME' => UnregisteredProfileName
+        }.freeze
+      end
+    end
+  end
+end

data/lib/relic_link/coh3/faraday/connection.rb

@@ -8,7 +8,7 @@ module RelicLink
       # Faraday connection implementation for API requests. You shouldn't
       # ever have to use this directly.
       module Connection
-        private
+      private
 
         def connection
           @connection ||= ::Faraday.new(
@@ -16,9 +16,11 @@ module RelicLink
           ) do |f|
             f.params[:title] = 'coh3'
 
-            f.response :logger, logger if logger
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseError
             f.response :mashify
             f.response :json
+            f.use ::RelicLink::Faraday::Response::WrapError
+            f.response :logger, logger if logger
           end
         end
       end

data/lib/relic_link/coh3/faraday/response/raise_error.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Faraday
+      module Response
+        # Middleware to catch CoH3 API errors and raise them as exceptions.
+        class RaiseError < ::Faraday::Middleware
+          def on_complete(env)
+            raise RelicLink::Errors::BadRequestError, env.response if env.status == 400
+            raise RelicLink::Errors::RateLimitError, env.response if env.status == 429
+
+            return unless env.success?
+
+            body = env.body
+            return unless body
+
+            return if body['result']['code'].zero?
+
+            raise_relic_error!(body, env)
+          end
+
+        private
+
+          def raise_relic_error!(body, env)
+            error_message = body['result']['message']
+            error_class = RelicLink::Coh3::Api::Errors::ERROR_CLASSES[error_message]
+            error_class ||= RelicLink::Coh3::Api::Errors::RelicError
+            raise error_class.new(error_message, env.response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relic_link/errors/server_error.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Errors
+    # Base wrapper for API server errors.
+    class ServerError < ::Faraday::Error
+      attr_reader :response
+
+      def initialize(message, response)
+        @response = response
+        super(message)
+      end
+    end
+
+    # Raised when an API response cannot be parsed.
+    class ParsingError < ServerError
+      def initialize(response)
+        super('parsing_error', response)
+      end
+    end
+
+    # Base wrapper for API HTTP request errors.
+    class HttpRequestError < ServerError; end
+
+    # Raised when a 400 is returned in an API response.
+    class BadRequestError < HttpRequestError
+      def initialize(response)
+        super('bad_request', response)
+      end
+    end
+
+    # Raised when a 429 is returned in an API response.
+    class RateLimitError < HttpRequestError
+      def initialize(response)
+        super('rate_limited', response)
+      end
+    end
+
+    # Raised when an API request times out.
+    class TimeoutError < HttpRequestError
+      def initialize(response)
+        super('timeout_error', response)
+      end
+    end
+
+    # Raised when a 5xx is returned in an API response.
+    class UnavailableError < HttpRequestError
+      def initialize(response)
+        super('unavailable_error', response)
+      end
+    end
+  end
+end

data/lib/relic_link/faraday/request.rb

@@ -9,6 +9,8 @@ module RelicLink
         connection.get(path) do |req|
           req.params = req.params.merge(options)
         end.body
+      rescue ::Faraday::ParsingError => e
+        raise RelicLink::Errors::ParsingError, e.response
       end
     end
   end

data/lib/relic_link/faraday/response/wrap_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Faraday
+    module Response
+      # Middleware to wrap generic API errors and raise them as exceptions.
+      class WrapError < ::Faraday::Middleware
+        UNAVAILABLE_ERROR_STATUSES = (500..599)
+
+        def on_complete(env)
+          return unless UNAVAILABLE_ERROR_STATUSES.cover?(env.status)
+
+          raise RelicLink::Errors::UnavailableError, env.response
+        end
+
+        def call(env)
+          super
+        rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
+          raise RelicLink::Errors::TimeoutError, env.response
+        end
+      end
+    end
+  end
+end

data/lib/relic_link/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelicLink
-  VERSION = '0.1.2'
+  VERSION = '1.1.0'
 end

data/lib/relic_link.rb

@@ -7,6 +7,13 @@ require 'json'
 require_relative 'relic_link/logger'
 require_relative 'relic_link/coh3/config'
 
+require_relative 'relic_link/errors/server_error'
+require_relative 'relic_link/coh3/api/errors/relic_error'
+require_relative 'relic_link/coh3/api/error'
+require_relative 'relic_link/coh3/api/errors'
+require_relative 'relic_link/coh3/faraday/response/raise_error'
+require_relative 'relic_link/faraday/response/wrap_error'
+
 require_relative 'relic_link/coh3/util'
 require_relative 'relic_link/coh3/api/endpoints'
 require_relative 'relic_link/faraday/request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relic_link
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.1.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,11 +76,17 @@ files:
 - lib/relic_link/coh3/api/endpoints/leaderboards/sort.rb
 - lib/relic_link/coh3/api/endpoints/matches.rb
 - lib/relic_link/coh3/api/endpoints/stats.rb
+- lib/relic_link/coh3/api/error.rb
+- lib/relic_link/coh3/api/errors.rb
+- lib/relic_link/coh3/api/errors/relic_error.rb
 - lib/relic_link/coh3/client.rb
 - lib/relic_link/coh3/config.rb
 - lib/relic_link/coh3/faraday/connection.rb
+- lib/relic_link/coh3/faraday/response/raise_error.rb
 - lib/relic_link/coh3/util.rb
+- lib/relic_link/errors/server_error.rb
 - lib/relic_link/faraday/request.rb
+- lib/relic_link/faraday/response/wrap_error.rb
 - lib/relic_link/logger.rb
 - lib/relic_link/version.rb
 - relic_link.gemspec