effective_orders 4.5.0

data/config/routes.rb

@@ -0,0 +1,70 @@
+EffectiveOrders::Engine.routes.draw do
+  scope :module => 'effective' do
+    resources :orders, except: [:destroy] do
+      member do
+        get :purchased
+        get :deferred
+        get :declined
+        get :send_buyer_receipt
+
+        post :free if EffectiveOrders.free?
+        post :mark_as_paid if EffectiveOrders.mark_as_paid?
+        post :cheque if EffectiveOrders.cheque?
+        post :phone if EffectiveOrders.phone?
+        post :pretend if EffectiveOrders.pretend?
+        post :refund if EffectiveOrders.refund?
+        post :stripe if EffectiveOrders.stripe?
+      end
+
+      collection do
+        post :bulk_send_buyer_receipt
+
+        post :moneris_postback if EffectiveOrders.moneris?
+        post :paypal_postback if EffectiveOrders.paypal?
+      end
+    end
+
+    post 'orders/:id', to: 'orders#update'
+
+    if EffectiveOrders.subscriptions?
+      match 'subscribe', to: 'subscripter#update', via: :post, as: :subscripter
+
+      match 'customer/settings', to: 'customers#edit', as: :customer_settings, via: [:get]
+      match 'customer/settings', to: 'customers#update', via: [:patch, :put, :post]
+      match 'webhooks/stripe', to: 'webhooks#stripe', via: [:get, :post, :put]
+    end
+
+    match 'cart', to: 'carts#show', as: 'cart', via: :get
+    match 'cart', to: 'carts#destroy', via: :delete
+
+    # If you Tweak this route, please update EffectiveOrdersHelper too
+    match 'cart/:purchasable_type/:purchasable_id', to: 'carts#add_to_cart', via: [:get, :post], as: 'add_to_cart'
+    match 'cart/:id', to: 'carts#remove_from_cart', via: [:delete], as: 'remove_from_cart'
+  end
+
+  namespace :admin do
+    resources :customers, only: [:index, :show]
+
+    resources :orders do
+      member do
+        post :send_payment_request
+
+        get :checkout
+        post :checkout
+        patch :checkout
+      end
+
+      collection do
+        post :bulk_send_payment_request
+      end
+    end
+
+    post 'orders/:id', to: 'orders#update'
+
+    resources :order_items, only: [:index]
+  end
+end
+
+Rails.application.routes.draw do
+  mount EffectiveOrders::Engine => '/', as: 'effective_orders'
+end

data/db/migrate/01_create_effective_orders.rb.erb

@@ -0,0 +1,137 @@
+class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
+  def self.up
+    create_table <%= @orders_table_name %> do |t|
+      t.integer   :user_id
+
+      t.integer   :parent_id
+      t.string    :parent_type
+
+      t.string    :state
+      t.datetime  :purchased_at
+
+      t.text      :note
+      t.text      :note_to_buyer
+      t.text      :note_internal
+
+      t.string    :billing_name
+      t.string    :email
+      t.string    :cc
+
+      t.text      :payment
+      t.string    :payment_provider
+      t.string    :payment_card
+
+      t.decimal   :tax_rate, :precision => 6, :scale => 3
+
+      t.integer   :subtotal
+      t.integer   :tax
+      t.integer   :total
+
+      t.timestamps
+    end
+
+    add_index <%= @orders_table_name %>, :user_id
+
+
+    create_table <%= @order_items_table_name %> do |t|
+      t.integer   :order_id
+      t.string    :purchasable_type
+      t.integer   :purchasable_id
+
+      t.string    :name
+      t.integer   :quantity
+      t.integer   :price, :default => 0
+      t.boolean   :tax_exempt
+
+      t.timestamps
+    end
+
+    add_index <%= @order_items_table_name %>, :order_id
+    add_index <%= @order_items_table_name %>, :purchasable_id
+    add_index <%= @order_items_table_name %>, [:purchasable_type, :purchasable_id]
+
+
+    create_table <%= @carts_table_name %> do |t|
+      t.integer   :user_id
+      t.integer   :cart_items_count, :default => 0
+      t.timestamps
+    end
+
+    add_index <%= @carts_table_name %>, :user_id
+
+    create_table <%= @cart_items_table_name %> do |t|
+      t.integer   :cart_id
+      t.string    :purchasable_type
+      t.integer   :purchasable_id
+
+      t.string    :unique
+      t.integer   :quantity
+
+      t.timestamps
+    end
+
+    add_index <%= @cart_items_table_name %>, :cart_id
+    add_index <%= @cart_items_table_name %>, :purchasable_id
+    add_index <%= @cart_items_table_name %>, [:purchasable_type, :purchasable_id]
+
+    create_table <%= @customers_table_name %> do |t|
+      t.integer   :user_id
+
+      t.string    :stripe_customer_id
+      t.string    :payment_method_id
+      t.string    :active_card
+      t.string    :status
+
+      t.integer   :subscriptions_count, :default => 0
+
+      t.timestamps
+    end
+
+    add_index <%= @customers_table_name %>, :user_id
+
+    create_table <%= @subscriptions_table_name %> do |t|
+      t.integer   :customer_id
+
+      t.integer   :subscribable_id
+      t.string    :subscribable_type
+
+      t.string    :stripe_plan_id
+      t.string    :stripe_subscription_id
+
+      t.string    :name
+      t.string    :description
+      t.string    :interval
+      t.integer   :quantity
+      t.string    :status
+
+      t.timestamps
+    end
+
+    add_index <%= @subscriptions_table_name %>, :customer_id
+    add_index <%= @subscriptions_table_name %>, :subscribable_id
+    add_index <%= @subscriptions_table_name %>, [:subscribable_type, :subscribable_id]
+
+    create_table <%= @products_table_name %> do |t|
+      t.integer   :purchased_order_id
+
+      t.string    :name
+      t.integer   :price
+      t.boolean   :tax_exempt, :default => false
+
+      t.string    :qb_item_name
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table <%= @orders_table_name %>
+    drop_table <%= @order_items_table_name %>
+    drop_table <%= @carts_table_name %>
+    drop_table <%= @cart_items_table_name %>
+    drop_table <%= @customers_table_name %>
+    drop_table <%= @subscriptions_table_name %>
+    drop_table <%= @products_table_name %>
+  end
+end

data/lib/effective_orders.rb

@@ -0,0 +1,243 @@
+require 'effective_addresses'
+require 'effective_orders/engine'
+require 'effective_orders/version'
+
+module EffectiveOrders
+  PENDING = 'pending'.freeze        # New orders are created in a pending state
+  CONFIRMED = 'confirmed'.freeze    # Once the order has passed checkout step 1
+  DEFERRED = 'deferred'.freeze      # Deferred providers. Cheque or Phone was selected.
+  PURCHASED = 'purchased'.freeze    # Purchased by provider
+  DECLINED = 'declined'.freeze      # Declined by provider
+
+  STATES = { PENDING => PENDING, CONFIRMED => CONFIRMED, DEFERRED => DEFERRED, PURCHASED => PURCHASED, DECLINED => DECLINED }
+
+  # Subscription statuses (as per stripe)
+  ACTIVE = 'active'.freeze
+  PAST_DUE = 'past_due'.freeze
+  CANCELED = 'canceled'.freeze
+
+  STATUSES = { ACTIVE => ACTIVE, PAST_DUE => PAST_DUE, CANCELED => CANCELED }
+
+  # The following are all valid config keys
+  mattr_accessor :orders_table_name
+  mattr_accessor :order_items_table_name
+  mattr_accessor :carts_table_name
+  mattr_accessor :cart_items_table_name
+  mattr_accessor :customers_table_name
+  mattr_accessor :subscriptions_table_name
+  mattr_accessor :products_table_name
+
+  mattr_accessor :authorization_method
+
+  mattr_accessor :layout
+  mattr_accessor :mailer
+
+  mattr_accessor :orders_collection_scope
+  mattr_accessor :order_tax_rate_method
+
+  mattr_accessor :obfuscate_order_ids
+  mattr_accessor :billing_address
+  mattr_accessor :shipping_address
+  mattr_accessor :use_address_full_name
+
+  mattr_accessor :collect_note
+  mattr_accessor :collect_note_required
+  mattr_accessor :collect_note_message
+
+  mattr_accessor :terms_and_conditions
+  mattr_accessor :terms_and_conditions_label
+
+  mattr_accessor :minimum_charge
+
+  # Features
+  mattr_accessor :free_enabled
+  mattr_accessor :mark_as_paid_enabled
+  mattr_accessor :pretend_enabled
+  mattr_accessor :pretend_message
+
+  # Payment processors. false or Hash
+  mattr_accessor :cheque
+  mattr_accessor :moneris
+  mattr_accessor :paypal
+  mattr_accessor :phone
+  mattr_accessor :refund
+  mattr_accessor :stripe
+  mattr_accessor :subscriptions  # Stripe subscriptions
+  mattr_accessor :trial          # Trial mode
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    @_exceptions ||= [Effective::AccessDenied, (CanCan::AccessDenied if defined?(CanCan)), (Pundit::NotAuthorizedError if defined?(Pundit))].compact
+
+    return !!authorization_method unless authorization_method.respond_to?(:call)
+    controller = controller.controller if controller.respond_to?(:controller)
+
+    begin
+      !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
+    rescue *@_exceptions
+      false
+    end
+  end
+
+  def self.authorize!(controller, action, resource)
+    raise Effective::AccessDenied.new('Access Denied', action, resource) unless authorized?(controller, action, resource)
+  end
+
+  def self.permitted_params
+    [
+      :cc, :note, :terms_and_conditions, :confirmed_checkout,
+      billing_address: EffectiveAddresses.permitted_params,
+      shipping_address: EffectiveAddresses.permitted_params,
+      subscripter: [:stripe_plan_id, :stripe_token]
+    ]
+  end
+
+  def self.cheque?
+    cheque.kind_of?(Hash)
+  end
+
+  def self.free?
+    free_enabled == true
+  end
+
+  def self.deferred?
+    deferred_providers.present?
+  end
+
+  def self.mark_as_paid?
+    mark_as_paid_enabled == true
+  end
+
+  def self.moneris?
+    moneris.kind_of?(Hash)
+  end
+
+  def self.paypal?
+    paypal.kind_of?(Hash)
+  end
+
+  def self.phone?
+    phone.kind_of?(Hash)
+  end
+
+  def self.pretend?
+    pretend_enabled == true
+  end
+
+  def self.refund?
+    refund.kind_of?(Hash)
+  end
+
+  def self.stripe?
+    stripe.kind_of?(Hash)
+  end
+
+  def self.subscriptions?
+    subscriptions.kind_of?(Hash)
+  end
+
+  def self.trial?
+    trial.kind_of?(Hash)
+  end
+
+  def self.single_payment_processor?
+    [moneris?, paypal?, stripe?].select { |enabled| enabled }.length == 1
+  end
+
+  # The Effective::Order.payment_provider value must be in this collection
+  def self.payment_providers
+    [
+      ('cheque' if cheque?),
+      ('credit card' if mark_as_paid?),
+      ('free' if free?),
+      ('moneris' if moneris?),
+      ('paypal' if paypal?),
+      ('phone' if phone?),
+      ('pretend' if pretend?),
+      ('refund' if refund?),
+      ('stripe' if stripe?),
+      ('other' if mark_as_paid?),
+      'none'
+    ].compact
+  end
+
+  def self.deferred_providers
+    [('cheque' if cheque?), ('phone' if phone?)].compact
+  end
+
+  def self.can_skip_checkout_step1?
+    return false if require_billing_address
+    return false if require_shipping_address
+    return false if collect_note
+    return false if terms_and_conditions
+    true
+  end
+
+  def self.stripe_plans
+    return [] unless (stripe? && subscriptions?)
+
+    @stripe_plans ||= (
+      Rails.logger.info '[STRIPE] index plans'
+
+      plans = begin
+        Stripe::Plan.respond_to?(:all) ? Stripe::Plan.all : Stripe::Plan.list
+      rescue => e
+        raise e if Rails.env.production?
+        Rails.logger.info "[STRIPE ERROR]: #{e.message}"
+        Rails.logger.info "[STRIPE ERROR]: effective_orders continuing with empty stripe plans. This would fail loudly in Rails.env.production."
+        []
+      end
+
+      plans = plans.map do |plan|
+        description = ("$#{'%0.2f' % (plan.amount / 100.0)}" + ' ' + plan.currency.upcase + '/' +  plan.interval.to_s)
+
+        {
+          id: plan.id,
+          product_id: plan.product,
+          name: plan.nickname || description,
+          description: description,
+          amount: plan.amount,
+          currency: plan.currency,
+          interval: plan.interval,
+          interval_count: plan.interval_count,
+          trial_period_days: plan.trial_period_days
+        }
+      end.sort do |x, y|
+        val ||= (x[:interval] <=> y[:interval])
+        val = nil if val == 0
+
+        val ||= (x[:amount] <=> y[:amount])
+        val = nil if val == 0
+
+        val ||= (x[:name] <=> y[:name])
+        val = nil if val == 0
+
+        val || (x[:id] <=> y[:id])
+      end
+
+      # Calculate savings for any yearly per user plans, based on their matching monthly plans
+      plans.select { |plan| plan[:interval] == 'year' }.each do |yearly|
+        monthly_name = yearly[:name].downcase.gsub('year', 'month')
+        monthly = plans.find { |plan| plan[:interval] == 'month' && plan[:name].downcase == monthly_name }
+        next unless monthly
+
+        savings = (monthly[:amount].to_i * 12) - yearly[:amount].to_i
+        next unless savings > 0
+
+        yearly[:savings] = savings
+      end
+
+      plans
+    )
+  end
+
+  def self.stripe_plans_collection
+    stripe_plans.map { |plan| [plan[:name], plan[:id]] }
+  end
+
+  class SoldOutException < Exception; end
+  class AlreadyPurchasedException < Exception; end
+end