erp_commerce 3.0.0 → 3.0.1

data/README.md

@@ -0,0 +1,13 @@
+#ErpCommerce
+
+The CompassAE Commerce Engine uses the engines that implement Parties, Products and Orders, and adds the ability to conduct commerce. It implements a pricing engine, fees, payment gateways.
+
+### Override Initializer
+
+To override these settings simple create a erp_commerce.rb file in your initializers and override the config options you want
+
+    Rails.application.config.erp_commerce.configure do |config|
+      config.encryption_key                   = 'my_secret_code'
+      config.active_merchant_gateway_wrapper = ErpCommerce::ActiveMerchantWrappers::BrainTreeGatewayWrapper
+    end
+    Rails.application.config.erp_commerce.configure!

data/app/mailers/checkout_mailer.rb

@@ -0,0 +1,9 @@
+class CheckoutMailer < ActionMailer::Base
+  default :from => ErpTechSvcs::Config.email_notifications_from
+
+  def email_confirmation(to_email, order, payment)
+    @order = order
+    @payment = payment
+    mail(:to => to_email, :subject => 'Your Confirmation')
+  end
+end

data/app/models/bank_account.rb

@@ -0,0 +1,87 @@
+class BankAccount < ActiveRecord::Base
+  require 'attr_encrypted'
+
+  acts_as_biz_txn_account
+
+  belongs_to :bank_account_type
+
+  validates :routing_number, :presence => {:message => 'Routing number cannot be blank.'}
+  validates :name_on_account, :presence => {:message => 'Name on account cannot be blank.'}
+  validates :crypted_private_account_number, :presence => {:message => 'Account number cannot be blank.'}
+
+  alias :account_type :bank_account_type
+
+  #the function EncryptionKey.get_key is meant to be overridden to provide a means for implementations to specify their
+  #own encryption schemes and locations. It will default to a simple string for development and testing
+  attr_encrypted :private_account_number, :key => Rails.application.config.erp_commerce.encryption_key, :marshall => true, :attribute => :crypted_private_account_number
+
+  # These methods are exposed for the purposes of displaying a version of the account number
+  # string containing the last four digits of the account number. The idea is to make it
+  # painfully obvious when any coder is using the private_account_number, which should
+  # be used only in limited circumstances.
+
+  def account_number
+    if self.private_account_number
+      BankAccount.mask_number(self.private_account_number)
+    else
+      ''
+    end
+  end
+
+  # Note that the setter method allows the same variable to be set, and delegates through
+  # the encryption process
+
+  def account_number=(num)
+    self.private_account_number=num
+  end
+
+  def financial_txns
+    self.biz_txn_events.where('biz_txn_record_type = ?', 'FinancialTxn').collect(&:biz_txn_record)
+  end
+
+  def successful_payments
+    payments = []
+    self.financial_txns.each do |financial_txn|
+      payments << financial_txn.payments.last if financial_txn.has_captured_payment?
+    end
+    payments
+  end
+
+  def purchase(financial_txn, gateway_wrapper, gateway_options={}, gateway_account_number=nil, gateway_routing_number=nil)
+    gateway_account_number = self.private_account_number unless gateway_account_number
+    gateway_routing_number = self.routing_number unless gateway_routing_number
+
+    #call some service to pay via bank accounts
+    result = gateway_wrapper.purchase(gateway_account_number, gateway_routing_number, financial_txn.money.amount)
+
+    unless result[:payment].nil?
+      result[:payment].financial_txn = financial_txn
+      result[:payment].save
+      financial_txn.payments << result[:payment]
+      financial_txn.save
+    end
+
+    result
+  end
+
+  class << self
+    
+    def mask_number(number)
+      total_chars = number.length
+      total_chars -= 4
+      result = ''
+      result.tap do |str|
+        total_chars.times do
+          str << 'X'
+        end
+      end
+      result + number[number.length-4..number.length]
+    end
+
+  end
+
+  def refund
+    # implement a refund on an account
+  end
+
+end

data/app/models/bank_account_type.rb

@@ -0,0 +1,3 @@
+class BankAccountType < ActiveRecord::Base
+  has_many :bank_accounts
+end

data/app/models/credit_card.rb

