effective_orders 2.2.4 → 3.0.0

data/app/views/layouts/effective_orders_mailer_layout.html.haml

@@ -2,26 +2,24 @@
 %html{style: 'background: #fff;'}
   %head
     %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
+
   :css
-    .effective-order table.table { min-width: 650px; }
+    .effective-order table.table { min-width: 650px; vertical-align: top; border: 0; }
+    .effective-order table.table td { border: 0; vertical-align: top; }
     .effective-order { text-align: left; }
     .effective-order .price { text-align: right; }
     .effective-order tfoot th { text-align: right; }
     .effective-order tfoot tr:first-child td { padding-top: 24px; }
     .effective-order tfoot tr:first-child th { padding-top: 24px; }
     .effective-order-shipping { padding-top: 12px; padding-bottom: 12px; }
+    .effective-order-header h1 { margin: 0; }
+    @media print { .effective-page-break { page-break-inside: avoid; page-break-after: always; min-height: 1px; } }
 
   %body{style: 'background: #fff;'}
     %table{style: 'width: 100%;'}
       %tr
         %td
           %table{style: 'max-width: 650px; margin: 4px auto 30px;'}
-            %thead{style: 'width: 100%;'}
-              %tr
-                %th
-            %tbody{style: 'width: 100%'}
+            %tbody{style: 'width: 100%;'}
               %tr
                 %td= yield
-            %tfoot{style: 'width: 100%;'}
-              %tr
-                %th

data/config/effective_orders.rb

@@ -10,7 +10,6 @@ EffectiveOrders.setup do |config|
   config.subscriptions_table_name = :subscriptions
   config.products_table_name = :products
 
-
   # Authorization Method
   #
   # This method is called by all controller actions with the appropriate action and resource
@@ -38,18 +37,9 @@ EffectiveOrders.setup do |config|
   # Filter the @orders on admin/orders#index screen
   # config.orders_collection_scope = Proc.new { |scope| scope.where(...) }
 
-  # Register Effective::Order with ActiveAdmin if ActiveAdmin is present
-  # You must have authorization to authorized?(:manage, Effective::Order)
-  # For the activeadmin menu to item to show up
-  config.use_active_admin = true
-  config.active_admin_namespace = :admin  # Passed internally to ActiveAdmin.register
-
   # Use effective_obfuscation gem to change order.id into a seemingly random 10-digit number
   config.obfuscate_order_ids = false
 
-  # Silence the price deprecation warnings
-  config.silence_deprecation_warnings = false
-
   # Require these addresses when creating a new Order.  Works with effective_addresses gem
   config.require_billing_address = true
   config.require_shipping_address = false
@@ -95,10 +85,15 @@ EffectiveOrders.setup do |config|
 
   # Free Orders
   # Allow orders with a total of 0.00 to be purchased (regardless of the minimum charge setting)
-  # When enabled, the checkout process will skip the paypal/stripe/purchasing step
   # and just display the 'Thank You' after checkout is clicked
   config.allow_free_orders = true
 
+  # Refunds
+  # Allow admins to create orders with a negative total
+  # Refunds don't perform any kind of refund action with the payment processor.
+  # This just changes the validations
+  config.allow_refunds = false
+
   # Display a 'Purchase order' button on the Checkout screen allowing the user
   # to purchase an Order without going through the payment processor
   config.allow_pretend_purchase_in_development = true
@@ -137,12 +132,12 @@ EffectiveOrders.setup do |config|
   config.admin_simple_form_options = {}  # For the /admin/orders/new form
 
   # config.simple_form_options = {
-  #   html: {class: 'form-horizontal'},
-  #   wrapper: :horizontal_form,
-  #   wrapper_mappings: {
-  #     boolean: :horizontal_boolean,
-  #     check_boxes: :horizontal_radio_and_checkboxes,
-  #     radio_buttons: :horizontal_radio_and_checkboxes
+  #   :html => {:class => ['form-horizontal']},
+  #   :wrapper => :horizontal_form,
+  #   :wrapper_mappings => {
+  #     :boolean => :horizontal_boolean,
+  #     :check_boxes => :horizontal_radio_and_checkboxes,
+  #     :radio_buttons => :horizontal_radio_and_checkboxes
   #   }
   # }
 
