relic_link 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 933d2d2f0ea7389569d273f910d7c81ccd0abb7f4db84353ba52a537a44fcff8
-  data.tar.gz: 927197b6cf76cc074e4a01bf945f9970005e1c10322ec260f3117022fa39c9ef
+  metadata.gz: 5dd48a69634e2aa875e803418d20d0a0efbe30b967fa79291446011141cad56a
+  data.tar.gz: f88e3a85be7b1b8294e0f70eefed82d5e2dbc37e0e4e84f15d3d3dc2a86ee4ac
 SHA512:
-  metadata.gz: d1a53aefa0bd7708f790901dd03d25446b04702dabf7037abeacdef38127365ba9d5f9ffd37969a5604ca254ed73f08f2fa6908b7eda5cba6427e9e49c314d18
-  data.tar.gz: 5b1286b258c58bd9fcaf29123da22a944a6942a455b955bfe1b7e4e9b8f1951500c495b13e364d58ce3141cc8a8fe323482904b756f7b2f72726cf81d826d657
+  metadata.gz: 152d82681993c93f8032dc16cb404569d12a248f0946085d49f4b0d660a21d2fad41d6659a0764128f7d014448ea3c61e41cd970a3cb9ee62be83f4134266154
+  data.tar.gz: 2da9d7c64bce6cccbfec9b7db516fdea4214a952e3938d9cd0cd61c1b6abda752c7a247edc94505036fa32a6572ec46afa4ac1bd1f36277407880848e80092f1

data/.rubocop.yml

@@ -1,3 +1,7 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
@@ -11,6 +15,39 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 15
 
+Naming/PredicateMethod:
+  Enabled: false
+
+Rake/Desc:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/HookArgument:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
 Style/GlobalStdStream:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-3.2.4
+3.4.5

data/Gemfile

@@ -5,10 +5,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in relic_link.gemspec
 gemspec
 
-gem 'rake', '~> 13.2'
+gem 'rake', '~> 13.4'
 
 gem 'rspec', '~> 3.13'
 
-gem 'rubocop', '~> 1.65'
+gem 'rubocop', '~> 1.86'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
 
-gem 'vcr', '~> 6.2'
+gem 'vcr', '~> 6.4'

data/Gemfile.lock

@@ -1,83 +1,97 @@
 PATH
   remote: .
   specs:
-    relic_link (1.2.0)
+    relic_link (1.3.0)
       faraday (~> 2.7)
-      faraday-mashify (~> 0.1)
+      faraday-mashify (>= 0.1, < 2.0)
       hashie (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    diff-lcs (1.5.1)
-    faraday (2.10.1)
-      faraday-net_http (>= 2.0, < 3.2)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    faraday (2.14.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
       logger
-    faraday-mashify (0.1.1)
+    faraday-mashify (1.0.2)
       faraday (~> 2.0)
       hashie
-    faraday-net_http (3.1.1)
-      net-http
-    hashie (5.0.0)
-    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)
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    hashie (5.1.0)
+      logger
+    json (2.19.4)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
+    prism (1.9.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.4)
-      strscan
-    rspec (3.13.0)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.65.1)
+    rspec-support (3.13.7)
+    rubocop (1.86.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.0)
-      parser (>= 3.3.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
-    uri (0.13.0)
-    vcr (6.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    vcr (6.4.0)
 
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-23
+  arm64-darwin-24
+  arm64-darwin-25
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.2)
+  rake (~> 13.4)
   relic_link!
   rspec (~> 3.13)
-  rubocop (~> 1.65)
-  vcr (~> 6.2)
+  rubocop (~> 1.86)
+  rubocop-rake
+  rubocop-rspec
+  vcr (~> 6.4)
 
 BUNDLED WITH
-   2.5.17
+  4.0.5

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.2.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.1)
 
 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.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!
