fiat_stripe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39405774aeb607ed7423c0c565206a0d988821fb
+  data.tar.gz: 47e62f40fa50ab1f1465e240cc177e064f254fa6
+SHA512:
+  metadata.gz: 9f04ddec88aea2b6a59708354849ea6688dc83f998733d141099e66e97d073ddffb172c3b6443c7216150107f35a1352e7ec2a9d110d3ca1c241a92154012132
+  data.tar.gz: e3a197a8b208a6f1e9736055f3bee59baeafffe77d97f84b3ab32253f2f6f7156922201c94d3557fe91fc4b5d056a8d8e4928af282a5b5e23ac7dd6c19af73c9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Andrew Haines
+
+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,91 @@
+# Fiat Stripe
+
+This gem is designed to be used by Fiat Insight developers on Rails projects that need to connect paying entities with Stripe.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fiat_stripe'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fiat_stripe
+
+## Setup
+
+You'll need to configure the `stripe` and `stripe_event` gems like normal.
+
+Create an initializer at `config/initializers/fiat_stripe.rb` to set some global configs:
+
+```ruby
+FiatStripe.live_default_plan_id = "plan_id"
+FiatStripe.test_default_plan_id = "plan_id"
+```
+
+Install the migrations in your app root folder by running:
+
+    $ rails fiat_stripe:install:migrations
+    $ rake db:migrate
+
+To include all the helpers, add this line in your `ApplicationController`:
+
+```ruby
+helper FiatStripe::Engine.helpers
+```
+
+### Stripeable
+
+The `Stripeable` concern for models does the work of ensuring a class is able to act as a Stripe customer. Call it using `include Stripeable`. You'll also need to make sure that any classes in your application that will connect as Stripe customers have the following database fields: `name`, `stripe_customer_id`, `stripe_card_token`, and `remove_card`.
+
+Here is a sample migration generation for this:
+
+    $ rails g migration add_stripe_fields_to_xyz name:string stripe_customer_id:string stripe_card_token:string remove_card:boolean
+
+### Subscriptions
+
+Subscriptions handle the records and logic for controlling Stripe subscriptions in your app. And they connect directly to Stripe subscriptions to actively manage pricing.
+
+You can choose how to initiate a subscription. They're not automatically created when a new Stripe customer ID is created. So, for example, on a `Stripeable` class, you could run:
+
+```ruby
+after_commit :create_subscription, on: :create
+
+def create_subscription
+  FiatStripe::Subscription.create(subscriber_type: "ClassName", subscriber_id: self.id)
+end
+```
+
+Or you could manually create subscriptions using a separate controller action, etc.
+
+Extend the `Subscription` model to include `rate` logic by adding a file at `app/decorators/models/fiat_stripe/subscription_decorator.rb`:
+
+```ruby
+FiatStripe::Subscription.class_eval do
+  def rate
+    # Put logic here to calculate rate per payment period
+    # Note: monthly vs annual payment periods are determined by the plan_id that's active
+    # E.g., self.subscriber.rate
+  end
+end
+```
+
+## Development
+
+To build this gem for the first time, run `gem build fiat_stripe.gemspec` from the project folder.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fiatinsight/fiat_stripe.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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    = 'FiatStripe'
+  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/fiat_stripe_manifest.js

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

data/app/assets/javascripts/fiat_stripe/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/stylesheets/fiat_stripe/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/fiat_stripe/application_controller.rb

@@ -0,0 +1,5 @@
+module FiatStripe
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/fiat_stripe/stripe_controller.rb

@@ -0,0 +1,18 @@
+module FiatStripe
+  class StripeController < ActionController::Base
+
+    def create_stripe_customer_id
+      customer = Stripe::Customer.create(
+        description: params[:name],
+        email: params[:email]
+      )
+
+      # TODO: Figure out how to handle this
+      object_class = params[:object_class].constantize
+      object_id = params[:object_id].to_i
+      object_class.find(object_id).update_attributes(stripe_customer_id: customer.id)
+      redirect_back(fallback_location: nil, notice: 'Your payment profile was created.')
+    end
+
+  end
+end