@@ -3,12 +3,18 @@ class CreditCard < ActiveRecord::Base
   require 'attr_encrypted'
   
   belongs_to  :postal_address
-  has_many    :payments
-  belongs_to  :credit_card_account_party_role
+  has_one     :credit_card_account_party_role, :dependent => :destroy
+
+  validates :first_name_on_card, :presence => {:message => 'First name on card cannot be blank.'}
+  validates :last_name_on_card, :presence => {:message => 'Last name on card cannot be blank.'}
+  #validates :card_type, :presence => {:message => 'Card type cannot be blank.'}
+  validates :expiration_month, :presence => {:message => 'Expiration month cannot be blank.'}
+  validates :expiration_year, :presence => {:message => 'Expiration year cannot be blank.'}
+  validates :crypted_private_card_number, :presence => {:message => 'Card number cannot be blank.'}
 
   #the function EncryptionKey.get_key is meant to be overridden to provide a means for implementations to specify their 
   #own encryption schemes and locations. It will default to a simple string for development and testing
-  attr_encrypted :private_card_number, :key => EncryptionKey.get_key, :marshall => true, :attribute => :crypted_private_card_number
+  attr_encrypted :private_card_number, :key => Rails.application.config.erp_commerce.encryption_key, :marshall => true, :attribute => :crypted_private_card_number
 
   # These methods are exposed for the purposes of displaying a version of the card number
   # string containing the last four digits of the card number. The idea is to make it
@@ -17,8 +23,7 @@ class CreditCard < ActiveRecord::Base
 
   def card_number
     if self.private_card_number
-      n = self.private_card_number
-      'xxxx-xxxx-xxxx-' + n[n.length-4..n.length]
+      CreditCard.mask_number(self.private_card_number)
     else
       ''
     end
@@ -38,6 +43,10 @@ class CreditCard < ActiveRecord::Base
   def to_s
     "#{card_type}:  #{card_number}"
   end
+
+  def add_party_with_role(party, role_type)
+    
+  end
      
   def cardholder
     return self.credit_card_account_party_role.party
@@ -46,7 +55,13 @@ class CreditCard < ActiveRecord::Base
   def before_create
     token = CreditCardToken.new
     self.credit_card_token = token.cc_token.strip
-  end   
+  end
+
+  class << self
+    def mask_number(number)
+      'XXXX-XXXX-XXXX-' + number[number.length-4..number.length]
+    end
+  end
  
 end
 

data/app/models/credit_card_account.rb

@@ -1,4 +1,123 @@
 class CreditCardAccount < ActiveRecord::Base
   acts_as_biz_txn_account
+  
   belongs_to :credit_card_account_purpose
