effective_orders 2.2.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7006871350baa02cd389c691d50c31240809e934
-  data.tar.gz: 2881b82a65e145a785921e7b8dfc65f057a25bf2
+  metadata.gz: 2ec2b7db0f986ae5f26513e93e940bbf6daad8fd
+  data.tar.gz: e10dd21a55398487ab2460f14b74008a7d54ba20
 SHA512:
-  metadata.gz: 22755b105fc451ea5d7f0ee5d0a5392f46a4248a639f8d1df46c188f76408d96b6e1cd80bf0b3f21998334ed6d168dc292c223ceb9e351f807f9804a2164ca1d
-  data.tar.gz: 3928a9a2fe440a733be0e10bc99b2e021aff7dd8253e72dbf75f9500a45abb4e1be4547cadb467764634b6abe7bed8bcc511469ab9b3c9c4fe5bec3345c66b0d
+  metadata.gz: a5e492bd4496e236c506b7b2656a0506100044c10f5c79b7c079da96c6e5a74c2b9b4020c8c66397d61ed94a0c1941f6c980231eca0bb2b41ae07cff3bc396f7
+  data.tar.gz: a2d8b2c04e632ddd1b61680e339fdd0a57356a33ff90ca02c17c82222028b0398806f7933b9e1c9d4efd41ba7f82fe45d6b4f209e006d77adcd7793345321de2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 Code and Effect Inc.
+Copyright 2018 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

@@ -10,9 +10,18 @@ Sends order receipt emails automatically.
 
 Has Order History, My Purchases, My Sales and Admin screens.
 
+## Bootstrap3
+
+This is the `bootstrap3` branch of effective_orders which supports Twitter Bootstrap 3.
+
+All published effective_orders 3.x gems will support Twitter Bootstrap 3 and SimpleForm.
+
+For Bootstrap 4 please see the master branch and/or effective_orders 4.x gems.
+
+
 ## Getting Started
 
