effective_orders 1.8.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c32ade8d8bebb1a9228624548b1ab9702e193d
-  data.tar.gz: a3b35b62b2b44f30ca4475af4e130ae7dc5d9775
+  metadata.gz: 491804404e9833c139b5f3c4d90c190e09ad2fba
+  data.tar.gz: 1d3773f087028234c8c04d784ebec0fcb290efc5
 SHA512:
-  metadata.gz: 8a573c500321453ec640db547d37096c27f74da1de0d79ed1f4dc805c2a97b4d982f0f570e9e03ea75e510390d706f1bfe6e79f2e280e2bc081d56ecba08c2d2
-  data.tar.gz: 87cdd2c31a3a701caf49ad1e6d69c06747c63689ac92ae5a036265229df4d7b98e86c8c7460d5ce632c644fe48f742eb0261fd2573a000d6adc860f8afbaf413
+  metadata.gz: e906c27c833ce87d77450b7d99ed5ac8a94c6d1f72e1be9bbd3efeb16ea7d59403947755c567c0e3f73334f15dff060779b2760b9272dceabfc0c6d5f570d70e
+  data.tar.gz: a3727d9a492c1512fe2f22b4ff540f2c02536454f43fbc239da67ca0b99d955e4604fc947565f571573416c4849b9b3fd087b088010f3e89182f7d6f13b0c71d

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Code and Effect Inc.
+Copyright 2016 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,7 @@
+# 2.0 Branch
+
+This is a work in progress branch.  Don't use this yet!
+
 # Effective Orders
 
 Carts, Orders, and collecting payment via Stripe, PayPal and Moneris.
@@ -12,6 +16,12 @@ Has Order History, My Purchases, My Sales and Admin screens.
 
 ## Getting Started
 
+Check your ruby version.  As of the 2.0 branch, effective_orders requires a minimum ruby version of `2.1`:
+
+```console
+ruby -v
+```
+
 Add to your Gemfile:
 
 ```ruby
@@ -52,28 +62,27 @@ Require the stylesheet on the asset pipeline by adding the following to your app
 *= require effective_orders
 ```
 
-### Upgrading from 0.3.x
+### Upgrading to 2.0.x
 
-In the 0.3.x versions of this gem, prices were internally represented as Decimals
+The `tax_rate_method` configuration option has been removed and renamed to `order_tax_rate_method`.
+Changing this in `/config/initializers/effective_orders.rb` is the first step.
 
-This has been changed in 0.4.x to properly be Integer columns
-
-If you're running a 0.3.x or earlier version, please upgrade to 0.4.x with this one command:
+The default implementation assigns the tax rate based on the order's billing_address (see the [Tax section](#tax)):
 
 ```ruby
-rails generate effective_orders:upgrade_from03x
+config.order_tax_rate_method = Proc.new { |order| Effective::TaxRateCalculator.new(order: order).tax_rate }
 ```
 
-the above command will upgrade the order_items and subscriptions tables.
-
-If you have additional (products or whatever..) tables with a column `price` represented as a Decimal, they should also be upgraded.
+There are numerous database changes in the 2.0.0 line of effective_orders.
 
-To upgrade, use this generator to create a migration on table `products` with column `price`:
+if you are running a 1.x version, please upgrade your database with this command:
 
 ```ruby
-bundle exec rails generate effective_orders:upgrade_price_column products price
+rails generate effective_orders:upgrade_from1x
 ```
 
+the above command will add `products` table to you DB.
+
 ## High Level Overview
 
 Your rails app creates and displays a list of `acts_as_purchsable` objects, each with a `link_to_add_to_cart(object)`.
@@ -133,22 +142,22 @@ class Product < ActiveRecord::Base
   structure do
     title               :string
 
-    price               :integer, :default => 0
-    tax_exempt          :boolean, :default => false
+    price               :integer, default: 0
+    tax_exempt          :boolean, default: false
 
-    archived            :boolean, :default => false
+    archived            :boolean, default: false
 
     timestamps
   end
 
   validates_presence_of :title
-  validates_numericality_of :price, :greater_than_or_equal_to => 0
+  validates_numericality_of :price, greater_than_or_equal_to: 0
 
-  scope :products, -> { where(:archived => false) }
+  scope :products, -> { where(archived: false) }
 
   # This archives Products instead of deleting them
   def destroy
-    update_attributes(:archived => true)
+    update_attributes(archived: true)
   end
 
 end
