pay 0.0.2 → 1.0.0.beta2

data/Rakefile

@@ -15,12 +15,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
 
+load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'
-
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
@@ -39,7 +38,3 @@ task :console do
   ARGV.clear
   IRB.start
 end
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new

data/app/controllers/pay/webhooks/braintree_controller.rb

@@ -0,0 +1,56 @@
+module Pay
+  module Webhooks
+    class BraintreeController < Pay::ApplicationController
+      if Rails.application.config.action_controller.default_protect_from_forgery
+        skip_before_action :verify_authenticity_token
+      end
+
+      def create
+        case verified_event.kind
+        when "subscription_charged_successfully"
+          subscription_charged_successfully(verified_event)
+        when "subscription_canceled"
+          subscription_canceled(verified_event)
+        end
+
+        render json: {success: true}
+      rescue Braintree::InvalidSignature => e
+        head :ok
+      end
+
+      private
+
+      def subscription_charged_successfully(event)
+        subscription = event.subscription
+        return if subscription.nil?
+
+        user = Pay.user_model.find_by(processor: :braintree, processor_id: subscription.id)
+        return unless user.present?
+
+        charge = user.save_braintree_transaction(subscription.transactions.first)
+
+        if Pay.send_emails
+          Pay::UserMailer.receipt(user, charge).deliver_later
+        end
+      end
+
+      def subscription_canceled(event)
+        subscription = event.subscription
+        return if subscription.nil?
+
+        user = Pay.user_model.find_by(processor: :braintree, processor_id: subscription.id)
+        return unless user.present?
+
+        # User canceled or failed to make payments
+        user.update(braintree_subscription_id: nil)
+      end
+
+      def verified_webhook
+        @webhook_notification ||= Braintree::WebhookNotification.parse(
+          params[:bt_signature],
+          params[:bt_payload]
+        )
+      end
+    end
+  end
+end

data/app/jobs/pay/email_sync_job.rb

@@ -0,0 +1,12 @@
+module Pay
+  class EmailSyncJob < ApplicationJob
+    queue_as :default
+
+    def perform(id)
+      billable = Pay.user_model.find(id)
+      billable.sync_email_with_processor
+    rescue ActiveRecord::RecordNotFound
+      Rails.logger.info "Couldn't find a #{Pay.billable_class} with ID = #{id}"
+    end
+  end
+end

data/app/mailers/pay/user_mailer.rb

@@ -0,0 +1,42 @@
+module Pay
+  class UserMailer < ApplicationMailer
+    def receipt(user, charge)
+      @user, @charge = user, charge
+
+      if charge.respond_to? :receipt
+        attachments[charge.filename] = charge.receipt
+      end
+
+      mail(
+        to: to(user),
+        subject: Pay.email_receipt_subject,
+      )
+    end
+
+    def refund(user, charge)
+      @user, @charge = user, charge
+
+      mail(
+        to: to(user),
+        subject: Pay.email_refund_subject,
+      )
+    end
+
+    def subscription_renewing(user, subscription)
+      mail(
+        to: to(user),
+        subject: Pay.email_renewing_subject,
+      )
+    end
+
+    private
+
+    def to(user)
+      if user.respond_to?(:name)
+        "#{user.name} <#{user.email}>"
+      else
+        user.email
+      end
+    end
+  end
+end

data/app/models/pay/charge.rb

@@ -0,0 +1,31 @@
+module Pay
+  class Charge < ApplicationRecord
+    self.table_name = Pay.chargeable_table
+
+    # Associations
+    belongs_to :owner, class_name: Pay.billable_class, foreign_key: :owner_id
+
+    # Scopes
+    scope :sorted, -> { order(created_at: :desc) }
+    default_scope -> { sorted }
+
+    # Validations
+    validates :amount, presence: true
+    validates :processor, presence: true
+    validates :processor_id, presence: true
+    validates :card_type, presence: true
+
+    def processor_charge
+      send("#{processor}_charge")
+    end
+
+    def refund!(refund_amount = nil)
+      refund_amount ||= amount
+      send("#{processor}_refund!", refund_amount)
+    end
+
+    def charged_to
+      "#{card_type} (**** **** **** #{card_last4})"
+    end
+  end
+end

data/app/models/pay/subscription.rb

