moneytree-rails 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3cb24c4e2a58def5e8f26fdd8ec1bce493b0deea44320eb30eed239a16f470
-  data.tar.gz: c8d266821266b5b886777afd8f45ed0bb19af5fb11b74de5145f77e25dd10b18
+  metadata.gz: e93dc9ca7a7f7c33bb6866abec9c4ef68038d5c9c542a92ea20d890086ab4369
+  data.tar.gz: ab099aef15f26a36c21934d1a70d39e8641db9fee2feb88107681b3f72b5f890
 SHA512:
-  metadata.gz: ee2779c427433363015894190d09a801cb2cb8ecc3b7eb746cf067149b95486acd8c221ddbc074f0f943b7baf6bcd5845b3c22ccb59cb8464cac11fba5b4d760
-  data.tar.gz: 04de96735920050133081445ffae416e9248a08d0f33e6c1e806b0f9968a53a0dc8da60c2fa4d0274455a021fc251fb6662cfb567e712449e158bdccf71e6327
+  metadata.gz: c76a4655eb8f63a3c7643b95b595e8cbe7484ff5a92642ca28e1947225ed6ebce4be3bf80cb620bc1ace05450b308a976901f4f3415fcfce2083dd4f475453fd
+  data.tar.gz: ddb835e4f3a5113752ca9929a4fd0788565729a8881a7c917bbb13548bdc856e025e0b7def3c0647d6e5314bf4e0670ce70036355be1a21a77439002cb786699

data/README.md

@@ -1,19 +1,5 @@
 # 🚧 WORK IN PROGRESS 🚧
 
