sorare-rewards 1.4.8 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cf28260c062178e86145831e78dc6df1698d0dd5da71b9e912c43ad3490819
-  data.tar.gz: b8568cee0173df5c1f6682f6ebc8381e10102bb4a1bee09ff11836098e6be6fa
+  metadata.gz: 7fdc6ffec6880ea7d786427427f64c3a360eddf15fc6b9d1fc116e714ba14c28
+  data.tar.gz: d65afecddd570ddcce250d98142dfa0928a85759afc2ab2b6be01f80ab51ee99
 SHA512:
-  metadata.gz: c3e88fbd0e0075431410adfa570d3f491039eb7172a933cce94cfded653dfe6f03599c73f35c7caaf5a49964e6235e3ae2d761f316f4ad7278b4c84641a7aab6
-  data.tar.gz: 6df7258e3b292a6ea86cf36d0602c08c4e8762c89629d50928fbc69feac19ac1c05fc2fc8dfcec6650c73f4067b573e15512967e0c52161d7312d33b53a0a722
+  metadata.gz: f1f39c17511050c7870261c524707001b48897d79d0ee1ab19fe699b8165202fce4345a62574d69132dfab3d81bf95000963af4b5318d4a8815b6c7b412e7d5d
+  data.tar.gz: d5a363cf277ecf27fa0f18a2ac3cb4e6f2eae071088985b53536b5ccbafb2761b1864678b250c996f6e79735bfee1407e646094fa9220e050656c02564bf2ef1

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.6.0] - 2022-08-12
+
+### Added
+
+- Expose `rarity_limit` and `cooldown_limit` on `GameWeekRewards`
+
+## [1.5.0] - 2022-03-07
+
+### Added
+
+- Expose `CardPicker` as `picker_of(rarity, tier, **args)` on `League`. `args` can be used to toggle off `rarity_limit` and `cooldown_limit`
+
 ## [1.4.1] - 2021-12-14
 
 ### Fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorare-rewards (1.4.7)
+    sorare-rewards (1.6.0)
       activesupport (>= 6.1.4)
       interactor_with_steroids (>= 1.0.0)
       json (~> 2)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.1)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -23,7 +23,7 @@ GEM
       rexml
     diff-lcs (1.4.4)
     hashdiff (1.0.1)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     interactor_with_steroids (1.1.2)
       activesupport

data/lib/sorare/rewards/card_picker.rb

@@ -1,39 +1,48 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/module/delegation'
+require './lib/sorare/rewards/flat_picker'
 
 module Sorare
   module Rewards
-    # CardPicker allows to randomly pick a card
-    class CardPicker
-      attr_accessor :cards, :player_counter
-
-      delegate :length, to: :cards
+    # CardPicker allows to randomly pick card rewards for a league
+    class CardPicker < FlatPicker
+      attr_reader :league, :rarity, :quality, :limits
+
+      def initialize(league, rarity, quality, rarity_limit: true, cooldown_limit: true)
+        super(league.public_seed, league.salt)
+        @league = league
+        @rarity = rarity
+        @quality = quality
+        @limits = %i[overall].tap do |l|
+          l << :cooldowned if cooldown_limit
+          l << :limited if rarity_limit
+        end
 
-      def initialize(seed, salt)
-        @random = Random.new(seed, salt)
-        @cards = []
-        @player_counter = Hash.new(0)
-        @shuffled = false
+        load_picker
       end
 
-      def add_player(slug, count)
-        raise "Can't add a player to a started draw" if @shuffled
+      def pick
+        player = super
+        return player if valid_pick?(player)
 
-        @cards += Array.new(count, slug)
+        pick
       end
 
-      def pick
-        shuffle! unless @shuffled
+      def valid_pick?(player)
+        current_player_limit = limits.map { |l| supply_for(player).send(l) }.min
+        picked_count(player) <= current_player_limit
+      end
 
-        @cards.shift.tap do |card|
-          @player_counter[card] += 1 if card
-        end
+      private
+
+      def supply_for(player_slug)
+        league.game_week.player(player_slug).supply_for(league, rarity)
       end
 
