Ryze 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cfbeff4b1caa0fe79b4a7e1fcb47b219f332e4fc8e2835461fa2b08dd88c4ca
-  data.tar.gz: cb693eb925b0fe22305f35ec8f97260b45c537450534e15c2bd34b8e364abcac
+  metadata.gz: 16d56dbc179a28d73d4a5883e868fbfc59e14215b854411a0896c4435a1e2258
+  data.tar.gz: c8f83399719110a8df97fcdd1fcebdc67f59cd0064503d4266eb0d40ae52709d
 SHA512:
-  metadata.gz: 1e819e04cf37c7dbb378365a6f6b0b7f0b3cff02f340f3ca456b9c06272b67891dae413a89db88332e60918baebbf6b0fd4e46308e3000097b5d8c884691a393
-  data.tar.gz: 1fd6a0705e23a9cdd85235113de6a50a93f42c5d1521e59346d14b5f7d646ca7c0d06cd4e3540b9bb60801b0e0faf10ca4373a3ea225ec25413b4174c0b6061b
+  metadata.gz: dd0efe9ba09fc6070f234678519157773dc5f5a5b90bcf57745aacb9f659c5a779542910aefbc933ab8c2ddd06f4f1c2888e38cb24f1e99a68f68b10b22b7008
+  data.tar.gz: 91cfb64cc9a5744c6a7dd424143fa1523b8812a17d6770b614466519e5762aafd320ed9da5bb355cea2cabafe2a90df3359bf4adbf65b839976b48be8c3218ec

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.4.0] - 2023-04-13
+
+### Added
+
+- Added new AccountV1 API Endpoints:
+  - `getAccountByPuuid`
+
+
+## [0.3.0] - 2023-04-12
+
+### Added
+
+- Added new `League` Resource.
+- Added new LeagueV4 API Endpoints:
+  - `getEntriesBySummonerId`
+- Add documentation for `Object#to_ostruct` method.
+### Changed
+
+- Add default `tag_line` value to `retrieve_account_by_riot_id` method.
+- Fix typo in `Account` object class.
+
 ## [0.2.0] - 2023-04-12
 
 - Lots of changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Ryze (0.2.0)
+    Ryze (0.4.0)
       addressable (~> 2.7)
       faraday (~> 2.9.0)
 

data/README.md

@@ -35,7 +35,7 @@ client = Ryze::Client.new(api_key: 'YOUR_API_KEY')
 You can then use the client to make requests to the Riot API:
 
 ```ruby
-client.summoner.retrieve_summoner_by_name(summoner_name: 'Faker')
+client.account.retrieve_account_by_riot_id(game_name: 'SAKEN')
 ```
 
 ## Roadmap
@@ -48,7 +48,8 @@ client.summoner.retrieve_summoner_by_name(summoner_name: 'Faker')
 
 ## Endpoints
 
-- [x] Summoner-v4
+- [X] Account-v1
+- [X] Summoner-v4
 - [ ] Match-v5
 - [ ] Champion-Mastery-v4
 - [ ] Spectator-V4

data/lib/Ryze/client.rb

@@ -37,6 +37,11 @@ module Ryze
       SpectatorResource.new(self)
     end
 
+    # @return [LeagueResource] A new instance of LeagueResource.
+    def league
+      LeagueResource.new(self)
+    end
+
     # @return [Faraday::Connection] A new instance of Faraday::Connection or the current instance.
     def connection
       @connection ||= Faraday.new do |conn|

data/lib/Ryze/object.rb

@@ -11,6 +11,10 @@ module Ryze
 
     private
 
+    # Convert a hash to an OpenStruct recursively.
+    #
+    # @param obj [Hash, Array, ::Object] The object to convert.
+    # @return [OpenStruct, Array, ::Object] The converted object.
     def to_ostruct(obj)
       if obj.is_a?(Hash)
         OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })

data/lib/Ryze/objects/account.rb

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

data/lib/Ryze/objects/league.rb

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

data/lib/Ryze/resources/account.rb

@@ -8,10 +8,18 @@ module Ryze
     # Retrieve an account by Riot ID.
     #
     # @param game_name [String] Game name of the account.
-    # @param tag_line [String] Tag line of the account.
+    # @param tag_line [String] Tag line of the account. Default is 'EUW'.
     # @return [Account] Account object.
-    def retrieve_account_by_riot_id(game_name:, tag_line:)
+    def retrieve_account_by_riot_id(game_name:, tag_line: "EUW")
       Account.new get_request("#{BASE_URL}/by-riot-id/#{game_name}/#{tag_line}").body
     end
+
+    # Retrieve an account by puuid.
+    #
+    # @param puuid [String] puuid of the account.
+    # @return [Account] Account object.
+    def retrieve_account_by_puuid(puuid:)
+      Account.new get_request("#{BASE_URL}/by-puuid/#{puuid}").body
+    end
   end
 end

data/lib/Ryze/resources/league.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ryze
+  # LeagueResource is a class corresponding to the LeagueV4 Riot API endpoint.
+  class LeagueResource < Resource
+    BASE_URL = "https://euw1.api.riotgames.com/lol/league/v4"
+
+    # Retrieve the summoner's leagues by summoner ID.
+    #
+    # @param summoner_id [String] Summoner ID.
+    # @return [Array<League>] League objects.
+    def retrieve_leagues_by_summoner_id(summoner_id:)
+      leagues = get_request("#{BASE_URL}/entries/by-summoner/#{summoner_id}").body
+      leagues.map(&League.method(:new))
+    end
+  end
+end

data/lib/Ryze/version.rb

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

data/lib/Ryze.rb

@@ -12,10 +12,12 @@ module Ryze
   autoload :Summoner, "Ryze/objects/summoner"
   autoload :Match, "Ryze/objects/match"
   autoload :Account, "Ryze/objects/account"
+  autoload :League, "Ryze/objects/league"
   autoload :Spectator, "Ryze/objects/spectator"
 
   autoload :SummonerResource, "Ryze/resources/summoner"
   autoload :MatchResource, "Ryze/resources/match"
   autoload :AccountResource, "Ryze/resources/account"
+  autoload :LeagueResource, "Ryze/resources/league"
   autoload :SpectatorResource, "Ryze/resources/spectator"
 end

data/sig/Ryze/account_resource.rbs

@@ -2,6 +2,8 @@ module Ryze
   class AccountResource
     BASE_URL: String
 
+    def retrieve_account_by_puuid: (puuid: String) -> Account
+
     def retrieve_account_by_riot_id: (game_name: String, tag_line: String) -> Account
   end
 end

data/sig/Ryze/league.rbs

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

data/sig/Ryze/league_resource.rbs

@@ -0,0 +1,7 @@
+module Ryze
+  class LeagueResource
+    BASE_URL: String
+
+    def retrieve_leagues_by_summoner_id: (summoner_id: String) -> Array[League]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Ryze
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Clément Sapt
@@ -60,11 +60,13 @@ files:
 - lib/Ryze/error.rb
 - lib/Ryze/object.rb
 - lib/Ryze/objects/account.rb
+- lib/Ryze/objects/league.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/league.rb
 - lib/Ryze/resources/match.rb
 - lib/Ryze/resources/spectator.rb
 - lib/Ryze/resources/summoner.rb
@@ -73,6 +75,8 @@ files:
 - sig/Ryze/account.rbs
 - sig/Ryze/account_resource.rbs
 - sig/Ryze/client.rbs
+- sig/Ryze/league.rbs
+- sig/Ryze/league_resource.rbs
 - sig/Ryze/match.rbs
 - sig/Ryze/match_resource.rbs
 - sig/Ryze/spectator.rbs