data/app/controllers/fiat_stripe/subscriptions_controller.rb

@@ -0,0 +1,8 @@
+module FiatStripe
+  class SubscriptionsController < ActionController::Base
+
+    def create
+    end
+
+  end
+end

data/app/helpers/card_helper.rb

@@ -0,0 +1,30 @@
+module CardHelper
+  def stripe_card_months
+    [
+      ['01', '01'],
+      ['02', '02'],
+      ['03', '03'],
+      ['04', '04'],
+      ['05', '05'],
+      ['06', '06'],
+      ['07', '07'],
+      ['08', '08'],
+      ['09', '09'],
+      ['10', '10'],
+      ['11', '11'],
+      ['12', '12']
+    ]
+  end
+  def stripe_card_years
+    [
+      ['2018', '2018'],
+      ['2019', '2019'],
+      ['2020', '2020'],
+      ['2021', '2021'],
+      ['2022', '2022'],
+      ['2023', '2023'],
+      ['2024', '2024'],
+      ['2025', '2025']
+    ]
+  end
+end

data/app/helpers/fiat_stripe/application_helper.rb

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

data/app/jobs/fiat_stripe/application_job.rb

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

data/app/jobs/fiat_stripe/subscription/cancel_stripe_subscription_job.rb

@@ -0,0 +1,10 @@
+class FiatStripe::Subscription::CancelStripeSubscriptionJob < ApplicationJob
+  queue_as :default
+
+  def perform(stripe_subscription_id)
+    if stripe_subscription_id
+      sub = Stripe::Subscription.retrieve(stripe_subscription_id)
+      sub.delete
+    end
+  end
+end

data/app/jobs/fiat_stripe/subscription/create_stripe_subscription_job.rb

@@ -0,0 +1,24 @@
+class FiatStripe::Subscription::CreateStripeSubscriptionJob < ApplicationJob
+  queue_as :default
+
+  def perform(subscription)
+
+    # Find the Stripe pricing plan for $0/mo on the Monthly Subscription product
+    if Rails.env.development?
+      plan = FiatStripe.test_default_plan_id.to_s
+    elsif Rails.env.production?
+      plan = FiatStripe.live_default_plan_id.to_s
+    end
+
+    stripe_subscription = Stripe::Subscription.create(
+      customer: subscription.subscriber.stripe_customer_id,
+      trial_period_days: 14,
+      items: [
+        {
+          plan: plan
+        }
+      ]
+    )
+    subscription.update_attributes(stripe_subscription_id: stripe_subscription.id)
+  end
+end

data/app/jobs/fiat_stripe/subscription/update_stripe_subscription_job.rb

@@ -0,0 +1,28 @@
+class FiatStripe::Subscription::UpdateStripeSubscriptionJob < ApplicationJob
+  queue_as :default
+
+  def perform(subscription)
+    if subscription.stripe_subscription_id?
+      product = subscription.stripe_product
+
+      correct_plan = Stripe::Plan.list(product: product, amount: (subscription.monthly_rate * 100)).first
+
+      if correct_plan
+        item = subscription.stripe_subscription.items.first
+        item.plan = correct_plan.id
+        item.save
+      else
+        new_plan = Stripe::Plan.create(
+          amount: subscription.monthly_rate * 100,
+          interval: "month",
+          product: product,
+          currency: "usd",
+          nickname: "$#{subscription.monthly_rate}/mo"
+        )
+        item = subscription.stripe_subscription.items.first
+        item.plan = new_plan.id
+        item.save
+      end
+    end
+  end
+end

data/app/mailers/fiat_stripe/application_mailer.rb

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

data/app/models/concerns/stripeable.rb