-Please first install the [effective_addresses](https://github.com/code-and-effect/effective_addresses) and [effective_datatables](https://github.com/code-and-effect/effective_datatables) gems.
+Please first install the [effective_addresses](https://github.com/code-and-effect/effective_addresses), [effective_datatables](https://github.com/code-and-effect/effective_datatables) and [effective_form_inputs](https://github.com/code-and-effect/effective_form_inputs) gems.
 
 Add to your Gemfile:
 
@@ -54,27 +63,6 @@ Require the stylesheet on the asset pipeline by adding the following to your app
 *= require effective_orders
 ```
 
-### Upgrading to 2.0.x
-
-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.
-
-The default implementation assigns the tax rate based on the order's billing_address (see the [Tax section](#tax)):
-
-```ruby
-config.order_tax_rate_method = Proc.new { |order| Effective::TaxRateCalculator.new(order: order).tax_rate }
-```
-
-There are numerous database changes in the 2.0.0 line of effective_orders.
-
-if you are running a 1.x version, please upgrade your database with this command:
-
-```ruby
-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_purchasable` objects, each with a `link_to_add_to_cart(object)`.
@@ -107,7 +95,7 @@ These purchasables could be Products, EventTickets, Memberships or anything else
 
 ### Representing Prices
 
-All prices should be internally represented as Integers.  For us North Americans, think of it as the number of cents.
+All prices should be internally represented as Integers. For us North Americans, think of it as the number of cents.
 
 To represent the value of `$10.00` the price method should return `1000`.
 
@@ -130,28 +118,14 @@ If someone purchased a Product which is later deleted, the Order History page wi
 class Product < ActiveRecord::Base
   acts_as_purchasable
 
-  # this structure do... block is provided by the migrant gem https://github.com/pascalh1011/migrant
-  structure do
-    title               :string
-
-    price               :integer, default: 0
-    tax_exempt          :boolean, default: false
-
-    archived            :boolean, default: false
-
-    timestamps
-  end
+  # Attributes
+  # title               :string
+  # price               :integer, default: 0
+  # tax_exempt          :boolean, default: false
+  # timestamps
 
   validates_presence_of :title
   validates_numericality_of :price, greater_than_or_equal_to: 0
-
-  scope :products, -> { where(archived: false) }
-
-  # This archives Products instead of deleting them
-  def destroy
-    update_attributes(archived: true)
-  end
-
 end
 ```
 
@@ -164,7 +138,6 @@ class CreateProducts < ActiveRecord::Migration
       t.string :title
       t.integer :price, :default=>0
       t.boolean :tax_exempt, :default=>false
-      t.boolean :archived, :default=>false
       t.datetime :updated_at
       t.datetime :created_at
     end
@@ -180,7 +153,7 @@ Once the database has been migrated, it is time to scaffold/build the CRUD Produ
 
 ### Products#new/#edit
 
-Use the EffectiveOrders price input to enter the price.
+Use an [effective_form_inputs](https://github.com/code-and-effect/effective_form_inputs#effective-price) effective_price input to enter the price.
 
 It displays the underlying Integer price as a currency formatted value, ensures that a properly formatted price is entered by the user, and POSTs the appropriate Integer value back to the server.
 
@@ -190,7 +163,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: :effective_price
   = f.button :submit
 ```
 
@@ -198,26 +171,14 @@ or
 
 ```ruby
 = semantic_form_for(@product) do |f|
-  = f.input :price, as: :price
+  = f.input :price, as: :effective_price
 ```
 
 or
 
 ```haml
 = form_for(@product) do |f|
-  = 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
-
-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
-
-= semantic_form_for @user do |f|
-  = f.input :price, as: :price_formtastic
+  = f.effective_price :price
 ```
 
 ### Products#show
@@ -362,19 +323,40 @@ Or to apply 0% tax:
 config.order_tax_rate_method = Proc.new { |order| 0 }
 ```
 
+Or, hardcode a country and state code:
+
+```ruby
+config.order_tax_rate_method = Proc.new { |order| Effective::TaxRateCalculator.new(country_code: 'CA', state_code: 'AB').tax_rate }
+```
+
 Please see the initializer file for more information.
 
 
 ### Callbacks
 
+There are three interesting callbacks you can define on the purchasable object, `before_purchase`, `after_purchase` and `after_decline`.
+
+The `before_purchase` callback runs just before the `order` object is saved.  This callback lets you do things in the same transaction the order is saved in.
+
+The `after_purchase` callback runs just after the `order` object is saved. It runs outside and just after the order save transaction.
+
+All three of these callbacks will re-raise any exceptions when in development mode, and swallow them in production.
+
 When defined, upon purchase the following callback will be triggered:
 
 ```ruby
 class Product
   acts_as_purchasable
 
-  after_purchase do |order, order_item|   # These are optional, if you don't care about the order or order_item
-    self.do_something() # self is the newly purchased instance of this Product
+  # Will automatically be saved when order is saved
+  before_purchase do |order, order_item|
+    self.completed_at = Time.zone.now
+  end
+
+  # Won't be automatically saved. You need to call save on your own.
+  after_purchase do |order, order_item|
+    self.completed_at = Time.zone.now
+    save!
   end
 
 end
@@ -494,7 +476,7 @@ On this final checkout screen, links to all configured payment providers are dis
 
 The payment processor handles collecting the Credit Card number, and through one way or another, the `Effective::Order` `@order.purchase!` method is called.
 
-Once the order has been marked purchased, the user is redirected to the `effective_orders.order_purchased_path` screen where they see a 'Thank You!' message, and the Order receipt.
+Once the order has been marked purchased, the user is redirected to the `effective_orders.purchased_order_path` screen where they see a 'Thank You!' message, and the Order receipt.
 
 If the configuration option `config.mailer[:send_order_receipt_to_buyer] == true` the order receipt will be emailed to the user.
 
@@ -506,7 +488,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_url: '/', declined_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
 
@@ -587,7 +569,7 @@ or
 or
 
 ```ruby
-= link_to 'My Order History', effective_orders.my_purchases_path
+= link_to 'My Order History', effective_orders.my_purchases_orders_path
 ```
 
 or render it inline on an existing page with
@@ -676,23 +658,29 @@ We are also going to use ngrok to give us a public facing URL
 
 Visit https://esqa.moneris.com/mpg/ and login with: demouser / store1 / password
 
-Select ADMIN -> hosted config from the menu
+Select Admin -> Hosted Paypage Config from the menu
 
 Click the 'Generate a New Configuration' button which should bring us to a "Hosted Paypage Configuration"
 
 ### Basic Configuration
 
-Description:  'My Test store'
+Description: My Test Store
 
 Transaction Type: Purchase
 
+Payment Methods: Credit Cards
+
 Response Method: Sent to your server as a POST
 
 Approved URL: https://myapp.herokuapp.com/orders/moneris_postback
 
 Declined URL: https://myapp.herokuapp.com/orders/moneris_postback
 
-Note: The Approved and Declined URLs must match the effective_orders.moneris_postback_path value in your application. By default it is /orders/moneris_postback
+Note: The Approved and Declined URLs must match the effective_orders.moneris_postback_orders_path value in your application. By default it is /orders/moneris_postback
+
+Use 'Enhanced Cancel': false
+Use 'Enhanced Response Feedback': false
+
 
 Click 'Save Changes'
 
@@ -734,11 +722,11 @@ Display billing address details: true
 
 Display shipping address details: true
 
-Enable input of Billing, Shipping and extra fields: false
+Enable input of Billing, Shipping, and extra data fields on the hosted paypage: false
 
-Display merchange name: true, if you have an SSL cert
+Display merchant name: true, if you have an SSL cert
 
-Cancel Button Text:  'Cancel'
+Cancel Button Text: Cancel
 
 Cancel Button URL: https://myapp.herokuapp.com/
 
@@ -746,13 +734,15 @@ Click 'Save Appearance Settings'
 
 Click 'Return to main configuration'
 
-### Response Fields
+### Response/Receipt Data
+
+Click 'Configure Response Fields' from the main Hosted Paypage Configuration
 
 None of the 'Return...' checkboxes are needed. Leave unchecked.
 
-Perform asynchronous data post:  false, unchecked
+Perform asynchronous data post: false, unchecked
 
-Async Response URL:  leave blank
+Async Response URL: leave blank
 
 Click 'Save Response Settings'
 
@@ -761,7 +751,9 @@ Click 'Return to main configuration'
 
 ### Security
 
-Referring URL: https://myapp.herokuapp.com/
+Click 'Configure Security' from the main Hosted Paypage Configuration
+
+Referring URL -> Add URL: https://myapp.herokuapp.com/
 
 Enable Card Verification: false, unused
 
@@ -789,20 +781,20 @@ With this test store set up, you can make a successful purchase with:
 
 Cardholder Name: Any name
 
-Credit Card Number: 4242 4242 4242 4242
+Credit Card Number: 4502 2850 7000 0007
 
 Expiry Date: Any future date
 
 Some gotchas:
 
-1. When using a test store, if your order total price is less than $10, the penny amount may be used to raise an error code.
+1. When using a test store, there are a whole bunch of ways to simulate failures by posting an order less than $10.00
 
-Order totals ending in .00 will be Approved
-Order totals ending in .05 will be Declined
+Please refer to:
 
-And there's a whole bunch more.  Please refer to:
+https://developer.moneris.com/en/More/Testing/Penny%20Value%20Simulator
 
-https://www.collinsharper.com/downloadable/download/sample/sample_id/5/
+The following card will always be approved: 4502 2850 7000 0007
+The following card will always be declined: 4355 3100 0257 6375
 
 2. Moneris will not process a duplicate order ID
 
@@ -843,7 +835,7 @@ Stripe Connect allows effective_orders to collect payments on behalf of users.
 
 First register your application with Stripe
 
-Stripe Dashbaord -> Your Account (dropdown) -> Account Settings -> Apps
+Stripe Dashboard -> Your Account (dropdown) -> Account Settings -> Apps
 
 Register your application
 
@@ -891,11 +883,59 @@ end
 
 ### Stripe Subscriptions
 
-Subscriptions and Stripe Connect do not currently work together.
+To set up stripe subscriptions:
+
+Define your model
+
+```ruby
+acts_as_subscribable
+```
+
+and then in your form, to choose a subscription:
+
+```ruby
+= effective_subscription_fields(f, item_wrapper_class: 'col-sm-3')
+```
+
+and in your controller:
+
+```ruby
+@team.save! && @team.subscripter.save!
+```
+
+and in your application controller:
+
+```ruby
+before_action :set_subscription_notice
+
+def set_subscription_notice
+  return unless team && team.subscription_active? == false
+
+  if team.trial_expired?
+    flash.now[:warning] = 'Your trial has expired'
+  elsif team.subscription_active? == false
+    flash.now[:warning] = 'Your subscription has become unpaid'
+  end
+end
+```
+
+And you can link to the customer#show page
+
+```ruby
+link_to 'Customer', effective_orders.customer_settings_path
+```
+
+To set up stripe:
+
+1.) Set up a stripe account as above.
+
+2.) Ceate one or more plans. Don't include any trial or trial periods.
+
+3.) Subscription Settings: 3-days. Then 1-day, 3-days, 3-days, then Cancel subscription
 
-Register an additional Webhook, to accept Stripe subscription creation events from Stripe
+4.) Click API -> Webhooks and add an endpoint `root_url/webhooks/stripe`. You will need something like ngrok to test this.
 
-root_url/webhooks/stripe
+5.) Record the webhook Signing secret in `config.subscription[:webhook_secret]`
 
 
 ## Paying Via PayPal

data/app/assets/javascripts/effective_orders/customers.js.coffee

@@ -0,0 +1,39 @@
+stripeCustomerChangeCardHandler = (key, form) ->
+  StripeCheckout.configure
+    key: key
+    closed: ->
+      form.find("input[type='submit']").removeAttr('disabled')
+      $('input[data-disable-with]').each -> try $.rails.enableFormElement($(this))
+    token: (token, args) ->
+      if token.error
+        form.find("input[type='submit']").removeAttr('disabled')
+        $('input[data-disable-with]').each -> try $.rails.enableFormElement($(this))
+
+        alert("An error ocurred when contacting Stripe. Your card has not been charged. Your subscription has not changed. Please refresh the page and try again. #{token.error.message}")
+      else
+        form.find("input[name$='[stripe_token]']").val('' + token['id'])
+
+        customer = form.find('.effective-orders-customer')
+        customer.find('.active-card').html("**** **** **** #{token.card.last4} #{token.card.brand} #{token.card.exp_month}/#{token.card.exp_year}")
+
+        if customer.data('submit')
+          form.find("input[type='submit']").prop('disabled', true)
+          $('input[data-disable-with]').each -> try $.rails.disableFormElement($(this))
+          form.submit()
+
+# When we click 'Change credit card', make sure the form collects a credit card
+$(document).on 'click', '.effective-orders-customer .btn-change-card', (event) ->
+  event.preventDefault()
+
+  $form = $(event.currentTarget).closest('form')
+  stripe = $(event.currentTarget).closest('.effective-orders-customer').data('stripe')
+
+  # Disable the form
+  $form.find("input[type='submit']").prop('disabled', true)
+  $('input[data-disable-with]').each -> try $.rails.disableFormElement($(this))
+
+  stripeCustomerChangeCardHandler(stripe.key, $form).open
+    image: stripe.image
+    name: stripe.name
+    email: stripe.email
+    panelLabel: 'Update Card Details'

data/app/assets/javascripts/effective_orders/providers/{stripe_charges.js.coffee → stripe.js.coffee}

@@ -1,34 +1,36 @@
 stripeCheckoutHandler = (key, form) ->
   StripeCheckout.configure
     key: key
+    closed: ->
+      form.find("input[type='submit']").removeAttr('disabled')
+      $('input[data-disable-with]').each -> try $.rails.enableFormElement($(this))
     token: (token, args) ->
       if token.error
         form.find("input[type='submit']").removeAttr('disabled')
         $('input[data-disable-with]').each -> try $.rails.enableFormElement($(this))
 
-        alert("An error ocurred when contacting Stripe.  Your card has not been charged.  Please refresh the page and try again. #{token.error.message}")
+        alert("An error ocurred when contacting Stripe. Your card has not been charged. Please refresh the page and try again. #{token.error.message}")
       else
-        form.find('input#effective_providers_stripe_charge_token').val('' + token['id'])
+        form.find("input[name$='[stripe_token]']").val('' + token['id'])
 
         form.find("input[type='submit']").prop('disabled', true)
         $('input[data-disable-with]').each -> try $.rails.disableFormElement($(this))
-
         form.submit()
 
 $(document).on 'click', "#effective-orders-new-charge-form form input[type='submit']", (event) ->
   event.preventDefault()
 
   obj = $('#effective-orders-new-charge-form')
-  form = obj.find('form').first()
+  $form = obj.find('form').first()
+  stripe = obj.data('stripe')
 
-  form.find("input[type='submit']").prop('disabled', true)
+  # Disable the form
+  $form.find("input[type='submit']").prop('disabled', true)
   $('input[data-disable-with]').each -> try $.rails.disableFormElement($(this))
 
-  stripeCheckoutHandler(obj.data('stripe-publishable-key'), form).open
-    name: obj.data('site-title')
-    email: obj.data('user-email')
-    description: obj.data('description')
-    amount: obj.data('amount')
-    closed: ->
-      form.find("input[type='submit']").removeAttr('disabled')
-      $('input[data-disable-with]').each -> try $.rails.enableFormElement($(this))
+  stripeCheckoutHandler(stripe.key, $form).open
+    image: stripe.image
+    name: stripe.name
+    description: stripe.description
+    email: stripe.email
+    amount: stripe.amount