@@ -169,28 +164,45 @@ EffectiveOrders.setup do |config|
     send_order_receipt_to_seller: true,   # Only applies to StripeConnect
     send_payment_request_to_buyer: true,
     send_pending_order_invoice_to_buyer: true,
-    send_order_receipts_when_mark_as_paid_by_admin: false,
+    send_order_receipts_when_mark_as_paid: false,
+
+    send_subscription_payment_succeeded: true,
+    send_subscription_payment_failed: true,
+    send_subscription_canceled: true,
+    send_subscription_trial_expiring: true,   # Only if you schedule the rake task to run
+    send_subscription_trial_expired: true,    # Only if you schedule the rake task to run
 
     subject_prefix: '[example]',
+
     subject_for_order_receipt_to_admin: '',
     subject_for_order_receipt_to_buyer: '',
     subject_for_order_receipt_to_seller: '',
     subject_for_pending_order_invoice_to_buyer: '',
     subject_for_payment_request_to_buyer: '',
 
+    subject_for_subscription_payment_succeeded: '',
+    subject_for_subscription_payment_failed: '',
+    subject_for_subscription_canceled: '',
+    subject_for_subscription_trial_expiring: '',
+    subject_for_subscription_trial_expired: '',
+
     layout: 'effective_orders_mailer_layout',
 
     default_from: 'info@example.com',
     admin_email: 'admin@example.com',
 
     deliver_method: nil,   # :deliver (rails < 4.2), :deliver_now (rails >= 4.2) or :deliver_later
-    delayed_job_deliver: false
+    delayed_job_deliver: false   # Use the oldschool pre-ActiveJob delayed_job way of sending email
   }
 
   #######################################
   ### Payment Provider specific options
   #######################################
 
+  # Mark an order as paid without going through a processor
+  # This is accessed via the admin screens only. Must have can?(:admin, :effective_orders)
+  config.mark_as_paid_enabled = false
+
   # Moneris configuration
   config.moneris_enabled = false
 
@@ -239,10 +251,19 @@ EffectiveOrders.setup do |config|
 
   # Stripe configuration
   config.stripe_enabled = false
-  config.stripe_subscriptions_enabled = false # https://stripe.com/docs/subscriptions
+  config.subscriptions_enabled = false # https://stripe.com/docs/subscriptions
+
   config.stripe_connect_enabled = false # https://stripe.com/docs/connect
   config.stripe_connect_application_fee_method = Proc.new { |order_item| order_item.total * 0.10 } # 10 percent
 
+  config.subscription = {
+    trial_name: 'Free Trial',
+    trial_description: '45-Day Free Trial',
+    trial_period: 45.days,
+    trial_remind_at: [1.day, 3.days, 7.days],  # Send email notification to trialing users 1, 3 and 7 days before expiring. false to disable.
+    webhook_secret: 'whsec_1234567890'
+  }
+
   if Rails.env.production?
     config.stripe = {
       secret_key: '',

data/config/routes.rb

@@ -7,71 +7,71 @@ end
 EffectiveOrders::Engine.routes.draw do
   scope module: 'effective' do
 
-    match 'orders/(:id)/purchased', to: 'orders#purchased', as: 'order_purchased', via: :get
-    match 'orders/:id/declined', to: 'orders#declined', as: 'order_declined', via: :get
-    match 'orders/:id/resend_buyer_receipt', to: 'orders#resend_buyer_receipt', via: :get, as: 'resend_buyer_receipt'
-    match 'orders/my_purchases', to: 'orders#my_purchases', as: 'my_purchases', via: :get
-
-    if EffectiveOrders.cheque_enabled
-      match 'orders/:id/pay_by_cheque', to: 'orders#pay_by_cheque', via: :post, as: 'pay_by_cheque'
-    end
-
-    if EffectiveOrders.paypal_enabled
-      match 'orders/paypal_postback', to: 'orders#paypal_postback', as: 'paypal_postback', via: :post
-    end
-
-    if EffectiveOrders.moneris_enabled
-      match 'orders/moneris_postback', to: 'orders#moneris_postback', as: 'moneris_postback', via: :post
-    end
-
-    if EffectiveOrders.stripe_enabled
-      match 'orders/stripe_charge', to: 'orders#stripe_charge', as: 'stripe_charges', via: :post
-    end
+    resources :orders, except: [:destroy] do
+      member do
+        get :purchased
+        get :declined
+        get :send_buyer_receipt
+
+        post :app_checkout if EffectiveOrders.app_checkout_enabled
+        post :free if EffectiveOrders.allow_free_orders
+        post :mark_as_paid if EffectiveOrders.mark_as_paid_enabled
+        post :pay_by_cheque if EffectiveOrders.cheque_enabled
+        post :pretend if EffectiveOrders.allow_pretend_purchase_in_production && Rails.env.production?
+        post :pretend if EffectiveOrders.allow_pretend_purchase_in_development && !Rails.env.production?
+        post :refund if EffectiveOrders.allow_refunds
+      end
 
-    if EffectiveOrders.stripe_subscriptions_enabled
-      resources :subscriptions, only: [:index, :show, :new, :create, :destroy]
-    end
+      collection do
+        get :my_purchases
+        post :bulk_send_buyer_receipt
 
-    if EffectiveOrders.stripe_connect_enabled
-      match 'orders/stripe_connect_redirect_uri', to: 'orders#stripe_connect_redirect_uri', as: 'stripe_connect_redirect_uri', via: :get
-      match 'orders/my_sales', to: 'orders#my_sales', as: 'my_sales', via: :get
-    end
+        if EffectiveOrders.stripe_connect_enabled
+          get :stripe_connect_redirect_uri # oAuth2
+          get :my_sales
+        end
 
-    if EffectiveOrders.ccbill_enabled
-      match 'orders/ccbill_postback', to: 'orders#ccbill_postback', as: 'ccbill_postback', via: :post
+        post :ccbill_postback if EffectiveOrders.ccbill_enabled
+        post :moneris_postback if EffectiveOrders.moneris_enabled
+        post :paypal_postback if EffectiveOrders.paypal_enabled
+        post :stripe_charge if EffectiveOrders.stripe_enabled
+      end
     end
 
-    if EffectiveOrders.app_checkout_enabled
-      match 'orders/:id/app_checkout', to: 'orders#app_checkout', as: 'app_checkout', via: :post
-    end
+    post 'orders/:id', to: 'orders#update'
 
-    if (Rails.env.development? || Rails.env.test?) || EffectiveOrders.allow_pretend_purchase_in_production
-      match 'orders/:id/pretend_purchase', to: 'orders#pretend_purchase', as: 'pretend_purchase', via: [:get, :post]
+    if EffectiveOrders.subscriptions_enabled
+      match 'customer/settings', to: 'customers#edit', as: :customer_settings, via: [:get]
+      match 'customer/settings', to: 'customers#update', via: [:patch, :put]
+      match 'webhooks/stripe', to: 'webhooks#stripe', via: [:post, :put]
     end
 
-    resources :orders, except: [:destroy]
-
     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'
-
-    match 'webhooks/stripe', to: 'webhooks#stripe', via: [:post, :put]
   end
 
-  if !EffectiveOrders.use_active_admin? || Rails.env.test?
-    namespace :admin do
-      resources :customers, only: [:index]
-      resources :orders, except: [:edit] do
-        member do
-          get :mark_as_paid
-          post :mark_as_paid
-          post :send_payment_request
-        end
+  namespace :admin do
+    resources :customers, only: [:index, :show]
+    resources :orders do
+      member do
+        post :send_payment_request
+        post :checkout
+        patch :checkout
       end
-      resources :order_items, only: [:index]
+
+      collection do
+        post :bulk_send_payment_request
+      end
+
     end
+
+    post 'orders/:id', to: 'orders#update'
+
+    resources :order_items, only: [:index]
   end
+
 end

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

@@ -47,6 +47,7 @@ class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
 
     create_table <%= @carts_table_name %> do |t|
       t.integer   :user_id
+      t.integer   :cart_items_count, :default => 0
       t.timestamps
     end
 
@@ -57,6 +58,7 @@ class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
       t.string    :purchasable_type
       t.integer   :purchasable_id
 
+      t.string    :unique
       t.integer   :quantity
 
       t.timestamps
@@ -68,10 +70,17 @@ class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
 
     create_table <%= @customers_table_name %> do |t|
       t.integer   :user_id
+
       t.string    :stripe_customer_id
-      t.string    :stripe_active_card
+      t.string    :active_card
+
+      t.string    :stripe_subscription_id
+      t.string    :status
+
       t.string    :stripe_connect_access_token
 
+      t.integer   :subscriptions_count, :default => 0
+
       t.timestamps
     end
 
@@ -79,17 +88,22 @@ class CreateEffectiveOrders < ActiveRecord::Migration[4.2]
 
     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    :stripe_coupon_id
-      t.string    :title
+      t.string    :status
+
+      t.string    :name
       t.integer   :price, :default => 0
 
       t.timestamps
     end
 
     add_index <%= @subscriptions_table_name %>, :customer_id
-    add_index <%= @subscriptions_table_name %>, :stripe_subscription_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.string    :title

data/lib/effective_orders.rb

@@ -1,4 +1,3 @@
-require 'simple_form'
 require 'effective_addresses'
 require 'effective_orders/engine'
 require 'effective_orders/version'
@@ -10,6 +9,8 @@ module EffectiveOrders
   DECLINED = 'declined'
   PENDING = 'pending'
 
+  PURCHASE_STATES = { nil => ABANDONED, PURCHASED => PURCHASED, DECLINED => DECLINED, PENDING => PENDING }
+
   # The following are all valid config keys
   mattr_accessor :orders_table_name
   mattr_accessor :order_items_table_name
@@ -29,12 +30,9 @@ module EffectiveOrders
   mattr_accessor :layout
   mattr_accessor :simple_form_options
   mattr_accessor :admin_simple_form_options
-
-  mattr_accessor :use_active_admin
-  mattr_accessor :active_admin_namespace
+  mattr_accessor :show_order_history_button
 
   mattr_accessor :obfuscate_order_ids
-  mattr_accessor :silence_deprecation_warnings
 
   mattr_accessor :allow_pretend_purchase_in_development
   mattr_accessor :allow_pretend_purchase_in_production
@@ -56,73 +54,63 @@ module EffectiveOrders
 
   mattr_accessor :minimum_charge
   mattr_accessor :allow_free_orders
-  mattr_accessor :show_order_history_button
+  mattr_accessor :allow_refunds
 
+  mattr_accessor :app_checkout_enabled
+  mattr_accessor :ccbill_enabled
   mattr_accessor :cheque_enabled
-  mattr_accessor :paypal_enabled
+  mattr_accessor :mark_as_paid_enabled
   mattr_accessor :moneris_enabled
-  mattr_accessor :ccbill_enabled
-  mattr_accessor :app_checkout_enabled
+  mattr_accessor :paypal_enabled
 
   mattr_accessor :stripe_enabled
-  mattr_accessor :stripe_subscriptions_enabled
   mattr_accessor :stripe_connect_enabled
 
+  mattr_accessor :subscriptions_enabled
+
   # application fee is required if stripe_connect_enabled is true
   mattr_accessor :stripe_connect_application_fee_method
 
   # These are hashes of configs
+  mattr_accessor :app_checkout
+  mattr_accessor :ccbill
+  mattr_accessor :cheque
   mattr_accessor :mailer
-  mattr_accessor :paypal
   mattr_accessor :moneris
+  mattr_accessor :paypal
   mattr_accessor :stripe
-  mattr_accessor :ccbill
-  mattr_accessor :app_checkout
-  mattr_accessor :cheque
+  mattr_accessor :subscription
 
   mattr_accessor :deliver_method
 
   def self.setup
     yield self
-
-    if EffectiveOrders.stripe_enabled
-      begin
-        require 'stripe'
-      rescue Exception
-        raise "unable to load stripe.  Plese add gem 'stripe' to your Gemfile and then 'bundle install'"
-      end
-
-      ::Stripe.api_key = stripe[:secret_key]
-    end
   end
 
   def self.authorized?(controller, action, resource)
-    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
-      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
-    end
-    true
-  end
+    @_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)
 
-  def self.minimum_charge
-    if @@minimum_charge.nil? || @@minimum_charge.kind_of?(Integer)
-      @@minimum_charge
-    else
-      ActiveSupport::Deprecation.warn('EffectiveOrders.minimum_charge config option is a non-integer. It should be an Integer representing the number of cents.  Continuing with (price * 100.0).round(0).to_i conversion') unless EffectiveOrders.silence_deprecation_warnings
-      ((@@minimum_charge * 100.0).round(0).to_i rescue nil)
+    begin
+      !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
+    rescue *@_exceptions
+      false
     end
   end
 
-  def self.use_active_admin?
-    use_active_admin && defined?(ActiveAdmin)
+  def self.authorize!(controller, action, resource)
+    raise Effective::AccessDenied unless authorized?(controller, action, resource)
   end
 
   def self.permitted_params
     [
-      :note, :save_billing_address, :save_shipping_address, :terms_and_conditions,
+      :note, :terms_and_conditions,
       billing_address: EffectiveAddresses.permitted_params,
       shipping_address: EffectiveAddresses.permitted_params,
       user_attributes: (EffectiveOrders.collect_user_fields || []),
-      order_items_attributes: [:stripe_coupon_id, :class, :id]
+      subscripter: [:stripe_plan_id, :stripe_token]
     ]
   end
 
@@ -152,15 +140,63 @@ module EffectiveOrders
     ].compact
   end
 
+  # One of these is used when Admin marks as paid
   def self.other_payment_providers
     ['credit card', 'none', 'other']
   end
 
-  def self.tax_rate_method=(*args)
-    raise 'EffectiveOrders.tax_rate_method has been removed and renamed to EffectiveOrders.order_tax_rate_method.  Its expected value is now different too. Return 5.25 for 5.25% tax. Please refer to the readme for more info.'
+  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
+    return false if collect_user_fields.present?
+
+    true
+  end
+
+  def self.stripe_plans
+    return {} unless (stripe_enabled && subscriptions_enabled)
+
+    @stripe_plans ||= (
+      plans = Stripe::Plan.all.inject({}) do |h, plan|
+        occurrence = case plan.interval
+          when 'daily'    ; '/day'
+          when 'weekly'   ; '/week'
+          when 'monthly'  ; '/month'
+          when 'yearly'   ; '/year'
+          when 'day'      ; plan.interval_count == 1 ? '/day' : " every #{plan.interval_count} days"
+          when 'week'     ; plan.interval_count == 1 ? '/week' : " every #{plan.interval_count} weeks"
+          when 'month'    ; plan.interval_count == 1 ? '/month' : " every #{plan.interval_count} months"
+          when 'year'     ; plan.interval_count == 1 ? '/year' : " every #{plan.interval_count} years"
+          else            ; plan.interval
+        end
+
+        h[plan.id] = {
+          id: plan.id,
+          name: plan.name,
+          amount: plan.amount,
+          currency: plan.currency,
+          description: "$#{'%0.2f' % (plan.amount / 100.0)} #{plan.currency.upcase}#{occurrence}",
+          occurrence: "#{occurrence}",
+          interval: plan.interval,
+          interval_count: plan.interval_count
+        }; h
+      end
+
+      if subscription.kind_of?(Hash)
+        plans['trial'] = {
+          id: 'trial',
+          amount: 0,
+          name: (subscription[:trial_name] || 'Free Trial'),
+          description: (subscription[:trial_description] || 'Free Trial')
+        }
+      end
+
+      plans
+    )
   end
 
   class SoldOutException < Exception; end
   class AlreadyPurchasedException < Exception; end
-
 end