Ryze 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1ffc8a0a48b952413020566a3adfc125fe69acd7b15286fb6649383683a6b6
-  data.tar.gz: 167af25e1e8087b48e9f67b359cbeb0202347e7a79d4e8990ddcc2248cd88747
+  metadata.gz: 9cfbeff4b1caa0fe79b4a7e1fcb47b219f332e4fc8e2835461fa2b08dd88c4ca
+  data.tar.gz: cb693eb925b0fe22305f35ec8f97260b45c537450534e15c2bd34b8e364abcac
 SHA512:
-  metadata.gz: c7483f8ad68979857238802950ce017e8445b8643617d695b9a242c4aba1910525207b1d9e640ffdd1652aa1b478b4a9ddfed78027bac86c2e275103fcd449a7
-  data.tar.gz: 86e97a917c1cc8099610434c1026de42788e72c4a8c651830848be935f9792eb8899b9605cc6014613c2fdf01229dbfa814afaefd7b7b6f3ea58e7f1468cc666
+  metadata.gz: 1e819e04cf37c7dbb378365a6f6b0b7f0b3cff02f340f3ca456b9c06272b67891dae413a89db88332e60918baebbf6b0fd4e46308e3000097b5d8c884691a393
+  data.tar.gz: 1fd6a0705e23a9cdd85235113de6a50a93f42c5d1521e59346d14b5f7d646ca7c0d06cd4e3540b9bb60801b0e0faf10ca4373a3ea225ec25413b4174c0b6061b

data/.rubocop.yml

@@ -1,5 +1,7 @@
+require: rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true
@@ -13,7 +15,7 @@ Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  AllowedMethods:
     - 'describe'
     - 'context'
     - 'it'
@@ -22,3 +24,13 @@ Naming/FileName:
   Exclude:
     - 'lib/Ryze.rb'
     - 'spec/Ryze_spec.rb'
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+  AllowSubject: true

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2023-04-12
+
+- Lots of changes
 
 ## [0.1.0] - 2023-05-07
 

data/Gemfile

@@ -10,3 +10,9 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "rubocop-rspec", "~> 2.29"
+
+gem "racc"
+
+gem "addressable"

data/Gemfile.lock

@@ -1,22 +1,26 @@
 PATH
   remote: .
   specs:
