ecko-plugins-sponsor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2beab402173ba1462a969906af825db63641f56bdb10916cc26f63c356ddad27
+  data.tar.gz: 0f6fa5357ed8c9465b83fcce4399a973f51732411486ff9667d57276636c6c8c
+SHA512:
+  metadata.gz: 3e830986afae5fe73c0dca22e202ff76cd79cbc37cdcbead869eeb366b62e7f5b72bee8ab53062451bb9e0c0b1ac1e9a9c5ab596115a651161e66ae0a6005ed6
+  data.tar.gz: 9d9b961eff613e121fc5d664fbc1b96f91f54ee812ecd95e95bcc2a033edd5e84344ce690876b5f8f0e5366806dfdcecc80319d8c306baf53a2c2468faca2a68

data/app/controllers/ecko/plugins/donations_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    class DonationsController < 'ApplicationController'.constantize
+      layout 'public'
+
+      before_action :authenticate_user!
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/configurations.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Sponsor
+      # This error can be raised when no gateways are configured
+      class NoGatewaysConfiguredError < StandardError; end
+
+      class Configurations
+        include Singleton
+        attr_accessor :schema
+
+        # Need to validate schema structure here
+        def setup(schema)
+          # Check any gateways where configured
+          raise NoGatewaysConfiguredError if schema[:gateways].blank?
+
+          # Validate configurations
+          schema[:gateways].each do |gateway|
+            Ecko::Plugins::Sponsor::SchemaValidator::GatewayValidator.validate(gateway)
+            Ecko::Plugins::Sponsor.add_gateway(gateway)
+          end
+
+          @schema = schema
+        end
+
+        def gateways
+          return { run: 'default', default: schema[:gateways].first } if schema[:gateways].length == 1
+
+          { run: 'choice', choices: schema[:gateways] }
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/donated.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This class is used to perform post donation and add a donation to the account.
+# This actually should be a service that app should run.
+module Ecko
+  module Plugins
+    module Sponsor
+      class Donated
+        attr_accessor :intent, :account, :package
+
+        # Sets the intent of the donation and finds account and package with whom the
+        # intent is related to.
+        def initialize(intent)
+          @intent = intent
+          @account = ::Account.find(intent.payable_id)
+          @package = ::DonationPackage.find(intent.metadata['package_id'])
+        end
+
+        # Just the processor.
+        def process
+          create_donation && update_account_sponsorship && close_intent
+        end
+
+        private
+
+        # This is to help donations
+        def update_account_sponsorship
+          account.refresh_sponsorship
+        end
+
+        # Close the intent that was used for the donation
+        def close_intent
+          intent.update(status: 'closed')
+        end
+
+        # When the donation has been made, Create a donation for the account.
+        def create_donation
+          ::Donation.create(account: account, amount: package.amount)
+        end
+
+        class << self
+          def process(intent)
+            new(intent).process
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'configurations'
+require_relative 'schema_validator'
+require_relative 'process'
+
+# This class is the engine of the sponsor plugin. IT doesnt do much but helps in
+# redirecting process and configurations to different classes within the plugin.
+# THis class is registered in the ecko plugins registry
+module Ecko
+  module Plugins
+    module Sponsor
+      class Engine
+        class << self
+          # THis is the main engine configurer that the registry uses. THe schema is passed here
+          # and configured accordingly.
+          def configure(schema)
+            Ecko::Plugins::Sponsor::Configurations.instance.setup(schema)
+          end
+
+          # The gateways to be able to sponsor.
+          def gateways
+            Ecko::Plugins::Sponsor::Configurations.instance.gateways
+          end
+
+          # Processes the donation here.
+          def process(package_id, account)
+            Ecko::Plugins::Sponsor::Process.run(package_id, account)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/generator/donation_package_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+begin
+  require 'rails/generators'
+rescue LoadError
+end
+
+if defined?(Rails::Generators::Base)
+  module Ecko
+    module Plugins
+      module Sponsor
+        class DonationPackageGenerator < Rails::Generators::Base
+          DATA_TYPES = %w(binary json jsonb).freeze
+
+          source_root File.expand_path(File.join(File.dirname(__FILE__), '../generators/templates'))
+          class_option(
+            :data_type,
+            type: :string,
+            default: 'binary',
+            desc: "Configure the data type for `data` and `meta data` fields in Postgres migration (options: #{DATA_TYPES.join('/')})"
+          )
+
+          def initialize(*args)
+            super
+
+            if DATA_TYPES.exclude?(options.fetch(:data_type))
+              raise Error, "Invalid value for --data-type option. Supported for options are: #{DATA_TYPES.join(", ")}."
+            end
+          end
+
+          # THis will help in generating new templates for donations service.
+          def create_migration
+            template 'create_donation_package_template.rb', "db/migrate/#{timestamp}_create_donation_packages.rb"
+            template 'donation_package.rb', 'app/models/donation_package.rb'
+            template 'donation.rb', 'app/models/donation.rb'
+          end
+
+          private
+
+          def data_type
+            options.fetch('data_type')
+          end
+
+          def rails_version
+            Rails::VERSION::STRING
+          end
+
+          def migration_version
+            return nil if Gem::Version.new(rails_version) < Gem::Version.new('5.0.0')
+            '[6.0]'
+          end
+
+          def timestamp
+            Time.now.strftime('%Y%m%d%H%M%S')
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/ecko/plugins/sponsor/generator/templates/create_donation_package_template.rb

@@ -0,0 +1,14 @@
+class CreateDonationPackages < ActiveRecord::Migration[6.1]
+  def change
+    create_table :donation_packages do |t|
+      t.float :amount
+      t.integer :currency
+      t.string :title
+      t.text :description
+      t.integer :donation_reference, default: 0
+      t.boolean :visible, default: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/generator/templates/donation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# == Schema Information
+#
+# Table name: donations
+#
+#  id         :bigint(8)        not null, primary key
+#  account_id :bigint(8)        not null
+#  amount     :float            not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+class Donation < ApplicationRecord
+  belongs_to :account, inverse_of: :donations
+end

data/lib/ecko/plugins/sponsor/generator/templates/donation_package.rb

@@ -0,0 +1,27 @@
+# == Schema Information
+#
+# Table name: donation_packages
+#
+#  id                 :bigint(8)        not null, primary key
+#  amount             :float
+#  currency           :integer
+#  title              :string
+#  description        :text
+#  donation_reference :integer          default("free_tier")
+#  visible            :boolean          default(TRUE)
+#  created_at         :datetime         not null
+#  updated_at         :datetime         not null
+#
+class DonationPackage < ApplicationRecord
+  scope :visible, -> { where(visible: true) }
+  enum donation_reference: {
+    free_tier: 0,
+    silver_tier: 100,
+    gold_tier: 1000,
+    platinum_tier: 2000
+  }
+  enum currency: {
+    usd: 0,
+    eur: 1
+  }
+end

data/lib/ecko/plugins/sponsor/parser/stripe.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Sponsor
+      module Parser
+        class Stripe
+          attr_reader :package, :account
+
+          def initialize(package, account)
+            @package = package
+            @account = account
+          end
+
+          def build
+            {
+              submit_type: 'donate',
+              success_message: 'Thanks for being part of our community, Your donation was well received', # Need to add translation options,
+              callback: 'Ecko::Plugins::Sponsor::Donated',
+              package_id: package.id,
+              payable_type: account.class.name,
+              payable_id: account.id,
+              line_items: [
+                {
+                  quantity: 1,
+                  amount: package.amount,
+                  name: "#{package.title} Donation",
+                  description: 'Donation for the instance',
+                }
+              ]
+            }
+          end
+
+          class << self
+            def build(package, account)
+              new(package, account).build
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/process.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'ecko/plugins/sponsor/parser/stripe'
+
+# This class processes the gateway and parses the donation object. Currently only default option
+# as a runner is provided but when adding multiple parsers in future, we will have a choice option when
+# we add multiple gateways in the future.
+module Ecko
+  module Plugins
+    module Sponsor
+      class Process
+        attr_accessor :package, :account
+
+        # Get the donation package and set it here. If it is not found, RecordNotFound error
+        # will be raised
+        def initialize(package_id, account)
+          # Find the package through which we can donate.
+          @package = ::DonationPackage.find(package_id)
+
+          # A sponsor should always be associated with an account
+          @account = account
+        end
+
+        # This will run the gateway process based on the object set during configuration
+        def run
+          send("run_#{gateways[:run]}")
+        end
+
+        private
+
+        # Currently we just have a stripe parser which will never run this process so it is an empty
+        # runner currently.
+        # TODO: Set this up when we have multiple parsers. It should not run gateway process but redirect to a choice of gateway
+        def run_choice; end
+
+        # When we have only a default processor, we just parse the gateway object
+        # and then run the checkout flow for it.
+        def run_default
+          value = Object.const_get("Ecko::Plugins::Sponsor::Parser::#{gateways[:default][:name]}").build(package, account)
+          gateways[:default][:checkout].execute(value)
+        end
+
+        # Gets all the gateways that was registered for this plugin.
+        def gateways
+          @gateways ||= Ecko::Plugins::Sponsor::Configurations.instance.gateways
+        end
+
+        class << self
+          def run(package_id, account)
+            new(package_id, account).run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/schema_validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Sponsor
+      class InvalidGatewayName < StandardError; end
+
+      class InvalidGatewayCheckout < StandardError; end
+
+      module SchemaValidator
+        class Base
+          attr_accessor :schema
+
+          def initialize(schema)
+            @schema = schema
+          end
+
+          class << self
+            def validate(schema)
+              new(schema).validate
+            end
+          end
+        end
+
+        class GatewayValidator < Base
+
+          # Validate all the gateway schema which helps in providing correct structure for the gateways
+          # that is used for donation
+          def validate
+            # Validate name
+            raise InvalidGatewayName if schema[:name].nil?
+
+            # validate checkout
+            raise InvalidGatewayCheckout if schema[:checkout].nil? || !schema[:checkout].is_a?(Class)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/sponsor/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Sponsor
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/ecko/plugins/sponsor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'sponsor/version'
+require 'rails'
+require 'ecko/plugins'
+require_relative 'sponsor/engine'
+
+module Ecko
+  module Plugins
+    module Sponsor
+      autoload(:Donated, 'ecko/plugins/sponsor/donated')
+
+      class Error < StandardError; end
+      @@gateways = []
+
+      class << self
+        # It will add all the gateways here to be able to redirect when someone tries to donate
+        # If none of the gateways are configured there are no ways to donate
+        # Therefore an error will be thrown
+        def add_gateway(checkout)
+          @@gateways << checkout
+        end
+
+        # We can get all the available gateways that we can use to donate.
+        def available_gateways
+          return { run: 'default', default: @@gateways.first } if @@gateways.length == 1
+
+          # The choice runner will help in setting up a UI for the users to
+          # choose which gateway do they prefer.
+          { run: 'choice', choices: @@gateways }
+        end
+
+        # THis will register the sponsor engine to the ecko plugin registry
+        def register(schema)
+          Ecko::Plugins.register(name: 'sponsor', schema: schema, engine: Ecko::Plugins::Sponsor::Engine)
+        end
+      end
+    end
+  end
+end
+
+require 'ecko/plugins/sponsor/generator/donation_package_generator'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ecko-plugins-sponsor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manish Sharma
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ecko-plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Adds mastodon functionality to donate to an instance and sponsorship
+  tags
+email:
+- arnoltherasing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/ecko/plugins/donations_controller.rb
+- lib/ecko/plugins/sponsor.rb
+- lib/ecko/plugins/sponsor/configurations.rb
+- lib/ecko/plugins/sponsor/donated.rb
+- lib/ecko/plugins/sponsor/engine.rb
+- lib/ecko/plugins/sponsor/generator/donation_package_generator.rb
+- lib/ecko/plugins/sponsor/generator/templates/create_donation_package_template.rb
+- lib/ecko/plugins/sponsor/generator/templates/donation.rb
+- lib/ecko/plugins/sponsor/generator/templates/donation_package.rb
+- lib/ecko/plugins/sponsor/parser/stripe.rb
+- lib/ecko/plugins/sponsor/process.rb
+- lib/ecko/plugins/sponsor/schema_validator.rb
+- lib/ecko/plugins/sponsor/version.rb
+homepage: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-sponsor
+licenses:
+- GPL-3.0+
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-sponsor
+  source_code_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-sponsor
+  changelog_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-sponsor
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- app
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Adds sponsor functionality through donations
+test_files: []