-      def shuffle!
-        @cards.shuffle!(random: @random)
-        @shuffled = true
+      def load_picker
+        league.qualified_supply(rarity, quality).each do |player_slug|
+          add(player_slug, supply_for(player_slug).overall)
+        end
       end
     end
   end

data/lib/sorare/rewards/configuration.rb

@@ -11,7 +11,7 @@ module Sorare
 
       def initialize
         @tiers = 4
-        @gateway = 'https://gateway.pinata.cloud/ipfs/'
+        @gateway = 'https://sorare.mypinata.cloud/ipfs/'
         @transform_tier = ->(tier) { "tier_#{tier}" }
         @transform_division = ->(division) { "D#{division}" }
         @allocation_configuration = load_yaml_configuration_file('allocation_configuration.yml')['leagues']

data/lib/sorare/rewards/flat_picker.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
+
+module Sorare
+  module Rewards
+    # FlatPicker allows to randomly pick an element in a flat array
+    class FlatPicker
+      attr_accessor :elements, :counter
+
+      class NoSupplyError < StandardError; end
+
+      delegate :length, to: :elements
+
+      def initialize(seed, salt)
+        @random = Random.new(seed, salt)
+        @elements = []
+        @counter = Hash.new(0)
+        @shuffled = false
+      end
+
+      def add(slug, count)
+        raise "Can't add an element to a started draw" if @shuffled
+
+        @elements += Array.new(count, slug)
+      end
+
+      def pick
+        shuffle! unless @shuffled
+
+        @elements.shift.tap do |element|
+          @counter[element] += 1 if element
+        end
+      end
+
+      def pick!
+        pick.tap do |picked|
+          raise NoSupplyError unless picked
+        end
+      end
+
+      def picked_count(element)
+        @counter[element]
+      end
+
+      private
+
+      def shuffle!
+        return if @shuffled
+
+        @elements.shuffle!(random: @random)
+        @shuffled = true
+      end
+    end
+  end
+end

data/lib/sorare/rewards/game_week.rb

@@ -56,6 +56,14 @@ module Sorare
       def player(slug)
         Player.new(slug, self)
       end
+
+      def inspect
+        format('#<%<class>s %<data>s>', { class: self.class.name, data: { loaded: loaded?, hash: hash, salt: salt } })
+      end
+
+      def loaded?
+        data.present?
+      end
     end
   end
 end

data/lib/sorare/rewards/game_week_rewards.rb

@@ -12,21 +12,25 @@ module Sorare
     #      }
     #    }
     class GameWeekRewards
-      attr_reader :game_week, :salt, :card_allocations
+      attr_reader :game_week, :salt, :card_allocations, :rarity_limit, :cooldown_limit
 
       MISSING_PARAMETER = '%s parameter required'
 
-      def initialize(game_week:, salt: nil, card_allocations: nil)
+      def initialize(game_week:, salt: nil, card_allocations: nil, rarity_limit: true, cooldown_limit: true)
         @game_week = game_week
         @salt = salt || game_week.salt
         @card_allocations = card_allocations || computed_card_allocations
+        @rarity_limit = rarity_limit
+        @cooldown_limit = cooldown_limit
       end
 
       def cards
         @cards ||= Sorare::Rewards::Pick.call!(
           salt: salt,
           game_week: game_week,
-          card_allocations: card_allocations
+          card_allocations: card_allocations,
+          rarity_limit: rarity_limit,
+          cooldown_limit: cooldown_limit
         ).cards_picked
       end
 

data/lib/sorare/rewards/interactor.rb

@@ -2,6 +2,7 @@
 
 require 'active_support/concern'
 require 'interactor'
+require './lib/sorare/rewards/interactors/concerns/with_picker_options'
 
 module Sorare
   module Rewards

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

@@ -7,13 +7,8 @@ require 'yaml'
 module Sorare
   module Rewards
     module Cards
-      # PickForDivision picks the rewards for a given division
-      # Receive a list of pickers for each tiers and quality
-      #   {
-      #     'rare' => { 'tier_0' => CardPicker, 'tier_1' => CardPicker },
-      #     'super_rare' => { 'tier_0' => CardPicker, 'tier_1' => CardPicker }
-      #   }
-      # And a reward allocations
+      # PickForDivision picks the rewards for a given league
+      # And a division reward allocations
       #   {
       #     'rare' => [5, 15, 0, 0],
       #     'super_rare' => [1, 4, 0, 0],
