stripe_saas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c193fb3ee82f3bcec3747eb5bf791125b143615f
+  data.tar.gz: a1dd02c5730217bbfa261ee773b3213e537e1f9d
+SHA512:
+  metadata.gz: 196b684766f5a7f1e2e9ca9ae43a374bf923b64557b58e7ce1ec9d7aaba373f3d6ff3827f4374cacb3c55e70e038b6c3c25fff8d95cfd66f53f196f965fde747
+  data.tar.gz: 112b6bbb7df2e6548e6669d5b009befe9272d58d0e27e9576faf784a5f3213d08f979f574e3de59ee6636643679fded38663d529a63665fc381ff4debe38b71f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Brian Sam-Bodden
+
+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.asc

@@ -0,0 +1,159 @@
+== StripeSaas
+
+A Rails 4 Engine providing Stripe subscription management for SaaS applications.
+Based on the work of Andrew Culver in Koudoku (https://github.com/andrewculver/koudoku).
+
+== Installation
+
+=== Add gem dependency
+
+Include the stripe_saas gem in your Gemfile and bundle (install):
+
+[source,ruby]
+-------------------------------------------
+gem 'stripe_saas'
+-------------------------------------------
+
+=== Install subscriptions management on a model.
+
+A rails generator is provided to install the StripeSaas models:
+
+[source,ruby]
+-------------------------------------------
+rails g stripe_saas:install user
+-------------------------------------------
+
+==== Stripe Subscriptions
+
+A model that mirrors a Stripe subscription (https://stripe.com/docs/api/ruby#subscriptions)
+is generated and a one-to-one relationship between it and one of your
+application's models as the owner of the subscription.
+
+In the example above the generated StripeSaas::Subscription 'belongs to' your
+application's User:
+
+[source,ruby]
+-------------------------------------------
+class Subscription < ActiveRecord::Base
+  include StripeSaas::Subscription
+
+  belongs_to :user
+end
+-------------------------------------------
+
+and the User class will 'has one' subscription:
+
+[source,ruby]
+-------------------------------------------
+has_one :subscription
+-------------------------------------------
+
+==== Stripe Plans
+
+A model that mirrors a Stripe plan (https://stripe.com/docs/api/ruby#plans) is
+generated.
+
+[source,ruby]
+-------------------------------------------
+class Plan < ActiveRecord::Base
+  has_many :subscriptions
+  has_many :plan_features
+  has_many :features, through: :plan_features
+
+  default_scope { order(:display_order) }
+
+  include StripeSaas::Plan
+end
+-------------------------------------------
+
+Plans have PlanFeatures which in turn are join table/model between Plan and Feature:
+
+[source,ruby]
+-------------------------------------------
+class Feature < ActiveRecord::Base
+  has_many :plan_features
+  has_many :plans, through: :plan_features
+
+  default_scope { order(:display_order) }
+
+  include StripeSaas::Feature
+end
+-------------------------------------------
+
+To create a Feature for example, you could use:
+
+[source,ruby]
+-------------------------------------------
+Feature.find_or_create_by(name: 'signals').update({
+  description: "Inbound Signals",
+  feature_type: :number,
+  unit: "signals",
+  display_order: 1
+})
+-------------------------------------------
+
+Where the feature type can be one of:
+
+[source,ruby]
+-------------------------------------------
+FEATURE_TYPES = {
+  boolean: 'Boolean',
+  interval: 'Interval (in seconds)',
+  filesize: 'Filesize (in bytes)',
+  number: 'Number',
+  percentage: 'Percentage (%)'
+}
+-------------------------------------------
+
+To create a plan (in your seeds for example) with a set of features you could use
+something like:
+
+[source,ruby]
+-------------------------------------------
+developer_plan = Plan.find_or_create_by(stripe_id: 'developer')
+developer_plan.update({
+  name: 'Developer',
+  price: 0.0,
+  interval: 'month',
+  interval_count: 1,
+  statement_descriptor: 'Binnacle Developer Plan',
+  trial_period_days: 30,
+  display_order: 1
+})
+
+developer_plan.add_feature(:signals, 50000)
+-------------------------------------------
+
+Any plan with a price of 0.0 is considered a free plan in StripeSaas which will
+not require the user to enter credit card information.
+
+After running the installer you will have to migrate your database:
+
+[source,ruby]
+-------------------------------------------
+rake db:migrate
+-------------------------------------------
+
+== Configuration
+
+As part of the installation procedure an initializer is generated under config/initializers/stripe_saas.rb:
+
+[source,ruby]
+-------------------------------------------
+StripeSaas.setup do |config|
+  config.subscriptions_owned_by = :user
+  # config.devise_scope = :user
+  config.stripe_publishable_key = ENV['STRIPE_PUBLISHABLE_KEY']
+  config.stripe_secret_key = ENV['STRIPE_SECRET_KEY']
+  config.create_plans_in_stripe = false
+end
+-------------------------------------------
+
+* _subscriptions_owned_by_: The symbol of the class that owns the subscription
+* _devise_scope_: If using Devise and the subscription is not owned by the devise
+  class (user/customer). For example, if users have accounts, and accounts have
+  subscriptions. Then config.subscriptions_owned_by = :account and config.devise_scope = :user
+* _stripe_publishable_key_: Your Stripe Publishable Key https://stripe.com/docs/tutorials/dashboard#api-keys
+* _stripe_secret_key_: Your Stripe Secret Key https://stripe.com/docs/tutorials/dashboard#api-keys
+* _create_plans_in_stripe_: Whether to autogenerate the local Plans in Stripe and
+  keep then in synch

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'StripeSaas'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/stripe_saas/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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/concerns/stripe_saas/feature.rb

@@ -0,0 +1,23 @@
+module StripeSaas::Feature
+  extend ActiveSupport::Concern
+
+  FEATURE_TYPES = {
+    boolean: 'Boolean',
+    interval: 'Interval (in seconds)',
+    filesize: 'Filesize (in bytes)',
+    number: 'Number',
+    percentage: 'Percentage (%)'
+  }
+
+  def feature_type=(val)
+    val = val.to_sym
+    raise(ArgumentError, "#{val} is not a valid feature type") unless FEATURE_TYPES.keys.include?(val)
+    self[:feature_type] = val
+    self[:unit] = FEATURE_TYPES[val]
+  end
+
+  def to_s
+    name
+  end
+
+end

data/app/concerns/stripe_saas/plan.rb

@@ -0,0 +1,45 @@
+module StripeSaas::Plan
+  extend ActiveSupport::Concern
+
+  included do
+    monetize :price_cents
+  end
+
+  def is_upgrade_from?(plan)
+    (price || 0) >= (plan.price || 0)
+  end
+
+  def is_downgrade_from?(plan)
+    !is_upgrade_from?(plan)
+  end
+
+  def free?
+    price == 0.0
+  end
+
+  def add_feature(feature, value, display_value=nil)
+    feature = Feature.find_by(name: feature.to_s) if feature.is_a?(String) || feature.is_a?(Symbol)
+
+    plan_features.find_or_create_by(feature: feature).update({
+      value: value,
+      display_value: display_value
+    })
+  end
+
+  def has_feature?(feature)
+    if feature.is_a?(String)
+      !features.find_by(name: feature).first.nil?
+    else
+      features.any? { |f| f.id == feature.id }
+    end
+  end
+
+  def metadata
+    metadata_as_json.present? ? JSON::parse(metadata_as_json) : {}
+  end
+
+  def metadata=(metadata_hash)
+    metadata_as_json = metadata_hash.to_json
+  end
+
+end

data/app/concerns/stripe_saas/plan_feature.rb

@@ -0,0 +1,25 @@
+module StripeSaas::PlanFeature
+  extend ActiveSupport::Concern
+
+  def value=(val)
+    super(val.to_s)
+  end
+
+  def value
+    case feature.feature_type.to_sym
+      when :boolean
+        self[:value] == 'true'
+      when :number, :percentage, :filesize, :interval
+        self[:value].to_i
+    end
+  end
+
+  def to_s
+    case feature.feature_type
+      when :boolean
+        feature.name
+      when :number, :percentage, :filesize, :interval
+        "#{self[:value]} #{feature.description}"
+    end
+  end
+end

data/app/concerns/stripe_saas/subscription.rb

@@ -0,0 +1,182 @@
+module StripeSaas::Subscription
+  extend ActiveSupport::Concern
+
+  included do
+    monetize :current_price_cents, allow_nil: true
+
+    # We don't store these one-time use tokens, but this is what Stripe provides
+    # client-side after storing the credit card information.
+    attr_accessor :credit_card_token
+
+    belongs_to :plan
+
+    # update details.
+    before_save :processing!
+
+    def processing!
+      # if their package level has changed ..
+      if changing_plans?
+        # and a customer exists in stripe ..
+        if stripe_id.present?
+          # fetch the customer.
+          customer = Stripe::Customer.retrieve(stripe_id)
+
+          if customer.default_card.nil? && !credit_card_token.nil?
+            customer.card = credit_card_token
+            customer.save
+          end
+
+          # if a new plan has been selected
+          if self.plan.present?
+
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+
+            # update the package level with stripe.
+            customer.update_subscription(:plan => self.plan.stripe_id)
+
+            # if no plan has been selected.
+          else
+
+            # Remove the current pricing.
+            self.current_price = nil
+
+            # delete the subscription.
+            customer.cancel_subscription
+
+          end
+
+          # otherwise
+        else
+          # if a new plan has been selected
+          if self.plan.present?
+            # Record the new plan pricing.
+            self.current_price = self.plan.price
+
+            begin
+              customer_attributes = if self.plan.free?
+                {
+                  description: subscription_owner_description,
+                  email: subscription_owner_email,
+                }
+              else
+                {
+                  description: subscription_owner_description,
+                  email: subscription_owner_email,
+                  card: credit_card_token
+                }
+              end
+
+              # create a customer at that package level.
+              customer = Stripe::Customer.create(customer_attributes)
+              customer.update_subscription(:plan => plan.stripe_id)
+            rescue Stripe::CardError => card_error
+              errors[:base] << card_error.message
+              card_was_declined
+              return false
+            end
+
+            # store the customer id.
+            self.stripe_id = customer.id
+            unless self.plan.free?
+              self.last_four = customer.cards.retrieve(customer.default_card).last4
+            end
+          else
+
+            # This should never happen.
+
+            self.plan_id = nil
+
+            # Remove any plan pricing.
+            self.current_price = nil
+
+          end
+
+        end
+
+        # if they're updating their credit card details.
+      elsif self.credit_card_token.present?
+        # fetch the customer.
+        customer = Stripe::Customer.retrieve(self.stripe_id)
+        customer.card = self.credit_card_token
+        customer.save
+
+        # update the last four based on this new card.
+        self.last_four = customer.cards.retrieve(customer.default_card).last4
+      end
+    end
+  end
+
+  # Set a Stripe coupon code that will be used when a new Stripe customer (a.k.a. StripeSaas subscription)
+  # is created
+  def coupon_code=(new_code)
+    @coupon_code = new_code
+  end
+
+  # Pretty sure this wouldn't conflict with anything someone would put in their model
+  def subscription_owner
+    StripeSaas::Subscription.find_customer(self)
+  end
+
+  def self.find_customer(subscription_or_owner)
+    if subscription_or_owner.class.to_s.downcase.to_sym == StripeSaas.subscriptions_owned_by
+      owner = subscription_or_owner
+    else
+      owner = subscription_or_owner.send StripeSaas.subscriptions_owned_by
+    end
+    # Return whatever we belong to.
+    # If this object doesn't respond to 'name', please update owner_description.
+    if StripeSaas.customer_accessor
+      if StripeSaas.customer_accessor.kind_of?(Array)
+        StripeSaas.customer_accessor.inject(subscription_or_owner) {|o, a| o.send(a); o }
+      else
+        owner.send StripeSaas.customer_accessor
+      end
+    else
+      owner
+    end
+  end
+
+  def subscription_owner=(owner)
+    # e.g. @subscription.user = @owner
+    send StripeSaas.owner_assignment_sym, owner
+  end
+
+  def subscription_owner_description
+    # assuming owner responds to name.
+    # we should check for whether it responds to this or not.
+    "#{subscription_owner.try(:name) || subscription_owner.try(:id)}"
+  end
+
+  def subscription_owner_email
+    "#{subscription_owner.try(:email)}"
+  end
+
+  def changing_plans?
+    plan_id_changed?
+  end
+
+  def downgrading?
+    plan.present? and plan_id_was.present? and plan_id_was > self.plan_id
+  end
+
+  def upgrading?
+    (plan_id_was.present? and plan_id_was < plan_id) or plan_id_was.nil?
+  end
+
+  # TODO: this does not belong in here - need a presenter
+  def describe_difference(plan_to_describe)
+    if plan.nil?
+      if persisted?
+        "Upgrade"
+      end
+    else
+      if plan_to_describe.is_upgrade_from?(plan)
+        "Upgrade"
+      else
+        "Downgrade"
+      end
+    end
+  end
+
+end