@@ -189,7 +198,7 @@ This is available for simple_form, formtastic and Rails default FormBuilder.
 = simple_form_for(@product) do |f|
   = f.input :title
   = f.input :tax_exempt
-  = f.input :price, :as => :price
+  = f.input :price, as: :price
   = f.button :submit
 ```
 
@@ -197,7 +206,7 @@ or
 
 ```ruby
 = semantic_form_for(@product) do |f|
-  = f.input :price, :as => :price
+  = f.input :price, as: :price
 ```
 
 or
@@ -207,16 +216,16 @@ or
   = f.price_field :price
 ```
 
-The `:as => :price` will work interchangeably with SimpleForm or Formtastic, as long as only one of these gems is present in your application
+The `as: :price` will work interchangeably with SimpleForm or Formtastic, as long as only one of these gems is present in your application
 
 If you use both SimpleForm and Formtastic, you will need to call price input differently:
 
 ```ruby
 = simple_form_for(@product) do |f|
-  = f.input :price, :as => :price_simple_form
+  = f.input :price, as: :price_simple_form
 
 = semantic_form_for @user do |f|
-  = f.input :price, :as => :price_formtastic
+  = f.input :price, as: :price_formtastic
 ```
 
 ### Products#show
@@ -226,7 +235,7 @@ So back on the Product#show page, we will render the product with an Add To Cart
 ```haml
 %h4= @product.title
 %p= price_to_currency(@product.price)
-%p= link_to_add_to_cart(@product, :class => 'btn btn-primary', :label => 'Add To My Shopping Cart')
+%p= link_to_add_to_cart(@product, class: 'btn btn-primary', label: 'Add To My Shopping Cart')
 ```
 
 Please take note of the `price_to_currency` helper above.
@@ -246,7 +255,7 @@ We still need to create a link to the Shopping Cart page so that the user can vi
 or
 
 ```ruby
-= link_to_current_cart(:label => 'Shopping Cart', :class => 'btn btn-prmary')  # To display Shopping Cart (3) when there are 3 items
+= link_to_current_cart(label: 'Shopping Cart', class: 'btn btn-prmary')  # To display Shopping Cart (3) when there are 3 items
 ```
 
 or
@@ -266,13 +275,13 @@ The checkout screen can be reached through the My Cart page, or linked to direct
 or
 
 ```ruby
-= link_to_checkout(:label => 'Continue to Checkout', :class => 'btn btn-primary')
+= link_to_checkout(label: 'Continue to Checkout', class: 'btn btn-primary')
 ```
 
 or
 
 ```ruby
-= link_to 'Go Checkout Already', effective_orders.new_order_path
+= link_to 'Continue to Checkout', effective_orders.new_order_path
 ```
 
 From here, the effective_orders engine takes over, walks the user through billing and shipping details screens, then finally collects payment through one of the configured payment processors.
@@ -325,17 +334,43 @@ Of course, there's no mechanism here to prevent someone from just copy&pasting t
 If you're interested in that kind of restricted-download functionality, please check out [effective_assets](https://github.com/code-and-effect/effective_assets) and the authenticated-read temporary URLs.
 
 
-### Tax
+### Tax Exempt
 
 All `acts_as_purchasable` objects will respond to the boolean method `tax_exempt`.
 
 By default, `tax_exempt` is false, meaning that tax must be applied to this item.
 
-The tax calculation is controlled by the config/initializers/effective_orders.rb `config.tax_rate_method` and may be set on an app wide basis.
-
 If `tax_exempt` returns true, it means that no tax will be applied to this item.
 
-Please see the initializer for more information.
+### Tax
+
+The tax calculation applied to an order is controlled by the config/initializers/effective_orders.rb `config.order_tax_rate_method`
+
+The default implementation assigns the tax rate based on the order's billing_address:
+
+```ruby
+config.order_tax_rate_method = Proc.new { |order| Effective::TaxRateCalculator.new(order: order).tax_rate }
+```
+
+Right now, the `Effective::TaxRateCalculator` only supports taxes for Canadian provinces.
+
+US and international tax rates are not currently supported and are assigned 0% tax.
+
+Instead of calculating based on the billing_address, a single static tax rate can be applied to all orders.
+
+To apply 12.5% tax to all orders:
+
+```ruby
+config.order_tax_rate_method = Proc.new { |order| 12.5 }
+```
+
+Or to apply 0% tax:
+
+```ruby
+config.order_tax_rate_method = Proc.new { |order| 0 }
+```
+
+Please see the initializer file for more information.
 
 
 ### Callbacks