+Consult the [documentation](https://rubydoc.info/github/ryantaylor/relic_link/v1.2.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!
 
 ## Contributing
 

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Api
+      module Endpoints
+        # Endpoint definitions for the internal CoH3 advertisement API.
+        module Advertisements
+          # Fetch games currently observable by spectators.
+          #
+          # This is a private internal Relic endpoint that returns games currently open
+          # to spectators. Both +data_checksum+ and +app_binary_checksum+ act as
+          # version-compatibility filters — only games matching both checksums are returned.
+          #
+          # @option options [String] :token
+          #   Valid CoH3 game client authentication token (required)
+          # @option options [Integer] :data_checksum
+          #   Version-specific CRC32 of game data files (required)
+          # @option options [Integer] :app_binary_checksum
+          #   PE build number of the game binary (required)
+          # @option options [Integer] :start (0)
+          #   Zero-based index of the first result to return.
+          # @option options [Integer] :count (200)
+          #   Number of results to return. Must be an integer between 1 and 200.
+          #
+          # @raise [ArgumentError] if one of the required parameters are not provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [RelicLink::Errors::UnauthorizedError] if the +token+ provided is invalid.
+          # @raise [RelicLink::Errors::BadRequestError] if inputs are missing or violate type constraints.
+          def find_observable_advertisements(options = {})
+            validate_observable_advertisements_options!(options)
+            get(advertisements, 'findObservableAdvertisements',
+                observable_advertisements_params(options))
+          end
+
+          # Fetch active game lobbies (ranked and custom) for a given match type.
+          #
+          # @option options [String] :token
+          #   Valid CoH3 game client authentication token (required)
+          # @option options [Integer] :data_checksum
+          #   Version-specific CRC32 of game data files (required)
+          # @option options [Integer] :app_binary_checksum
+          #   PE build number of the game binary (required)
+          # @option options [Integer] :matchtype_id
+          #   Match type to filter by (required)
+          # @option options [Integer] :start (0)
+          #   Zero-based index of the first result to return.
+          # @option options [Integer] :count (200)
+          #   Number of results to return. Must be an integer between 1 and 200.
+          #
+          # @raise [ArgumentError] if one of the required parameters are not provided.
+          # @raise [RelicLink::Errors::ServerError] if Relic's API is down.
+          # @raise [RelicLink::Errors::RateLimitError] if you're rate-limited.
+          # @raise [RelicLink::Errors::UnauthorizedError] if the +token+ provided is invalid.
+          # @raise [RelicLink::Errors::BadRequestError] if inputs are missing or violate type constraints.
+          def find_advertisements(options = {})
+            validate_advertisements_options!(options)
+            get(advertisements, 'findAdvertisements',
+                advertisements_params(options))
+          end
+
+        private
+
+          def observable_advertisements_params(options)
+            base_advertisement_params(options).merge(observerGroupID: -2)
+          end
+
+          def advertisements_params(options)
+            base_advertisement_params(options).merge(matchtype_id: options[:matchtype_id])
+          end
+
+          def base_advertisement_params(options) # rubocop:disable Metrics/MethodLength
+            {
+              connect_id: options[:token],
+              sessionID: options[:token],
+              appBinaryChecksum: options[:app_binary_checksum],
+              dataChecksum: options[:data_checksum],
+              modDLLChecksum: 0,
+              modDLLFile: 'INVALID',
+              modName: 'INVALID',
+              modVersion: 'INVALID',
+              versionFlags: 0,
+              callNum: rand(1..999),
+              desc: 0,
+              sortOrder: 0,
+              start: options.fetch(:start, 0),
+              count: options.fetch(:count, 200)
+            }
+          end
+
+          def validate_observable_advertisements_options!(options)
+            missing = []
+            missing << 'token'               if options[:token].nil?
+            missing << 'data_checksum'       if options[:data_checksum].nil?
+            missing << 'app_binary_checksum' if options[:app_binary_checksum].nil?
+            missing_str = missing.map { |s| ":#{s}" }.join(', ')
+
+            raise ArgumentError, "Missing required params #{missing_str}" unless missing.empty?
+
+            true
+          end
+
+          def validate_advertisements_options!(options) # rubocop:disable Metrics/AbcSize
+            missing = []
+            missing << 'token'               if options[:token].nil?
+            missing << 'data_checksum'       if options[:data_checksum].nil?
+            missing << 'app_binary_checksum' if options[:app_binary_checksum].nil?
+            missing << 'matchtype_id'        if options[:matchtype_id].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.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'endpoints/advertisements'
 require_relative 'endpoints/leaderboards'
 require_relative 'endpoints/matches'
 require_relative 'endpoints/replays'
@@ -9,6 +10,7 @@ module RelicLink
   module Coh3
     module Api
       module Endpoints
+        include Advertisements
         include Leaderboards
         include Matches
         include Replays

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

@@ -14,6 +14,8 @@ module RelicLink
           @stats ||= ::Faraday.new(
             url: 'https://coh3-api.reliclink.com/community/leaderboard'
           ) do |f|
+            ::Faraday::Mashify::Middleware.mash_class = ResponseMash
+
             f.params[:title] = 'coh3'
 
             f.use ::RelicLink::Coh3::Faraday::Response::RaiseHttpError
@@ -29,6 +31,8 @@ module RelicLink
           @replays ||= ::Faraday.new(
             url: 'https://coh3-api.reliclink.com/game/Replay'
           ) do |f|
+            ::Faraday::Mashify::Middleware.mash_class = ResponseMash
+
             f.params[:callNum] = rand(5..354)
 
             f.use ::RelicLink::Coh3::Faraday::Response::RaiseHttpError
@@ -39,6 +43,21 @@ module RelicLink
             f.response :logger, logger if logger
           end
         end
+
+        def advertisements
+          @advertisements ||= ::Faraday.new(
+            url: 'https://coh3-api.reliclink.com/game/advertisement'
+          ) do |f|
+            ::Faraday::Mashify::Middleware.mash_class = ResponseMash
+
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseHttpError
+            f.use ::RelicLink::Coh3::Faraday::Response::RaiseAdvertisementError
+            f.response :mashify
+            f.response :json
+            f.use ::RelicLink::Faraday::Response::WrapError
+            f.response :logger, logger if logger
+          end
+        end
       end
     end
   end

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

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

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RelicLink
+  module Coh3
+    module Faraday
+      # Wrapper for +Hashie::Mash+ that disables conflict warnings.
+      class ResponseMash < Hashie::Mash
+        disable_warnings
+      end
+    end
+  end
+end

data/lib/relic_link/version.rb

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

data/lib/relic_link.rb

@@ -12,6 +12,7 @@ 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_http_error'
+require_relative 'relic_link/coh3/faraday/response/raise_advertisement_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'
@@ -19,6 +20,7 @@ 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'
+require_relative 'relic_link/coh3/faraday/response_mash'
 require_relative 'relic_link/coh3/faraday/connection'
 require_relative 'relic_link/coh3/client'
 require_relative 'relic_link/version'

data/relic_link.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '~> 2.7'
-  spec.add_dependency 'faraday-mashify', '~> 0.1'
+  spec.add_dependency 'faraday-mashify', '>= 0.1', '< 2.0'
   spec.add_dependency 'hashie', '~> 5.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: relic_link
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ryantaylor
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,16 +27,22 @@ dependencies:
   name: faraday-mashify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +76,7 @@ files:
 - Rakefile
 - lib/relic_link.rb
 - lib/relic_link/coh3/api/endpoints.rb
+- lib/relic_link/coh3/api/endpoints/advertisements.rb
 - lib/relic_link/coh3/api/endpoints/leaderboards.rb
 - lib/relic_link/coh3/api/endpoints/leaderboards/ids.rb
 - lib/relic_link/coh3/api/endpoints/leaderboards/sort.rb
@@ -83,9 +89,11 @@ 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_advertisement_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/faraday/response_mash.rb
 - lib/relic_link/coh3/util.rb
 - lib/relic_link/errors/server_error.rb
 - lib/relic_link/faraday/request.rb
@@ -102,7 +110,6 @@ metadata:
   homepage_uri: https://github.com/ryantaylor/relic_link
   source_code_uri: https://github.com/ryantaylor/relic_link
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Wrapper for Relic APIs
 test_files: []