relic_link 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91f52523becf51e404509246fefdcdbd84a86113924a1e8d0c9d82a1c29b0930
-  data.tar.gz: 914a001a68c62e4ddea565bc2591c09ffe3ce71de99461f079a56c91e6891dae
+  metadata.gz: 933d2d2f0ea7389569d273f910d7c81ccd0abb7f4db84353ba52a537a44fcff8
+  data.tar.gz: 927197b6cf76cc074e4a01bf945f9970005e1c10322ec260f3117022fa39c9ef
 SHA512:
-  metadata.gz: fcb580a08a348b9332adfd000c3621f7c91553f066618e0ae0f6e2ddafec2d9be22dfd61e2cbac35a4464891bd5cf92ea2df5f0194413c1065b5623e6cf6bf1a
-  data.tar.gz: 6641c8b30587fb37118a3201a8e3dca50ebd112f96280774f74ad9749ec2e350e6cd4ffc342be75608c025a2fa5ee87f8a76aafec9f88973052361ff68ce54c8
+  metadata.gz: d1a53aefa0bd7708f790901dd03d25446b04702dabf7037abeacdef38127365ba9d5f9ffd37969a5604ca254ed73f08f2fa6908b7eda5cba6427e9e49c314d18
+  data.tar.gz: 5b1286b258c58bd9fcaf29123da22a944a6942a455b955bfe1b7e4e9b8f1951500c495b13e364d58ce3141cc8a8fe323482904b756f7b2f72726cf81d826d657

data/.rubocop.yml

@@ -2,9 +2,15 @@ AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
 
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/MethodLength:
+  Max: 15
+
 Style/GlobalStdStream:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.4

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.2'
 
-gem 'rspec', '~> 3.0'
+gem 'rspec', '~> 3.13'
 
-gem 'rubocop', '~> 1.52'
+gem 'rubocop', '~> 1.65'
 
-gem 'vcr', '~> 6.1'
+gem 'vcr', '~> 6.2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    relic_link (0.1.2)
+    relic_link (1.2.0)
       faraday (~> 2.7)
       faraday-mashify (~> 0.1)
       hashie (~> 5.0)
@@ -10,65 +10,74 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    diff-lcs (1.5.0)
-    faraday (2.7.6)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    diff-lcs (1.5.1)
+    faraday (2.10.1)
+      faraday-net_http (>= 2.0, < 3.2)
+      logger
     faraday-mashify (0.1.1)
       faraday (~> 2.0)
       hashie
-    faraday-net_http (3.0.2)
+    faraday-net_http (3.1.1)
+      net-http
     hashie (5.0.0)
-    json (2.6.3)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    logger (1.6.0)
+    net-http (0.4.1)
+      uri
+    parallel (1.26.1)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
-    racc (1.7.0)
+    racc (1.8.1)
     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.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.4)
+      strscan
+    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.1)
       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.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.52.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.1)
       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)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.32.0)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    unicode-display_width (2.4.2)