@@ -0,0 +1,111 @@
+module Stripeable
+  extend ActiveSupport::Concern
+
+  included do
+    after_commit :create_stripe_customer_id, on: :create
+    before_commit :update_stripe, on: :update
+  end
+
+  def create_stripe_customer_id
+    customer = Stripe::Customer.create(
+      :description => self.name
+      #:email => @agency.email
+    )
+    self.update_attributes(stripe_customer_id: customer.id)
+  end
+
+  def update_stripe
+    # TODO: Update this method to work w/ bank accounts
+    if self.saved_change_to_stripe_card_token? && self.stripe_card_token? && self.stripe_customer_id?
+      token = self.stripe_card_token
+      customer = Stripe::Customer.retrieve(self.stripe_customer_id)
+      customer.sources.create(source: self.stripe_card_token)
+      customer.save
+    elsif saved_change_to_remove_card? && remove_card && stripe_customer_id
+      customer = Stripe::Customer.retrieve(self.stripe_customer_id)
+      customer.sources.retrieve(customer.sources.data.first.id).delete
+      customer.save
+      self.update_attributes(remove_card: nil, stripe_card_token: nil)
+    end
+  end
+
+  def has_source?
+    if self.stripe_customer_id?
+      if Stripe::Customer.retrieve(self.stripe_customer_id).sources.any?
+        true
+      else
+        false
+      end
+    else
+      false
+    end
+  end
+
+  def has_card?
+    if self.stripe_customer_id?
+      if Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.object == "card"
+        true
+      else
+        false
+      end
+    else
+      false
+    end
+  end
+
+  def has_bank_account?
+    if self.stripe_customer_id?
+      if Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.object == "bank_account"
+        true
+      else
+        false
+      end
+    else
+      false
+    end
+  end
+
+  def is_billable?
+    if self.stripe_customer_id? && self.has_source?
+      true
+    else
+      false
+    end
+  end
+
+  def payment_name
+    if self.is_billable?
+      Rails.cache.fetch("#{cache_key}/payment_name", expires_in: 7.days) do
+        if self.has_card?
+          name = Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.brand
+          "#{name}"
+        elsif self.has_bank_account?
+          # Something...
+        end
+      end
+    end
+  end
+
+  def payment_last4
+    if self.is_billable?
+      Rails.cache.fetch("#{cache_key}/payment_last4", expires_in: 7.days) do
+        if self.has_card?
+          last4 = Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.last4
+          "#{last4}"
+        elsif self.has_bank_account?
+          # Something...
+        end
+      end
+    end
+  end
+
+  def card_expiration # TODO: Redo this to accommodate banks?
+    if self.stripe_customer_id? && self.stripe_card_token?
+      Rails.cache.fetch("#{cache_key}/card_expiration", expires_in: 7.days) do
+        exp_month = Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.exp_month
+        exp_year = Stripe::Customer.retrieve(self.stripe_customer_id).sources.data.first.exp_year
+        "#{exp_month}/#{exp_year}"
+      end
+    end
+  end
+end

data/app/models/fiat_stripe/application_record.rb

@@ -0,0 +1,5 @@
+module FiatStripe
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/fiat_stripe/subscription.rb

@@ -0,0 +1,44 @@
+module FiatStripe
+  class Subscription < ApplicationRecord
+    include Tokenable
+
+    belongs_to :subscriber, polymorphic: true
+
+    validates :subscriber, presence: true
+
+    after_touch :save
+    after_commit -> { FiatStripe::Subscription::CreateStripeSubscriptionJob.set(wait: 5.seconds).perform_later(self) }, on: :create
+    after_commit -> { FiatStripe::Subscription::UpdateStripeSubscriptionJob.set(wait: 5.seconds).perform_later(self) }, on: :update, if: :is_stripe_pricing_inaccurate? # This runs when an associated support plan is updated, too, b/c of touch
+    after_commit -> { FiatStripe::Subscription::CancelStripeSubscriptionJob.set(wait: 5.seconds).perform_later(self.stripe_subscription_id) }, on: :destroy
+
+    def stripe_subscription
+      if self.stripe_subscription_id?
+        Rails.cache.fetch("#{cache_key}/stripe_subscription", expires_in: 30.days) do
+          subscription = Stripe::Subscription.retrieve(self.stripe_subscription_id)
+        end
+      end
+    end
+
+    def stripe_plan
+      if self.stripe_subscription
+        self.stripe_subscription.items.first.plan.id
+      end
+    end
+
+    def stripe_product
+      if self.stripe_subscription
+        self.stripe_subscription.items.first.plan.product
+      end
+    end
+
+    def is_stripe_pricing_inaccurate?
+      if self.stripe_subscription
+        if self.stripe_subscription.items.first.plan.amount != (self.rate * 100)
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/fiat_stripe/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Fiat stripe</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "fiat_stripe/application", media: "all" %>
+  <%= javascript_include_tag "fiat_stripe/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+FiatStripe::Engine.routes.draw do
+  resources :stripe do
+    post :create_stripe_customer_id, on: :collection
+  end
+end