-    Ryze (0.1.0)
-      faraday (~> 2.7.4)
+    Ryze (0.2.0)
+      addressable (~> 2.7)
+      faraday (~> 2.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     diff-lcs (1.5.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
     faraday-net_http (3.0.2)
     json (2.6.3)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
+    public_suffix (5.0.5)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
@@ -46,19 +50,33 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.29.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-darwin-22
+  x86_64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   Ryze!
+  addressable
+  racc
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rspec (~> 2.29)
 
 BUNDLED WITH
    2.4.1

data/README.md

@@ -8,11 +8,16 @@ Ryze is a Ruby gem that provides a simple interface to the League of Legends Rio
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add ryze
+    $ bundle add Ryze
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install ryze
+    $ gem install Ryze
+
+
+## Documentation
+
+The documentation for this gem can be found [here](https://rubydoc.info/github/clement0910/Ryze/master)
 
 ## Usage
 
@@ -24,7 +29,7 @@ Than, you can create a new client by passing your API key as an argument:
 ```ruby
 require 'ryze'
 
-client = Client.new(api_key: 'YOUR_API_KEY')
+client = Ryze::Client.new(api_key: 'YOUR_API_KEY')
 ```
 
 You can then use the client to make requests to the Riot API:

data/lib/Ryze/client.rb

@@ -27,10 +27,20 @@ module Ryze
       MatchResource.new(self)
     end
 
+    # @return [AccountResource] A new instance of AccountResource.
+    def account
+      AccountResource.new(self)
+    end
+
+    # @return [SpectatorResource] A new instance of SpectatorResource.
+    def spectator
+      SpectatorResource.new(self)
+    end
+
     # @return [Faraday::Connection] A new instance of Faraday::Connection or the current instance.
     def connection
       @connection ||= Faraday.new do |conn|
-        conn.request :json
+        conn.headers["X-Riot-Token"] = @api_key
         conn.response :json, content_type: "application/json"
         conn.adapter adapter, @stubs
       end

data/lib/Ryze/object.rb

@@ -5,9 +5,8 @@ require "ostruct"
 module Ryze
   # Object is a base class for all objects returned from the Riot API.
   class Object < OpenStruct
-    def initialize(attributes, client = nil)
+    def initialize(attributes)
       super to_ostruct(attributes)
-      @client = client
     end
 
     private

data/lib/Ryze/objects/account.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ryze
+  # Match is a class corresponding to the AccountDto Riot API object.
+  class Account < Object; end
+end

data/lib/Ryze/objects/spectator.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ryze
+  # Spectator is a class corresponding to the CurrentGameInfo Riot API object.
+  class Spectator < Object; end
+end

data/lib/Ryze/objects/summoner.rb

@@ -2,13 +2,5 @@
 
 module Ryze
   # Summoner is a class corresponding to the SummonerDto Riot API object.
-  class Summoner < Object
-    # Retrieve the last match of the summoner.
-    #
-    # @return [Match] Match object.
-    def retrieve_last_match
-      match_id = MatchResource.new(@client).retrieve_match_list_by_puuid(puuid: puuid, count: 1).first
-      MatchResource.new(@client).retrieve_match(match_id: match_id)
-    end
-  end
+  class Summoner < Object; end
 end

data/lib/Ryze/resource.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "addressable/uri"
+
 module Ryze
   # Resource is a class that provides a base for all Riot API resources.
   class Resource
@@ -15,10 +17,9 @@ module Ryze
     #
     # @param url [String] The URL to make the request to.
     # @param params [Hash] The parameters to pass to the request.
-    # @param headers [Hash] The headers to pass to the request additional to the default headers.
     # @return [Faraday::Response] The response from the Riot API trailed by the Ryze response handler.
-    def get_request(url, params: {}, headers: {})
-      handle_response client.connection.get(@base_url + url, params, default_headers.merge(headers))
+    def get_request(url, params: {})
+      handle_response client.connection.get(Addressable::URI.encode(url), params)
     end
 
     private
@@ -34,9 +35,5 @@ module Ryze
 
       response
     end
-
-    def default_headers
-      { "X-Riot-Token" => client.api_key }
-    end
   end
 end

data/lib/Ryze/resources/account.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ryze
+  # AccountResource is a class corresponding to the AccountV1 Riot API endpoint.
+  class AccountResource < Resource
+    BASE_URL = "https://europe.api.riotgames.com/riot/account/v1/accounts"
+
+    # Retrieve an account by Riot ID.
+    #
+    # @param game_name [String] Game name of the account.
+    # @param tag_line [String] Tag line of the account.
+    # @return [Account] Account object.
+    def retrieve_account_by_riot_id(game_name:, tag_line:)
+      Account.new get_request("#{BASE_URL}/by-riot-id/#{game_name}/#{tag_line}").body
+    end
+  end
+end

data/lib/Ryze/resources/match.rb

@@ -3,17 +3,14 @@
 module Ryze
   # MatchResource is a class corresponding to the MatchV5 Riot API endpoint.
   class MatchResource < Resource
-    def initialize(client)
-      super
-      @base_url = "https://europe.api.riotgames.com/lol/match/v5"
-    end
+    BASE_URL = "https://europe.api.riotgames.com/lol/match/v5"
 
     # Retrieve a match by match ID.
     #
     # @param match_id [String] Match ID.
     # @return [Match] Match object.
     def retrieve_match(match_id:)
-      Match.new get_request("/matches/#{match_id}").body
+      Match.new get_request("#{BASE_URL}/matches/#{match_id}").body
     end
 
     # Retrieve a match list by account puuid.
@@ -22,7 +19,7 @@ module Ryze
     # @param params [Hash] Parameters to pass to the request.
     # @return [Array<String>] Match IDs.
     def retrieve_match_list_by_puuid(puuid:, **params)
-      Array.new get_request("/matches/by-puuid/#{puuid}/ids", params: params).body
+      Array.new get_request("#{BASE_URL}/matches/by-puuid/#{puuid}/ids", params: params).body
     end
   end
 end

data/lib/Ryze/resources/spectator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ryze
+  # SpectatorResource is a class corresponding to the SpectatorV5 Riot API endpoint.
+  class SpectatorResource < Resource
+    BASE_URL = "https://euw1.api.riotgames.com/lol/spectator/v5"
+
+    # Retrieve a current game by summoner puuid.
+    #
+    # @param puuid [String] Summoner puuid.
+    # @return [Spectator] Spectator object.
+    def retrieve_current_game_by_puuid(puuid:)
+      Spectator.new get_request("#{BASE_URL}/active-games/by-summoner/#{puuid}").body
+    end
+  end
+end

data/lib/Ryze/resources/summoner.rb

@@ -3,25 +3,14 @@
 module Ryze
   # SummonerResource is a class corresponding to the SummonerV4 Riot API endpoint.
   class SummonerResource < Resource
-    def initialize(client)
-      super
-      @base_url = "https://euw1.api.riotgames.com/lol/summoner/v4"
-    end
-
-    # Retrieve a summoner by summoner name.
-    #
-    # @param summoner_name [String] Summoner name.
-    # @return [Summoner] Summoner object.
-    def retrieve_summoner_by_name(summoner_name:)
-      Summoner.new get_request("/summoners/by-name/#{summoner_name}").body, @client
-    end
+    BASE_URL = "https://euw1.api.riotgames.com/lol/summoner/v4"
 
     # Retrieve a summoner by summoner puuid.
     #
     # @param puuid [String] Summoner puuid.
     # @return [Summoner] Summoner object.
     def retrieve_summoner_by_puuid(puuid:)
-      Summoner.new get_request("/summoners/by-puuid/#{puuid}").body, @client
+      Summoner.new get_request("#{BASE_URL}/summoners/by-puuid/#{puuid}").body
     end
 
     # Retrieve a summoner by summoner account ID.
@@ -29,7 +18,7 @@ module Ryze
     # @param account_id [String] Summoner account ID.
     # @return [Summoner] Summoner object.
     def retrieve_summoner_by_account_id(account_id:)
-      Summoner.new get_request("/summoners/by-account/#{account_id}").body, @client
+      Summoner.new get_request("#{BASE_URL}/summoners/by-account/#{account_id}").body
     end
 
     # Retrieve a summoner by summoner ID.
@@ -37,7 +26,7 @@ module Ryze
     # @param summoner_id [String] Summoner ID.
     # @return [Summoner] Summoner object.
     def retrieve_summoner_by_summoner_id(summoner_id:)
-      Summoner.new get_request("/summoners/#{summoner_id}").body, @client
+      Summoner.new get_request("#{BASE_URL}/summoners/#{summoner_id}").body
     end
   end
 end

data/lib/Ryze/version.rb

@@ -2,5 +2,5 @@
 
 module Ryze
   # The current version of the Ryze gem.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/Ryze.rb

@@ -11,7 +11,11 @@ module Ryze
 
   autoload :Summoner, "Ryze/objects/summoner"
   autoload :Match, "Ryze/objects/match"
+  autoload :Account, "Ryze/objects/account"
+  autoload :Spectator, "Ryze/objects/spectator"
 
   autoload :SummonerResource, "Ryze/resources/summoner"
   autoload :MatchResource, "Ryze/resources/match"
+  autoload :AccountResource, "Ryze/resources/account"
+  autoload :SpectatorResource, "Ryze/resources/spectator"
 end

data/sig/Ryze/account.rbs

@@ -0,0 +1,4 @@
+module Ryze
+  class Account
+  end
+end

data/sig/Ryze/account_resource.rbs

@@ -0,0 +1,7 @@
+module Ryze
+  class AccountResource
+    BASE_URL: String
+
+    def retrieve_account_by_riot_id: (game_name: String, tag_line: String) -> Account
+  end
+end

data/sig/{ryze → Ryze}/match_resource.rbs

@@ -1,6 +1,6 @@
 module Ryze
   class MatchResource
-    @base_url: String
+    BASE_URL: String
 
     def retrieve_match: (match_id: String) -> Match
 

data/sig/Ryze/spectator.rbs

@@ -0,0 +1,4 @@
+module Ryze
+  class Spectator
+  end
+end

data/sig/Ryze/spectator_resource.rbs

@@ -0,0 +1,7 @@
+module Ryze
+  class SpectatorResource
+    BASE_URL: String
+
+    def retrieve_current_game_by_puuid: (puuid: String) -> Spectator
+  end
+end

data/sig/{ryze → Ryze}/summoner.rbs

@@ -1,4 +1,4 @@
 module Ryze
-  class Sumonner
+  class Summoner
   end
 end

data/sig/{ryze → Ryze}/summoner_resource.rbs

@@ -1,13 +1,13 @@
 module Ryze
-  class SummonerResource < Resource
-    @base_url: String
+  class SummonerResource
+    BASE_URL: String
 
-    def retrieve_summoner_by_name: (summoner_name: String) -> Sumonner
+    def retrieve_summoner_by_name: (summoner_name: String) -> Summoner
 
-    def retrieve_summoner_by_puuid: (puuid: String) -> Sumonner
+    def retrieve_summoner_by_puuid: (puuid: String) -> Summoner
 
-    def retrieve_summoner_by_account_id: (account_id: String) -> Sumonner
+    def retrieve_summoner_by_account_id: (account_id: String) -> Summoner
 
-    def retrieve_summoner_by_summoner_id: (summoner_id: String) -> Sumonner
+    def retrieve_summoner_by_summoner_id: (summoner_id: String) -> Summoner
   end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: Ryze
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Clément Sapt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.4
+        version: 2.9.0
 description: 'Ruby wrapper for the Riot Games API. Riot Games API can be found here:
   https://developer.riotgames.com/apis'
 email:
@@ -41,23 +55,30 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- Ryze.gemspec
 - lib/Ryze.rb
 - lib/Ryze/client.rb
 - lib/Ryze/error.rb
 - lib/Ryze/object.rb
+- lib/Ryze/objects/account.rb
 - lib/Ryze/objects/match.rb
+- lib/Ryze/objects/spectator.rb
 - lib/Ryze/objects/summoner.rb
 - lib/Ryze/resource.rb
+- lib/Ryze/resources/account.rb
 - lib/Ryze/resources/match.rb
+- lib/Ryze/resources/spectator.rb
 - lib/Ryze/resources/summoner.rb
 - lib/Ryze/version.rb
 - sig/Ryze.rbs
-- sig/ryze/client.rbs
-- sig/ryze/match.rbs
-- sig/ryze/match_resource.rbs
-- sig/ryze/summoner.rbs
-- sig/ryze/summoner_resource.rbs
+- sig/Ryze/account.rbs
+- sig/Ryze/account_resource.rbs
+- sig/Ryze/client.rbs
+- sig/Ryze/match.rbs
+- sig/Ryze/match_resource.rbs
+- sig/Ryze/spectator.rbs
+- sig/Ryze/spectator_resource.rbs
+- sig/Ryze/summoner.rbs
+- sig/Ryze/summoner_resource.rbs
 homepage: https://github.com/clement0910/Ryze
 licenses:
 - MIT
@@ -73,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Simple Ruby wrapper for the Riot Games API.

data/Ryze.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/Ryze/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "Ryze"
-  spec.version = Ryze::VERSION
-  spec.authors = ["Clément Sapt"]
-  spec.email = ["clementsapt@gmail.com"]
-
-  spec.summary = "Simple Ruby wrapper for the Riot Games API."
-  spec.description = "Ruby wrapper for the Riot Games API. Riot Games API can be found here: https://developer.riotgames.com/apis"
-  spec.homepage = "https://github.com/clement0910/Ryze"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/clement0910/Ryze"
-  spec.metadata["changelog_uri"] = "https://github.com/clement0910/Ryze/blob/master/CHANGELOG.md"
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 2.7.4"
-end