-    vcr (6.1.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
+    vcr (6.2.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.0)
+  rake (~> 13.2)
   relic_link!
-  rspec (~> 3.0)
-  rubocop (~> 1.52)
-  vcr (~> 6.1)
+  rspec (~> 3.13)
+  rubocop (~> 1.65)
+  vcr (~> 6.2)
 
 BUNDLED WITH
-   2.4.7
+   2.5.17

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/v1.0.0)
+[![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.2.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/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!
+Consult the [documentation](https://rubydoc.info/github/ryantaylor/relic_link/v1.2.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,8 +10,11 @@ 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')
+            get(stats, 'getAvailableLeaderboards')
           end
 
           # Retrieve the leaderboard with the given ID. For your convenience
@@ -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))
+            get(stats, '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,12 +22,18 @@ 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'
             end
 
-            get('getRecentMatchHistory', array_params(options))
+            get(stats, 'getRecentMatchHistory', array_params(options))
           end
 
           # Retrieve the match history information for the given profile ID. Profile
@@ -39,10 +45,13 @@ 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?
 
-            get('getRecentMatchHistoryByProfileId', { profile_id: })
+            get(stats, 'getRecentMatchHistoryByProfileId', { profile_id: })
           end
         end
       end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Api
+      module Endpoints
+        # Endpoint definitions for the internal CoH3 replays API.
+        module Replays
+          # Request a signed download URL for a replay at the given +path+, using the given
+          # authentication +token+. Path values can be retrieved from any endpoint that returns
+          # a player's game history, by looking for a +matchurls+ key in the JSON response.
+          # Note that this is a protected internal endpoint, which means a request without a
+          # valid token will return an authentication error. Tokens can be extracted from the
+          # game client by setting up a man-in-the-middle proxy between your game client and
+          # the Relic servers, but be warned that tokens expire quickly and this endpoint may
+          # change at any time. Use at your own risk!
+          #
+          # Relic generally keeps a player's 10 most recent replay files, and files older than
+          # that are removed from storage and inaccessible. When this happens, the replay is
+          # considered expired and requests for that path will raise an error.
+          #
+          # @option options [String] :token
+          #   Valid CoH3 game client authentication token (required)
+          # @option options [String] :path
+          #   Path to a CoH3 replay file stored on Relic's infrastructure (required)
+          #
+          # @raise [ArgumentError] if one of the required parameters are not provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::UnauthorizedError] if the +token+ provided is invalid.
+          # @raise [Errors::ExpiredPath] if the file at the +path+ provided has expired or does not exist.
+          def replay_url(options = {})
+            validate_options!(options)
+            get(replays, 'requestSignedReplayDownloadUri', {
+                  connect_id: options[:token],
+                  key: options[:path],
+                  sessionID: options[:token]
+                })
+          end
+
+        private
+
+          def validate_options!(options)
+            missing = []
+            missing << 'token' if options[:token].nil?
+            missing << 'path' if options[:path].nil?
+            missing_str = missing.map { |s| ":#{s}" }.join(', ')
+
+            raise ArgumentError, "Missing required params #{missing_str}" unless missing.empty?
+
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,12 +22,18 @@ 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'
             end
 
-            get('getPersonalStat', array_params(options))
+            get(stats, 'getPersonalStat', array_params(options))
           end
         end
       end

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

@@ -2,6 +2,7 @@
 
 require_relative 'endpoints/leaderboards'
 require_relative 'endpoints/matches'
+require_relative 'endpoints/replays'
 require_relative 'endpoints/stats'
 
 module RelicLink
@@ -10,6 +11,7 @@ module RelicLink
       module Endpoints
         include Leaderboards
         include Matches
+        include Replays
         include Stats
       end
     end

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

@@ -9,7 +9,7 @@ module RelicLink
           attr_reader :response
 
           def initialize(message, response = nil)
-            super message
+            super(message)
             @response = response
           end
 

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

@@ -5,6 +5,8 @@ module RelicLink
     module Api
       # Errors specific to the Relic CoH3 API.
       module Errors
+        # Raised when querying for a replay URL with a path that has expired.
+        class ExpiredPath < RelicError; end
         # Raised when querying for a leaderboard that doesn't exist.
         class NotFound < RelicError; end
         # Raised when querying for aliases that don't exist.

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

@@ -8,15 +8,31 @@ 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(
+        def stats
+          @stats ||= ::Faraday.new(
             url: 'https://coh3-api.reliclink.com/community/leaderboard'
           ) do |f|
             f.params[:title] = 'coh3'
 
-            f.use ::RelicLink::Coh3::Faraday::Response::RaiseError
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseHttpError
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseStatsError
+            f.response :mashify
+            f.response :json
+            f.use ::RelicLink::Faraday::Response::WrapError
+            f.response :logger, logger if logger
+          end
+        end
+
+        def replays
+          @replays ||= ::Faraday.new(
+            url: 'https://coh3-api.reliclink.com/game/Replay'
+          ) do |f|
+            f.params[:callNum] = rand(5..354)
+
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseHttpError
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseReplayError
             f.response :mashify
             f.response :json
             f.use ::RelicLink::Faraday::Response::WrapError

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Faraday
+      module Response
+        # Middleware to catch CoH3 API errors and raise them as exceptions.
+        class RaiseHttpError < ::Faraday::Middleware
+          def on_complete(env)
+            raise RelicLink::Errors::BadRequestError, env.response if env.status == 400
+            raise RelicLink::Errors::UnauthorizedError, env.response if env.status == 401
+            raise RelicLink::Errors::RateLimitError, env.response if env.status == 429
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Faraday
+      module Response
+        # Middleware to catch CoH3 API errors and raise them as exceptions.
+        class RaiseReplayError < ::Faraday::Middleware
+          def on_complete(env)
+            return unless env.success?
+
+            body = env.body
+            return unless body
+
+            raise RelicLink::Coh3::Api::Errors::ExpiredPath.new('path has expired', env.response) if body.first == 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relic_link/coh3/faraday/response/{raise_error.rb → raise_stats_error.rb}

@@ -5,10 +5,8 @@ module RelicLink
     module Faraday
       module Response
         # Middleware to catch CoH3 API errors and raise them as exceptions.
-        class RaiseError < ::Faraday::Middleware
+        class RaiseStatsError < ::Faraday::Middleware
           def on_complete(env)
-            raise RelicLink::Errors::BadRequestError, env.response if env.status == 400
-
             return unless env.success?
 
             body = env.body
@@ -16,6 +14,12 @@ module RelicLink
 
             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

data/lib/relic_link/errors/server_error.rb

@@ -8,7 +8,7 @@ module RelicLink
 
       def initialize(message, response)
         @response = response
-        super message
+        super(message)
       end
     end
 
@@ -29,6 +29,20 @@ module RelicLink
       end
     end
 
+    # Raised when a 401 is returned in an API response
+    class UnauthorizedError < HttpRequestError
+      def initialize(response)
+        super('unauthorized', 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)

data/lib/relic_link/faraday/request.rb

@@ -5,7 +5,7 @@ module RelicLink
     # Wrapper for HTTP client +GET+ requests. You should never
     # have to use this directly.
     module Request
-      def get(path, options = {})
+      def get(connection, path, options = {})
         connection.get(path) do |req|
           req.params = req.params.merge(options)
         end.body

data/lib/relic_link/version.rb

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

data/lib/relic_link.rb

@@ -11,7 +11,9 @@ 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/coh3/faraday/response/raise_http_error'
+require_relative 'relic_link/coh3/faraday/response/raise_replay_error'
+require_relative 'relic_link/coh3/faraday/response/raise_stats_error'
 require_relative 'relic_link/faraday/response/wrap_error'
 
 require_relative 'relic_link/coh3/util'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relic_link
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-11 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,7 @@ files:
 - lib/relic_link/coh3/api/endpoints/leaderboards/ids.rb
 - lib/relic_link/coh3/api/endpoints/leaderboards/sort.rb
 - lib/relic_link/coh3/api/endpoints/matches.rb
+- lib/relic_link/coh3/api/endpoints/replays.rb
 - lib/relic_link/coh3/api/endpoints/stats.rb
 - lib/relic_link/coh3/api/error.rb
 - lib/relic_link/coh3/api/errors.rb
@@ -82,7 +83,9 @@ files:
 - 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/faraday/response/raise_http_error.rb
+- lib/relic_link/coh3/faraday/response/raise_replay_error.rb
+- lib/relic_link/coh3/faraday/response/raise_stats_error.rb
 - lib/relic_link/coh3/util.rb
 - lib/relic_link/errors/server_error.rb
 - lib/relic_link/faraday/request.rb
@@ -114,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Wrapper for Relic APIs