effective_orders 1.0.0

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

@@ -0,0 +1,91 @@
+class CreateEffectiveOrders < ActiveRecord::Migration
+  def self.up
+    create_table <%= @orders_table_name %> do |t|
+      t.integer   :user_id
+      t.string    :purchase_state
+      t.datetime  :purchased_at
+
+      t.text      :payment
+
+      t.timestamps
+    end
+
+    add_index <%= @orders_table_name %>, :user_id
+
+
+    create_table <%= @order_items_table_name %> do |t|
+      t.integer   :order_id
+      t.integer   :seller_id
+      t.string    :purchasable_type
+      t.integer   :purchasable_id
+
+      t.string    :title
+      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
+
+    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.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.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    :stripe_active_card
+      t.string    :stripe_connect_access_token
+
+      t.timestamps
+    end
+
+    add_index <%= @customers_table_name %>, :user_id
+
+    create_table <%= @subscriptions_table_name %> do |t|
+      t.integer   :customer_id
+      t.string    :stripe_plan_id
+      t.string    :stripe_subscription_id
+      t.string    :stripe_coupon_id
+      t.string    :title
+      t.integer   :price, :default => 0
+
+      t.timestamps
+    end
+
+    add_index <%= @subscriptions_table_name %>, :customer_id
+    add_index <%= @subscriptions_table_name %>, :stripe_subscription_id
+  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 %>
+  end
+end

data/db/upgrade/02_upgrade_effective_orders_from03x.rb.erb

@@ -0,0 +1,29 @@
+class UpgradeEffectiveOrdersFrom03x < ActiveRecord::Migration
+  def self.up
+    prices = ActiveRecord::Base.connection.execute("SELECT price from <%= @order_items_table_name.gsub(':', '') %> LIMIT 10").values.flatten
+    if prices.blank? || prices.any? { |price| price.to_s.include?('.') }
+      ActiveRecord::Base.connection.execute("UPDATE <%= @order_items_table_name.gsub(':', '') %> O SET price = (O.price * 100.0)")
+      change_column <%= @order_items_table_name %>, :price, :integer, :default => 0
+    end
+
+    prices = ActiveRecord::Base.connection.execute("SELECT price from <%= @subscriptions_table_name.gsub(':', '') %> LIMIT 10").values.flatten
+    if prices.blank? || prices.any? { |price| price.to_s.include?('.') }
+      ActiveRecord::Base.connection.execute("UPDATE <%= @subscriptions_table_name.gsub(':', '') %> O SET price = (O.price * 100.0)")
+      change_column <%= @subscriptions_table_name %>, :price, :integer, :default => 0
+    end
+  end
+
+  def self.down
+    prices = ActiveRecord::Base.connection.execute("SELECT price from <%= @order_items_table_name.gsub(':', '') %> LIMIT 10").values.flatten
+    if prices.none? { |price| price.to_s.include?('.') }
+      change_column <%= @order_items_table_name %>, :price, :decimal, :precision => 8, :scale => 2, :default => 0.0
+      ActiveRecord::Base.connection.execute("UPDATE <%= @order_items_table_name.gsub(':', '') %> O SET price = (O.price / 100.0)")
+    end
+
+    prices = ActiveRecord::Base.connection.execute("SELECT price from <%= @subscriptions_table_name.gsub(':', '') %> LIMIT 10").values.flatten
+    if prices.none? { |price| price.to_s.include?('.') }
+      change_column <%= @subscriptions_table_name %>, :price, :decimal, :precision => 8, :scale => 2, :default => 0.0
+      ActiveRecord::Base.connection.execute("UPDATE <%= @subscriptions_table_name.gsub(':', '') %> O SET price = (O.price / 100.0)")
+    end
+  end
+end

data/db/upgrade/upgrade_price_column_on_table.rb.erb

