ecko-plugins-stripe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9e1cd65716b38c451d99de1930b876bd506b7ef29993679b831b27496fa042b
+  data.tar.gz: 15bccabf1f00fe687e35b4a28c6c065416d193c3a6bcbfcdb3c9b97cc860b3ed
+SHA512:
+  metadata.gz: 6df3346303f4870426c5aaef107370c9e47240d1a63bf097e8f4061bbb3613cc9acab93b32ba4163491c5d403f0f9f639b509dae98c85dcb08836fd921c28de0
+  data.tar.gz: be237693365e670e728990f0975e24f7fc68f06a47916a52a4303c320f922336b2a12950e03a9a9f594091814feb7bcb79f4c1023e6d888f1f5b72a9756f5a63

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

@@ -0,0 +1,22 @@
+module Ecko
+  module Plugins
+    class StripeCallbacksController < 'ApplicationController'.constantize
+
+      # This can be used to extend and run the payment success.
+      def success
+        raise Ecko::Plugins::Stripe::InvalidPaymentIntent if intent.nil?
+
+        @message = intent.metadata['success_message']
+        Object.const_get(intent.metadata['callback']).process(intent)
+
+        view_response
+      end
+
+      def intent
+        @intent ||= StripePaymentIntent.find_by(code: params[:state])
+      end
+
+      def view_response; end
+    end
+  end
+end

data/lib/ecko/plugins/stripe/authenticator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require 'ecko/plugins/stripe/configurations'
+
+module Ecko
+  module Plugins
+    module Stripe
+      # Base class with
+      class Authenticator
+        attr_reader :params
+
+        def initialize(params)
+          @params = params
+          ::Ecko::Plugins.stripe.authenticate
+        end
+
+        def run
+          raise Ecko::Plugins::ExecutionError
+        end
+
+        def state_secret
+          Ecko::Plugins::Stripe::Configurations.instance.state_secret
+        end
+
+        class << self
+          # Hits the run instance method.
+          def execute(params)
+            new(params).run
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/stripe/checkout.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Stripe
+      class Checkout < Authenticator
+        def run
+          session.url
+        end
+
+        # Creates a session based on the parameters send
+        def session
+          @session ||= ::Stripe::Checkout::Session.create(
+            payment_method_types: payment_method_types,
+            mode: 'payment',
+            submit_type: params[:submit_type] || 'pay',
+            client_reference_id: SecureRandom.uuid,
+            success_url: success_url,
+            cancel_url: cancel_url,
+            line_items: line_items
+          )
+        end
+
+        private
+
+        # Currently we only provide card payments, We can implment multiple types when required.
+        def payment_method_types
+          params[:types] || ['card']
+        end
+
+        # Creates a valid line item structure to pass it to the stipe checkout process.
+        def line_items
+          raise Ecko::Plugins::Stripe::InvalidLineItemError unless valid_line_items?
+
+          params[:line_items].map do |line_item|
+            # Amount ot be transferred
+            amount = line_item[:amount].to_i
+
+            # Raise invalid amount error if the amount is 0
+            raise Ecko::Plugins::Stripe::InvalidAmountError if amount.zero?
+
+            # Quantity of the item, normally its 1.
+            quantity = line_item[:quantity].to_i
+
+            # If Quantity is 0, then it doesnt let us go thorough by raising this error.
+            raise Ecko::Plugins::Stripe::InvalidQuantityError if quantity.zero?
+
+            # If Name is nil, then it doesnt let us go thorough by raising this error.
+            raise Ecko::Plugins::Stripe::InvalidNameError if line_item[:name].nil?
+
+            {
+              name: line_item[:name],
+              description: line_item[:description],
+              images: line_item[:images],
+              amount: amount * 100, # Stripe takes values for cents
+              currency: line_item[:currency] || default_currency,
+              quantity: quantity,
+            }
+          end
+        end
+
+        # When the checkout is a success, this url is triggered.
+        def success_url
+          "#{callback}/stripe_success?state=#{state}&session_id={CHECKOUT_SESSION_ID}"
+        end
+
+        # When the checkout is cancelled, this url is triggered.
+        def cancel_url
+          "#{callback}/stripe/callbacks/cancel?state=#{state}"
+        end
+
+        # The state provided as the code of the payment intent
+        def state
+          payment_intent.code
+        end
+
+        # Gets the currency from the configurations
+        def default_currency
+          Ecko::Plugins::Stripe::Configurations.instance.currency
+        end
+
+        # Callback url for the checkout process to come back to when the payment is complete or
+        # cancelled.
+        def callback
+          @callback ||= Ecko::Plugins::Stripe::Configurations.instance.callback
+        end
+
+        # Validates and returns boolean if the line item is present or not.
+        def valid_line_items?
+          params[:line_items].present? && params[:line_items].is_a?(Array)
+        end
+
+        # This is the payment intent provided from the checkout process only.
+        # It can be configured when intent is already building outside of the checkout
+        # process.
+        def intent
+          params[:intent]
+        end
+
+        # Creates an intent or pull the intent from the given checkout request
+        # Here we save the params to make sure to get data correctly.
+        def payment_intent
+          @payment_intent ||= intent || ::StripePaymentIntent.create(
+            reference: 'payment_only',
+            metadata: params.as_json,
+            payable_type: params[:payable_type],
+            payable_id: params[:payable_id]
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Ecko
+  module Plugins
+    module Stripe
+      class Configurations
+        include Singleton
+        attr_accessor :schema
+
+        def setup(schema)
+          @schema = schema
+        end
+
+        # Stripe API key configured through schema
+        def stripe_api_key
+          schema[:stripe_api_key]
+        end
+
+        # The state secret is used if we have to encrypt any state on callbacks
+        # Currently this hasn't been used.
+        def state_secret
+          schema[:state_secret]
+        end
+
+        # Configured currency while checkout process.
+        def currency
+          schema[:currency] || 'USD'
+        end
+
+        # Callback url which helps in returning to the correct url when a payment is complete or
+        # cancelled
+        def callback
+          schema[:callback]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require 'ecko/plugins/stripe/configurations'
+require 'ecko/plugins/stripe/authenticator'
+require 'ecko/plugins/stripe/checkout'
+
+module Ecko
+  module Plugins
+    module Stripe
+      class Engine
+        class << self
+          # Configures all the schema and setups the configurations instance of the plugin
+          def configure(schema)
+            Ecko::Plugins::Stripe::Configurations.instance.setup(schema)
+          end
+
+          # It helps authenticate the stripe plugin api key.
+          def authenticate
+            ::Stripe.api_key = Ecko::Plugins::Stripe::Configurations.instance.stripe_api_key
+          end
+
+          # This will provide the checkout reference for other plugins as well
+          # Currently ecko sponsor plugin uses this.
+          def checkout_reference
+            Ecko::Plugins::Stripe::Checkout
+          end
+
+          # Creates a checkout session with a payment intent as well.
+          def checkout(params)
+            checkout_reference.execute(params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecko/plugins/stripe/generators/payment_intent_generator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+begin
+  require 'rails/generators'
+rescue LoadError
+end
+
+if defined?(Rails::Generators::Base)
+  module Ecko
+    module Plugins
+      module Stripe
+        class PaymentIntentionGenerator < 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
+
+          def create_migration
+            template 'create_payment_intent_template.rb', "db/migrate/#{timestamp}_create_payable_intent.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/stripe/generators/templates/create_payment_intent_template.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreatePayableIntent < ActiveRecord::Migration[6.1]
+  def change
+    create_table(:payment_intentions, force: false) do |t|
+      t.string :code, null: false
+      t.string :reference, null: false
+      t.string :category, null: false, default: 'stripe'
+      t.references :payable, polymorphic: true
+      t.jsonb :metadata, null: false
+      t.integer :status, default: 0
+    end
+    add_index :payment_intentions, [:code], unique: true
+    add_index :payment_intentions, [:reference]
+  end
+end

data/lib/ecko/plugins/stripe/payment_intent.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# == Schema Information
+#
+# Table name: payment_intentions
+#
+#  id           :bigint(8)        not null, primary key
+#  code         :string           not null
+#  reference    :string           not null
+#  category     :string           default("stripe"), not null
+#  payable_type :string
+#  payable_id   :bigint(8)
+#  metadata     :jsonb            not null
+#  status       :integer          default("pending")
+#
+
+class StripePaymentIntent < ApplicationRecord
+  self.table_name = 'payment_intentions'
+  before_create :set_code
+
+  enum status: {
+    pending: 0,
+    closed: 0,
+  }
+
+  belongs_to :payable, polymorphic: true
+
+  def set_code
+    self.code = SecureRandom.uuid
+  end
+end

data/lib/ecko/plugins/stripe/rails/routes.rb

@@ -0,0 +1,15 @@
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/hash/slice"
+
+module ActionDispatch::Routing
+  class Mapper
+
+    # Sets all the stripe routes specification
+    def stripe_callbacks(*resources)
+      return if resources.first.nil?
+
+      get :stripe_success, to: "#{resources.first}#success", as: :stripe_success_callback
+      get :stripe_cancel, to: "#{resources.first}#cancel", as: :stripe_cancel_callback
+    end
+  end
+end

data/lib/ecko/plugins/stripe/rails.rb

@@ -0,0 +1,15 @@
+# This will load the custom routes set by the app
+require 'ecko/plugins/stripe/rails/routes'
+
+module Ecko
+  module Plugins
+    class Engine < ::Rails::Engine
+      config.ecko_plugins = Ecko::Plugins
+
+      # Force routes to be loaded if we are doing any eager load.
+      config.before_eager_load do |app|
+        app.reload_routes!
+      end
+    end
+  end
+end

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

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

data/lib/ecko/plugins/stripe.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "stripe/version"
+require 'stripe'
+require 'rails'
+require 'ecko/plugins/stripe/engine'
+require 'ecko/plugins/stripe/generators/payment_intent_generator'
+require 'ecko/plugins/stripe/rails'
+require 'ecko/plugins'
+
+module Ecko
+  module Plugins
+    module Stripe
+      class ExecutionError < StandardError; end
+
+      # This error will be thrown when line items are not provided
+      class InvalidLineItemError < StandardError; end
+
+      # This error will be thrown if amount is not provided or it is 0
+      # or string is provided
+      class InvalidAmountError < StandardError; end
+
+      # This error will be thrown if quantity is set to zero
+      class InvalidQuantityError < StandardError; end
+
+      # This error will be thrown if name of a line item is not provided
+      class InvalidNameError < StandardError; end
+
+      # When payment Intent is not found this error is thrown
+      class InvalidPaymentIntent < StandardError; end
+
+      class << self
+        # This is the initializer for tp register the plugin to the ecko plugin registry
+        def register(schema)
+          Ecko::Plugins.register(name: 'stripe', schema: schema, engine: Ecko::Plugins::Stripe::Engine)
+        end
+      end
+    end
+  end
+end
+
+autoload(:StripePaymentIntent, 'ecko/plugins/stripe/payment_intent')

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ecko-plugins-stripe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manish Sharma
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-09 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: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.39'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.39'
+- !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: ''
+email:
+- arnoltherasing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/ecko/plugins/stripe_callbacks_controller.rb
+- lib/ecko/plugins/stripe.rb
+- lib/ecko/plugins/stripe/authenticator.rb
+- lib/ecko/plugins/stripe/checkout.rb
+- lib/ecko/plugins/stripe/configurations.rb
+- lib/ecko/plugins/stripe/engine.rb
+- lib/ecko/plugins/stripe/generators/payment_intent_generator.rb
+- lib/ecko/plugins/stripe/generators/templates/create_payment_intent_template.rb
+- lib/ecko/plugins/stripe/payment_intent.rb
+- lib/ecko/plugins/stripe/rails.rb
+- lib/ecko/plugins/stripe/rails/routes.rb
+- lib/ecko/plugins/stripe/version.rb
+homepage: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-stripe
+licenses:
+- GPL-3.0+
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-stripe
+  source_code_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-stripe
+  changelog_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins-stripe
+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: Mastodon stripe plugin, extendable to ecko-plugins sdk
+test_files: []