relic_link 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf617099e292af72fd7cca5444c0ed5133db251d8d147697e91d75cf7d8dc0b9
-  data.tar.gz: e9dd839fe8db31538220b633150cac6b226b3bb87f76bc6ab7b0d0d48dfca613
+  metadata.gz: d2c116d6c2b0d54175c3bd00e7989271a969cda9f449e9a4ed2cf39e9680a830
+  data.tar.gz: 7fc992b307a307571689b9b882a749f98b9b704e91c33e96a1efc2ab98283148
 SHA512:
-  metadata.gz: 663c350662a7ef6b58a737dfae8b0065475b40f09f1b0c09a827e861d77fe1ddac0cce349d7f9ca7cd06e8ff220f3f723be32755b7fb6739612b654808de491a
-  data.tar.gz: b280809d55eb9142913360eaf50b9d4ee6ad3bfa1ba90c785efe1a22254d6ef0004fc4627374af0864e3aaf02912726a1ec0e01b0fa2ab8a1bf308a5520ae62b
+  metadata.gz: fe144e6f63b10cf4692c796860aa35d682d4e9738aab9ac0af471465ec7415628d36825581f2f505f07b40af7013052cfd8d82e647c5113b250325b8424127e8
+  data.tar.gz: 9c84ca93917faf1262bbdcd49446ec5d6bf813df88e984bf33c19c3665a37c3b7b34b6056485e8fb9cb45c06fb71a236c2a810633eeff6d8e63cd09b30260973

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.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    relic_link (0.1.0)
+    relic_link (0.1.1)
       faraday (~> 2.7)
+      faraday-mashify (~> 0.1)
+      hashie (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,39 +14,43 @@ GEM
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
+    faraday-mashify (0.1.1)
+      faraday (~> 2.0)
+      hashie
     faraday-net_http (3.0.2)
+    hashie (5.0.0)
     json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    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.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rubocop (1.50.2)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
@@ -53,6 +59,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)

data/README.md

@@ -1,5 +1,7 @@
 # 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)
+
 A client wrapper for Relic APIs. Currently supports the Company of Heroes 3 leaderboard, stats, and recent matches API.
 
 ## Installation
@@ -27,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 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/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!
 
 ## Contributing
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'faraday/mashify'
+
 module RelicLink
   module Coh3
     module Faraday
@@ -14,7 +16,8 @@ module RelicLink
           ) do |f|
             f.params[:title] = 'coh3'
 
-            f.response :logger
+            f.response :logger, logger if logger
+            f.response :mashify
             f.response :json
           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.0'
+  VERSION = '0.1.2'
 end

data/lib/relic_link.rb

@@ -1,8 +1,12 @@
 # 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/coh3/util'
 require_relative 'relic_link/coh3/api/endpoints'
 require_relative 'relic_link/faraday/request'

data/relic_link.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -31,6 +31,8 @@ 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 'hashie', '~> 5.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relic_link
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-mashify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Wraps Relic APIs for easy access in Ruby. Current supports CoH3 stats/leaderboards
   API.
 email:
@@ -49,9 +77,11 @@ files:
 - lib/relic_link/coh3/api/endpoints/matches.rb
 - lib/relic_link/coh3/api/endpoints/stats.rb
 - lib/relic_link/coh3/client.rb
+- lib/relic_link/coh3/config.rb
 - lib/relic_link/coh3/faraday/connection.rb
 - lib/relic_link/coh3/util.rb
 - lib/relic_link/faraday/request.rb
+- lib/relic_link/logger.rb
 - lib/relic_link/version.rb
 - relic_link.gemspec
 - sig/relic_link.rbs