relic_link 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a9653c0649e12019ff4063d809eda6a317fa0eb0dbc1bf7518df0dc2a92ef3
-  data.tar.gz: 476e0b48c7753f552fbb1e0b33f1366c1683b75845f4244716574a39bb62c161
+  metadata.gz: 91f52523becf51e404509246fefdcdbd84a86113924a1e8d0c9d82a1c29b0930
+  data.tar.gz: 914a001a68c62e4ddea565bc2591c09ffe3ce71de99461f079a56c91e6891dae
 SHA512:
-  metadata.gz: a5337418bfd5336e1f1e2e521dab13ae49e5e711e94bee4b4b5499bf703344d8cc82e6515f75deae727c3718a425a2fe0ad3a7a88ffd7f2e1f926b726dd29b26
-  data.tar.gz: e0d92805ae1aadba0cd464e12b2a056f9112d40f525f41982dafab433b04dd5c8ec0e9979c4fc4fab5b01a914b48b0a76d62f22a4cc56c7d4795e335eedff69a
+  metadata.gz: fcb580a08a348b9332adfd000c3621f7c91553f066618e0ae0f6e2ddafec2d9be22dfd61e2cbac35a4464891bd5cf92ea2df5f0194413c1065b5623e6cf6bf1a
+  data.tar.gz: 6641c8b30587fb37118a3201a8e3dca50ebd112f96280774f74ad9749ec2e350e6cd4ffc342be75608c025a2fa5ee87f8a76aafec9f88973052361ff68ce54c8

data/.rubocop.yml

@@ -5,5 +5,11 @@ AllCops:
 Metrics/BlockLength:
   Enabled: false
 
+Style/GlobalStdStream:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
 Style/NumericLiterals:
   Enabled: false

data/Gemfile

@@ -9,6 +9,6 @@ gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
 
-gem 'rubocop', '~> 1.21'
+gem 'rubocop', '~> 1.52'
 
 gem 'vcr', '~> 6.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    relic_link (0.1.1)
+    relic_link (0.1.2)
       faraday (~> 2.7)
       faraday-mashify (~> 0.1)
       hashie (~> 5.0)
@@ -11,7 +11,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    faraday (2.7.4)
+    faraday (2.7.6)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-mashify (0.1.1)
@@ -21,8 +21,10 @@ GEM
     hashie (5.0.0)
     json (2.6.3)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
@@ -40,7 +42,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -50,7 +52,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
@@ -59,12 +61,13 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)
   relic_link!
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.52)
   vcr (~> 6.1)
 
 BUNDLED WITH

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.1)
+[![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.0.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.1) 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.0.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/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/client.rb

@@ -13,6 +13,34 @@ module RelicLink
       include Faraday::Connection
       include Api::Endpoints
       include Util
+
+      attr_accessor(*RelicLink::Coh3::Config::ATTRIBUTES)
+
+      # Initializes a new client.
+      #
+      # @option options [Logger] :logger
+      #   Instance of a logging class. If not provided, defaults to +STDOUT+ at +Logging::WARN+.
+      #
+      # @return [Client]
+      def initialize(options = {})
+        RelicLink::Coh3::Config::ATTRIBUTES.each do |key|
+          send("#{key}=", options.fetch(key, RelicLink::Coh3.config.send(key)))
+        end
+        @logger ||= RelicLink::Coh3::Config.logger || RelicLink::Logger.default
+      end
+
+      class << self
+        # Set configuration options. Can be set on the returned object
+        # directly or in a block.
+        def configure
+          block_given? ? yield(RelicLink::Coh3::Config) : RelicLink::Coh3::Config
+        end
+
+        # Current config module.
+        def config
+          RelicLink::Coh3::Config
+        end
+      end
     end
   end
 end

data/lib/relic_link/coh3/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RelicLink
+  # Company of Heroes 3 API wrapper.
+  module Coh3
+    # Configuration options for the CoH3 API client.
+    module Config
+      extend self
+
+      # Configurable attributes
+      ATTRIBUTES = %i[
+        logger
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      # Set all config options back to defaults.
+      def reset
+        self.logger = nil
+      end
+
+      module_function :reset
+    end
+
+    class << self
+      # Set configuration options. Can be set on the returned object
+      # directly or in a block.
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      # Current config module.
+      def config
+        Config
+      end
+    end
+  end
+end
+
+RelicLink::Coh3::Config.reset

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

@@ -16,9 +16,11 @@ module RelicLink
           ) do |f|
             f.params[:title] = 'coh3'
 
-            f.response :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,28 @@
+# 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
+
+            return unless env.success?
+
+            body = env.body
+            return unless body
+
+            return if body['result']['code'].zero?
+
+            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,46 @@
+# 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 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/logger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module RelicLink
+  # Default logging class.
+  class Logger < ::Logger
+    # Default logger, used when a logger is not provided in config.
+    # Default log output is +STDOUT+ and log level is +Logger::WARN+.
+    #
+    # @return [::Logger]
+    def self.default
+      return @default if @default
+
+      logger = new STDOUT
+      logger.level = Logger::WARN
+      @default = logger
+    end
+  end
+end

data/lib/relic_link/version.rb

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

data/lib/relic_link.rb

@@ -1,8 +1,19 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'hashie'
 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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,10 +76,18 @@ 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
 - sig/relic_link.rbs