effective_orders 1.8.1 → 2.0.0

data/app/models/effective/order_item.rb

@@ -6,24 +6,27 @@ module Effective
     belongs_to :purchasable, :polymorphic => true
     belongs_to :seller, :class_name => 'User'
 
-    structure do
-      title                 :string, :validates => [:presence]
-      quantity              :integer, :validates => [:presence, :numericality]
-      price                 :integer, :default => 0, :validates => [:numericality]
-      tax_exempt            :boolean, :validates => [:inclusion => {:in => [true, false]}]
-      tax_rate              :decimal, :precision => 5, :scale => 3, :default => 0.000, :validates => [:presence]
+    delegate :purchased_download_url, :to => :purchasable
+    delegate :purchased?, :declined?, :to => :order
 
-      timestamps
-    end
+    # structure do
+    #   title                 :string
+    #   quantity              :integer
+    #   price                 :integer, default: 0
+    #   tax_exempt            :boolean
+    #
+    #   timestamps
+    # end
 
-    validates_associated :purchasable
-    validates_presence_of :purchasable
-    accepts_nested_attributes_for :purchasable, :allow_destroy => false, :reject_if => :all_blank, :update_only => true
+    validates :purchasable, associated: true, presence: true
+    accepts_nested_attributes_for :purchasable, allow_destroy: false, reject_if: :all_blank, update_only: true
 
-    validates_presence_of :seller_id, :if => Proc.new { |order_item| EffectiveOrders.stripe_connect_enabled }
+    validates :title, presence: true
+    validates :quantity, presence: true, numericality: { greater_than: 0 }
+    validates :price, numericality: true
+    validates :tax_exempt, inclusion: { in: [true, false] }
 
-    delegate :purchased_download_url, :to => :purchasable
-    delegate :purchased?, :declined?, :to => :order
+    validates :seller_id, presence: true, if: Proc.new { |order_item| EffectiveOrders.stripe_connect_enabled }
 
     scope :sold, -> { joins(:order).where(:orders => {:purchase_state => EffectiveOrders::PURCHASED}) }
     scope :sold_by, lambda { |user| sold().where(:seller_id => user.try(:id)) }
@@ -36,11 +39,15 @@ module Effective
       price * quantity
     end
 
-    def tax  # This is the total tax, for 3 items if quantity is 3
-      tax_exempt ? 0 : (subtotal * tax_rate).round(0).to_i
+    def tax
+      return 0 if tax_exempt?
+      raise 'parent Effective::Order must have a tax_rate to compute order item tax' unless order.try(:tax_rate).present?
+      (subtotal * order.tax_rate / 100.0).round(0).to_i
     end
 
     def total
+      return subtotal if tax_exempt?
+      raise 'parent Effective::Order must have a tax_rate to compute order item total' unless order.try(:tax_rate).present?
       subtotal + tax
     end
 

data/app/models/effective/product.rb

@@ -0,0 +1,23 @@
+module Effective
+  class Product < ActiveRecord::Base
+    self.table_name = EffectiveOrders.products_table_name.to_s
+
+    acts_as_purchasable
+
+    # structure do
+    #   title         :string
+    #   price         :integer, default: 0
+    #   tax_exempt    :boolean, default: false
+    #
+    #   timestamps
+    # end
+
+    validates :title, presence: true
+    validates :price, numericality: { greater_than: 0 }
+
+    def to_s
+      self[:title] || 'New Product'
+    end
+
+  end
+end

data/app/models/effective/providers/ccbill_postback.rb

@@ -0,0 +1,85 @@
+# https://www.ccbill.com/cs/wiki/tiki-index.php?page=Background+Post
+class Effective::Providers::CcbillPostback
+  attr_reader :params
+
+  def initialize(params)
+    @params = params
+  end
+
+  def verified?
+    params[:responseDigest] == digest(digest_value)
+  end
+
+  def matches?(order)
+    price == order.total && order_id == order.to_param
+  end
+
+  def approval?
+    !denial?
+  end
+
+  def denial?
+    # denialId is for subscriptions only
+    [:reasonForDeclineCode, :reasonForDecline, :denialId].any? {|key| params[key].present?}
+  end
+
+  def order_details
+    @order_details ||= get_order_details
+  end
+
+  def order_id
+    params[:order_id]
+  end
+
+  private
+
+  # https://www.ccbill.com/cs/wiki/tiki-index.php?page=Dynamic+Pricing+User+Guide#Postback
+  def digest_value
+    if approval?
+      "#{params[:subscription_id]}1#{salt}" # the `subscriptionId` param in the linked docs is a typo
+    else
+      "#{params[:denialId]}0#{salt}"
+    end
+  end
+
+  def digest(value)
+    Digest::MD5.hexdigest(value)
+  end
+
+  def salt
+    EffectiveOrders.ccbill[:dynamic_pricing_salt]
+  end
+
+  # in cents
+  def price
+    return @price if @price.present?
+    formatted_price = params[:initialFormattedPrice] # example: "$10.00"
+    formatted_price = Nokogiri::HTML::DocumentFragment.parse(formatted_price).to_s # => "$10.00"
+    match = formatted_price.match(/^\D(\d*.\d\d)$/) # {a currency symbol}(digits.two digits)
+    return false unless match.present?
+    formatted_price = match[1] # => "10.00"
+    @price = formatted_price.sub('.', '').to_i # => 1000
+  end
+
+  def get_order_details
+    # ignore some params
+    keepable = params.except(*ignorable_params)
+    # remove blanks
+    keepable.inject({}) do |details, kv_pair|
+      details[kv_pair[0]] = kv_pair[1] if kv_pair[1].present?
+      details
+    end
+  end
+
+  def ignorable_params
+    [
+      # we have these already
+      :clientAccnum,
+      :clientSubacc,
+      :productDesc,
+      # a hash of billing information which CCBill doesn't share the format of (afaik)
+      :paymentAccount
+    ]
+  end
+end
+