@@ -398,8 +433,8 @@ You can rescue from this exception by adding the following to your application_c
 ```ruby
 rescue_from Effective::AccessDenied do |exception|
   respond_to do |format|
-    format.html { render 'static_pages/access_denied', :status => 403 }
-    format.any { render :text => 'Access Denied', :status => 403 }
+    format.html { render 'static_pages/access_denied', status: 403 }
+    format.any { render text: 'Access Denied', status: 403 }
   end
 end
 ```
@@ -409,9 +444,9 @@ end
 The permissions you actually want to define for a regular user are as follows (using CanCan):
 
 ```ruby
-can [:manage], Effective::Cart, :user_id => user.id
-can [:manage], Effective::Order, :user_id => user.id # Orders cannot be deleted
-can [:manage], Effective::Subscription, :user_id => user.id
+can [:manage], Effective::Cart, user_id: user.id
+can [:manage], Effective::Order, user_id: user.id # Orders cannot be deleted
+can [:manage], Effective::Subscription, user_id: user.id
 ```
 
 In addition to the above, the following permissions allow access to the `/admin` screens:
@@ -479,7 +514,7 @@ The Order has now been purchased.
 If you are using effective_orders to roll your own custom payment workflow, you should be aware of the following helpers:
 
 - `render_checkout(order)` to display the standard Checkout step inline.
-- `render_checkout(order, :purchased_redirect_url => '/', :declined_redirect_url => '/')` to display the Checkout step with custom redirect paths.
+- `render_checkout(order, purchased_redirect_url: '/', declined_redirect_url: '/')` to display the Checkout step with custom redirect paths.
 
 - `render_purchasables(one_or_more_acts_as_purchasable_objects)` to display a list of purchasable items
 