data/db/migrate/20181004213428_create_fiat_stripe_subscriptions.rb

@@ -0,0 +1,12 @@
+class CreateFiatStripeSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    create_table :fiat_stripe_subscriptions do |t|
+      t.string :subscriber_type
+      t.integer :subscriber_id
+      t.string :stripe_subscription_id
+      t.string :token
+
+      t.timestamps
+    end
+  end
+end

data/lib/fiat_stripe.rb

@@ -0,0 +1,6 @@
+require "fiat_stripe/engine"
+
+module FiatStripe
+  mattr_accessor :live_default_plan_id
+  mattr_accessor :test_default_plan_id
+end

data/lib/fiat_stripe/engine.rb

@@ -0,0 +1,12 @@
+module FiatStripe
+  class Engine < ::Rails::Engine
+    isolate_namespace FiatStripe
+
+    # This allows an app to override model / controller code using decorator pattern: https://edgeguides.rubyonrails.org/engines.html#a-note-on-decorators-and-loading-code
+    config.to_prepare do
+      Dir.glob(Rails.root + "app/decorators/**/*_decorator*.rb").each do |c|
+        require_dependency(c)
+      end
+    end
+  end
+end

data/lib/fiat_stripe/version.rb

@@ -0,0 +1,3 @@
+module FiatStripe
+  VERSION = '0.1.0'
+end

data/lib/tasks/fiat_stripe_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fiat_stripe do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fiat_stripe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Haines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stripe_event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is designed to be used by Fiat Insight developers on Rails projects
+  that need to connect paying entities with Stripe.
+email:
+- andrew@fiatinsight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/fiat_stripe_manifest.js
+- app/assets/javascripts/fiat_stripe/application.js
+- app/assets/stylesheets/fiat_stripe/application.css
+- app/controllers/fiat_stripe/application_controller.rb
+- app/controllers/fiat_stripe/stripe_controller.rb
+- app/controllers/fiat_stripe/subscriptions_controller.rb
+- app/helpers/card_helper.rb
+- app/helpers/fiat_stripe/application_helper.rb
+- app/jobs/fiat_stripe/application_job.rb
+- app/jobs/fiat_stripe/subscription/cancel_stripe_subscription_job.rb
+- app/jobs/fiat_stripe/subscription/create_stripe_subscription_job.rb
+- app/jobs/fiat_stripe/subscription/update_stripe_subscription_job.rb
+- app/mailers/fiat_stripe/application_mailer.rb
+- app/models/concerns/stripeable.rb
+- app/models/fiat_stripe/application_record.rb
+- app/models/fiat_stripe/subscription.rb
+- app/views/layouts/fiat_stripe/application.html.erb
+- config/routes.rb
+- db/migrate/20181004213428_create_fiat_stripe_subscriptions.rb
+- lib/fiat_stripe.rb
+- lib/fiat_stripe/engine.rb
+- lib/fiat_stripe/version.rb
+- lib/tasks/fiat_stripe_tasks.rake
+homepage: https://github.com/fiatinsight/fiat_stripe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Fiat Insight handling for Stripe
+test_files: []