data/app/models/effective/{stripe_charge.rb → providers/stripe_charge.rb}

@@ -1,5 +1,5 @@
 # This is an object for the stripe charge form
-module Effective
+module Effective::Providers
   class StripeCharge
     extend ActiveModel::Naming
     include ActiveModel::Conversion

data/app/models/effective/subscription.rb

@@ -8,21 +8,25 @@ module Effective
 
     belongs_to :customer
 
-    structure do
-      stripe_plan_id          :string, :validates => [:presence]  # This will be 'Weekly' or something like that
-      stripe_subscription_id  :string
-      stripe_coupon_id        :string
-
-      title                   :string, :validates => [:presence]
-      price                   :integer, :default => 0, :validates => [:numericality => {:greater_than => 0}]
-
-      timestamps
-    end
+    # structure do
+    #   stripe_plan_id          :string  # This will be 'Weekly' or something like that
+    #   stripe_subscription_id  :string
+    #   stripe_coupon_id        :string
+    #
+    #   title                   :string
+    #   price                   :integer, default: 0
+    #
+    #   timestamps
+    # end
 
     delegate :user, :user_id, :to => :customer
 
-    validates_presence_of :customer
-    validates_uniqueness_of :customer_id, :scope => [:stripe_plan_id] # Can only be on each plan once.
+    validates :stripe_plan_id, presence: true
+    validates :title, presence: true
+    validates :price, numericality: { greater_than: 0 }
+
+    validates :customer, presence: true
+    validates :customer_id, uniqueness: { scope: [:stripe_plan_id] }  # Can only be on each plan once.
 
     before_validation do
       self.errors.add(:stripe_plan_id, "is an invalid Plan") if stripe_plan_id.present? && stripe_plan.blank?

data/app/models/effective/tax_rate_calculator.rb

@@ -0,0 +1,45 @@
+module Effective
+  class TaxRateCalculator
+    attr_reader :order
+
+    RATES = {
+      'CA' => {         # Canada
+        'AB' => 5.00,   # Alberta
+        'BC' => 5.00,   # British Columbia
+        'MB' => 5.00,   # Manitoba
+        'NB' => 13.0,   # New Brunswick
+        'NL' => 13.0,   # Newfoundland and Labrador
+        'NT' => 5.00,   # Northwest Territories
+        'NS' => 15.0,   # Nova Scotia
+        'ON' => 13.0,   # Ontario
+        'PE' => 14.0,   # Prince Edward Island
+        'QC' => 5.00,   # Quebec
+        'SK' => 5.00,   # Saskatchewan
+        'YT' => 5.00,   # Yukon Territory
+        'NU' => 5.00    # Nunavut
+      }
+    }
+
+    def initialize(order:)
+      @order = order
+    end
+
+    def tax_rate
+      return nil unless order.billing_address.try(:country_code).present?
+
+      country = order.billing_address.country_code
+      state = order.billing_address.state_code
+
+      rate = RATES[country]
+      return rate if rate.kind_of?(Numeric)
+      return unknown_tax_rate() if rate.nil?
+
+      rate[state].presence || unknown_tax_rate()
+    end
+
+    def unknown_tax_rate
+      order.skip_buyer_validations? ? nil : 0
+    end
+
+  end
+end

data/app/views/admin/customers/index.html.haml

@@ -1,12 +1,9 @@
-%h2.effective-orders-page-title Customers
+%h2.effective-orders-page-title= (@page_title || 'Customers')
 
 %p.text-right= link_to 'Stripe Dashboard: Customers', 'https://manage.stripe.com/customers', :class => 'btn btn-primary'
 
 - if @datatable.nil?