@@ -21,8 +16,9 @@ module Sorare
       #   }
       class PickForDivision
         include Interactor
+        include WithPickerOptions
 
-        receive :league, :allocations, :pickers
+        receive :league, :allocations
         hold :cards_picked
 
         def call
@@ -30,7 +26,6 @@ module Sorare
             PickForDivisionAndRarity.call!(
               **context.to_h,
               rarity: rarity,
-              pickers: pickers[rarity],
               allocations: allocations[rarity]
             ).cards_picked
           end

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

@@ -7,17 +7,14 @@ module Sorare
   module Rewards
     module Cards
       # PickForDivisionAndRarity picks the rewards for a given division and rarity
-      # Receive a list of pickers for each tiers
-      #   {
-      #     'tier_0' => CardPicker, 'tier_1' => CardPicker
-      #   }
       # A game week data
       # And a reward allocations
       #   { 'tier_0' => 1, 'tier_1' => 2 }
       class PickForDivisionAndRarity
         include Interactor
+        include WithPickerOptions
 
-        receive :league, :rarity, :allocations, :pickers
+        receive :league, :rarity, :allocations
         hold :cards_picked
 
         def call
@@ -26,10 +23,12 @@ module Sorare
 
         def supply!
           allocations.keys.index_with do |tier|
-            next [] if pickers&.dig(tier).nil?
+            picker = league.picker_of(rarity, tier, rarity_limit: rarity_limit, cooldown_limit: cooldown_limit)
+            next [] unless picker
 
-            PickForDivisionRarityAndQuality.call!(**context.to_h, allocations: allocations[tier],
-                                                                  picker: pickers[tier]).cards_picked
+            PickForDivisionRarityAndQuality.call!(
+              **context.to_h, allocations: allocations[tier], picker: picker
+            ).cards_picked
           end
         end
       end

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

@@ -34,7 +34,7 @@ module Sorare
 
         def pick_if_available!
           player = picker.pick
-          return if picker.player_counter[player] > game_week.player(player).pickable_supply(league, rarity)
+          return if picker.picked_count(player) > game_week.player(player).supply_for(league, rarity).available
 
           cards_picked.push(player)
         end

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

@@ -18,6 +18,7 @@ module Sorare
       #    }
       class PickForGameWeek
         include Interactor
+        include WithPickerOptions
 
         receive :game_week, :allocations
         hold :cards_picked

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

@@ -16,51 +16,21 @@ module Sorare
       #   }
       class PickForLeague
         include Interactor
+        include WithPickerOptions
 
         receive :league, :allocations
-        hold :pickers, :cards_picked
+        hold :cards_picked
 
         delegate :game_week, to: :league
         delegate :public_seed, :salt, to: :game_week
 
         def call
-          context.pickers = {}
-          add_pickers!
-
           context.cards_picked = allocations.keys.index_with do |division|
             PickForDivision.call!(
-              **context.to_h, pickers: pickers, allocations: allocations[division]
+              **context.to_h, allocations: allocations[division]
             ).cards_picked
           end
         end
-
-        def add_pickers!
-          league.supply.keys.index_with do |rarity|
-            pickers[rarity] = {}
-            qualify_and_add!(rarity)
-          end
-        end
-
-        def qualify_and_add!(rarity)
-          sorted_supply = league.supply[rarity]
-          qualified_players = Tiers::QualifyPlayers.call!(sorted_supply: sorted_supply).players
-          qualified_players.each_with_index.map do |players, tier|
-            transformed_tier = Sorare::Rewards.configuration.transform_tier.call(tier)
-            initialize_tier_picker(players, rarity, transformed_tier)
-          end
-        end
-
-        def initialize_tier_picker(players, rarity, tier)
-          pickers[rarity][tier] = CardPicker.new(public_seed, salt)
-
-          players.each do |slug, _|
-            pickers[rarity][tier].add_player(slug, player_supply(rarity, slug))
-          end
-        end
-
-        def player_supply(rarity, slug)
-          game_week.player(slug).overall_supply(league, rarity)
-        end
       end
     end
   end