-- [ ] OAuth
-  - [ ] Controller actions
-  - [ ] Scopes
-  - [ ] Square
-  - [ ] Stripe
-  - [ ] Braintree
-- [ ] Moneytree models
-  - [ ] Payment gateway, belongs to account
-  - [ ] Cards
-  - [ ] Customers
-  - [ ] Payments
-  - [ ] Refunds
-- [ ] Notifications
-
 # Moneytree 💵 🌴
 
 [![Actions Status](https://github.com/kieranklaassen/moneytree/workflows/build/badge.svg)](https://github.com/kieranklaassen/moneytree/actions)
@@ -26,16 +12,16 @@ functionality with almost no work on your end:
 
 - 💵💶💷💴 Multi-currency
 - 🔑 OAuth to link your PSP account
-- 👩‍💻PSP account creation, (with commission)
+- 👩‍💻 PSP account creation, (with commission)
 - ⚙️ Webhooks
-- 💳 PCI compliance with Javascript libraries
-- 🧲 Platform fees
+- 💳 ~~PCI compliance with Javascript libraries~~ comming soon
+- 🧲 Platform fees a.k.a. Market Places
 
 Currently we support the following PSP's:
 
-- Square
+- ~~Square~~ comming soon
 - Stripe
-- Braintree
+- ~~Braintree~~ comming soon
 
 But if you want to add more PSP's, we make it easy to do so. Read our
 [Contributing](https://github.com/kieranklaassen/moneytree#contributing) section to learn more.
@@ -57,31 +43,72 @@ Add the latest version of Moneytree to your gem Gemfile by running:
 ```bash
 $ bundle add moneytree-rails
 $ bundle install
-$ bundle exec moneytree init
+$ rails g moneytree:install:migrations
+$ rails g db:migrate
 ```
 
-Or your can use environment variables:
-
-FIXME: add
-
 ## Configuration
 
+### Initializer
+
 Do you need to make some changes to how Moneytree is used? You can create an initializer
 `config/initializers/moneytree.rb`
 
 ```ruby
 Moneytree.setup do |config|
-  config.enabled_psps = [:square, :stripe, :braintree]
-  config.account_class = 'Account'
-  config.order_class = 'Order'
-  config.transaction_class = 'Transaction'
-
-  config.square_credentials = {
-    app_id: ENV['SQUARE_APP_ID'],
-    app_secret: ENV['SQUARE_APP_SECRET'],
-    environment: Rails.env.production? : 'production' : 'sandbox',
-    oauth_domain: Rails.env.production? ? 'https://connect.squareup.com' : 'https://connect.squareupsandbox.com'
+  config.current_account = :current_merchant
+  config.stripe_credentials = {
+    api_key: ENV['STRIPE_API_KEY'],
+    client_id: ENV['STRIPE_CLIENT_ID']
   }
+  config.oauth_redirect = '/welcome_back'
+  config.refund_application_fee = true # false by default
+end
+```
+
+### Routes
+
+Add to your routes and authenticate if needed to make sure only admins can integrate with OAuth.
+
+```ruby
+  authenticate :user, ->(u) { u.admin? } do
+    mount Moneytree::Engine => '/moneytree'
+  end
+```
+
+### Models
+
+Include account concern into your models and make sure the following attributes work:
+
+```ruby
+class Merchant < ApplicationRecord
+  include Moneytree::Account
+
+  def email
+    owner.email
+  end
+
+  def currency_code
+    currency.code
+  end
+
+  def website
+    'https://www.boomtown.com'
+  end
+
+  # Optional, will be called by Moneytree after authenticating with the PSP
+  def moneytree_oauth_callback
+    puts "Hurray, I just got associated with a Moneytree gateway!"
+  end
+end
+```
+
+And add `Moneytree::Order` concern to the model that will be the parent for all the transactions. In most cases this
+will be an order. This model will keep a balance and you can add multiple payments and refunds to it.
+
+```ruby
+class Order < ApplicationRecord
+  include Moneytree::Order
 end
 ```
 
@@ -95,6 +122,10 @@ transaction attached for the payment. You can name these models however you want
 
 ### The API
 
+#### Moneytree::PaymentGateway
+
+##### #method here
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
@@ -112,25 +143,9 @@ intended to be a safe, welcoming space for collaboration, and contributors are e
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
 Everyone interacting in the Moneytree project's codebases, issue trackers, chat rooms and mailing lists is expected to
 follow the [code of conduct](https://github.com/kieranklaassen/moneytree/blob/master/CODE_OF_CONDUCT.md).
-
-rails g model payment_gateway psp_credentials:text moneytree_psp:integer account:references{polymorphic}
-
-owner t.string :name t.text :psp_credentials t.integer :moneytree_psp
-
-rails g model orders t.string :description t.string :remote_identifier t.references :customer t.references :account
-
-rails g model transactions t.decimal :amount t.decimal :app_fee_amount t.integer :status t.integer :type t.string
-:remote_identifier t.string :currency_code t.string :psp_error t.integer :moneytree_psp t.references :account
-t.references :order t.references :card
-
-rails g model customers t.string :first_name t.string :last_name t.string :email t.string :remote_identifier t.integer
-:moneytree_psp t.references :account
-
-rails g model cards t.string :card_brand t.string :last_4 t.integer :expiration_month t.integer :expiration_year
-t.string :cardholder_name t.string :fingerprint t.integer :moneytree_psp t.references :customer t.references :account

data/app/controllers/moneytree/oauth/stripe_controller.rb

@@ -6,9 +6,10 @@ module Moneytree
       end
 
       def callback
-        payment_gateway = PaymentGateway.create!(psp: 'stripe', account: current_account)
+        # TODO: Remove this module prefix once we figure out how to properly autoload this.
+        payment_gateway = Moneytree::PaymentGateway.create!(psp: 'stripe', account: current_account)
         payment_gateway.oauth_callback(payment_gateway_params)
-        redirect_to '/', notice: 'Connected to Stripe'
+        redirect_to Moneytree.oauth_redirect, notice: 'Connected to Stripe'
       end
 
       private
@@ -27,7 +28,7 @@ module Moneytree
             response_type: :code,
             client_id: Moneytree.stripe_credentials[:client_id],
             scope: PaymentProvider::Stripe::PERMISSION,
-            redirect_uri: oauth_stripe_callback_url, # FIXME: use rails url helper and add host
+            redirect_uri: oauth_stripe_callback_url,
             'stripe_user[email]': current_account.email,
             'stripe_user[url]': current_account.website,
             'stripe_user[currency]': current_account.currency_code

data/app/controllers/moneytree/webhooks/stripe_controller.rb

@@ -1,8 +1,66 @@
 module Moneytree
   module Webhooks
     class StripeController < ApplicationController
+      skip_before_action :verify_authenticity_token
+
       def create
-        # Do some callback magic here
+        case webhook_params.type
+        when 'charge.succeeded'
+          process_charge!
+        when 'charge.refunded'
+          process_refund!
+        else
+          puts "Unhandled event type: #{webhook_params.type}"
+        end
+
+        head :ok
+      end
+
+      private
+
+      def webhook_params
+        @webhook_params ||=
+          ::Stripe::Event.construct_from(
+            JSON.parse(request.body.read, symbolize_names: true)
+          )
+      end
+
+      def process_charge!
+        return if transaction.completed?
+
+        transaction.process_response(
+          TransactionResponse.new(:success, '', { charge_id: stripe_object.id })
+        )
+
+        if Moneytree.order_status_trigger_method
+          transaction.order.send(Moneytree.order_status_trigger_method, transaction)
+        end
+      end
+
+      def process_refund!
+        stripe_object.refunds.data.each do |stripe_refund_object|
+          # TODO: Create refund transaction in db for PSP-initiated refunds
+          next if stripe_refund_object.metadata[:moneytree_transaction_id].blank?
+
+          refund = transaction.refunds.find(stripe_refund_object.metadata[:moneytree_transaction_id])
+
+          next if refund.completed?
+
+          refund.process_response(
+            TransactionResponse.new(:success, '')
+          )
+          if Moneytree.order_status_trigger_method
+            transaction.order.send(Moneytree.order_status_trigger_method, transaction)
+          end
+        end
+      end
+
+      def transaction
+        @transaction ||= Transaction.find(stripe_object.metadata[:moneytree_transaction_id])
+      end
+
+      def stripe_object
+        @stripe_object ||= webhook_params.data.object
       end
     end
   end

data/app/models/moneytree/payment.rb

@@ -0,0 +1,23 @@
+module Moneytree
+  class Payment < Transaction
+    has_many :refunds, class_name: 'Refund'
+
+    validates_absence_of :payment_id
+
+    validates_numericality_of :amount, greater_than: 0
+    validates_numericality_of :app_fee_amount, greater_than_or_equal_to: 0
+
+    private
+
+    def execute_transaction(metadata: {})
+      process_response(
+        payment_gateway.charge(
+          amount,
+          details,
+          app_fee_amount: app_fee_amount,
+          metadata: metadata.merge(moneytree_transaction_id: id)
+        )
+      )
+    end
+  end
+end

data/app/models/moneytree/payment_gateway.rb

@@ -1,14 +1,12 @@
 module Moneytree
   class PaymentGateway < ApplicationRecord
-    include Moneytree::Account
-
     belongs_to :account, polymorphic: true
 
     enum psp: Moneytree::PSPS
     serialize :psp_credentials
     # encrypts :psp_credentials
     # FIXME: enable https://github.com/ankane/lockbox
-    delegate :oauth_link, :scope_correct?, to: :payment_provider
+    delegate :oauth_link, :scope_correct?, :charge, :refund, to: :payment_provider
 
     # has_many :orders
     # has_many :transactions
@@ -17,6 +15,7 @@ module Moneytree
 
     def oauth_callback(params)
       update! psp_credentials: payment_provider.get_access_token(params)
+      account.send(:moneytree_oauth_callback) if account.respond_to?(:moneytree_oauth_callback, true)
     end
 
     def psp_connected?
@@ -31,16 +30,13 @@ module Moneytree
       psp_credentials[:scope] == payment_provider.scope
     end
 
-    def charge; end
-
-    def refund; end
-
     private
 
     def payment_provider
       @payment_provider ||=
         case psp
         when 'stripe'
+          # TODO: see if we only need to pass credentials
           Moneytree::PaymentProvider::Stripe.new(self)
         # when 'square'
         #   Moneytree::PaymentProvider::Square.new(self)

data/app/models/moneytree/refund.rb

@@ -0,0 +1,46 @@
+module Moneytree
+  class Refund < Transaction
+    belongs_to :payment, class_name: 'Moneytree::Payment'
+
+    before_validation :set_order, :set_payment_gateway
+
+    validates_presence_of :payment
+
+    validates_numericality_of :amount, less_than: 0
+    validates_numericality_of :app_fee_amount, less_than_or_equal_to: 0
+
+    validate :order_matches_payment, :gateway_matches_payment
+
+    private
+
+    def execute_transaction(metadata: {})
+      process_response(
+        payment_gateway.refund(
+          amount,
+          payment.details,
+          metadata: metadata.merge(moneytree_transaction_id: id)
+        )
+      )
+    end
+
+    # validates_presence_of :payment
+    def set_order
+      self.order ||= payment&.order
+    end
+
+    # validates_presence_of :payment
+    def set_payment_gateway
+      self.payment_gateway ||= payment&.payment_gateway
+    end
+
+    # validates
+    def order_matches_payment
+      errors.add(:order_id, :mismatch) if order_id != payment&.order_id
+    end
+
+    # validates
+    def gateway_matches_payment
+      errors.add(:payment_gateway_id, :mismatch) if payment_gateway_id != payment&.payment_gateway_id
+    end
+  end
+end

data/app/models/moneytree/transaction.rb

@@ -0,0 +1,30 @@
+module Moneytree
+  class Transaction < ApplicationRecord
+    belongs_to :payment_gateway
+    belongs_to :order, polymorphic: true
+
+    validates_presence_of :psp_error, if: :failed?
+
+    enum status: %i[initialized pending completed failed]
+
+    serialize :details
+
+    after_create_commit :execute_transaction
+
+    def process_response(response)
+      if response.success?
+        update!(
+          status: :completed,
+          psp_error: response.message,
+          details: (details || {}).merge(response.body)
+        )
+      else
+        # FIXME: pending state
+        update!(
+          status: :failed,
+          psp_error: response.message
+        )
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,4 +1,8 @@
 Moneytree::Engine.routes.draw do
   get 'oauth/stripe/new', to: 'oauth/stripe#new'
   get 'oauth/stripe/callback', to: 'oauth/stripe#callback'
+
+  namespace :webhooks do
+    resources :stripe, only: :create
+  end
 end

data/db/migrate/20200914151648_create_moneytree_payment_gateways.rb

@@ -3,7 +3,7 @@ class CreateMoneytreePaymentGateways < ActiveRecord::Migration[6.0]
     create_table :moneytree_payment_gateways do |t|
       t.text :psp_credentials
       t.integer :psp, null: false
-      t.references :account, polymorphic: true, null: false, index: { name: 'index_moneytree_pg_account_type_and_account_id' }
+      t.references :account, polymorphic: true, index: { name: 'index_moneytree_pg_account_type_and_account_id' }
 
       t.timestamps
     end

data/db/migrate/20201008161617_create_moneytree_transactions.rb

@@ -0,0 +1,18 @@
+class CreateMoneytreeTransactions < ActiveRecord::Migration[6.0]
+  def change
+    create_table :moneytree_transactions do |t|
+      t.decimal :amount, null: false, default: 0
+      t.decimal :app_fee_amount, null: false, default: 0
+      t.integer :status, null: false, default: 0
+      t.string :type, null: false, default: 'Moneytree::Payment'
+      t.references :order, polymorphic: true, null: false
+      t.references :payment_gateway, null: false
+      t.references :payment, foreign_key: { to_table: :moneytree_transactions }
+      t.text :psp_error
+      t.text :details
+      t.text :refund_reason
+
+      t.timestamps
+    end
+  end
+end

data/lib/moneytree-rails.rb

@@ -0,0 +1 @@
+require 'moneytree'

data/lib/moneytree.rb

@@ -5,7 +5,9 @@
 # modules
 # FIXME: autoload instead? https :/ / github.com / excid3 / noticed / blob / master / lib / noticed.rb
 require 'moneytree/version'
+require 'moneytree/transaction_response'
 require 'moneytree/account'
+require 'moneytree/order'
 require 'moneytree/payment_provider/base'
 require 'moneytree/payment_provider/stripe'
 require 'moneytree/engine'
@@ -16,9 +18,14 @@ module Moneytree
   mattr_accessor :enabled_psps
   mattr_accessor :stripe_credentials
   mattr_accessor :current_account
+  mattr_accessor :oauth_redirect
+  mattr_accessor :refund_application_fee
+  mattr_accessor :order_status_trigger_method
 
   @@enabled_psps = PSPS
   @@current_account = :current_account
+  @@oauth_redirect = '/'
+  @@refund_application_fee = false
 
   def self.setup
     yield self

data/lib/moneytree/account.rb

@@ -3,9 +3,10 @@ require 'active_support/concern'
 module Moneytree
   module Account
     extend ActiveSupport::Concern
+    # FIXME: see if we can remove  config.current_account = :current_merchant and set it from here
 
     included do
-      has_one :moneytree_payment_gateway, class_name: 'Moneytree::PaymentGateway', foreign_key: 'account_id'
+      has_one :moneytree_payment_gateway, class_name: 'Moneytree::PaymentGateway', foreign_key: 'account_id', inverse_of: :account, as: :account
     end
   end
 end

data/lib/moneytree/order.rb

@@ -0,0 +1,15 @@
+require 'active_support/concern'
+
+module Moneytree
+  module Order
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :moneytree_transactions, class_name: 'Moneytree::Transaction', foreign_key: 'order_id', inverse_of: :order, as: :order
+    end
+
+    def new_payment(*args)
+      moneytree_transactions << Payment.new(*args)
+    end
+  end
+end

data/lib/moneytree/payment_provider/stripe.rb

@@ -14,16 +14,62 @@ module Moneytree
 
       def get_access_token(params)
         # FIXME: add error handling
-        ::Stripe::OAuth.token({
-          grant_type: 'authorization_code',
-          code: params[:code]
-        }).to_hash
+        ::Stripe::OAuth.token(
+          {
+            grant_type: 'authorization_code',
+            code: params[:code]
+          }
+        ).to_hash
       end
 
       def scope
         PERMISSION.to_s
       end
 
+      def charge(amount, details, app_fee_amount: 0, description: "Charge for #{account.name}", metadata:)
+        # `source` is obtained with Stripe.js; see https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token
+        response = ::Stripe::Charge.create(
+          {
+            amount: (amount * 100).to_i,
+            currency: account.currency_code,
+            source: details[:card_token],
+            description: description,
+            metadata: metadata,
+            application_fee_amount: (app_fee_amount * 100).to_i
+          },
+          stripe_account: payment_gateway.psp_credentials[:stripe_user_id]
+        )
+        # succeeded, pending, or failed
+        TransactionResponse.new(
+          { succeeded: :success, pending: :pending, failed: :failed }[response[:status].to_sym],
+          response[:failure_message],
+          { charge_id: response[:id] }
+        )
+      rescue ::Stripe::StripeError => e
+        TransactionResponse.new(:failed, e.message)
+      end
+
+      def refund(amount, details, metadata:)
+        response = ::Stripe::Refund.create(
+          {
+            charge: details[:charge_id],
+            amount: (-amount * 100).to_i,
+            metadata: metadata,
+            refund_application_fee: Moneytree.refund_application_fee
+          },
+          stripe_account: payment_gateway.psp_credentials[:stripe_user_id]
+        )
+
+        # succeeded, pending, or failed
+        TransactionResponse.new(
+          { succeeded: :success, pending: :pending, failed: :failed }[response[:status].to_sym],
+          response[:failure_message],
+          { refund_id: response[:id] }
+        )
+      rescue ::Stripe::StripeError => e
+        TransactionResponse.new(:failed, e.message)
+      end
+
       private
 
       def credentitals

data/lib/moneytree/transaction_response.rb

@@ -0,0 +1,15 @@
+module Moneytree
+  class TransactionResponse
+    attr_reader :message, :status, :body
+
+    def initialize(status, message, body = {})
+      @status = status
+      @message = message
+      @body = body
+    end
+
+    def success?
+      @status == :success
+    end
+  end
+end

data/lib/moneytree/version.rb

@@ -1,3 +1,3 @@
 module Moneytree
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moneytree-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Kieran Klaassen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,21 +56,26 @@ files:
 - app/controllers/moneytree/oauth/stripe_controller.rb
 - app/controllers/moneytree/webhooks/square_controller.rb
 - app/controllers/moneytree/webhooks/stripe_controller.rb
-- app/helpers/moneytree/application_helper.rb
-- app/helpers/moneytree/oauth/stripe_helper.rb
 - app/jobs/moneytree/application_job.rb
 - app/mailers/moneytree/application_mailer.rb
 - app/models/moneytree/application_record.rb
+- app/models/moneytree/payment.rb
 - app/models/moneytree/payment_gateway.rb
+- app/models/moneytree/refund.rb
+- app/models/moneytree/transaction.rb
 - app/views/layouts/moneytree/application.html.erb
 - config/routes.rb
 - db/migrate/20200914151648_create_moneytree_payment_gateways.rb
+- db/migrate/20201008161617_create_moneytree_transactions.rb
+- lib/moneytree-rails.rb
 - lib/moneytree.rb
 - lib/moneytree/account.rb
 - lib/moneytree/engine.rb
+- lib/moneytree/order.rb
 - lib/moneytree/payment_provider/base.rb
 - lib/moneytree/payment_provider/square.rb
 - lib/moneytree/payment_provider/stripe.rb
+- lib/moneytree/transaction_response.rb
 - lib/moneytree/version.rb
 - lib/tasks/moneytree_tasks.rake
 homepage: https://github.com/kieranklaassen/moneytree
@@ -92,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A payments engine for rails centered aorund transactional payments and orders.

data/app/helpers/moneytree/application_helper.rb

@@ -1,4 +0,0 @@
-module Moneytree
-  module ApplicationHelper
-  end
-end

data/app/helpers/moneytree/oauth/stripe_helper.rb

@@ -1,6 +0,0 @@
-module Moneytree
-  module Oauth
-    module StripeHelper
-    end
-  end
-end