sorare-rewards 1.0.0.beta5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a70b22851cb74e28254ed02396bcb2663b0af657ea7b91ab95517d8be764e27
-  data.tar.gz: 8bee3c9c69e8e7cbf16ad0f612b9cbbde502582cc657e4b952ded56e6c11fce5
+  metadata.gz: 8cc85589244de6f453ed70184da06e8c679ec19b4b2c5fe86ee1ea4936c2c402
+  data.tar.gz: 521385c5b0b1e917d7be61eaef02d2284c24082fb18eeec561f9da6160ea650f
 SHA512:
-  metadata.gz: 9ccfd7fa498eb3c7795a0c658a6921703bcd25bd536f3742aac1492e7d7e0963bb6828b4ed3836e40aab6d1844542353c137c447e461af3ca88da3eb67969936
-  data.tar.gz: 6baec2fd1cec6cbdb0c3493c64169afabe0d07df70920b6f8a8a253a8a330053feed8a1a03ed62e0d4034b6aab601a4fe90dd8a213c514fdf77bf56fddf2d59e
+  metadata.gz: 4b998f1b6bca4cbb8ca9fc9fcab6b2d9f2f32b7f4384e4b736ec2dcd3b51b9e1e17d62daf7f85b715e21a060445abd5e495342a01bc725994847ca028a991733
+  data.tar.gz: fff45a44fc25d684adeb45985aac4fde3b876977feca1f9fd3b4f9cd7b3e60f82b3f3f0294df25cc28aead951ee16f0b287192d4bb44fb1cd823602067f3ac42

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorare-rewards (1.0.0.beta5)
+    sorare-rewards (1.0.1)
       activesupport (~> 6.1)
       interactor (~> 3.0)
       json (~> 2)

data/README.md

@@ -1,9 +1,5 @@
 # Sorare::Rewards
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sorare/rewards`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,13 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-To compute the rewards distribution for a given Game Week :
+
+First you need to load a game week
 
 ```ruby