+  has_one    :credit_card_account_party_role, :dependent => :destroy
+  has_one    :credit_card, :through => :credit_card_account_party_role
+
+  def account_number
+    self.credit_card.card_number
+  end
+
+  def financial_txns
+    self.biz_txn_events.where('biz_txn_record_type = ?', 'FinancialTxn').collect(&:biz_txn_record)
+  end
+
+  def successful_payments
+    payments = []
+    self.financial_txns.each do |financial_txn|
+      payments << financial_txn.payments.last if financial_txn.has_captured_payment?
+    end
+    payments
+  end
+
+  #params
+  #financial_txn
+  #cvv
+  #gateway_wrapper
+  #
+  #Optional
+  #gateway_options
+  #credit_card_to_use
+  def authorize(financial_txn, cvv, gateway_wrapper, gateway_options={}, credit_card_to_use=nil)
+    credit_card_to_use = self.credit_card unless credit_card_to_use
+    
+    gateway_options[:debug] = true
+    result = gateway_wrapper.authorize(credit_card_to_use, financial_txn.money.amount, cvv, gateway_options)
+
+    unless result[:payment].nil?
+      result[:payment].financial_txn = financial_txn
+      result[:payment].save
+      financial_txn.payments << result[:payment]
+      financial_txn.save
+    end
+
+    result
+  end
+
+  #params
+  #financial_txn
+  #cvv
+  #gateway_wrapper
+  #
+  #Optional
+  #gateway_options
+  #credit_card_to_use
+  def purchase(financial_txn, cvv, gateway_wrapper, gateway_options={}, credit_card_to_use=nil)
+    credit_card_to_use = self.credit_card unless credit_card_to_use
+    
+    gateway_options[:debug] = true
+    result = gateway_wrapper.purchase(credit_card_to_use, financial_txn.money.amount, cvv, gateway_options)
+
+    unless result[:payment].nil?
+      result[:payment].financial_txn = financial_txn
+      result[:payment].save
+      financial_txn.payments << result[:payment]
+      financial_txn.save
+    end
+
+    result
+  end
+
+  #params
+  #financial_txn
+  #cvv
+  #gateway_wrapper
+  #
+  #Optional
+  #gateway_options
+  #credit_card_to_use
+  def capture(financial_txn, cvv, gateway_wrapper, gateway_options={}, credit_card_to_use=nil)
+    credit_card_to_use = self.credit_card unless credit_card_to_use
+
+    result = {:success => true}
+    payment = Payment.find(:first, :order => 'created_at desc', :conditions => ["current_state = ? and success = ? and financial_txn_id = ?",'authorized', 1, financial_txn.id])
+    #only capture this payment if it was authorized
+    if !payment.nil? && payment.current_state.to_sym == :authorized
+      gateway_options[:debug] = true
+      result = gateway_wrapper.capture(credit_card_to_use, payment, cvv,gateway_options)
+    end
+    result
+  end
+  
+  #params
+  #financial_txn
+  #cvv
+  #gateway_wrapper
+  #
+  #Optional
+  #gateway_options
+  #credit_card_to_use
+  def reverse_authorization(financial_txn, cvv, gateway_wrapper, gateway_options={}, credit_card_to_use=nil)
+    credit_card_to_use = self.credit_card unless credit_card_to_use
+
+    result = {:success => true}
+    payment = Payment.find(:first, :order => 'created_at desc', :conditions => ["current_state = ? and success = ? and financial_txn_id = ?",'authorized', 1, financial_txn.id])
+    #only reverse this payment if it was authorized
+    if !payment.nil? && payment.current_state.to_sym == :authorized
+      gateway_options[:debug] = true
+
+      result = gateway_wrapper.full_reverse_of_authorization(credit_card_to_use, payment, cvv, gateway_options)
+    end
+    result
+  end
+
+  def void
+    # implement a void transaction of a transaction
+  end
+  
+  def refund
+    # implement a refund on a card
+  end
+
 end

data/app/models/credit_card_account_party_role.rb

@@ -1,8 +1,6 @@
 class CreditCardAccountPartyRole < ActiveRecord::Base
-  
-  belongs_to :credit_card_account, :class_name => "CreditCardAccount"
+  belongs_to :credit_card_account
   belongs_to :role_type
   belongs_to :party
-  has_one :credit_card, :class_name => "CreditCard", :dependent => :destroy
-  
+  belongs_to :credit_card
 end

data/app/models/extensions/financial_txn.rb

@@ -1,3 +1,4 @@
 FinancialTxn.class_eval do
-  has_many :payments  
+  has_many :payments
+  has_many :payment_applications, :dependent => :destroy
 end

data/app/models/extensions/party.rb

@@ -1,7 +1,7 @@
 Party.class_eval do
 
   #credit cards
-	has_many  :credit_card_account_party_roles
+	has_many :credit_card_account_party_roles, :dependent => :destroy
   
   # return primary credit card
   def primary_credit_card
@@ -17,5 +17,39 @@ Party.class_eval do
     end 
     return nil  
   end
-  
-end
+
+  def credit_card_accounts
+     self.accounts.where('biz_txn_acct_type = ?', 'CreditCardAccount').all.collect(&:account)
+  end
+
+  def bank_accounts
+     self.accounts.where('biz_txn_acct_type = ?', 'BankAccount').all.collect(&:account)
+  end
+
+  def payment_accounts
+    (bank_accounts | credit_card_accounts).flatten
+  end
+
+  ##
+  #Get payment accounts in a more useful format for 
+  #displaying in CSR, website, etc.
+  def payment_accounts_hash
+    cc_results = credit_card_accounts.map do |cca|
+      { id: cca.id,
+        description: cca.credit_card.description,
+        card_type: cca.credit_card.card_type,
+        last_four: nil, #not stored yet
+        exp_dt: "#{cca.credit_card.expiration_month}-#{cca.credit_card.expiration_year}",
+        account_type: 'Credit Card'}
+    end
+
+    ba_results = bank_accounts.map do |ba|
+      {id: ba.id,
+       description: ba.name_on_account,
+       routing_number: ba.routing_number,
+       account_type: 'Bank Account'}
+    end
+
+    (ba_results | cc_results).flatten
+  end
+end

