sorare-rewards 1.1.3.beta0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb36662a381adcf213a5ab17ad97ae1d57f862f84e274679657a05d096476cb
-  data.tar.gz: 1d38e28d7fc1912cf14ae3dfa48546f1aa87b427e5025ac8e2896dd3dce6a117
+  metadata.gz: 385b50a4b23229464d9807665633f7bc5475f2572a1981fb2be18dd5501f3620
+  data.tar.gz: 01f7f7d0bed52e96f3caec5743004bb10b16f4a223ce83f804ec4e94d96b4bd3
 SHA512:
-  metadata.gz: e66851acb6b951557c607e2ebf24552ea5b16d63d3faf260f344175bf674758dc5efe7549b96c6fa164f1bdfc263066234b0e09f79a66ccbbb1c5f7dc0df903e
-  data.tar.gz: 6a2a8979952b7446ac9470b360fae8e7c2d8c53dd4db4442da9e60472090c2bae881fcf625e9c5da5a19d8bcff9c0356f80c2acb3a1586b074bdeb87f2e0689c
+  metadata.gz: 188333489495c2a7ab8e4da7a1f0cd7874131cdb01acde247997f925edf473639db04ee8a7ddb02c8458c77f89888c0bb6a6eaccd724523d86c305cd50c86835
+  data.tar.gz: 00c0276d280c1c3b0e5980837709d69d24dbd5263975f33546099589ddca46aeebb8cad4bee0572561bd85febfdea98e986f5cb622ab92bd0bca9d1357500ee0

data/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: ruby:2.7.1
+image: ruby:3.0
 
 workflow:
   rules:

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## [1.4.0] - 2021-12-14
+
+### Added
+
+- Added support for rarity based `rewards_ratio_per_cards_in_circulation`
+
+## [1.3.0] - 2021-11-02
+
+### Breaking
+
+- Removed rewards method from `GameWeek` (`card_rewards`, `cards_picked`, `reward_allocations`, `prize_pools`, `card_allocations`)
+- `Picker` has been renamed to `CardPicker`
+
+### Added
+
+- Added a `GameWeekRewards` class that provides all rewards related methods
+- Added a way to pick cards with a custom `card_allocations`
+
+## [1.2.0] - 2021-11-02
+
+### Added
+
+- Enable cross leagues cooldown using `per_league` configuration flag

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sorare-rewards (1.1.3.beta0)
+    sorare-rewards (1.4.0)
       activesupport (~> 6.1.4)
       interactor (~> 3.1.2)
       json (~> 2)
@@ -29,7 +29,7 @@ GEM
     net-http (0.1.1)
       net-protocol
       uri
-    net-protocol (0.1.1)
+    net-protocol (0.1.2)
       io-wait
       timeout
     ostruct (0.4.0)
@@ -73,7 +73,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    uri (0.10.1)
+    uri (0.11.0)
     yaml (0.2.0)
     zeitwerk (2.5.0)
 
@@ -90,4 +90,4 @@ DEPENDENCIES
   sorare-rewards!
 
 BUNDLED WITH
-   2.2.22
+   2.2.30

data/README.md

@@ -10,15 +10,14 @@ gem 'sorare-rewards'
 
 And then execute:
 
-    $ bundle install
+$ bundle install
 
 Or install it yourself as:
 
-    $ gem install sorare-rewards
+$ gem install sorare-rewards
 
 ## Usage
 
-
 First you need to load a game week
 
 ```ruby
@@ -27,21 +26,37 @@ game_week = Sorare::Rewards::GameWeek.new(hash: 'QmbwCo1fuhRN1T2DyEQtETefsBH6yCj
 
 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 :
+To compute rewards for a game week :
 
 ```ruby
-# Card rewards :
-game_week.card_allocations
+rewards = Sorare::Rewards::GameWeekRewards.new(game_week: game_week)
+
+# Cards allocations :
+rewards.card_allocations
 
-# Eth rewards :
-game_week.prize_pools
+# Cards :
+rewards.cards
+
+# Prize pools :
+rewards.prize_pools
 ```
 
-To get the cards rewarded for a GameWeek :
+By default it uses the computed card allocations to pick the rewards. To override it :
 
 ```ruby
-game_week.cards_picked
+card_allocations = {
+  'global_all-star' => {
+    'D1' => {
+      'rare' => {
+        'tier_0' => 1,
+        ...
+      }
+    }
+  }
+}
+
+rewards = Sorare::Rewards::GameWeekRewards.new(game_week: game_week, card_allocations: card_allocations)
+
 ```
 
 ## Development
@@ -50,7 +65,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sorare/rewards/{picker.rb → card_picker.rb}

@@ -4,8 +4,8 @@ require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards
-    # Picker allows to randomly pick a card
-    class Picker
+    # CardPicker allows to randomly pick a card
+    class CardPicker
       attr_accessor :cards, :player_counter
 
       delegate :length, to: :cards

data/lib/sorare/rewards/game_week.rb

@@ -6,15 +6,10 @@ require 'active_support/core_ext/module/delegation'
 
 module Sorare
   module Rewards
-    # GameWeek stores the reward data of a game week
+    # GameWeek stores the data of a game week
     class GameWeek
-      include WithAnalytics
-
       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
@@ -50,16 +45,6 @@ module Sorare
         end
       end
 
-      def reward_allocations
-        raise 'Salt required' unless salt
-
-        @reward_allocations ||= Sorare::Rewards::Build.call!(game_week: self, salt: salt)
-      end
-
-      def card_rewards
-        @card_rewards ||= Sorare::Rewards::Pick.call!(reward_allocations.to_h)
-      end
-
       def league(name)
         raise 'Unknown league' unless (leagues || {})[name]
 
@@ -71,10 +56,6 @@ module Sorare
       def player(slug)
         Player.new(slug, self)
       end
-
-      def inspect
-        super.splice(:version)
-      end
     end
   end
 end

data/lib/sorare/rewards/game_week_config.rb

@@ -30,6 +30,12 @@ module Sorare
         cooldown.dig(rarity, 'quantity')
       end
 
+      def cooldown_per_league?(rarity)
+        per_league = cooldown.dig(rarity, 'per_league')
+
+        per_league.nil? ? true : per_league
+      end
+
       def cooldown_since(rarity)
         cooldown.dig(rarity, 'since')
       end

data/lib/sorare/rewards/game_week_rewards.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Sorare
+  module Rewards
+    # GameWeekRewards stores rewards related data for a specified GameWeek, salt,
+    # And a card allocations hash
+    #    {
+    #      'global-all_star' => {
+    #        'D1' => {
+    #          'rare' => { 'tier_0' => 0, 'tier_1' => 1 }
+    #        }
+    #      }
+    #    }
+    class GameWeekRewards
+      attr_reader :game_week, :salt, :card_allocations
+
+      MISSING_PARAMETER = '%s parameter required'
+
+      def initialize(game_week:, salt: nil, card_allocations: nil)
+        @game_week = game_week
+        @salt = salt || game_week.salt
+        @card_allocations = card_allocations || computed_card_allocations
+      end
+
+      def cards
+        @cards ||= Sorare::Rewards::Pick.call!(
+          salt: salt,
+          game_week: game_week,
+          card_allocations: card_allocations
+        ).cards_picked
+      end
+
+      def prize_pools
+        @prize_pools ||= reward_allocations.prize_pools
+      end
+
+      def reward_allocations
+        validate!(:salt)
+
+        @reward_allocations ||= Sorare::Rewards::Build.call!(game_week: game_week, salt: salt)
+      end
+
+      def computed_card_allocations
+        Transposer.transpose_allocations(reward_allocations.card_allocations)
+      end
+
+      private
+
+      def validate!(field)
+        raise format(MISSING_PARAMETER, field) unless send(field)
+      end
+    end
+  end
+end

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

@@ -8,27 +8,26 @@ module Sorare
     class Build
       include Interactor
 
-      delegate :game_week, :salt, to: :context
+      delegate :game_week, to: :context
 
       def call
         context.card_allocations = allocate!
         context.prize_pools = prize_pools!
-        context.prize_pool_currency = game_week.config.prize_pool_currency
       end
 
       def game_week_supply
-        @game_week_supply ||= Supply::ComputeForGameWeek.call!(game_week: game_week, salt: salt)
+        @game_week_supply ||= Supply::ComputeForGameWeek.call!(game_week: game_week)
                                                         .game_week_supply
       end
 
       def allocate!
         Allocations::ComputeForGameWeek.call!(
-          game_week: game_week, supply: game_week_supply, salt: salt
+          supply: game_week_supply, public_seed: game_week.public_seed, salt: game_week.salt
         ).game_week_allocations
       end
 
       def prize_pools!
-        PrizePools::ComputeForGameWeek.call!(game_week: game_week, salt: salt).prize_pools
+        PrizePools::ComputeForGameWeek.call!(game_week: game_week).prize_pools
       end
     end
   end

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

@@ -10,8 +10,8 @@ module Sorare
       # PickForDivision picks the rewards for a given division
       # Receive a list of pickers for each tiers and quality
       #   {
-      #     'rare' => { 'tier_0' => Picker, 'tier_1' => Picker },
-      #     'super_rare' => { 'tier_0' => Picker, 'tier_1' => Picker }
+      #     'rare' => { 'tier_0' => CardPicker, 'tier_1' => CardPicker },
+      #     'super_rare' => { 'tier_0' => CardPicker, 'tier_1' => CardPicker }
       #   }
       # And a reward allocations
       #   {

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

@@ -9,7 +9,7 @@ module Sorare
       # PickForDivisionAndRarity picks the rewards for a given division and rarity
       # Receive a list of pickers for each tiers
       #   {
-      #     'tier_0' => Picker, 'tier_1' => Picker
+      #     'tier_0' => CardPicker, 'tier_1' => CardPicker
       #   }
       # A game week data
       # And a reward allocations

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

@@ -19,7 +19,7 @@ module Sorare
       class PickForGameWeek
         include Interactor
 
-        delegate :game_week, :allocations, :salt, :picks, to: :context
+        delegate :game_week, :allocations, :picks, to: :context
 
         def call
           context.cards_picked = pick!

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

@@ -17,8 +17,9 @@ module Sorare
       class PickForLeague
         include Interactor
 
-        delegate :salt, :league, :allocations, :pickers, to: :context
+        delegate :league, :allocations, :pickers, to: :context
         delegate :game_week, to: :league
+        delegate :public_seed, :salt, to: :game_week
 
         def call
           context.pickers = {}
@@ -48,7 +49,7 @@ module Sorare
         end
 
         def initialize_tier_picker(players, rarity, tier)
-          pickers[rarity][tier] = Picker.new(game_week.public_seed, salt)
+          pickers[rarity][tier] = CardPicker.new(public_seed, salt)
 
           players.each do |slug, _|
             pickers[rarity][tier].add_player(slug, player_supply(rarity, slug))

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

@@ -11,8 +11,8 @@ module Sorare
     # And a reward allocations
     #    {
     #      'global-all_star' => {
-    #        'rare' => {
-    #          'D1' => { 'tier_0' => 0, 'tier_1' => 1 }
+    #        'D1' => {
+    #          'rare' => { 'tier_0' => 0, 'tier_1' => 1 }
     #        }
     #      }
     #    }
@@ -27,13 +27,9 @@ module Sorare
         context.cards_picked = Sorare::Rewards::Cards::PickForGameWeek.call!(
           **context.to_h,
           salt: salt,
-          allocations: transposed_allocations
+          allocations: Sorare::Rewards::GameWeekAllocations.new(card_allocations)
         ).cards_picked
       end
-
-      def transposed_allocations
-        Sorare::Rewards::GameWeekAllocations.new(Transposer.transpose_allocations(card_allocations))
-      end
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Sorare
       class ComputeForGameWeek
         include Interactor
 
-        delegate :salt, :game_week, :game_week_supply, to: :context
+        delegate :game_week, :game_week_supply, to: :context
 
         def call
           context.game_week_supply = game_week_supply!
@@ -31,7 +31,7 @@ module Sorare
         end
 
         def randomizer
-          @randomizer ||= Sorare::Rewards::Random.new(game_week.public_seed, salt)
+          @randomizer ||= Sorare::Rewards::Random.new(game_week.public_seed, game_week.salt)
         end
       end
     end

data/lib/sorare/rewards/league.rb

@@ -24,9 +24,17 @@ module Sorare
       end
 
       def cards_in_circulation_limit(rarity)
-        return unless cards_in_circulation&.dig(rarity) && game_week.config.rewards_ratio_per_cards_in_circulation
+        return unless cards_in_circulation&.dig(rarity) && rewards_ratio_per_cards_in_circulation_for_rarity(rarity)
 
-        (cards_in_circulation[rarity] * game_week.config.rewards_ratio_per_cards_in_circulation).floor
+        (cards_in_circulation[rarity] * rewards_ratio_per_cards_in_circulation_for_rarity(rarity)).floor
+      end
+
+      def rewards_ratio_per_cards_in_circulation_for_rarity(rarity)
+        if game_week.config.rewards_ratio_per_cards_in_circulation.is_a?(Hash)
+          return game_week.config.rewards_ratio_per_cards_in_circulation&.dig(rarity)
+        end
+
+        game_week.config.rewards_ratio_per_cards_in_circulation
       end
 
       def each_division_prize_pools

data/lib/sorare/rewards/player.rb

@@ -55,16 +55,22 @@ module Sorare
       end
 
       def available_during_cooldown(league, rarity)
-        [@config.cooldown_limit(rarity) - rewarded_during_cooldown(league, rarity), 0].max
+        [@config.cooldown_limit(rarity) - rewarded_under_cooldown(league, rarity), 0].max
       end
 
-      def rewarded_during_cooldown(league, rarity)
-        (@game_data&.dig(league.name, rarity) || []).count do |at|
+      def rewarded_under_cooldown(league, rarity)
+        rewarded(league, rarity).count do |at|
           (Time.parse(at) + @config.cooldown_since(rarity)) > Time.now
         end
       end
 
-      %w[remaining_games_for_supply remaining_games].each do |key|
+      def rewarded(league, rarity)
+        return (@game_data&.dig(league.name, rarity) || []) if @config.cooldown_per_league?(rarity)
+
+        latest_rewarded&.dig(rarity) || []
+      end
+
+      %w[remaining_games_for_supply remaining_games latest_rewarded].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.1.3.beta0'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorare-rewards
 version: !ruby/object:Gem::Version
-  version: 1.1.3.beta0
+  version: 1.4.0
 platform: ruby
 authors:
 - pierre
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.0
-description: 
+description:
 email:
 - pierre@sorare.com
 executables: []
@@ -161,6 +161,7 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -171,11 +172,12 @@ files:
 - data.patch
 - lib/sorare/rewards.rb
 - lib/sorare/rewards/allocation_configuration.yml
-- lib/sorare/rewards/concerns/with_analytics.rb
+- lib/sorare/rewards/card_picker.rb
 - lib/sorare/rewards/configuration.rb
 - lib/sorare/rewards/game_week.rb
 - lib/sorare/rewards/game_week_allocations.rb
 - lib/sorare/rewards/game_week_config.rb
+- lib/sorare/rewards/game_week_rewards.rb
 - lib/sorare/rewards/interactor.rb
 - lib/sorare/rewards/interactors/allocations/compute_for_game_week.rb
 - lib/sorare/rewards/interactors/allocations/compute_for_league.rb
@@ -197,7 +199,6 @@ files:
 - lib/sorare/rewards/interactors/tiers/qualify_players.rb
 - lib/sorare/rewards/interactors/tiers/qualify_supply.rb
 - lib/sorare/rewards/league.rb
-- lib/sorare/rewards/picker.rb
 - lib/sorare/rewards/player.rb
 - lib/sorare/rewards/prize_pool_configuration.yml
 - lib/sorare/rewards/random.rb
@@ -210,7 +211,7 @@ licenses:
 metadata:
   homepage_uri: https://gitlab.com/sorare/sorare-rewards
   source_code_uri: https://gitlab.com/sorare/sorare-rewards
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,12 +222,12 @@ 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.2.22
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: '["Sorare", "reward", "allocation", "algorithm"]'
 test_files: []

data/lib/sorare/rewards/concerns/with_analytics.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-
-module Sorare
-  module Rewards
-    # WithAnalytics defines analytics methods
-    module WithAnalytics
-      extend ActiveSupport::Concern
-
-      def analytics
-        @analytics ||= each_league.each_with_object({}) do |league, stats|
-          stats[league.name] = league_analytics(league)
-        end
-      end
-
-      private
-
-      def reward_distributed
-        @reward_distributed ||= reward_allocations.card_allocations.transform_values do |league|
-          league.transform_values do |rarity|
-            rarity.sum { |_, divisions| divisions.values.sum }
-          end
-        end
-      end
-
-      def league_analytics(league)
-        {
-          playing_players_with_supply: nb_of_playing_players(league),
-          available_cards: nb_of_available_cards(league),
-          cooldown_players: nb_of_fully_cooldown_players(league),
-          rewarded: reward_distributed[league.name]
-        }
-      end
-
-      def nb_of_playing_players(league)
-        supply_for(league.name).keys.index_with do |rarity|
-          (supply_for(league.name, rarity: rarity).keys & playing_players.keys).count
-        end
-      end
-
-      def nb_of_available_cards(league)
-        supply_for(league.name).keys.index_with do |rarity|
-          supply_for(league.name, rarity: rarity).sum { |_, data| data['supply'] }
-        end
-      end
-
-      def nb_of_fully_cooldown_players(league)
-        supply_for(league.name).keys.index_with do |rarity|
-          supply_for(league.name, rarity: rarity).filter do |player_slug|
-            player(player_slug).available_during_cooldown(league, rarity).zero?
-          end.count
-        end
-      end
-    end
-  end
-end