saas_payments 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 399ad7181e74c3e135ffbf7c1990babb8d1aec389a453fe0b5b2414401bb6f9b
+  data.tar.gz: da5bc44556fd4496ae64bece2da30f42cbdba80f77d79278714dad01681075f2
+SHA512:
+  metadata.gz: da830a93f1a7c9a757fa2a21c2068296b6d40198479ff802d8740a09ff0ee297582adbc94f50b127ee315ad3e3e00d5e08efb6818bba62753ff24642af20e4f5
+  data.tar.gz: 0765fa876818e55cd8b521199edf1adc58a77b96269bb54012a5ab1f74bebbab03555ac3f4571d98e02d8ad8b2479d82f79a9ad571157227944b79afd911facb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Cody
+
+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

@@ -0,0 +1,146 @@
+# SaasPayments
+
+SaasPayments is a thin wrapper around the Stripe API to manage the most common
+SAAS subscription actions. This gem includes
+
+- [ ] Subscription model to hold the state of a user's subscription
+- [ ] Payment form template
+- [ ] Webhook to handle subscription updates from Stripe
+- [ ] Sign up, cancel, and change plan routes
+
+
+This Gem also assumes you already have:
+
+- A `User` model (If you don't, try [Devise](https://github.com/plataformatec/devise))
+
+# Getting Started
+
+## Install
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'saas_payments'
+```
+
+And then run:
+```bash
+bundle install
+```
+
+## Migrations
+```bash
+rake saas_payments:install:migrations
+rails db:migrate
+```
+
+## Configuration
+
+```ruby
+SaasPayments.configure do |config|
+  # Stripe API Keys
+  config.stripe_secret_key = "sk_...."
+  config.stripe_publishable_key = "pk_..."
+
+  # Path to return to after successful subscription changes
+  config.account_path = '/dashboard'
+end
+```
+
+## Importing data from Stripe
+
+### Rake task to import Products/Plans
+```bash
+rake products:sync
+```
+
+## Managing Subscriptions
+
+Subscriptions are managed using a set of controller concerns. Subscriptions
+can be created and modified by including the `SaasPayments::Subscriptions`
+concern into your controller.
+
+### Creating subscriptions
+
+Currently, only one subscription is supported per user. Should a user enter
+their card information more than once, their current subscription will be
+updated, rather than creating a second subscription.
+
+```ruby
+class AccountsController < ApplicationController
+  # Include the subscriptions concern
+  include SaasPayments::Subscriptions
+
+  def create
+    sign_up_for_plan @current_user, @plan
+  end
+
+end
+```
+
+### Cancellation
+
+NOTE: Canceled subscriptions will be canceled at the end of the period.
+
+```ruby
+# Host application
+class AccountsController < ApplicationController
+  # Include the subscriptions concern
+  include SaasPayments::Subscriptions
+
+  def cancel
+    # Perform any logic you need
+
+    # Call the cancel_subscription method to perform the
+    # cancellation
+    cancel_at_period_end @current_user
+  end
+end
+```
+
+### Changing Plans
+
+The subscriptions concern also contains a method for changing plans.
+
+```ruby
+# Host application
+class AccountsController < ApplicationController
+  # Include the subscriptions concern
+  include SaasPayments::Subscriptions
+
+  def change_plan
+    # Perform any logic you need
+
+    # Call the change_plan method to change the plan a user is
+    # subscribed to.
+    change_plan @current_user, @plan
+  end
+end
+```
+
+## Development
+
+- Use `bin/rails`. For example, generators using this executable will create
+  models/controllers/etc that are namespaced to the saas_payments gem
+
+
+## Testing ([Rails Guide](https://guides.rubyonrails.org/engines.html#testing-an-engine))
+```bash
+make test
+```
+
+## Contributing
+Contribution directions go here.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## TODO
+
+- [ ] Per unit pricing
+- [ ] Tiered pricing
+- [ ] Metered pricing
+- [ ] Product pricing

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SaasPayments'
+  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/saas_payments_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/saas_payments .js
+//= link_directory ../stylesheets/saas_payments .css

data/app/assets/javascripts/saas_payments/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/javascripts/saas_payments/elements.js

@@ -0,0 +1,146 @@
+'use strict';
+
+document.addEventListener('DOMContentLoaded', function() {
+
+  var Card = function(stripe) {
+    // Create an instance of Elements.
+    var elements = stripe.elements();
+
+    // Custom styling can be passed to options when creating an Element.
+    // (Note that this demo uses a wider set of styles than the guide below.)
+    var style = {
+      base: {
+        color: '#32325d',
+        fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
+        fontSmoothing: 'antialiased',
+        fontSize: '16px',
+        '::placeholder': {
+          color: '#aab7c4'
+        }
+      },
+      invalid: {
+        color: '#fa755a',
+        iconColor: '#fa755a'
+      }
+    };
+
+    // Create an instance of the card Element.
+    var card = elements.create('card', {style: style});
+
+    // Handle real-time validation errors from the card Element.
+    card.addEventListener('change', function(event) {
+      var displayError = document.getElementById('card-errors');
+      if (event.error) {
+        displayError.textContent = event.error.message;
+      } else {
+        displayError.textContent = '';
+      }
+    });
+
+    return card
+  }
+
+  var SPElements = function() {
+    // Retrieve the publishable key
+    var key = document.getElementById("publishable-key").dataset.publishable
+
+    // Create a Stripe client.
+    var stripe = Stripe(key);
+
+    var options = options || {}
+    var card = Card(stripe);
+    var forms = document.getElementsByClassName('payment-form')
+
+    var init = function() {
+      for (var i = 0; i < forms.length; i++) {
+        initForm(forms[i])
+      }
+      if (forms.length === 1) {
+        this.show(forms[0].id)
+      }
+    }
+
+    // Submit the form with the token ID.
+    var stripeTokenHandler = function(form, token) {
+      // Insert the token ID into the form so it gets submitted to the server
+      var hiddenInput = document.createElement('input');
+      hiddenInput.setAttribute('type', 'hidden');
+      hiddenInput.setAttribute('name', 'stripeToken');
+      hiddenInput.setAttribute('value', token.id);
+      form.appendChild(hiddenInput);
+
+      // Submit the form
+      form.submit();
+    }
+
+    var initForm = function(form) {
+      // Handle form submission.
+      form.addEventListener('submit', onSubmit.bind(this, form))
+    }
+
+    var onSubmit = function(form, event) {
+      if (event) {
+        event.preventDefault();
+      }
+
+      stripe.createToken(card).then(function(result) {
+        if (result.error) {
+          // Inform the user if there was an error.
+          var errorElement = document.getElementById('card-errors');
+          errorElement.textContent = result.error.message;
+        } else {
+          // Send the token to your server.
+          stripeTokenHandler(form, result.token);
+        }
+      });
+    }
+
+    var hideAll = function() {
+      var forms = document.getElementsByClassName('payment-form')
+      for (var i = 0; i < forms.length; i++) {
+        forms[i].style.display = 'none'
+      }
+    }
+
+    var setHiddenValue = function(form, className, value) {
+      var field = form.getElementsByClassName(className)[0]
+      field.value = value
+    }
+
+    this.show = function(id) {
+      this.form = document.getElementById(id)
+
+      if(!this.form) {
+        console.error("Could not find form with id ("+id+")")
+        return
+      }
+
+      hideAll()
+      this.form.style.display = ''
+      card.unmount()
+      card.mount('#' + id + "_card") // Add an instance of the card Element into the `card-element` <div>.
+    }
+
+    this.setData = function(options) {
+      if(!this.form) {
+        console.error("Form must be shown first")
+        return
+      }
+
+      var defaults = ['plan_id', 'user_id']
+      for (var i = 0; i < defaults.length; i++) {
+        var key = defaults[i]
+        if(options[key]) setHiddenValue(this.form, 'form_'+key, options[key])
+      }
+    }
+
+    this.submit = function() {
+      onSubmit(this.form)
+    }
+
+    init.call(this)
+  }
+
+  window.SPElements = SPElements
+})
+

data/app/assets/stylesheets/saas_payments/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/assets/stylesheets/saas_payments/elements.css

@@ -0,0 +1,31 @@
+/**
+ * The CSS shown here will not be introduced in the Quickstart guide, but shows
+ * how you can use CSS to style your Element's container.
+ */
+.StripeElement {
+  box-sizing: border-box;
+
+  height: 40px;
+
+  padding: 10px 12px;
+
+  border: 1px solid transparent;
+  border-radius: 4px;
+  background-color: white;
+
+  box-shadow: 0 1px 3px 0 #e6ebf1;
+  -webkit-transition: box-shadow 150ms ease;
+  transition: box-shadow 150ms ease;
+}
+
+.StripeElement--focus {
+  box-shadow: 0 1px 3px 0 #cfd7df;
+}
+
+.StripeElement--invalid {
+  border-color: #fa755a;
+}
+
+.StripeElement--webkit-autofill {
+  background-color: #fefde5 !important;
+}

data/app/controllers/concerns/saas_payments/subscription_concerns.rb

@@ -0,0 +1,173 @@
+module SaasPayments
+  module SubscriptionConcerns
+    Stripe.api_key = SaasPayments.config.stripe_secret_key
+
+    class FailedPayment < StandardError; end
+    class ActionRequired < StandardError; end
+
+    extend ActiveSupport::Concern
+
+    def sign_up_for_plan user, plan
+      customer = get_customer user
+      sub = update_subscription customer, plan
+      render_success
+    rescue ActionRequired
+      render_action_required
+    rescue FailedPayment
+      render_card_failure
+    rescue Stripe::CardError
+      render_card_failure
+    end
+
+    def change_plan user, plan
+      customer = get_customer user
+      sub = customer.subscription(remote: true)
+      update_plan sub, customer, plan
+      render_success
+    rescue StandardError
+      render_error
+    end
+
+    def cancel_at_period_end user
+      customer = get_customer user
+      sub = customer.subscription(remote: true)
+
+      # Customer has an existing subscription, change plans
+      remote_sub = Stripe::Subscription.update(sub[:id], {
+        cancel_at_period_end: true
+      })
+
+      customer.subscription.update(Subscription.from_stripe(remote_sub))
+      render_success
+    rescue StandardError
+      render_error
+    end
+
+    def resume_subscription user
+      customer = get_customer user
+      sub = customer.subscription
+      remote_sub = Stripe::Subscription.update(sub.stripe_id, {
+        cancel_at_period_end: false
+      })
+
+      customer.subscription.update(Subscription.from_stripe(remote_sub))
+      render_success
+    rescue StandardError
+      render_error
+    end
+
+    def cancel_now user
+      customer = get_customer user
+      Stripe::Subscription.delete(customer.subscription.stripe_id)
+    end
+
+
+    private
+
+    def render_success
+      respond_to do |format|
+        format.html { redirect_to SaasPayments.config.account_path }
+        format.json { render json: { message: "success" } }
+      end
+    end
+
+    def render_error
+      format.html {
+        flash[:sp_error] = 'Failed to update plan'
+        redirect_back fallback_location: root_path
+      }
+      format.json { render json: { message: "update_failed" }, status: :bad_request }
+    end
+
+    def render_action_required
+      respond_to do |format|
+        format.html {
+          flash[:sp_notice] = 'Payment requires customer action'
+          redirect_to SaasPayments.successPath
+        }
+        format.json { render json: { message: "action_required" } }
+      end
+    end
+
+    def render_card_failure
+      respond_to do |format|
+        format.html {
+          flash[:sp_error] = 'Failed to process card'
+          redirect_back fallback_location: root_path
+        }
+        format.json { render json: { message: "card_error" }, status: :bad_request }
+      end
+    end
+
+    def get_customer user
+      # Try to find a customer in the database by the user id
+      customer = SaasPayments::Customer.find_by_user_id(user.id)
+
+      # If no customer exists, create a new one
+      if !customer.present?
+        # Create a new customer in stripe
+        c = Stripe::Customer.create({
+          email: user.email,
+          source: params.require(:stripeToken),
+          metadata: { user_id: user.id }
+        })
+
+        # Create a new customer locally that maps to the stripe customer
+        customer = Customer.create(Customer.from_stripe(c).merge({ user_id: user.id }))
+      end
+      customer
+    end
+
+    def update_subscription customer, plan
+      sub = customer.subscription(remote: true)
+      if sub.present?
+        update_plan sub, customer, plan
+      else
+        sub = create_subscription customer, plan
+      end
+
+      sub
+    end
+
+    def update_plan sub, customer, plan
+      # Customer has an existing subscription, change plans
+      remote_sub = Stripe::Subscription.update(sub[:id], {
+        cancel_at_period_end: false,
+        items: [{
+          id: sub[:items][:data][0][:id],
+          plan: plan.stripe_id
+        }]
+      })
+
+      customer.subscription.update(Subscription.from_stripe(remote_sub))
+    end
+
+    def create_subscription customer, plan
+      # Customer does not have a subscription, sign them up
+      sub = Stripe::Subscription.create({
+        customer: customer.stripe_id,
+        items: [{ plan: plan.stripe_id }]
+      })
+      complete_subscription sub
+    end
+
+    def complete_subscription sub
+      if incomplete?(sub)
+        raise FailedPayment if payment_intent(sub, :requires_payment_method)
+        raise ActionRequired if payment_intent(sub, :requires_action)
+      end
+
+      # Successful payment, or trialling: provision the subscription
+      # Create a local subscription
+      Subscription.create(Subscription.from_stripe(sub))
+    end
+
+    def incomplete? sub
+      sub[:status] == "incomplete"
+    end
+
+    def payment_intent sub, intent
+      sub[:latest_invoice][:payment_intent][:status] == intent.to_s
+    end
+  end
+end