data/app/models/payment.rb

@@ -1,7 +1,7 @@
 class Payment < ActiveRecord::Base
   include AASM
 
-  belongs_to :financial_txn
+  belongs_to :financial_txn, :dependent => :destroy
   has_many   :payment_gateways
 
   aasm_column :current_state
@@ -13,6 +13,11 @@ class Payment < ActiveRecord::Base
   aasm_state :authorized
   aasm_state :captured
   aasm_state :authorization_reversed
+  aasm_state :canceled
+
+  aasm_event :cancel do
+    transitions :to => :canceled, :from => [:pending]
+  end
 
   aasm_event :authorize do
       transitions :to => :authorized, :from => [:pending]
@@ -27,12 +32,10 @@ class Payment < ActiveRecord::Base
   end
 
   aasm_event :capture do
-      transitions :to => :captured, :from => [:authorized]
+      transitions :to => :captured, :from => [:authorized, :pending]
   end
 
   aasm_event :reverse_authorization do
       transitions :to => :authorization_reversed, :from => [:authorized]
   end
-
-  
-end
+end

data/app/views/checkout_mailer/email_confirmation.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  </head>
+  <body>
+    <h1>This is your confirmation</h1>
+    <p>Your order is complete.
+      <br/>Confirmation Number <%=@payment.authorization_code%>
+      <br/>Your order number is <%=@order.order_number%>
+      <br/>Your order status is <%=@order.status%>
+      <br/>Total for this order was <%=number_to_currency(@order.get_total_charges.sum{|money| money.amount})%>
+    </p>
+  </body>
+</html>

data/app/widgets/orders/base.rb

@@ -2,7 +2,7 @@ module Widgets
   module Orders
     class Base < ErpApp::Widgets::Base
       def index
-        @orders = OrderTxn.find_by_party_role('buyer', current_user.party)
+        @orders = OrderTxn.find_by_party_role('payor', current_user.party)
         @orders = @orders.select{|order| order.status != "Initialized"}
         render
       end
@@ -17,11 +17,7 @@ module Widgets
         def title
           "Orders"
         end
-
-        def views_location
-          File.join(File.dirname(__FILE__),"/views")
-        end
-
+        
         def widget_name
           File.basename(File.dirname(__FILE__))
         end

data/app/widgets/product_catalog/base.rb

@@ -32,10 +32,6 @@ module Widgets
         def title
           "Product Catalog"
         end
-
-        def views_location
-          File.join(File.dirname(__FILE__),"/views")
-        end
     
         def widget_name
           File.basename(File.dirname(__FILE__))

data/app/widgets/shopping_cart/base.rb

@@ -80,10 +80,11 @@ module Widgets
 
       def checkout_finalize
         @products_url = params[:products_url]
-        success, @message, @order = ErpCommerce::OrderHelper.new(self).complete_order(params)
+        success, @message, @order, @payment = ErpCommerce::OrderHelper.new(self).complete_order(params)
         set_total_price(@order)
 
         if success
+          CheckoutMailer.email_confirmation(self.current_user.party.billing_email_address.email_address, @order, @payment).deliver
           render :update => {:id => "#{@uuid}_result", :view => :confirmation}
         else
           render :update => {:id => "#{@uuid}_result", :view => :payment}
@@ -155,10 +156,6 @@ module Widgets
           "Shopping Cart"
         end
 
-        def views_location
-          File.join(File.dirname(__FILE__),"/views")
-        end
-
         def widget_name
           File.basename(File.dirname(__FILE__))
         end

data/app/widgets/shopping_cart/views/confirmation.html.erb

@@ -1,6 +1,7 @@
 <div id="<%=widget_result_id%>">
   <p>Your order is complete.
   <br/>Your should receive a confirmation email.
+  <br/>Confirmation Number <%=@payment.authorization_code%>
   <br/>Your order number is <%=@order.order_number%>
   </p>