@@ -0,0 +1,17 @@
+class UpgradePriceColumnOn<%= @table.capitalize %> < ActiveRecord::Migration
+  def self.up
+    prices = ActiveRecord::Base.connection.execute("SELECT <%= @column %> FROM <%= @table %> LIMIT 10").values.flatten
+    if prices.blank? || prices.any? { |<%= @column %>| <%= @column %>.to_s.include?('.') }
+      ActiveRecord::Base.connection.execute("UPDATE <%= @table %> O SET <%= @column %> = (O.<%= @column %> * 100.0)")
+      change_column :<%= @table %>, :<%= @column %>, :integer, :default => 0
+    end
+  end
+
+  def self.down
+    prices = ActiveRecord::Base.connection.execute("SELECT price FROM <%= @table %> LIMIT 10").values.flatten
+    if prices.none? { |<%= @column %>| <%= @column %>.to_s.include?('.') }
+      change_column :<%= @table %>, :<%= @column %>, :decimal, :precision => 8, :scale => 2, :default => 0.0
+      ActiveRecord::Base.connection.execute("UPDATE <%= @table %> O SET <%= @column %> = (O.<%= @column %> / 100.0)")
+    end
+  end
+end

data/lib/effective_orders/engine.rb

@@ -0,0 +1,52 @@
+module EffectiveOrders
+  class Engine < ::Rails::Engine
+    engine_name 'effective_orders'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/**/"]
+
+    # Include Helpers to base application
+    initializer 'effective_orders.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper EffectiveOrdersHelper
+        helper EffectiveCartsHelper
+        helper EffectivePaypalHelper if EffectiveOrders.paypal_enabled
+        helper EffectiveStripeHelper if EffectiveOrders.stripe_enabled
+      end
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_orders.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(ActsAsPurchasable::ActiveRecord)
+      end
+    end
+
+    initializer 'effective_orders.action_view' do |app|
+      ActiveSupport.on_load :action_view do
+        ActionView::Helpers::FormBuilder.send(:include, Inputs::PriceFormInput)
+      end
+    end
+
+    # Set up our default configuration options.
+    initializer "effective_orders.defaults", :before => :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_orders.rb")
+    end
+
+    # Set up our Stripe API Key
+    initializer "effective_orders.stripe_api_key", :after => :load_config_initializers do |app|
+      if EffectiveOrders.stripe_enabled
+        require 'stripe'
+        ::Stripe.api_key = EffectiveOrders.stripe[:secret_key]
+      end
+    end
+
+    # ActiveAdmin (optional)
+    # This prepends the load path so someone can override the assets.rb if they want.
+    initializer 'effective_orders.active_admin' do
+      if defined?(ActiveAdmin) && EffectiveOrders.use_active_admin == true
+        ActiveAdmin.application.load_paths.unshift Dir["#{config.root}/active_admin"]
+      end
+    end
+
+  end
+end

data/lib/effective_orders/version.rb

@@ -0,0 +1,3 @@
+module EffectiveOrders
+  VERSION = '1.0.0'.freeze
+end

data/lib/effective_orders.rb

@@ -0,0 +1,76 @@
+require 'effective_addresses'
+require "effective_orders/engine"
+require 'migrant'     # Required for rspec to run properly
+
+module EffectiveOrders
+  PURCHASED = 'purchased'
+  DECLINED = 'declined'
+
+  # 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 :authorization_method
+  mattr_accessor :tax_rate_method
+
+  mattr_accessor :layout
+  mattr_accessor :simple_form_options
+  mattr_accessor :use_active_admin
+  mattr_accessor :obfuscate_order_ids
+  mattr_accessor :silence_deprecation_warnings
+  mattr_accessor :allow_pretend_purchase_in_production
+
+  mattr_accessor :require_billing_address
+  mattr_accessor :require_shipping_address
+
+  mattr_accessor :collect_user_fields
+  mattr_accessor :skip_user_validation
+
+  mattr_accessor :minimum_charge
+  mattr_accessor :allow_free_orders
+
+  mattr_accessor :paypal_enabled
+  mattr_accessor :moneris_enabled
+
+  # application fee  is required if stripe_connect_enabled is true
+  mattr_accessor :stripe_enabled
+
+  mattr_accessor :stripe_subscriptions_enabled
+  mattr_accessor :stripe_connect_enabled
+  mattr_accessor :stripe_connect_application_fee_method
+
+  # These are hashes of configs
+  mattr_accessor :mailer
+  mattr_accessor :paypal
+  mattr_accessor :moneris
+  mattr_accessor :stripe
+
+  def self.setup
+    yield self
+  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
+
+  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).floor conversion') unless EffectiveOrders.silence_deprecation_warnings
+      ((@@minimum_charge * 100.0).floor rescue nil)
+    end
+  end
+
+  class SoldOutException < Exception; end
+  class AlreadyPurchasedException < Exception; end
+  class AlreadyDeclinedException < Exception; end
+
+end

data/lib/generators/effective_orders/install_generator.rb

@@ -0,0 +1,38 @@
+module EffectiveOrders
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectiveOrders initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template "effective_orders.rb", "config/initializers/effective_orders.rb"
+      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
+
+        migration_template '../../../db/migrate/01_create_effective_orders.rb.erb', 'db/migrate/create_effective_orders.rb'
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/effective_orders/upgrade_from03x_generator.rb

@@ -0,0 +1,34 @@
+module EffectiveOrders
+  module Generators
+    class UpgradeFrom03xGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Upgrade effective_orders from the 0.3.x branch"
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      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
+
+        migration_template '../../../db/upgrade/02_upgrade_effective_orders_from03x.rb.erb', 'db/migrate/upgrade_effective_orders_from03x.rb'
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/effective_orders/upgrade_price_column_generator.rb

@@ -0,0 +1,34 @@
+# bundle exec rails generate effective_orders:upgrade_price_column TABLE COLUMN
+
+module EffectiveOrders
+  module Generators
+    class UpgradePriceColumn < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Upgrade a table with a decimal column to integer"
+
+      source_root File.expand_path("../../templates", __FILE__)
+      argument :table, :type => :string, :default => nil
+      argument :column, :type => :string, :default => :price
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        @table = table.to_s.downcase
+        @column = column.to_s.downcase
+
+        migration_template '../../../db/upgrade/upgrade_price_column_on_table.rb.erb', "db/migrate/upgrade_price_column_on_#{table}.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveOrders

data/lib/generators/templates/effective_orders.rb

@@ -0,0 +1,210 @@
+# EffectiveOrders Rails Engine
+
+EffectiveOrders.setup do |config|
+  # Configure Database Tables
+  config.orders_table_name = :orders
+  config.order_items_table_name = :order_items
+  config.carts_table_name = :carts
+  config.cart_items_table_name = :cart_items
+  config.customers_table_name = :customers
+  config.subscriptions_table_name = :subscriptions
+
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) } # CanCan gem
+
+  # Register Effective::Order with ActiveAdmin if ActiveAdmin is present
+  config.use_active_admin = true
+
+  # Use effective_obfuscation gem to change order.id into a seemingly random 10-digit number
+  config.obfuscate_order_ids = true
+
+  # 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
+
+  # If set, the orders#new screen will render effective/orders/user_fields partial and capture this User Info
+  # The partial can be overridden to customize the form, but the following fields are also fed into strong_paramters
+  config.collect_user_fields = []
+  #config.collect_user_fields = [:salutation, :first_name, :last_name] # Must be valid fields on the User object
+
+  # Don't validate_associated :user when saving an Order
+  config.skip_user_validation = false
+
+  # Tax Calculation Method
+  config.tax_rate_method = Proc.new { |acts_as_purchasable| 0.05 } # Regardless of the object, charge 5% tax (GST)
+
+  # Minimum Charge
+  # Prevent orders less than this value from being purchased
+  # Stripe doesn't allow orders less than $0.50
+  # Set to nil for no minimum charge
+  # Default value is 50 cents, or $0.50
+  config.minimum_charge = 50
+
+  # 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
+
+  # Allow Pretend Purchase in Production
+  # WARNING: Setting this option to true will allow users to purchase! an Order without entering a credit card
+  # WARNING: When true, users can purchase! anything without paying money
+  #
+  # This should basically always be false, but sometimes you want to make a Beta/Demo site
+  # where users may test the purchase workflow without actually paying money
+  #
+  # When true, there will be a 'Process Order' button on the Checkout screen.
+  # Clicking this button will mark an Order purchased and redirect the user to the
+  # Thank You page just as if they had successfully Checked Out through a payment processor
+  config.allow_pretend_purchase_in_production = false
+
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+
+  # config.layout = 'application'   # All EffectiveOrders controllers will use this layout
+  config.layout = {
+    :carts => 'application',
+    :orders => 'application',
+    :subscriptions => 'application',
+    :admin_customers => 'application',
+    :admin_orders => 'application'
+  }
+
+  # SimpleForm Options
+  # This Hash of options will be passed into any simple_form_for() calls
+  config.simple_form_options = {}
+
+  # 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
+  #   }
+  # }
+
+  # Mailer Settings
+  # effective_orders will send out receipts to the buyer, seller and admins.
+  # For all the emails, the same :subject_prefix will be prefixed.  Leave as nil / empty string if you don't want any prefix
+  #
+  # The subject_for_admin_receipt, subject_for_buyer_receipt and subject_for_seller_receipt can be one of:
+  # - nil / empty string to use the built in defaults
+  # - A string with the full subject line for this email
+  # - A Proc to create the subject line based on the email
+  # In all three of these cases, the subject_prefix will still be used.
+
+  # The Procs are the same for admin & buyer receipt, the seller Proc is different
+  # :subject_for_admin_receipt => Proc.new { |order| "Order #{order.to_param} has been purchased"}
+  # :subject_for_buyer_receipt => Proc.new { |order| "Order #{order.to_param} has been purchased"}
+  # :subject_for_seller_receipt => Proc.new { |order, order_items, seller| "Order #{order.to_param} has been purchased"}
+
+  config.mailer = {
+    :send_order_receipt_to_admin => true,
+    :send_order_receipt_to_buyer => true,
+    :send_order_receipt_to_seller => true,   # Only applies to StripeConnect
+    :admin_email => 'admin@example.com',
+    :default_from => 'info@example.com',
+    :subject_prefix => '[example]',
+    :subject_for_admin_receipt => '',
+    :subject_for_buyer_receipt => '',
+    :subject_for_seller_receipt => ''
+  }
+
+  # Moneris configuration
+  config.moneris_enabled = false
+
+  if Rails.env.production?
+    config.moneris = {
+      :ps_store_id => '',
+      :hpp_key => '',
+      :hpp_url => 'https://www3.moneris.com/HPPDP/index.php',
+      :verify_url => 'https://www3.moneris.com/HPPDP/verifyTxn.php',
+      :order_nudge => 0
+    }
+  else
+    config.moneris = {
+      :ps_store_id => '',
+      :hpp_key => '',
+      :hpp_url => 'https://esqa.moneris.com/HPPDP/index.php',
+      :verify_url => 'https://esqa.moneris.com/HPPDP/verifyTxn.php',
+      :order_nudge => 0
+    }
+  end
+
+  # Paypal configuration
+  config.paypal_enabled = false
+
+  if Rails.env.production?
+    config.paypal = {
+      :seller_email => '',
+      :secret => '',
+      :cert_id => '',
+      :paypal_url => 'https://www.paypal.com/cgi-bin/webscr',
+      :currency => 'CAD',
+      :paypal_cert => "#{Rails.root}/config/paypalcerts/production/paypal_cert.pem",
+      :app_cert => "#{Rails.root}/config/paypalcerts/production/app_cert.pem",
+      :app_key => "#{Rails.root}/config/paypalcerts/production/app_key.pem"
+    }
+  else
+    config.paypal = {
+      :seller_email => '',
+      :secret => '',
+      :cert_id => '',
+      :paypal_url => 'https://www.sandbox.paypal.com/cgi-bin/webscr',
+      :currency => 'CAD',
+      :paypal_cert => "#{Rails.root}/config/paypalcerts/#{Rails.env}/paypal_cert.pem",
+      :app_cert => "#{Rails.root}/config/paypalcerts/#{Rails.env}/app_cert.pem",
+      :app_key => "#{Rails.root}/config/paypalcerts/#{Rails.env}/app_key.pem"
+    }
+  end
+
+  # Stripe configuration
+  config.stripe_enabled = false
+  config.stripe_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
+
+  if Rails.env.production?
+    config.stripe = {
+      :secret_key => '',
+      :publishable_key => '',
+      :currency => 'usd',
+      :site_title => 'My Site',
+      :site_image => '', # A relative URL pointing to a square image of your brand or product. The recommended minimum size is 128x128px.
+      :connect_client_id => ''
+    }
+  else
+    config.stripe = {
+      :secret_key => '',
+      :publishable_key => '',
+      :currency => 'usd',
+      :site_title => 'My Development Site',  # Displayed on the Embedded Stripe Form
+      :site_image => '', # A relative URL pointing to a square image of your brand or product. The recommended minimum size is 128x128px.
+      :connect_client_id => ''
+    }
+  end
+
+end