-  %p
-    Please install
-    = link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'
-    to see this page.
+  %p Please install #{link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'} to see this page.
 - elsif @datatable.present?
   = render_datatable @datatable
 - else

data/app/views/admin/order_items/index.html.haml

@@ -1,10 +1,7 @@
-%h2.effective-orders-page-title Order Items
+%h2.effective-orders-page-title= (@page_title || 'Order Items')
 
 - if @datatable.nil?
-  %p
-    Please install
-    = link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'
-    to see this page.
+  %p Please install #{link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'} to see this page.
 - elsif @datatable.present?
   = render_datatable @datatable
 - else

data/app/views/admin/orders/_actions.html.haml

@@ -0,0 +1,2 @@
+= link_to (datatables_admin_path? ? effective_orders.admin_order_path(order) : effective_orders.order_path(order)), title: 'View' do
+  %span.glyphicon.glyphicon-eye-open

data/app/views/admin/orders/_form.html.haml

@@ -0,0 +1,28 @@
+- unless defined?(Cocoon)
+  Please install #{link_to 'cocoon', 'https://github.com/nathanvda/cocoon'} to see this page.
+- else
+  = simple_form_for [:admin, order], (EffectiveOrders.admin_simple_form_options || {}).merge(url: effective_orders.admin_orders_path) do |f|
+    = f.association :user,
+      label: 'Buyer',
+      required: true,
+      as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
+      collection: @users || User.all.to_a.sort { |user1, user2| user1.to_s <=> user2.to_s }
+
+    %h3 Order Items
+    .order_items
+      - f.object.order_items.build unless f.object.order_items.present?
+      = f.simple_fields_for :order_items do |order_item|
+        = render 'order_item_fields', f: order_item
+
+      .links
+        = link_to_add_association '+ Add line item', f, :order_items, partial: 'order_item_fields'
+
+    = f.input :send_payment_request_to_buyer,
+      as: :boolean,
+      label: 'Yes, send a payment request email to the buyer.',
+      value: (f.object.send_payment_request_to_buyer.nil? ? EffectiveOrders.mailer[:send_payment_request_to_buyer] : f.object.send_payment_request_to_buyer?)
+
+    .form-group.pull-right
+      = f.button :submit, 'Save', data: { disable_with: 'Saving...' }
+      = f.button :submit, 'Save and Add New', data: { disable_with: 'Saving...' }
+      = link_to 'Cancel', effective_orders.admin_orders_path

data/app/views/admin/orders/_order_item_fields.html.haml

@@ -0,0 +1,9 @@
+.nested-fields.order-item
+  .row
+    - f.object.purchasable ||= Effective::Product.new
+    = f.simple_fields_for :purchasable do |purchasable|
+      .col-sm-2= f.input :quantity, input_html: { value: f.object.quantity || 1, min: 1 }
+      .col-sm-4= purchasable.input :title, input_html: { maxlength: 255 }
+      .col-sm-2= purchasable.input :price, as: (defined?(EffectiveFormInputs) ? :effective_price : :price)
+      .col-sm-2= purchasable.input :tax_exempt, label: 'Tax Exempt', input_html: { title: 'When checked, tax will not be applied to this item' }
+      .col-sm-2.remove-nested-fields= link_to_remove_association('Remove line item', f)

data/app/views/admin/orders/index.html.haml

@@ -1,11 +1,15 @@
-%h2.effective-orders-page-title Orders
+%h2.effective-orders-page-title= (@page_title || 'Orders')
+
+%p.text-right.effective-orders-page-action= link_to 'New Order', effective_orders.new_admin_order_path, :class => 'btn btn-primary'
 
 - if @datatable.nil?
-  %p
-    Please install
-    = link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'
-    to see this page.
+  %p Please install #{link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'} to see this page.
 - elsif @datatable.present?
   = render_datatable @datatable
 - else
   %p There are no orders present
+
+- if @datatable.present?
+  %p.text-right= link_to 'New Order', effective_orders.new_admin_order_path, :class => 'btn btn-primary'
+
+

data/app/views/admin/orders/new.html.haml

@@ -0,0 +1,3 @@
+%h2.effective-orders-page-title= (@page_title || 'New Order')
+
+= render partial: 'form', locals: { order: @order }

data/app/views/effective/carts/_cart.html.haml

@@ -19,19 +19,10 @@
       - if cart.empty?
         %tr
           %td.quantity
-          %td.item There are no items in your shopping cart
+          %td.item Your cart is empty.
           %td.price
     %tfoot
-      - if cart.tax > 0
-        %tr
-          %th.quantity
-          %th.subtotal Subtotal
-          %td.price.subtotal-price= price_to_currency(cart.subtotal)
-        %tr
-          %th.quantity
-          %th.tax Tax
-          %td.price.tax-price= price_to_currency(cart.tax)
       %tr
         %th.quantity