data/lib/sorare/rewards/interactors/concerns/with_picker_options.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Sorare
+  module Rewards
+    # WithPickerOptions is included by interactor that takes picker options as a parameter
+    module WithPickerOptions
+      extend ActiveSupport::Concern
+
+      included do
+        receive rarity_limit: true, cooldown_limit: true
+      end
+    end
+  end
+end

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

@@ -55,11 +55,11 @@ module Sorare
         end
 
         def player_contribution(slug)
-          game_week.player(slug).reward_pool_supply_contribution(league, rarity)
+          game_week.player(slug).supply_for(league, rarity).pool_contribution
         end
 
         def player_pickable_supply(slug)
-          game_week.player(slug).pickable_supply(league, rarity)
+          game_week.player(slug).supply_for(league, rarity).available
         end
 
         def remaining_supply(reward_probability)

data/lib/sorare/rewards/league.rb

@@ -8,7 +8,7 @@ module Sorare
     class League
       attr_reader :name, :supply, :config, :game_week
 
-      delegate :salt, to: :game_week
+      delegate :salt, :public_seed, to: :game_week
 
       def initialize(name:, config:, supply:, game_week:)
         @name = name
@@ -54,16 +54,32 @@ module Sorare
       end
 
       def each_rarity_tier_supply
-        each_rarity_supply do |rarity, rarity_supply|
-          qualified_supply = Tiers::QualifyPlayers.call!(sorted_supply: rarity_supply).players
-          qualified_supply.each_key.map do |tier|
+        each_rarity_supply do |rarity, _|
+          qualified_supply(rarity).each do |tier, qualified_supply|
             return to_enum(:each_rarity_tier_supply) unless block_given?
 
-            transformed_tier = Sorare::Rewards.configuration.transform_tier.call(tier)
-            yield(rarity, transformed_tier, qualified_supply[tier])
+            yield(rarity, tier, qualified_supply)
           end
         end
       end
+
+      def qualified_supply(rarity, tier = nil)
+        @qualified_supplies ||= {}
+        @qualified_supplies[rarity] ||= Tiers::QualifyPlayers.call!(sorted_supply: supply[rarity]).players
+                                                             .each_with_index.to_h do |supply, supply_tier|
+          [Sorare::Rewards.configuration.transform_tier.call(supply_tier), supply]
+        end
+        tier ? @qualified_supplies[rarity][tier] : @qualified_supplies[rarity]
+      end
+
+      def picker_of(rarity, tier, **kwargs)
+        scenario = kwargs.sort.to_h.to_json
+
+        @pickers ||= {}
+        @pickers[rarity] ||= {}
+        @pickers[rarity][tier] ||= {}
+        @pickers[rarity][tier][scenario] ||= CardPicker.new(self, rarity, tier, **kwargs)
+      end
     end
   end
 end

data/lib/sorare/rewards/player.rb

@@ -7,7 +7,21 @@ module Sorare
   module Rewards
     # Player stores the reward data of a player for a game week
     class Player
-      attr_reader :slug
+      attr_reader :slug, :supply
+
+      Supply = Struct.new(:overall, :projected, :cooldowned, :limited, keyword_init: true) do
+        def initialize(overall: 0, projected: 0, cooldowned: 0, limited: 0)
+          super(overall: overall, projected: projected, cooldowned: cooldowned, limited: limited)
+        end
+
+        def pool_contribution
+          [projected, available].min || 0
+        end
+
+        def available
+          [overall, cooldowned, limited].min || 0
+        end
+      end
 
       def initialize(slug, reward_data)
         @slug = slug
@@ -17,45 +31,22 @@ module Sorare
         load_supply(reward_data)
       end
 
-      def rewardable?(league, rarity)
-        !@config.cooldown?(rarity, @game_data.dig(league, rarity) || [])
+      %w[remaining_games_for_supply remaining_games latest_rewarded].each do |key|
+        define_method(key) do
+          @game_data&.dig(key)
+        end
       end
 
       def playing?
         @game_data.present?
       end
 