@@ -503,7 +538,7 @@ The `acts_as_purchasable` `.purchased?` and `.purchased_by?(user)` methods only
 To programatically purchase one or more `acts_as_purchasable` objects:
 
 ```ruby
-Effective::Order.new([@product1, @product2], current_user).purchase!('from my rake task')
+Effective::Order.new(@product1, @product2, user: current_user).purchase!(details: 'from my rake task')
 ```
 
 Here the `billing_address` and `shipping_address` are copied from the `current_user` object if the `current_user` responds_to `billing_address` / `shipping_address` as per [effective_addresses](https://github.com/code-and-effect/effective_addresses/).
@@ -517,7 +552,7 @@ order.billing_address = Effective::Address.new(...)
 order.shipping_address = Effective::Address.new(...)
 order.add(@product1)
 order.add(@product2)
-order.purchase!(:some => {:complicated => 'details', :in => 'a hash'})
+order.purchase!(details: {complicated: 'details', in: 'a hash'})
 ```
 
 The one gotcha with the above two scenarios, is that when `purchase!` is called, the `Effective::Order` in question will run through its validations.  These validations include:
@@ -526,13 +561,13 @@ The one gotcha with the above two scenarios, is that when `purchase!` is called,
 - `validates_presence_of :shipping_address` when configured to be required
 - `validates :user` which can be disabled via config initializer
 
-- `validates_numericality_of :total, :greater_than_or_equal_to => minimum_charge` where minimum_charge is the configured value, once again from the initializer
+- `validates_numericality_of :total, greater_than_or_equal_to: minimum_charge` where minimum_charge is the configured value, once again from the initializer
 - `validates_presence_of :order_items` the Order must have at least one OrderItem
 
 You can skip validations with the following command, but be careful as this skips all validations:
 
 ```ruby
-Effective::Order.new(@product, @user).purchase!('no validations', :validate => false)
+Effective::Order.new(@product, user: @user).purchase!(validate: false)
 ```
 
 The `@product` is now considered purchased.
@@ -554,7 +589,7 @@ This screen displays all past purchases made by the current user.  You can add i
 or
 
 ```ruby
-= link_to_my_purchases(:label => 'Order History', :class => 'btn btn-primary')
+= link_to_my_purchases(label: 'Order History', class: 'btn btn-primary')
 ```
 
 or
@@ -576,7 +611,7 @@ Totally optional, but another way of displaying the Order History is to use the
 In your controller:
 
 ```ruby
-@datatable = Effective::Datatables::Orders.new(:user_id => @user.id)
+@datatable = Effective::Datatables::Orders.new(user_id: @user.id)
 ```
 
 and then in the view:
@@ -667,17 +702,17 @@ Copy these two values into the appropriate lines of config/effective_orders.rb i
 
   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'
+      ps_store_id: '',
+      hpp_key: '',
+      hpp_url: 'https://www3.moneris.com/HPPDP/index.php',
+      verify_url: 'https://www3.moneris.com/HPPDP/verifyTxn.php'
     }
   else
     config.moneris = {
-      :ps_store_id => 'VZ9BNtore1',
-      :hpp_key => 'hp1Y5J35GVDM',
-      :hpp_url => 'https://esqa.moneris.com/HPPDP/index.php',
-      :verify_url => 'https://esqa.moneris.com/HPPDP/verifyTxn.php'
+      ps_store_id: 'VZ9BNtore1',
+      hpp_key: 'hp1Y5J35GVDM',
+      hpp_url: 'https://esqa.moneris.com/HPPDP/index.php',
+      verify_url: 'https://esqa.moneris.com/HPPDP/verifyTxn.php'
     }
   end
 ```
@@ -781,9 +816,9 @@ Then enable Stripe in the app/config/effective_orders.rb initializer and enter y
 config.stripe_enabled = true
 
 config.stripe = {
-  :secret_key => 'sk_live_IKd6HDaYUfoRjflWQTXfFNfc',
-  :publishable_key => 'pk_live_liEGn9f0mcxKmoSjoeNbbuE1',
-  :currency => 'usd'
+  secret_key: 'sk_live_IKd6HDaYUfoRjflWQTXfFNfc',
+  publishable_key: 'pk_live_liEGn9f0mcxKmoSjoeNbbuE1',
+  currency: 'usd'
 }
 ```
 
@@ -814,10 +849,10 @@ And add these values to the app/config/effective_orders.rb initializer:
 
 ```ruby
 config.stripe = {
-  :secret_key => 'sk_live_IKd6HDaYUfoRjflWQTXfFNfc',
-  :publishable_key => 'pk_live_liEGn9f0mcxKmoSjoeNbbuE1',
-  :currency => 'usd',
-  :connect_client_id => 'ca_35jLok5G9kosyYF7quTOwcauJjTnUnud'
+  secret_key: 'sk_live_IKd6HDaYUfoRjflWQTXfFNfc',
+  publishable_key: 'pk_live_liEGn9f0mcxKmoSjoeNbbuE1',
+  currency: 'usd',
+  connect_client_id: 'ca_35jLok5G9kosyYF7quTOwcauJjTnUnud'
 }
 ```
 
@@ -933,6 +968,63 @@ The secret can be any string. Here's a good way to come up with a secret:
 This process should be very similar although you'll create and configure a seller account on paypal.com rather than the sandbox site.
 You should generate separate private and public certificates/keys for this and it is advisable to not keep production certificates/keys in version control.
 
+## Paying via CCBill
+
+Effective Orders has implemented checkout with CCBill using their "Dynamic Pricing" API and does not
+integrate with CCBill subscriptions. If you need to make payments for CCBill subscriptions, please help
+by improving Effective Orders with this functionality.
+
+### CCBill Account Setup
+
+You need a merchant account with CCBill so go sign up and login. To set up your account with Dynamic
+Pricing, you'll need to go through some hoops with CCBill:
+
+1. Get approval to operate a merchant account from CCBill Merchant Services (they'll need to see your
+   site in action)
+2. Provide CCBill with two valid forms of ID and wait for them to approve your account
+3. Create two additional sub accounts for a staging server and your localhost
+   ("Account Info" > "Account Setup")
+4. Get each new sub account approved by Merchant Services (mention that they are for testing only)
+5. Ask CCBill tech support to set up all sub accounts with Dynamic Pricing
+6. Set the postback urls for each sub account to be `"#{ your_domain_name }/orders/ccbill_postback`
+   (Look for 'Approval Post URL' and 'Denial Post URL' in "Account Info" > "Sub Account Admin" > select sub account
+   \> "Advanced" > under 'Background Post Information')
+
+### Effective Orders Configuration
+
+Get the following information and add it
+to the Effective Orders initializer. CCBill live chat is generally quick and helpful. They can help you
+find any of this information.
+
+- Account number (`:client_accnum`)
+- Subaccount number (`:client_subacc`)
+- Checkout form id/name (`:form_name`)
+- Currency code (`:currency_code`)
+- Encryption key/salt (`:dynamic_pricing_salt`)("Account Info" > "Sub Account Admin" > select sub account
+  \> "Advanced" > under 'Upgrade Security Setup Information' > 'Encryption key')
+
+Effective Orders will authorize to make changes to the customer's order during CCBill's post back after
+the transaction. Since, this is not an action that the customer takes directly, please make sure
+that the Effective Orders authorization method returns `true` for the controller/action
+`'Effective::OrdersController#ccbill_postback'` with an `Effective::Order` resource.
+
+### Testing transactions with CCBill
+
+To test payments with CCBill:
+
+1. Set up yourself as a user who is authorized to make test transactions
+   ([See this guide](https://www.ccbill.com/cs/wiki/tiki-index.php?page=How+do+I+set+up+a+user+to+process+test+transactions%3F))
+2. Use ngrok on localhost or a staging server to go through a normal payment (remember to configure the
+   postback urls (see #6 of [CCBill Account Setup](#ccbill-account-setup))
+3. Use one of the provided credit card numbers in the guide from step 1 for the associated response
+
+### Helpful CCBill Documentation
+
+- [Dynamic Pricing](https://www.ccbill.com/cs/wiki/tiki-index.php?page=Dynamic+Pricing)
+- [Dynamic Pricing User Guide](https://www.ccbill.com/cs/wiki/tiki-index.php?page=Dynamic+Pricing+User+Guide)
+- [Background Post](https://www.ccbill.com/cs/wiki/tiki-index.php?page=Background+Post)
+- [Webhooks](https://www.ccbill.com/cs/wiki/tiki-index.php?page=Webhooks+User+Guide)
+- [How do I set up a user to process test transactions?](https://www.ccbill.com/cs/wiki/tiki-index.php?page=How+do+I+set+up+a+user+to+process+test+transactions%3F)
 
 ## Paying Using App Currency or Logic
 
@@ -1016,12 +1108,10 @@ Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/),
 
 ## Testing
 
-The test suite for this gem is mostly complete.
-
 Run tests by:
 
 ```ruby
-guard
+rspec
 ```
 
 

data/Rakefile

@@ -5,9 +5,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-# Our tasks
-load 'lib/tasks/effective_orders_tasks.rake'
-
 # Testing tasks
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'

data/active_admin/effective_orders.rb

@@ -19,6 +19,11 @@ if defined?(ActiveAdmin)
 
       def scoped_collection
         scoped = end_of_association_chain.includes(:user).includes(order_items: :purchasable)
+
+        if EffectiveOrders.orders_collection_scope.respond_to?(:call)
+          scoped = EffectiveOrders.orders_collection_scope.call(scoped)
+        end
+
         scoped = scoped.where(user: current_user) if !authorized?(:admin, :effective_orders)
         scoped
       end
@@ -55,12 +60,12 @@ if defined?(ActiveAdmin)
         price_to_currency(order.total)
       end
 
-      column :payment_method do |order|
-        order.payment_method
+      column :payment_provider do |order|
+        order.payment_provider
       end
 
-      column :payment_card_type do |order|
-        order.payment_card_type
+      column :payment_card do |order|
+        order.payment_card
       end
 
       column do |order|
@@ -80,8 +85,8 @@ if defined?(ActiveAdmin)
       col_headers << "Subtotal"
       col_headers << "Tax"
       col_headers << "Total"
-      col_headers << 'Purchase method'
-      col_headers << 'Card Type'
+      col_headers << 'Payment provider'
+      col_headers << 'Payment card'
 
       csv_string = CSV.generate do |csv|
         csv << col_headers
@@ -91,12 +96,12 @@ if defined?(ActiveAdmin)
             order.to_param,
             order.purchased_at.strftime("%Y-%m-%d %H:%M:%S %z"),
             order.user.try(:email),
-            (order.billing_address.try(:full_name) || order.user.to_s),
+            (order.try(:billing_address).try(:full_name) || order.user.to_s),
             (order.subtotal / 100.0).round(2),
             (order.tax / 100.0).round(2),
             (order.total / 100.0).round(2),
-            order.payment_method,
-            order.payment_card_type
+            order.payment_provider,
+            order.payment_card
           ]
         end
       end