@@ -0,0 +1,77 @@
+module Pay
+  class Subscription < ApplicationRecord
+    self.table_name = Pay.subscription_table
+
+    # Associations
+    belongs_to :owner, class_name: Pay.billable_class, foreign_key: :owner_id
+
+    # Validations
+    validates :name, presence: true
+    validates :processor, presence: true
+    validates :processor_id, presence: true
+    validates :processor_plan, presence: true
+    validates :quantity, presence: true
+
+    # Scopes
+    scope :for_name, ->(name) { where(name: name) }
+    scope :on_trial, ->{ where.not(trial_ends_at: nil).where("? < trial_ends_at", Time.zone.now) }
+    scope :cancelled, ->{ where.not(ends_at: nil) }
+    scope :on_grace_period, ->{ cancelled.where("? < ends_at", Time.zone.now) }
+    scope :active, ->{ where(ends_at: nil).or(on_grace_period).or(on_trial) }
+
+    attribute :prorate, :boolean, default: true
+
+    def no_prorate
+      self.prorate = false
+    end
+
+    def skip_trial
+      self.trial_ends_at = nil
+    end
+
+    def on_trial?
+      trial_ends_at? && Time.zone.now < trial_ends_at
+    end
+
+    def cancelled?
+      ends_at?
+    end
+
+    def on_grace_period?
+      cancelled? && Time.zone.now < ends_at
+    end
+
+    def active?
+      ends_at.nil? || on_grace_period? || on_trial?
+    end
+
+    def cancel
+      send("#{processor}_cancel")
+    end
+
+    def cancel_now!
+      send("#{processor}_cancel_now!")
+    end
+
+    def resume
+      unless on_grace_period?
+        raise StandardError,
+              'You can only resume subscriptions within their grace period.'
+      end
+
+      send("#{processor}_resume")
+
+      update(ends_at: nil)
+      self
+    end
+
+    def swap(plan)
+      send("#{processor}_swap", plan)
+      update(processor_plan: plan, ends_at: nil)
+    end
+
+    def processor_subscription
+      owner.processor_subscription(processor_id)
+    end
+  end
+end

data/app/views/pay/user_mailer/receipt.html.erb

@@ -0,0 +1,20 @@
+We received payment for your subscription. Thanks for your business!<br/>
+<br/>
+Questions? Please reply to this email.<br/>
+<br/>
+------------------------------------<br/>
+RECEIPT - SUBSCRIPTION<br/>
+<br/>
+Amount: USD <%= ActionController::Base.helpers.number_to_currency(@charge.amount / 100.0) %><br/>
+<br/>
+Charged to: <%= @charge.charged_to %><br/>
+Transaction ID: <%= @charge.id %><br/>
+Date: <%= @charge.created_at %><br/>
+<% if @charge.owner.extra_billing_info? %>
+<%= @charge.owner.extra_billing_info %><br/>
+<% end %>
+<br/>
+<br/>
+<%= Pay.business_name %><br/>
+<%= simple_format Pay.business_address %>
+------------------------------------<br/>

data/app/views/pay/user_mailer/refund.html.erb

@@ -0,0 +1,21 @@
+We have processed your refund.<br/>
+Please allow up to 7 business days for your refund to appear in your account<br/>
+<br/>
+Questions? Please reply to this email.<br/>
+<br/>
+------------------------------------<br/>
+RECEIPT - REFUND<br/>
+<br/>
+Amount: USD <%= ActionController::Base.helpers.number_to_currency(@charge.amount / 100.0) %><br/>
+<br/>
+Refunded to: <%= @charge.charged_to %><br/>
+Transaction ID: <%= @charge.id %><br/>
+Date: <%= @charge.created_at %><br/>
+<% if @charge.owner.extra_billing_info? %>
+<%= @charge.owner.extra_billing_info %><br/>
+<% end %>
+<br/>
+<br/>
+<%= Pay.business_name %><br/>
+<%= simple_format Pay.business_address %>
+------------------------------------<br/>

data/app/views/pay/user_mailer/subscription_renewing.html.erb

@@ -0,0 +1,6 @@
+<h3>Your upcoming subscription renewal</h3>
+<p>This is just a friendly reminder that your <%= Pay.business_name %> subscription will renew automatically on <%= @subscription %>.</p>
+
+<p>You may manage your subscription via your account. If you have any questions, please hit reply and let us know.</p>
+
+<p>- The <%= Pay.business_name %> Team</p>

data/config/routes.rb

@@ -1,2 +1,4 @@
-Pay::Engine.routes.draw do
+Rails.application.routes.draw do
+  post '/webhooks/stripe',    to: 'stripe_event/webhook#event'
+  post '/webhooks/braintree', to: 'pay/webhooks/braintree#create'
 end

data/db/migrate/20170205020145_create_subscriptions.rb

@@ -1,6 +1,6 @@
 class CreateSubscriptions < ActiveRecord::Migration[4.2]
   def change
-    create_table :subscriptions do |t|
+    create_table :pay_subscriptions do |t|
       t.references :owner
       t.string :name, null: false
       t.string :processor, null: false

data/db/migrate/20170503131610_add_fields_to_users.rb

@@ -6,10 +6,11 @@ class AddFieldsToUsers < ActiveRecord::Migration[4.2]
 
     add_column Pay.billable_table, :processor, :string
     add_column Pay.billable_table, :processor_id, :string
-    add_column Pay.billable_table, :card_token, :string
-    add_column Pay.billable_table, :card_brand, :string
+    add_column Pay.billable_table, :trial_ends_at, :datetime
+    add_column Pay.billable_table, :card_type, :string
     add_column Pay.billable_table, :card_last4, :string
     add_column Pay.billable_table, :card_exp_month, :string
     add_column Pay.billable_table, :card_exp_year, :string
+    add_column Pay.billable_table, :extra_billing_info, :text
   end
 end

data/db/migrate/20170727235816_create_charges.rb

@@ -0,0 +1,17 @@
+class CreateCharges < ActiveRecord::Migration[5.1]
+  def change
+    create_table :pay_charges do |t|
+      t.references :owner
+      t.string :processor, null: false
+      t.string :processor_id, null: false
+      t.integer :amount, null: false
+      t.integer :amount_refunded
+      t.string :card_type
+      t.string :card_last4
+      t.string :card_exp_month
+      t.string :card_exp_year
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/pay/email_views_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module Pay
+  module Generators
+    class EmailViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_views
+        directory 'app/views/pay/user_mailer', 'app/views/pay/user_mailer'
+      end
+    end
+  end
+end

data/lib/pay.rb

@@ -1,15 +1,79 @@
-require 'stripe'
 require 'pay/engine'
 require 'pay/billable'
+require 'pay/receipts'
 
 module Pay
   # Define who owns the subscription
   mattr_accessor :billable_class
   mattr_accessor :billable_table
+  mattr_accessor :braintree_gateway
+
   @@billable_class = 'User'
   @@billable_table = @@billable_class.tableize
 
+  mattr_accessor :chargeable_class
+  mattr_accessor :chargeable_table
+  @@chargeable_class = 'Pay::Charge'
+  @@chargeable_table = 'pay_charges'
+
+  mattr_accessor :subscription_class
+  mattr_accessor :subscription_table
+  @@subscription_class = 'Pay::Subscription'
+  @@subscription_table = 'pay_subscriptions'
+
+  # Business details for receipts
+  mattr_accessor :application_name
+  mattr_accessor :business_address
+  mattr_accessor :business_name
+  mattr_accessor :support_email
+
+  # Email configuration
+  mattr_accessor :send_emails
+  @@send_emails = true
+
+  mattr_accessor :email_receipt_subject
+  @@email_receipt_subject = 'Payment receipt'
+  mattr_accessor :email_refund_subject
+  @@email_refund_subject = 'Payment refunded'
+  mattr_accessor :email_renewing_subject
+  @@email_renewing_subject = 'Your upcoming subscription renewal'
+
   def self.setup
     yield self
   end
+
+  def self.user_model
+    if Rails.application.config.cache_classes
+      @@user_model ||= billable_class.constantize
+    else
+      billable_class.constantize
+    end
+  end
+
+  def self.charge_model
+    if Rails.application.config.cache_classes
+      @@charge_model ||= chargeable_class.constantize
+    else
+      chargeable_class.constantize
+    end
+  end
+
+  def self.subscription_model
+    if Rails.application.config.cache_classes
+      @@subscription_model ||= subscription_class.constantize
+    else
+      subscription_class.constantize
+    end
+  end
+
+  def self.receipts_supported?
+    charge_model.respond_to?(:receipt) &&
+      application_name.present? &&
+      business_name &&
+      business_address &&
+      support_email
+  end
+
+  class Error < StandardError
+  end
 end

data/lib/pay/billable.rb

@@ -1,58 +1,92 @@
-require 'pay/billable/stripe'
-require 'pay/billable/braintree'
+require 'pay/billable/sync_email'
 
 module Pay
   module Billable
     extend ActiveSupport::Concern
 
     included do
-      include Pay::Billable::Stripe
-      include Pay::Billable::Braintree
+      include Pay::Billable::SyncEmail
 
-      has_many :subscriptions, foreign_key: :owner_id
+      has_many :charges, class_name: Pay.chargeable_class, foreign_key: :owner_id, inverse_of: :owner
+      has_many :subscriptions, class_name: Pay.subscription_class, foreign_key: :owner_id, inverse_of: :owner
 
       attribute :plan, :string
       attribute :quantity, :integer
       attribute :card_token, :string
     end
 
-    def customer(token = nil)
+    def customer
       check_for_processor
-      send("#{processor}_customer", token)
+      raise Pay::Error, "Email is required to create a customer" if email.nil?
+
+      customer = send("#{processor}_customer")
+      update_card(card_token) if card_token.present?
+      customer
     end
 
-    def subscribe(name = 'default', plan = 'default', processor = 'stripe')
-      self.processor = processor
-      send("create_#{processor}_subscription", name, plan)
+    def customer_name
+      [try(:first_name), try(:last_name)].compact.join(" ")
+    end
+
+    def charge(amount_in_cents, options = {})
+      check_for_processor
+      send("create_#{processor}_charge", amount_in_cents, options)
+    end
+
+    def subscribe(name: 'default', plan: 'default', **options)
+      check_for_processor
+      send("create_#{processor}_subscription", name, plan, options)
     end
 
     def update_card(token)
       check_for_processor
+      customer if processor_id.nil?
       send("update_#{processor}_card", token)
     end
 
+    def on_trial?(name: 'default', plan: nil)
+      return true if default_generic_trial?(name, plan)
+
+      sub = subscription(name: name)
+      return sub && sub.on_trial? if plan.nil?
+
+      sub && sub.on_trial? && sub.processor_plan == plan
+    end
+
+    def on_generic_trial?
+      trial_ends_at? && trial_ends_at > Time.zone.now
+    end
+
     def processor_subscription(subscription_id)
       check_for_processor
       send("#{processor}_subscription", subscription_id)
     end
 
-    def subscribed?(name = 'default', plan = nil)
-      subscription = subscription(name)
+    def subscribed?(name: 'default', processor_plan: nil)
+      subscription = subscription(name: name)
 
       return false if subscription.nil?
-      return subscription.active? if plan.nil?
+      return subscription.active? if processor_plan.nil?
 
-      subscription.active? && subscription.plan == plan
+      subscription.active? && subscription.processor_plan == processor_plan
     end
 
-    def subscription(name = 'default')
+    def subscription(name: 'default')
       subscriptions.for_name(name).last
     end
 
+    def invoice!
+      send("#{processor}_invoice!")
+    end
+
+    def upcoming_invoice
+      send("#{processor}_upcoming_invoice")
+    end
+
     private
 
     def check_for_processor
-      raise StandardError, 'No processor selected' unless processor
+      raise StandardError, "No payment processor selected. Make sure to set the #{Pay.billable_class}'s `processor` attribute to either 'stripe' or 'braintree'." unless processor
     end
 
     def create_subscription(subscription, processor, name, plan, qty = 1)
@@ -61,19 +95,15 @@ module Pay
         processor: processor,
         processor_id: subscription.id,
         processor_plan: plan,
-        trial_ends_at: trial_end_date(subscription),
+        trial_ends_at: send("#{processor}_trial_end_date", subscription),
         quantity: qty,
         ends_at: nil
       )
     end
 
-    def update_card_on_file(card)
-      update!(
-        card_brand: card.brand,
-        card_last4: card.last4,
-        card_exp_month: card.exp_month,
-        card_exp_year: card.exp_year
-      )
+    def default_generic_trial?(name, plan)
+      # Generic trials don't have plans or custom names
+      plan.nil? && name == 'default' && on_generic_trial?
     end
   end
 end