-      def reward_pool_supply_contribution(league, rarity)
-        return 0 unless playing? && remaining_games_for_supply.positive?
-
-        [
-          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
-      end
-
       def rank(league, rarity)
         @supply.dig(league.name, rarity, 'rank')
       end
 
-      def overall_supply(league, rarity)
-        @supply.dig(league.name, rarity, 'supply') || 0
-      end
-
-      def uncapped_supply_for_game_week(league, rarity)
-        overall_supply(league, rarity) / remaining_games_for_supply.to_f
-      end
-
-      def available_during_cooldown(league, rarity)
-        [@config.cooldown_limit(rarity) - rewarded_under_cooldown(league, rarity), 0].max
+      def supply_for(league, rarity)
+        supply.dig(league.name, rarity, 'supply') || Supply.new
       end
 
       def rewarded_under_cooldown(league, rarity)
@@ -64,28 +55,45 @@ module Sorare
         end
       end
 
-      def rewarded(league, rarity)
-        return (@game_data&.dig(league.name, rarity) || []) if @config.cooldown_per_league?(rarity)
+      private
 
-        latest_rewarded&.dig(rarity) || []
+      def load_supply(reward_data)
+        reward_data.each_league do |league|
+          league.each_rarity_supply do |rarity, league_supply|
+            next unless league_supply[slug]
+
+            player_cards = league_supply.dig(slug, 'supply') || 0
+            @supply[league.name][rarity] = {
+              **league_supply[slug],
+              supply: parse_supply(league, rarity, player_cards)
+            }.with_indifferent_access
+          end
+        end
       end
 
-      %w[remaining_games_for_supply remaining_games latest_rewarded].each do |key|
-        define_method(key) do
-          @game_data&.dig(key)
-        end
+      def parse_supply(league, rarity, total_cards)
+        Supply.new(
+          overall: total_cards,
+          projected: projected_for_game_week(total_cards),
+          cooldowned: available_during_cooldown(league, rarity),
+          limited: @config.distribution_limit(rarity)
+        )
       end
 
-      private
+      def projected_for_game_week(total_cards)
+        return 0 unless playing? && remaining_games_for_supply.positive?
 
-      def load_supply(reward_data)
-        reward_data.each_league do |league|
-          league.each_rarity_supply do |rarity, supply|
-            next unless supply[slug]
+        total_cards / remaining_games_for_supply.to_f
+      end
 
-            @supply[league.name][rarity] = supply[slug]
-          end
-        end
+      def available_during_cooldown(league, rarity)
+        [@config.cooldown_limit(rarity) - rewarded_under_cooldown(league, rarity), 0].max
+      end
+
+      def rewarded(league, rarity)
+        return (@game_data&.dig(league.name, rarity) || []) if @config.cooldown_per_league?(rarity)
+
+        latest_rewarded&.dig(rarity) || []
       end
     end
   end

data/lib/sorare/rewards/version.rb

@@ -2,6 +2,6 @@
 
 module Sorare
   module Rewards
-    VERSION = '1.4.8'
+    VERSION = '1.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorare-rewards
 version: !ruby/object:Gem::Version
-  version: 1.4.8
+  version: 1.6.0
 platform: ruby
 authors:
 - Sorare team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -174,6 +174,7 @@ files:
 - lib/sorare/rewards/allocation_configuration.yml
 - lib/sorare/rewards/card_picker.rb
 - lib/sorare/rewards/configuration.rb
+- lib/sorare/rewards/flat_picker.rb
 - lib/sorare/rewards/game_week.rb
 - lib/sorare/rewards/game_week_allocations.rb
 - lib/sorare/rewards/game_week_config.rb
@@ -189,6 +190,7 @@ files:
 - lib/sorare/rewards/interactors/cards/pick_for_division_rarity_and_quality.rb
 - lib/sorare/rewards/interactors/cards/pick_for_game_week.rb
 - lib/sorare/rewards/interactors/cards/pick_for_league.rb
+- lib/sorare/rewards/interactors/concerns/with_picker_options.rb
 - lib/sorare/rewards/interactors/pick.rb
 - lib/sorare/rewards/interactors/prize_pools/compute_for_division.rb
 - lib/sorare/rewards/interactors/prize_pools/compute_for_game_week.rb