relic_link 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91f52523becf51e404509246fefdcdbd84a86113924a1e8d0c9d82a1c29b0930
-  data.tar.gz: 914a001a68c62e4ddea565bc2591c09ffe3ce71de99461f079a56c91e6891dae
+  metadata.gz: b0a6925bd59c93badd256bc6e31c23cf2ecd58827b93b604f2ce4fd954924ee5
+  data.tar.gz: 68e0f9f49e38f2c5d7b6e870684828c21bc88e9d4ecd56c4a7d6245e94462d43
 SHA512:
-  metadata.gz: fcb580a08a348b9332adfd000c3621f7c91553f066618e0ae0f6e2ddafec2d9be22dfd61e2cbac35a4464891bd5cf92ea2df5f0194413c1065b5623e6cf6bf1a
-  data.tar.gz: 6641c8b30587fb37118a3201a8e3dca50ebd112f96280774f74ad9749ec2e350e6cd4ffc342be75608c025a2fa5ee87f8a76aafec9f88973052361ff68ce54c8
+  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.52'
+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.2)
+    relic_link (1.1.0)
       faraday (~> 2.7)
       faraday-mashify (~> 0.1)
       hashie (~> 5.0)
@@ -10,65 +10,69 @@ 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.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.3)
+    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.0)
+    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.52.0)
+      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.29.0)
-      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.52)
-  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/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.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/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.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/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/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(

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

@@ -8,6 +8,7 @@ module RelicLink
         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?
 
@@ -16,6 +17,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,13 @@ module RelicLink
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relic_link
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-11 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday