munificent 1.0.0

data/config/initializers/money.rb

@@ -0,0 +1,140 @@
+require "monetize"
+require "money-rails"
+MoneyRails.configure do |config|
+  # To set the default currency
+  #
+  config.default_currency = :gbp
+
+  # Set default bank object
+  #
+  # Example:
+  # config.default_bank = EuCentralBank.new
+
+  # Add exchange rates to current money bank object.
+  # (The conversion rate refers to one direction only)
+  #
+  # Example:
+  config.add_rate "GBP", "EUR", 1.1536
+  config.add_rate "GBP", "USD", 1.3927
+  config.add_rate "GBP", "CAD", 1.7740
+  config.add_rate "GBP", "AUD", 1.8069
+
+  config.add_rate "EUR", "GBP", 0.86684
+  config.add_rate "EUR", "USD", 1.2072
+  config.add_rate "EUR", "CAD", 1.5377
+  config.add_rate "EUR", "AUD", 1.5663
+
+  config.add_rate "USD", "EUR", 0.82833
+  config.add_rate "USD", "GBP", 0.71803
+  config.add_rate "USD", "CAD", 1.2738
+  config.add_rate "USD", "AUD", 1.2974
+
+  config.add_rate "CAD", "USD", 0.78507
+  config.add_rate "CAD", "EUR", 0.65030
+  config.add_rate "CAD", "GBP", 0.56371
+  config.add_rate "CAD", "AUD", 1.0186
+
+  config.add_rate "AUD", "CAD", 0.98176
+  config.add_rate "AUD", "USD", 0.77075
+  config.add_rate "AUD", "EUR", 0.63844
+  config.add_rate "AUD", "GBP", 0.55343
+
+  # To handle the inclusion of validations for monetized fields
+  # The default value is true
+  #
+  # config.include_validations = true
+
+  # Default ActiveRecord migration configuration values for columns:
+  #
+  config.amount_column = {
+    prefix: "", # column name prefix
+    postfix: "_decimals", # column name  postfix
+    column_name: nil,     # full column name (overrides prefix, postfix and accessor name)
+    type: :integer,       # column type
+    present: true,        # column will be created
+    null: false,          # other options will be treated as column options
+    default: 0,
+  }
+  #
+  # config.currency_column = { prefix: '',
+  #                            postfix: '_currency',
+  #                            column_name: nil,
+  #                            type: :string,
+  #                            present: true,
+  #                            null: false,
+  #                            default: 'USD'
+  #                          }
+
+  # Register a custom currency
+  #
+  # Example:
+  # config.register_currency = {
+  #   priority:            1,
+  #   iso_code:            "EU4",
+  #   name:                "Euro with subunit of 4 digits",
+  #   symbol:              "€",
+  #   symbol_first:        true,
+  #   subunit:             "Subcent",
+  #   subunit_to_unit:     10000,
+  #   thousands_separator: ".",
+  #   decimal_mark:        ","
+  # }
+
+  # Specify a rounding mode
+  # Any one of:
+  #
+  # BigDecimal::ROUND_UP,
+  # BigDecimal::ROUND_DOWN,
+  # BigDecimal::ROUND_HALF_UP,
+  # BigDecimal::ROUND_HALF_DOWN,
+  # BigDecimal::ROUND_HALF_EVEN,
+  # BigDecimal::ROUND_CEILING,
+  # BigDecimal::ROUND_FLOOR
+  #
+  # set to BigDecimal::ROUND_HALF_EVEN by default
+  #
+  config.rounding_mode = BigDecimal::ROUND_HALF_UP
+
+  # Set default money format globally.
+  # Default value is nil meaning "ignore this option".
+  # Example:
+  #
+  # config.default_format = {
+  #   no_cents_if_whole: nil,
+  #   symbol: nil,
+  #   sign_before_symbol: nil
+  # }
+
+  # If you would like to use I18n localization (formatting depends on the
+  # locale):
+  config.locale_backend = :i18n
+  #
+  # Example (using default localization from rails-i18n):
+  #
+  # I18n.locale = :en
+  # Money.new(10_000_00, 'USD').format # => $10,000.00
+  # I18n.locale = :es
+  # Money.new(10_000_00, 'USD').format # => $10.000,00
+  #
+  # For the legacy behaviour of "per currency" localization (formatting depends
+  # only on currency):
+  # config.locale_backend = :currency
+  #
+  # Example:
+  # Money.new(10_000_00, 'USD').format # => $10,000.00
+  # Money.new(10_000_00, 'EUR').format # => €10.000,00
+  #
+  # In case you don't need localization and would like to use default values
+  # (can be redefined using config.default_format):
+  # config.locale_backend = nil
+
+  # Set default raise_error_on_money_parsing option
+  # It will be raise error if assigned different currency
+  # The default value is false
+  #
+  # Example:
+  # config.raise_error_on_money_parsing = false
+
+  Monetize.assume_from_symbol = true
+end
+MoneyRails::Hooks.init

data/db/migrate/20220525220035_create_munificent_models.rb

@@ -0,0 +1,211 @@
+class CreateMunificentModels < ActiveRecord::Migration[7.0]
+  def change
+    create_table :munificent_donators  do |t|
+      t.string :chosen_name
+      t.string :name
+
+      t.string :stripe_customer_id, index: { unique: true }
+      t.string :twitch_id, index: { unique: true }
+
+      # Email address and login
+      t.string :email_address, index: { unique: true, where: "confirmed = false" }
+      t.string :unconfirmed_email_address
+
+      # Authlogic::ActsAsAuthentic::Password
+      t.string :crypted_password
+      t.string :password_salt
+
+      # Authlogic::ActsAsAuthentic::PersistenceToken
+      t.string :persistence_token, index: { unique: true }
+
+      # Authlogic::ActsAsAuthentic::SingleAccessToken
+      t.string :single_access_token, index: { unique: true }
+
+      # Authlogic::ActsAsAuthentic::PerishableToken
+      t.string :perishable_token, index: { unique: true }
+
+      # See "Magic Columns" in Authlogic::Session::Base
+      t.datetime :current_login_at
+      t.datetime :last_login_at
+      t.datetime :last_request_at
+      t.integer :failed_login_count, default: 0, null: false
+      t.integer :login_count, default: 0, null: false
+      t.string :current_login_ip
+      t.string :last_login_ip
+
+      # See "Magic States" in Authlogic::Session::Base
+      t.boolean :active, default: false
+      t.boolean :approved, default: false
+      t.boolean :confirmed, default: false
+
+      t.timestamps
+    end
+
+    create_table :munificent_curated_streamers  do |t|
+      t.string :twitch_username, null: false, index: true, unique: true
+
+      t.timestamps
+    end
+
+    create_table :munificent_fundraisers  do |t|
+      t.datetime :ends_at
+      t.datetime :starts_at
+      t.string :main_currency, default: "GBP", null: false
+      t.string :name, null: false
+      t.string :overpayment_mode, null: false, default: "pro_bono"
+      t.string :short_url
+      t.string :state, null: false, default: "inactive"
+      t.text :description
+
+      t.timestamps
+    end
+
+    create_table :munificent_charities  do |t|
+      t.string :name, index: true, null: false
+      t.text :description
+
+      t.timestamps
+    end
+
+    create_table :munificent_games  do |t|
+      t.string :name, null: false
+      t.text :description
+
+      t.timestamps
+    end
+
+    create_table :munificent_donations  do |t|
+      t.monetize :amount
+      t.string :donator_name
+      t.string :message
+
+      t.string :state, null: false, default: "pending"
+
+      t.string :paypal_order_id
+      t.string :stripe_payment_intent_id, index: { unique: true }
+      t.check_constraint "num_nonnulls(stripe_payment_intent_id, paypal_order_id) > 0"
+
+      t.references :donator, null: false, foreign_key: { to_table: :munificent_donators }
+      t.references :donated_by, null: true, foreign_key: { to_table: :munificent_donators }
+      t.references :curated_streamer, null: true, foreign_key: { to_table: :munificent_curated_streamers }
+      t.references :fundraiser, index: true, foreign_key: { to_table: :munificent_fundraisers }
+
+      t.timestamps
+    end
+
+    create_table :munificent_payments  do |t|
+      t.monetize :amount
+
+      t.references :donation, null: true, foreign_key: { to_table: :munificent_donations }
+
+      t.string :stripe_payment_intent_id, unique: true
+      t.string :paypal_order_id
+      t.check_constraint "num_nonnulls(stripe_payment_intent_id, paypal_order_id) > 0"
+
+      t.timestamps
+    end
+
+    create_table :munificent_charity_splits  do |t|
+      t.monetize :amount
+
+      t.references :donation, null: true, foreign_key: { to_table: :munificent_donations }
+      t.references :charity, null: false, foreign_key: { to_table: :munificent_charities }
+
+      t.timestamps
+    end
+
+    create_table :munificent_bundles  do |t|
+      t.string :name, null: false
+
+      t.string :state, null: false, default: "draft"
+
+      t.references :fundraiser, index: true, null: false, foreign_key: { to_table: :munificent_fundraisers }
+      t.index [:name, :fundraiser_id], unique: true
+
+      t.timestamps
+    end
+
+    create_table :munificent_donator_bundles  do |t|
+      t.references :donator, null: false, foreign_key: { to_table: :munificent_donators }
+      t.references :bundle, null: false, foreign_key: { to_table: :munificent_bundles }
+
+      t.timestamps
+    end
+
+    create_table :munificent_bundle_tiers  do |t|
+      t.datetime :ends_at
+      t.datetime :starts_at
+      t.monetize :price
+      t.string :name
+
+      t.references :bundle, null: false, index: true, foreign_key: { to_table: :munificent_bundles }
+
+      t.timestamps
+    end
+
+    create_table :munificent_bundle_tier_games  do |t|
+      t.references :bundle_tier, null: false, foreign_key: { to_table: :munificent_bundle_tiers }
+      t.references :game, null: false, foreign_key: { to_table: :munificent_games }
+
+      t.timestamps
+    end
+
+    create_table :munificent_donator_bundle_tiers  do |t|
+      t.references :donator_bundle,
+        null: false,
+        index: { name: "donator_bundle_tier_donator_bundle_id_index" },
+        foreign_key: { to_table: :munificent_donator_bundles }
+      t.references :bundle_tier,
+        null: false,
+        index: { name: "donator_bundle_tier_bundle_tier_id_index" },
+        foreign_key: { to_table: :munificent_bundle_tiers }
+
+      t.boolean :unlocked, default: false, null: false
+
+      t.timestamps
+    end
+
+    create_table :munificent_keys  do |t|
+      t.references :game, null: false, foreign_key: { to_table: :munificent_games }
+      t.references :donator_bundle_tier, null: true, foreign_key: { to_table: :munificent_donator_bundle_tiers }
+      t.references :fundraiser, index: true, foreign_key: { to_table: :munificent_fundraisers }
+
+      # Ciphertext
+      t.text :code_ciphertext
+
+      # Encryption key
+      t.text :encrypted_kms_key
+
+      # Blind index
+      t.string :code_bidx, index: { unique: true }
+
+      t.index [:donator_bundle_tier_id, :game_id], unique: true, name: "donator_bundle_tier_game_idx"
+
+      t.timestamps
+    end
+
+    create_table :munificent_charity_fundraisers  do |t|
+      t.references :charity, foreign_key: { to_table: :munificent_charities }
+      t.references :fundraiser,
+        index: { name: "charity_fundraiser_fundraiser_id_index" },
+        foreign_key: { to_table: :munificent_fundraisers }
+
+      t.timestamps
+    end
+
+    create_table :munificent_curated_streamer_administrators  do |t|
+      t.references :curated_streamer,
+        null: false,
+        index: { name: "curated_streamer_administrator_curated_streamer_id_index" },
+        foreign_key: { to_table: :munificent_curated_streamers }
+      t.references :donator,
+        null: false,
+        index: { name: "curated_streamer_administrator_donator_id_index" },
+        foreign_key: { to_table: :munificent_donators }
+
+      t.index [:curated_streamer_id, :donator_id], unique: true, name: "curated_streamer_donator_index"
+
+      t.timestamps
+    end
+  end
+end

data/lib/munificent/engine.rb

@@ -0,0 +1,40 @@
+require "redis"
+require "rails"
+require "rollbar"
+
+require "authlogic"
+
+module Munificent
+  class Engine < ::Rails::Engine
+    isolate_namespace Munificent
+
+    logger = Rails.logger || ActiveSupport::Logger.new($stdout)
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: "test/factories"
+    end
+
+    initializer "munificent.hmac" do
+      require "hmac"
+      HMAC.configure do |config|
+        config.secret = ENV.fetch("HMAC_SECRET", nil)
+      end
+    end
+
+    initializer "munificent.stripe" do
+      require "stripe"
+      Stripe.api_key = ENV.fetch("STRIPE_SECRET_KEY", nil)
+    end
+
+    begin
+      # Expose factories to the parent app/engine
+      require "factory_bot_rails"
+      require_relative "./factories"
+      config.factory_bot.definition_file_paths += [File.expand_path("../../test/factories", __dir__)]
+    rescue LoadError
+      logger.debug("One or more factory_bot files could not be required, skipping additional factory_bot configuration")
+    end
+  end
+end

data/lib/munificent/factories.rb

@@ -0,0 +1,13 @@
+require "factory_bot/namespaced_factories"
+
+module Munificent
+  module Factories
+    def self.define(name, &)
+      FactoryBot.define do
+        with_namespace(:Munificent, require_prefix: false) do
+          factory(name, &)
+        end
+      end
+    end
+  end
+end

data/lib/munificent/seeds.rb

@@ -0,0 +1,47 @@
+# rubocop:disable Rails/Output
+module Munificent
+  class Seeds
+    def self.run
+      puts "Creating active fundraisers"
+      wwf = Fundraiser.create!(name: "WWF Manatee Matinée (London)", main_currency: "GBP")
+      msf = Fundraiser.create!(name: "MSF Gala (Paris)", main_currency: "EUR")
+
+      [wwf, msf].each do |fundraiser|
+        puts "Populating the fundraiser #{fundraiser.name}"
+        fundraiser.activate!
+
+        puts "Creating bundle"
+        bundle = Bundle.create!(
+          name: "Test bundle",
+          fundraiser:,
+          state: "live",
+        )
+
+        bundle.highest_tier.update(price_decimals: 25_00)
+        bundle.highest_tier.bundle_tier_games.create!(game: Game.find_or_initialize_by(name: "The Witness"))
+
+        tier = bundle.bundle_tiers.create!(price_decimals: 10_00, price_currency: fundraiser.main_currency)
+
+        tier.bundle_tier_games.create!(game: Game.find_or_initialize_by(name: "Doom"))
+        tier.bundle_tier_games.create!(game: Game.find_or_initialize_by(name: "Duke Nukem Forever"))
+
+        Game.all.each do |game|
+          puts "Adding 100 keys for #{game.name}"
+          100.times do
+            game.keys.create(
+              code: SecureRandom.uuid,
+              fundraiser:,
+            )
+          end
+        end
+      end
+
+      puts "Creating charities"
+      Charity.create(name: "Help the Penguins", fundraisers: [wwf])
+      Charity.create(name: "World Wildlife Foundation", fundraisers: [wwf])
+      Charity.create(name: "Vets Without Borders", fundraisers: [wwf, msf])
+      Charity.create(name: "Médecins Sans Frontières", fundraisers: [msf])
+    end
+  end
+end
+# rubocop:enable Rails/Output

data/lib/munificent/version.rb

@@ -0,0 +1,3 @@
+module Munificent
+  VERSION = "1.0.0".freeze
+end

data/lib/munificent.rb

@@ -0,0 +1,6 @@
+require "munificent/version"
+require "munificent/engine"
+
+module Munificent
+  EMAIL_ADDRESS_REGEX = %r{(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])} # rubocop:disable Layout/LineLength
+end

data/lib/tasks/default.rake

@@ -0,0 +1,31 @@
+begin
+  require "rspec/core/rake_task"
+  require "rubocop/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+  RuboCop::RakeTask.new
+rescue LoadError => exception
+  puts "Library not available: #{exception.message}"
+end
+
+desc "Build, lint, and test"
+task :build_and_test do
+  Rake::Task["lint"].invoke
+  Rake::Task["test"].invoke
+  Rake::Task["build"].invoke unless ENV["CI"]
+end
+
+desc "Lint"
+task lint: :rubocop
+
+desc "Test"
+task :test do
+  Rake::Task["spec"].invoke
+end
+
+desc "Build"
+task :build do
+  # no-op
+end
+
+task default: :build_and_test

data/lib/tasks/key_assignment.rake

@@ -0,0 +1,8 @@
+desc "Key assignment"
+namespace :key_assignment do
+  desc "A long running task to assign keys to donator bundle tiers"
+  task start: :environment do
+    Rails.logger.debug("Starting key assignment...")
+    Munificent::KeyAssignment::RequestProcessor.start
+  end
+end

data/lib/tasks/munificent_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :munificent do
+#   # Task goes here
+# end