-Sorare::Rewards::build_rewards(slug)
+game_week = Sorare::Rewards::GameWeek.new(hash: 'QmbwCo1fuhRN1T2DyEQtETefsBH6yCj8h7VjMW5iGfT11Z', salt: 'dce0053984405687efcdf3d1a61ffa67')
 ```
 
-With `slug` being the Fixture slug.
+Game Week's `hash` and `salt` can be retrieved using the GQL API, the salt is made public after the rewards have been distributed.
+
+
+To compute the number of rewards for the game week :
+
+```ruby
+# Card rewards :
+game_week.card_allocations
+
+# Eth rewards :
+game_week.prize_pools
+```
+
+To get the cards rewarded for a GameWeek :
+
+```ruby
+game_week.cards_picked
+```
 
 ## Development
 

data/lib/sorare/rewards/allocation_configuration.yml

@@ -1,116 +1,66 @@
 rare: &rare
   tier_0:
-    - loop: 0
-    - loop: 0
-    - loop: 2
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
   tier_1:
-    - loop: 0
-    - loop: 0
-    - loop: 2
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
   tier_2:
-    - loop: 0
-    - loop: 0
-    - loop: 0
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 4
   tier_3:
-    - loop: 0
-    - loop: 0
-    - loop: 0
-    - loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
 
 super_rare: &super_rare
   tier_0:
-    - loop: 2
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 2
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_1:
-    - loop: 1
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_2:
-    - loop: 0
-    - loop: 1
-    - loop: 0
-    - loop: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
   tier_3:
-    - loop: 0
-    - loop: 1
-    - loop: 0
-    - loop: 0
-
-unique: &unique
-  tier_0:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_1:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_2:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_3:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-
-empty: &empty
-  tier_0:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_1:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_2:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
-  tier_3:
-    - cards: 0
-    - cards: 0
-    - cards: 0
-    - cards: 0
+    - cards_per_loop: 0
+    - cards_per_loop: 1
+    - cards_per_loop: 0
+    - cards_per_loop: 0
 
 leagues:
   global-all_star:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   global-under_twenty_one:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   champion-europe:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   challenger-europe:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   champion-asia:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   champion-america:
     rare: *rare
     super_rare: *super_rare
-    unique: *unique
   special-weekly:
     rare:
       tier_0:
@@ -130,26 +80,7 @@ leagues:
         - pct: 1
       tier_3:
         - pct: 1
-    unique: *empty
   starter-rookie:
-    unique:
-      tier_0:
-        - cards: 0
-      tier_1:
-        - cards: 0
-      tier_2:
-        - cards: 0
-      tier_3:
-        - cards: 0
-    super_rare:
-      tier_0:
-        - cards: 0
-      tier_1:
-        - cards: 0
-      tier_2:
-        - cards: 0
-      tier_3:
-        - cards: 0
     rare:
       tier_0:
         - cards: 0
@@ -159,7 +90,3 @@ leagues:
         - cards: 2
       tier_3:
         - cards: 0
-  global-unique_only:
-    rare: *empty
-    super_rare: *empty
-    unique: *empty

data/lib/sorare/rewards/game_week.rb

@@ -2,17 +2,20 @@
 
 require 'json'
 require 'net/http'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards
     # GameWeek stores the reward data of a game week
     class GameWeek
-      attr_reader :data, :config, :salt
+      attr_reader :salt
+
+      delegate :card_allocations, :prize_pools, to: :reward_allocations
+      delegate :cards_picked, to: :card_rewards
 
       def initialize(data: nil, hash: nil, salt: nil)
-        uri = URI("#{Sorare::Rewards.configuration.gateway}#{hash}")
-        @data = data || JSON.parse(::Net::HTTP.get(uri))
-        @config = GameWeekConfig.new(@data['config'])
+        @uri = URI("#{Sorare::Rewards.configuration.gateway}#{hash}")
+        @data = data
         @salt = salt
       end
 
@@ -22,6 +25,14 @@ module Sorare
         end
       end
 
+      def data
+        @data ||= JSON.parse(::Net::HTTP.get(@uri))
+      end
+
+      def config
+        @config ||= GameWeekConfig.new(@data['config'])
+      end
+
       def supply_for(league, rarity: nil, player: nil)
         return (supply.dig(league, rarity, player) || 0) if rarity && player
         return (supply.dig(league, rarity) || {}) if rarity
@@ -37,14 +48,14 @@ module Sorare
         end
       end
 
-      def rewards
+      def reward_allocations
         raise 'Salt required' unless salt
 
-        @rewards ||= Sorare::Rewards::Build.call!(game_week: self, salt: salt)
+        @reward_allocations ||= Sorare::Rewards::Build.call!(game_week: self, salt: salt)
       end
 
       def card_rewards
-        @card_rewards ||= Sorare::Rewards::Pick.call!(rewards.to_h)
+        @card_rewards ||= Sorare::Rewards::Pick.call!(reward_allocations.to_h)
       end
 
       def league(name)

data/lib/sorare/rewards/interactors/allocations/compute_for_league.rb

@@ -29,7 +29,7 @@ module Sorare
         end
 
         def allocate!
-          supply.keys.index_with do |rarity|
+          (config || {}).keys.index_with do |rarity|
             ComputeForRarity.call!(**context.to_h, supply: supply[rarity], config: config[rarity]).rarity_allocations
           end
         end

data/lib/sorare/rewards/interactors/allocations/compute_for_quality.rb

@@ -29,7 +29,7 @@ module Sorare
           allocate_cards
           allocate_pct if has?('pct')
           allocate_extra if has?('pct')
-          allocate_loop if has?('loop')
+          allocate_loop if has?('cards_per_loop')
         end
 
         def allocate_divisions(&block)
@@ -55,7 +55,7 @@ module Sorare
         def allocate_loop
           while remaining_supply.positive?
             allocate_divisions do |division_config, division|
-              allocated[division] += [division_config['loop'] || 0, remaining_supply].min
+              allocated[division] += [division_config['cards_per_loop'] || 0, remaining_supply].min
             end
           end
         end

data/lib/sorare/rewards/interactors/cards/pick_for_division.rb

@@ -25,13 +25,13 @@ module Sorare
         delegate :league, :allocations, :pickers, :qualified_players, to: :context
 
         def call
-          context.division_picks = allocations.keys.index_with do |rarity|
+          context.cards_picked = allocations.keys.index_with do |rarity|
             PickForDivisionAndRarity.call!(
               **context.to_h,
               rarity: rarity,
               pickers: pickers[rarity],
               allocations: allocations[rarity]
-            ).rarity_picks
+            ).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_division_and_rarity.rb

@@ -20,7 +20,7 @@ module Sorare
         delegate :league, :rarity, :allocations, :pickers, to: :context
 
         def call
-          context.rarity_picks = supply!
+          context.cards_picked = supply!
         end
 
         def supply!
@@ -28,7 +28,7 @@ module Sorare
             next [] if pickers&.dig(tier).nil?
 
             PickForDivisionRarityAndQuality.call!(**context.to_h, allocations: allocations[tier],
-                                                                  picker: pickers[tier]).picks
+                                                                  picker: pickers[tier]).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_division_rarity_and_quality.rb

@@ -15,11 +15,11 @@ module Sorare
 
         MISSING_CARDS = 'There are not enough cards to fulfill the requirements'
 
-        delegate :picker, :allocations, :league, :rarity, :force, :picks, to: :context
+        delegate :picker, :allocations, :league, :rarity, :force, :cards_picked, to: :context
         delegate :game_week, to: :league
 
         def call
-          context.picks = []
+          context.cards_picked = []
 
           pick!
           check_length! unless force
@@ -27,24 +27,24 @@ module Sorare
         end
 
         def pick!
-          pick_if_available! while picks.length != allocations && picker.length.positive?
+          pick_if_available! while cards_picked.length != allocations && picker.length.positive?
         end
 
         def pick_if_available!
           player = picker.pick
-          return if picker.player_counter[player] > game_week.player(player).supply(league, rarity).ceil
+          return if picker.player_counter[player] > game_week.player(player).pickable_supply(league, rarity)
 
-          picks.push(player)
+          cards_picked.push(player)
         end
 
         def reorder!
-          picks.sort! do |a, b|
+          cards_picked.sort! do |a, b|
             game_week.player(a).rank(league, rarity) <=> game_week.player(b).rank(league, rarity)
           end
         end
 
         def check_length!
-          return if picks.length == allocations
+          return if cards_picked.length == allocations
 
           context.fail!(error: MISSING_CARDS)
         end

data/lib/sorare/rewards/interactors/cards/pick_for_game_week.rb

@@ -22,14 +22,14 @@ module Sorare
         delegate :game_week, :allocations, :salt, :picks, to: :context
 
         def call
-          context.picks = picks
+          context.cards_picked = pick!
         end
 
-        def picks
+        def pick!
           allocations.each_league_allocations.each_with_object({}) do |(league_name, league_allocations), picks|
             picks[league_name] = PickForLeague.call!(
               **context.to_h, league: game_week.league(league_name), allocations: league_allocations
-            ).league_picks
+            ).cards_picked
           end
         end
       end

data/lib/sorare/rewards/interactors/cards/pick_for_league.rb

@@ -24,10 +24,10 @@ module Sorare
           context.pickers = {}
           add_pickers!
 
-          context.league_picks = allocations.keys.index_with do |division|
+          context.cards_picked = allocations.keys.index_with do |division|
             PickForDivision.call!(
               **context.to_h, pickers: pickers, allocations: allocations[division]
-            ).division_picks
+            ).cards_picked
           end
         end
 
@@ -50,12 +50,12 @@ module Sorare
         def initialize_tier_picker(players, rarity, tier)
           pickers[rarity][tier] = Picker.new(game_week.public_seed, salt)
 
-          players.each do |slug|
-            pickers[rarity][tier].add_player(slug, player_supply(league, rarity, slug))
+          players.each do |slug, _|
+            pickers[rarity][tier].add_player(slug, player_supply(rarity, slug))
           end
         end
 
-        def player_supply(league, rarity, slug)
+        def player_supply(rarity, slug)
           game_week.player(slug).overall_supply(league, rarity)
         end
       end

data/lib/sorare/rewards/interactors/pick.rb

@@ -24,11 +24,11 @@ module Sorare
       # Depending on the way the allocations interpreter is implemented it could be done by him or we
       # update the allocations process to match the structure
       def call
-        context.picks = Sorare::Rewards::Cards::PickForGameWeek.call!(
+        context.cards_picked = Sorare::Rewards::Cards::PickForGameWeek.call!(
           **context.to_h,
           salt: salt,
           allocations: transposed_allocations
-        ).picks
+        ).cards_picked
       end
 
       def transposed_allocations

data/lib/sorare/rewards/interactors/prize_pools/compute_for_division.rb

@@ -13,7 +13,7 @@ module Sorare
 
         def call
           context.division_prize_pools = available_prize_pools.map do |available_prize_pool|
-            available_prize_pool * percentage_rewarded
+            (available_prize_pool * percentage_rewarded).round(2)
           end
         end
 

data/lib/sorare/rewards/interactors/supply/compute_for_rarity.rb

@@ -44,7 +44,7 @@ module Sorare
         end
 
         def player_supply(slug)
-          game_week.player(slug).supply(league, rarity)
+          game_week.player(slug).reward_pool_supply_contribution(league, rarity)
         end
 
         def rounded_supply(float_supply)

data/lib/sorare/rewards/interactors/tiers/qualify_players.rb

@@ -18,12 +18,11 @@ module Sorare
 
         # Use the tier specified within the data
         def qualified_players_by_tier
-          tiers = Sorare::Rewards.configuration.tiers.times.map { |_| {} }
-          sorted_supply.each do |slug, data|
-            tiers[data['tier']][slug] = data
+          Sorare::Rewards.configuration.tiers.times.map do |tier|
+            sorted_supply.keys.filter do |slug|
+              sorted_supply.dig(slug, 'tier') == tier
+            end
           end
-
-          tiers
         end
 
         # Use the rank in the array

data/lib/sorare/rewards/league.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'time'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards

data/lib/sorare/rewards/picker.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'net/http'
+require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards

data/lib/sorare/rewards/player.rb

@@ -25,11 +25,18 @@ module Sorare
         @game_data.present?
       end
 
-      def supply(league, rarity)
+      def reward_pool_supply_contribution(league, rarity)
         return 0 unless playing? && remaining_games_for_supply.positive?
 
         [
-          uncapped_supply_for_game_week(league, rarity), # Remaining supply
+          uncapped_supply_for_game_week(league, rarity),
+          pickable_supply(league, rarity)
+        ].min
+      end
+
+      def pickable_supply(league, rarity)
+        [
+          overall_supply(league, rarity), # Remaining supply
           available_during_cooldown(league, rarity), # Cooldown limit
           @config.distribution_limit(rarity) # Hard limit
         ].min
@@ -52,10 +59,12 @@ module Sorare
       end
 
       def rewarded_during_cooldown(league, rarity)
-        (rewards&.dig(league) || []).count { |at| (Time.parse(at) + @config.cooldown_since(rarity)) < Time.now }
+        (@game_data&.dig(league.name, rarity) || []).count do |at|
+          (Time.parse(at) + @config.cooldown_since(rarity)) > Time.now
+        end
       end
 
-      %w[rewards remaining_games_for_supply remaining_games].each do |key|
+      %w[remaining_games_for_supply remaining_games].each do |key|
         define_method(key) do
           @game_data&.dig(key)
         end

data/lib/sorare/rewards/version.rb

@@ -2,6 +2,6 @@
 
 module Sorare
   module Rewards
-    VERSION = '1.0.0.beta5'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorare-rewards
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.1
 platform: ruby
 authors:
 - pierre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,9 +220,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: