effective_orders 1.8.1 → 2.0.0

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

@@ -5,8 +5,19 @@ class CreateEffectiveOrders < ActiveRecord::Migration
       t.string    :purchase_state
       t.datetime  :purchased_at
 
+      t.text      :note
+
       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
 
@@ -23,7 +34,6 @@ class CreateEffectiveOrders < ActiveRecord::Migration
       t.integer   :quantity
       t.integer   :price, :default => 0
       t.boolean   :tax_exempt
-      t.decimal   :tax_rate, :precision => 5, :scale => 3, :default => 0.0
 
       t.timestamps
     end
@@ -78,6 +88,14 @@ class CreateEffectiveOrders < ActiveRecord::Migration
 
     add_index <%= @subscriptions_table_name %>, :customer_id
     add_index <%= @subscriptions_table_name %>, :stripe_subscription_id
+
+    create_table <%= @products_table_name %> do |t|
+      t.string    :title
+      t.integer   :price, :default => 0
+      t.boolean   :tax_exempt, :default => false
+
+      t.timestamps
+    end
   end
 
   def self.down
@@ -87,5 +105,6 @@ class CreateEffectiveOrders < ActiveRecord::Migration
     drop_table <%= @cart_items_table_name %>
     drop_table <%= @customers_table_name %>
     drop_table <%= @subscriptions_table_name %>
+    drop_table <%= @products_table_name %>
   end
 end

data/db/upgrade/03_upgrade_effective_orders_from1x.rb.erb

@@ -0,0 +1,95 @@
+class UpgradeEffectiveOrdersFrom1x < ActiveRecord::Migration
+  def self.up
+    create_table <%= @products_table_name %> do |t|
+      t.string    :title
+      t.integer   :price, :default => 0
+      t.boolean   :tax_exempt, :default => false
+
+      t.timestamps
+    end
+
+    add_column <%= @orders_table_name %>, :note, :text
+    add_column <%= @orders_table_name %>, :payment_provider, :string
+    add_column <%= @orders_table_name %>, :payment_card, :string
+
+    add_column <%= @orders_table_name %>, :tax_rate, :decimal, :precision => 6, :scale => 3
+    add_column <%= @orders_table_name %>, :subtotal, :integer
+    add_column <%= @orders_table_name %>, :tax, :integer
+    add_column <%= @orders_table_name %>, :total, :integer
+
+    puts 'Resaving all Effective::Order objects to assign new database column values.'
+
+    Effective::Order.reset_column_information
+
+    Effective::Order.find_each do |order|
+      order.tax_rate = ((order.order_items.first.try(:tax_rate) || 0.0) * 100.0)
+      update_payment_provider_and_card(order)
+      order.save(validate: false)
+      print '.'
+    end
+    print "\n" if Effective::Order.any?
+
+    remove_column <%= @order_items_table_name %>, :tax_rate
+
+    puts 'Done'
+  end
+
+  def self.down
+    add_column <%= @order_items_table_name %>, :tax_rate, :decimal, :precision => 5, :scale => 3
+    Effective::OrderItem.reset_column_information
+    Effective::OrderItem.find_each { |order_item| order_item.update_column(:tax_rate, (order_item.try(:order).tax_rate || 0.0) / 100.0) }
+
+    remove_column <%= @orders_table_name %>, :note
+    remove_column <%= @orders_table_name %>, :payment_provider
+    remove_column <%= @orders_table_name %>, :payment_card
+
+    remove_column <%= @orders_table_name %>, :tax_rate
+    remove_column <%= @orders_table_name %>, :subtotal
+    remove_column <%= @orders_table_name %>, :tax
+    remove_column <%= @orders_table_name %>, :total
+  end
+
+  def update_payment_provider_and_card(order)
+    return unless order.payment.present?
+
+    payment = HashWithIndifferentAccess.new(order.payment)
+    charge = HashWithIndifferentAccess.new(payment[:charge])
+
+    # Try to figure out the payment provider
+    provider =
+      if payment[:response_code] && payment[:transactionKey]
+        'moneris'
+      elsif charge[:id] && charge[:customer] && charge[:application_fee].present?
+        'stripe_connect'
+      elsif charge[:id] && charge[:customer]
+        'stripe'
+      elsif payment[:payer_email]
+        'paypal'
+      elsif (payment[:details] || '').include?('free')
+        'free'
+      else
+        'admin'
+      end
+
+    card =
+      case provider
+      when 'moneris'
+        payment[:card]
+      when 'stripe_connect'
+        (charge['card']['brand'] rescue nil)
+      when 'stripe'
+        (charge['card']['brand'] rescue nil)
+      when 'paypal'
+        payment[:payment_type]
+      when 'free'
+        'none'
+      when 'admin'
+        'none'
+      end
+
+    order.payment_provider = provider.presence || 'admin'
+    order.payment_card = card.presence || 'unknown'
+  end
+
+
+end

data/lib/effective_orders.rb

@@ -1,8 +1,6 @@
 require 'haml-rails'
-require 'migrant'
 require 'simple_form'
 require 'effective_addresses'
-require 'effective_obfuscation'
 require 'effective_orders/engine'
 require 'effective_orders/version'
 require 'effective_orders/app_checkout_service'
@@ -10,6 +8,7 @@ require 'effective_orders/app_checkout_service'
 module EffectiveOrders
   PURCHASED = 'purchased'
   DECLINED = 'declined'
+  PENDING = 'pending'
 
   # The following are all valid config keys
   mattr_accessor :orders_table_name
@@ -18,12 +17,18 @@ module EffectiveOrders
   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 :tax_rate_method
+
+  mattr_accessor :skip_mount_engine
+  mattr_accessor :orders_collection_scope
+
+  mattr_accessor :order_tax_rate_method
 
   mattr_accessor :layout
   mattr_accessor :simple_form_options
+  mattr_accessor :admin_simple_form_options
 
   mattr_accessor :use_active_admin
   mattr_accessor :active_admin_namespace
@@ -42,20 +47,25 @@ module EffectiveOrders
   mattr_accessor :collect_user_fields
   mattr_accessor :skip_user_validation
 
+  mattr_accessor :collect_note
+  mattr_accessor :collect_note_required
+  mattr_accessor :collect_note_message
+
   mattr_accessor :minimum_charge
   mattr_accessor :allow_free_orders
+  mattr_accessor :show_order_history_button
 
+  mattr_accessor :cheque_enabled
   mattr_accessor :paypal_enabled
   mattr_accessor :moneris_enabled
+  mattr_accessor :ccbill_enabled
   mattr_accessor :app_checkout_enabled
 
-  mattr_accessor :show_order_history_button
-
-  # application fee  is required if stripe_connect_enabled is true
   mattr_accessor :stripe_enabled
-
   mattr_accessor :stripe_subscriptions_enabled
   mattr_accessor :stripe_connect_enabled
+
+  # application fee is required if stripe_connect_enabled is true
   mattr_accessor :stripe_connect_application_fee_method
 
   # These are hashes of configs
@@ -63,12 +73,24 @@ module EffectiveOrders
   mattr_accessor :paypal
   mattr_accessor :moneris
   mattr_accessor :stripe
+  mattr_accessor :ccbill
   mattr_accessor :app_checkout
+  mattr_accessor :cheque
 
   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)
@@ -91,12 +113,48 @@ module EffectiveOrders
     use_active_admin && defined?(ActiveAdmin)
   end
 
+  def self.permitted_params
+    [
+      :note, :save_billing_address, :save_shipping_address, :shipping_address_same_as_billing,
+      billing_address: [:full_name, :address1, :address2, :city, :country_code, :state_code, :postal_code],
+      shipping_address: [:full_name, :address1, :address2, :city, :country_code, :state_code, :postal_code],
+      user_attributes: (EffectiveOrders.collect_user_fields || []),
+      order_items_attributes: [:stripe_coupon_id, :class, :id]
+    ]
+  end
+
   def self.single_payment_processor?
-    [moneris_enabled, paypal_enabled, stripe_enabled, app_checkout_enabled].select { |enabled| enabled }.length == 1
+    [
+      moneris_enabled,
+      paypal_enabled,
+      stripe_enabled,
+      cheque_enabled,
+      ccbill_enabled,
+      app_checkout_enabled
+    ].select { |enabled| enabled }.length == 1
+  end
+
+  # The Effective::Order.payment_provider value must be in this collection
+  def self.payment_providers
+    @payment_providers ||= [
+      'admin',
+      ('app_checkout' if app_checkout_enabled),
+      ('ccbill' if ccbill_enabled),
+      ('cheque' if cheque_enabled),
+      ('free' if allow_free_orders),
+      ('moneris' if moneris_enabled),
+      ('paypal' if paypal_enabled),
+      ('pretend' if (allow_pretend_purchase_in_production && Rails.env.production?) || (allow_pretend_purchase_in_development && !Rails.env.production?)),
+      ('stripe' if stripe_enabled),
+      ('stripe_connect' if stripe_connect_enabled)
+    ].compact
+  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.'
   end
 
   class SoldOutException < Exception; end
   class AlreadyPurchasedException < Exception; end
-  class AlreadyDeclinedException < Exception; end
 
 end

data/lib/effective_orders/app_checkout_service.rb

@@ -1,7 +1,6 @@
 module EffectiveOrders
   class AppCheckoutService
-    def self.call(options = {})
-      order = options[:order]
+    def self.call(order:)
       new(order).tap(&:call)
     end
 

data/lib/effective_orders/engine.rb

@@ -11,6 +11,7 @@ module EffectiveOrders
         helper EffectiveCartsHelper
         helper EffectivePaypalHelper if EffectiveOrders.paypal_enabled
         helper EffectiveStripeHelper if EffectiveOrders.stripe_enabled
+        helper EffectiveCcbillHelper if EffectiveOrders.ccbill_enabled
       end
     end
 
@@ -28,31 +29,28 @@ module EffectiveOrders
     end
 
     # Set up our default configuration options.
-    initializer "effective_orders.defaults", :before => :load_config_initializers do |app|
+    initializer "effective_orders.defaults", before: :load_config_initializers do |app|
       eval File.read("#{config.root}/lib/generators/templates/effective_orders.rb")
+    end
 
-      EffectiveOrders.mailer[:deliver_method] = case
-                            when Rails.gem_version >= Gem::Version.new('4.2')
-                              :deliver_now
-                            else
-                              :deliver
-                            end
+    # Set up mail delivering config option
+    initializer "effective_orders.mailer", after: :load_config_initializers do |app|
+      deliver_method = Rails.gem_version >= Gem::Version.new('4.2') ? :deliver_now : :deliver
+      EffectiveOrders.mailer[:deliver_method] ||= deliver_method
     end
 
     # Set up our Stripe API Key
-    initializer "effective_orders.stripe_api_key", :after => :load_config_initializers do |app|
+    initializer "effective_orders.stripe_api_key", after: :load_config_initializers do |app|
       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 = EffectiveOrders.stripe[:secret_key]
       end
     end
 
-    initializer 'effective_orders.moneris_config_validation', :after => :load_config_initializers do
+    initializer 'effective_orders.moneris_config_validation', after: :load_config_initializers do
       if EffectiveOrders.moneris_enabled
         unless EffectiveOrders.moneris.is_a?(Hash)
           raise ArgumentError, "expected EffectiveOrders.moneris to be a Hash but it is a #{EffectiveOrders.moneris.class}"
@@ -63,7 +61,7 @@ module EffectiveOrders
       end
     end
 
-    initializer 'effective_orders.paypal_config_validation', :after => :load_config_initializers do
+    initializer 'effective_orders.paypal_config_validation', after: :load_config_initializers do
       if EffectiveOrders.paypal_enabled
         unless EffectiveOrders.paypal.is_a?(Hash)
           raise ArgumentError, "expected EffectiveOrders.paypal to be a Hash but it is a #{EffectiveOrders.paypal.class}"
@@ -74,7 +72,7 @@ module EffectiveOrders
       end
     end
 
-    initializer 'effective_orders.stripe_config_validation', :after => :load_config_initializers do
+    initializer 'effective_orders.stripe_config_validation', after: :load_config_initializers do
       if EffectiveOrders.stripe_enabled
         unless EffectiveOrders.stripe.is_a?(Hash)
           raise ArgumentError, "expected EffectiveOrders.stripe to be a Hash but it is a #{EffectiveOrders.stripe.class}"
@@ -90,7 +88,23 @@ module EffectiveOrders
       end
     end
 
-    initializer 'effective_orders.app_checkout_config_validation', :after => :load_config_initializers do
+    initializer 'effective_orders.ccbill_config_validation', after: :load_config_initializers do
+      if EffectiveOrders.ccbill_enabled
+        unless EffectiveOrders.ccbill.is_a?(Hash)
+          raise ArgumentError, "expected EffectiveOrders.ccbill to be a Hash but it is a #{EffectiveOrders.ccbill.class}"
+        end
+        EffectiveOrders.ccbill[:form_period] ||= 365
+
+        missing = EffectiveOrders.stripe.select {|_config, value| value.blank? }
+        required = [:client_accnum, :client_subacc, :form_name, :currency_code, :dynamic_pricing_salt]
+
+        # perform an intersection operation between missing and required configs
+        missing_required = missing.keys & required
+        raise "Missing effective_orders Stripe configuration values: #{missing_required.join(', ')}" if missing_required.present?
+      end
+    end
+
+    initializer 'effective_orders.app_checkout_config_validation', after: :load_config_initializers do
       if EffectiveOrders.app_checkout_enabled
         unless EffectiveOrders.app_checkout.is_a?(Hash)
           raise ArgumentError, "expected EffectiveOrders.app_checkout to be a Hash but it is a #{EffectiveOrders.app_checkout.class}"
@@ -106,6 +120,24 @@ module EffectiveOrders
       end
     end
 
+    initializer 'effective_orders.cheque_config_validation', after: :load_config_initializers do
+      if EffectiveOrders.cheque_enabled
+        unless EffectiveOrders.cheque.is_a?(Hash)
+          raise ArgumentError, "expected EffectiveOrders.cheque to be a Hash but it is a #{EffectiveOrders.cheque.class}"
+        end
+      end
+    end
+
+    initializer 'effective_orders.obfuscate_order_ids_validation' do
+      if EffectiveOrders.obfuscate_order_ids
+        begin
+          require 'effective_obfuscation'
+        rescue Exception
+          raise "unable to load effective_obfuscation.  Plese add gem 'effective_obfuscation' to your Gemfile and then 'bundle install'"
+        end
+      end
+    end
+
     # Use ActiveAdmin (optional)
     initializer 'effective_orders.active_admin' do
       if EffectiveOrders.use_active_admin?

data/lib/effective_orders/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrders
-  VERSION = '1.8.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/generators/effective_orders/install_generator.rb

@@ -36,6 +36,7 @@ module EffectiveOrders
         @cart_items_table_name = ':' + EffectiveOrders.cart_items_table_name.to_s
         @customers_table_name = ':' + EffectiveOrders.customers_table_name.to_s
         @subscriptions_table_name = ':' + EffectiveOrders.subscriptions_table_name.to_s
+        @products_table_name = ':' + EffectiveOrders.products_table_name.to_s
 
         migration_template '../../../db/migrate/01_create_effective_orders.rb.erb', 'db/migrate/create_effective_orders.rb'
       end

data/lib/generators/effective_orders/upgrade_from03x_generator.rb

@@ -22,6 +22,7 @@ module EffectiveOrders
         @cart_items_table_name = ':' + EffectiveOrders.cart_items_table_name.to_s
         @customers_table_name = ':' + EffectiveOrders.customers_table_name.to_s
         @subscriptions_table_name = ':' + EffectiveOrders.subscriptions_table_name.to_s
+        @products_table_name = ':' + EffectiveOrders.products_table_name.to_s
 
         migration_template '../../../db/upgrade/02_upgrade_effective_orders_from03x.rb.erb', 'db/migrate/upgrade_effective_orders_from03x.rb'
       end

data/lib/generators/effective_orders/upgrade_from1x_generator.rb

@@ -0,0 +1,31 @@
+module EffectiveOrders
+  module Generators
+    class UpgradeFrom1xGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Upgrade effective_orders from the 1.x branch'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Migration.new.next_migration_number(1) #=> “20160114171807"
+      end
+
+      def create_migration_file
+        @orders_table_name = ':' + EffectiveOrders.orders_table_name.to_s
+        @order_items_table_name = ':' + EffectiveOrders.order_items_table_name.to_s
+        @carts_table_name = ':' + EffectiveOrders.carts_table_name.to_s
+        @cart_items_table_name = ':' + EffectiveOrders.cart_items_table_name.to_s
+        @customers_table_name = ':' + EffectiveOrders.customers_table_name.to_s
+        @subscriptions_table_name = ':' + EffectiveOrders.subscriptions_table_name.to_s
+        @products_table_name = ':' + EffectiveOrders.products_table_name.to_s
+
+        migration_template '../../../db/upgrade/03_upgrade_effective_orders_from1x.rb.erb', 'db/migrate/upgrade_effective_orders_from1x.rb'
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end