moneytree-rails 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac0effde5b67728b209c237fcd5eb32f1bfaf682396d6dd65b3bbef29614c880
-  data.tar.gz: 48b468a83dfd1a2099a04c3d137538d90444be660e281cbcf9fbb502469b28e7
+  metadata.gz: 2006000e7eb666a0edd1d8e035330c00804f41460dcca1a7e73d75f855dcd254
+  data.tar.gz: 1a36220066504521f1d9d4b477d9eeca1fb5ddd7dce1abc37daefe0a4412001f
 SHA512:
-  metadata.gz: f07412f98d4783a4e6b64316c1fe10300e0c47f6f008a9479b8df592e23a01c2d72697de61b53d5d495e504a64bdfdb79529bddc71af205ff1fa968a3742b420
-  data.tar.gz: c04082cfb750538aa4ae3f9500c2d3b9fcae56ad546a81e326ae5994e7045c781ff4ac408b99b71492fef642dccd60d2c5ac851f17b55b957ed04ca780fb30d3
+  metadata.gz: 72fbbd0d1f6dd0e144e6d72a412aa7313487afa0d92c2bbb5213925a4d3e4eaebdcb1369a64060183d7b073de41823f97d1f978f8751151c82799a8565324530
+  data.tar.gz: 296df5c1b71b78acd51639d49caca1964bf8260c156ddc7ea68aa648dcf47a6fe8e1e0b9887e1cf20236365a8436dd9b76f45c7e1a5f18fdb74d537a3944d8bf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Kieran Klaassen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,16 +1,9 @@
 # 🚧 WORK IN PROGRESS 🚧
 
-- [ ] OAuth
-- [ ] Cards
-- [ ] Customers
-- [ ] Payments
-- [ ] Refunds
-- [ ] Notifications
-
 # Moneytree 💵 🌴
 
 [![Actions Status](https://github.com/kieranklaassen/moneytree/workflows/build/badge.svg)](https://github.com/kieranklaassen/moneytree/actions)
-[![Gem Version](https://badge.fury.io/rb/moneytree.svg)](https://badge.fury.io/rb/moneytree)
+[![Gem Version](https://badge.fury.io/rb/moneytree-rails.svg)](https://badge.fury.io/rb/moneytree-rails)
 
 🔥 A powerful, simple, and extendable payment engine for rails, centered around transactional payments. 💵 🌴
 
@@ -19,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.
@@ -48,33 +41,69 @@ rails app:template LOCATION='https://railsbytes.com/script/Xg8sOv'
 Add the latest version of Moneytree to your gem Gemfile by running:
 
 ```bash
-$ bundle add moneytree
+$ 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
+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
 ```
 
@@ -88,6 +117,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
@@ -105,7 +138,7 @@ 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
 

data/Rakefile

@@ -1,6 +1,32 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rdoc/task'
 
-task :default => :spec
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Moneytree'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/moneytree_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/moneytree .css

data/app/assets/stylesheets/moneytree/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/moneytree/application_controller.rb

@@ -0,0 +1,9 @@
+module Moneytree
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery with: :exception
+
+    # def current_account
+    #   send(Moneytree.current_account)
+    # end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Moneytree
+  module Oauth
+    class SquareController < ApplicationController
+      def new
+        redirect_to current_account.oauth_link
+      end
+
+      def callback
+        current_account.oauth_callback(params)
+        render text: 'Boom'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Moneytree
+  module Oauth
+    class StripeController < ApplicationController
+      def new
+        redirect_to stripe_oauth_url
+      end
+
+      def callback
+        # 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 Moneytree.oauth_redirect, notice: 'Connected to Stripe'
+      end
+
+      private
+
+      def payment_gateway_params
+        params.permit :scope, :code
+      end
+
+      def stripe_oauth_url
+        # https://stripe.com/docs/connect/oauth-reference
+        # https://stripe.com/docs/connect/oauth-reference#get-authorize
+        URI::HTTPS.build(
+          host: 'connect.stripe.com',
+          path: '/oauth/authorize',
+          query: {
+            response_type: :code,
+            client_id: Moneytree.stripe_credentials[:client_id],
+            scope: PaymentProvider::Stripe::PERMISSION,
+            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
+          }.to_query
+        ).to_s
+      end
+
+      def current_account
+        send(Moneytree.current_account)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Moneytree
+  module Webhooks
+    class SquareController < ApplicationController
+      def create
+        # Do some callback magic here
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module Moneytree
+  module Webhooks
+    class StripeController < ApplicationController
+      skip_before_action :verify_authenticity_token
+
+      def create
+        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
+end

data/app/jobs/moneytree/application_job.rb

@@ -0,0 +1,4 @@
+module Moneytree
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/moneytree/application_mailer.rb

@@ -0,0 +1,6 @@
+module Moneytree
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/moneytree/application_record.rb

@@ -0,0 +1,5 @@
+module Moneytree
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  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

@@ -0,0 +1,47 @@
+module Moneytree
+  class PaymentGateway < ApplicationRecord
+    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?, :charge, :refund, to: :payment_provider
+
+    # has_many :orders
+    # has_many :transactions
+    # has_many :customers
+    # has_many :cards
+
+    def oauth_callback(params)
+      update! psp_credentials: payment_provider.get_access_token(params)
+    end
+
+    def psp_connected?
+      psp.present? && psp_credentials.present?
+    end
+
+    def needs_oauth?
+      !psp_connected? || !scope_correct?
+    end
+
+    def scope_correct?
+      psp_credentials[:scope] == payment_provider.scope
+    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)
+        else
+          raise 'BOOM'
+        end
+    end
+  end
+end