-        %th.total Total Due
-        %td.price.total-price= price_to_currency(cart.total)
+        %th.subtotal Subtotal
+        %td.price.subtotal-price= price_to_currency(cart.subtotal)

data/app/views/effective/carts/_cart_actions.html.haml

@@ -0,0 +1,4 @@
+.effective-order-actions.pull-right
+  %p
+    = link_to_checkout
+    = link_to_empty_cart

data/app/views/effective/carts/show.html.haml

@@ -1,20 +1,18 @@
-%h2.effective-orders-page-title Shopping Cart
+%h2.effective-orders-page-title= (@page_title || 'My Cart')
 
 - if @cart.empty?
   %p Your cart is empty.
-
-  %hr
-  = link_to 'Home', root_url, :class => 'btn btn-primary'
-  - if EffectiveOrders.show_order_history_button
-    = link_to 'Order History', effective_orders.my_purchases_path, class: 'btn btn-default'
-
 - else
   %p Your cart has #{@cart.cart_items.length} items.
 
   = render_cart(@cart)
-
   %hr
-  = link_to_checkout :class => 'btn btn-primary pull-right'
-  = link_to_empty_cart
-  - if EffectiveOrders.show_order_history_button
-    = link_to 'Order History', effective_orders.my_purchases_path, class: 'btn btn-default', rel: :nofollow
+  = render partial: '/effective/carts/cart_actions', locals: { cart: @cart }
+
+- if @pending_orders.present?
+  %h3 Pending Orders
+  %p The following orders are ready for you to purchase:
+  = render_orders_table(@pending_orders)
+
+- if EffectiveOrders.show_order_history_button
+  = link_to_my_purchases(label: 'Order History')

data/app/views/effective/orders/_checkout_step1.html.haml

@@ -0,0 +1,46 @@
+.effective-order
+  = simple_form_for(order, (EffectiveOrders.simple_form_options || {}).merge(url: (order.new_record? ? effective_orders.orders_path : effective_orders.order_path(order)))) do |f|
+    = render partial: 'effective/orders/order_items', locals: {order: order, form: f}
+
+    - if order.errors[:order_items].present?
+      %p.inline-errors= order.errors[:order_items].first
+
+    - if order.errors[:total].present?
+      %p.inline-errors= order.errors[:total].first.gsub(EffectiveOrders.minimum_charge.to_i.to_s, price_to_currency(EffectiveOrders.minimum_charge.to_i))
+
+    - if EffectiveOrders.collect_user_fields.present? && (f.object.user rescue nil).present?
+      = render partial: 'effective/orders/order_user_fields', locals: {form: f, user: f.object.user }
+
+    - num_addresses = [EffectiveOrders.require_billing_address, EffectiveOrders.require_shipping_address].count(true)
+
+    - if num_addresses > 0
+      .row
+        - if EffectiveOrders.require_billing_address
+          %div{class: "col-sm-#{12 / num_addresses}"}
+            %h3 Billing Address
+            = effective_address_fields(f, :billing_address)
+            - if f.object.user.respond_to?(:billing_address=)
+              = f.input :save_billing_address, as: :boolean, label: 'Save as my default billing address', required: false
+
+        - if EffectiveOrders.require_shipping_address
+          %div{class: "col-sm-#{12 / num_addresses}"}
+            %h3 Shipping Address
+            - if EffectiveOrders.require_billing_address && EffectiveOrders.require_shipping_address
+              .shipping_address_fields{style: (f.object.shipping_address_same_as_billing? && (f.object.errors[:shipping_address] || []).blank?) ? 'display: none;' : 'display: block;'}
+                = effective_address_fields(f, :shipping_address)
+                - if f.object.user.respond_to?(:shipping_address=)
+                  = f.input :save_shipping_address, as: :boolean, label: 'Save as my default shipping address', required: false
+
+              = f.input :shipping_address_same_as_billing, as: :boolean, label: 'My shipping address is the same as my billing address', required: false
+
+    - if EffectiveOrders.collect_note
+      = render partial: 'effective/orders/order_note_fields', locals: {form: f}
+
+    - unless f.object.pending? || current_cart.try(:empty?)
+      = link_to_current_cart(label: 'Change Items')
+
+    .pull-right
+      - if order.total == 0 && EffectiveOrders.allow_free_orders
+        = f.submit order_checkout_label(:free), class: 'btn btn-primary', rel: :nofollow, data: {'disable_with' => 'Processing...' }
+      - else
+        = f.submit 'Save and Continue', class: 'btn btn-primary', rel: :nofollow, data: {'disable_with' => 'Saving...' }