erp_commerce 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4e6b6692526e51decb1e65fe0e0c8f144722105
-  data.tar.gz: 6c0d00362d5a6c460588775a8fe18eb22bc5ddc6
+  metadata.gz: 0a6407956b3a3bc60b5271fd3fa5f00682d0f7ac
+  data.tar.gz: 4124637d314b584201f71d652975e2c05729df26
 SHA512:
-  metadata.gz: d3289c22d87a6549677659a617b9f36777700c2510f2996453e3748f3db53a2fcd9f24a808842b8fe2181bc7531df340a57bc94db6c6f1d92ebd6caa44202041
-  data.tar.gz: bb1b935e104f9979aa6fc8b8729e4009f62d35b69e12340810af4354548392302e2b1e1f52c55cd6a63db9407fd44c8a8865bde77bb454c8c87397d5e9677eb4
+  metadata.gz: eb84968b78265e2ba95216c81a2f124b71d839be133d849857b810f1463f1fd4c85d7cb9afa2d12b1af141ee1dc2eecee74595bf682e7504d96dc112ddf8fef2
+  data.tar.gz: d3d8c59cde92c6c51e800fbb246aa236ced5c6daa37c876b568e4f11336db5e1c8bceb49789e4c5757e030333122928327f2b5e31555910cb3f65910383f2d03

data/README.md

@@ -8,6 +8,5 @@ To override these settings simple create a erp_commerce.rb file in your initiali
 
     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/models/accepted_credit_card.rb

@@ -1,3 +1,13 @@
+### Table Definition ###############################
+#  create_table :accepted_credit_cards do |t|
+#
+#    t.references :organization
+#    t.string :card_type
+#
+#    t.timestamps
+#  end
+###################################################
+
 class AcceptedCreditCard < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 

data/app/models/bank_account.rb

@@ -1,3 +1,16 @@
+### Table Definition ###############################
+#  create_table :bank_accounts do |t|
+#    t.string :routing_number
+#    t.string :crypted_private_account_number
+#    t.string :name_on_account
+#    t.references :bank_account_type
+#
+#    t.timestamps
+#  end
+#
+#  add_index :bank_accounts, :bank_account_type_id, :name => 'bank_accounts_account_type_idx'
+####################################################
+
 class BankAccount < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 

data/app/models/bank_account_type.rb

@@ -1,3 +1,12 @@
+### Table Definition ###############################
+#  create_table :bank_account_types do |t|
+#    t.string :description
+#    t.string :internal_identifier
+#
+#    t.timestamps
+#  end
+####################################################
+
 class BankAccountType < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 

data/app/models/credit_card.rb

@@ -1,13 +1,30 @@
+#### Table Definition ####################################
+#  create_table :credit_cards do |t|
+#
+#    t.column :crypted_private_card_number,       :string
+#    t.column :crypted_private_cvc,               :string
+#    t.column :expiration_month,                  :integer
+#    t.column :expiration_year,                   :integer
+#
+#    t.column :description,                       :string
+#    t.column :name_one_card,                     :string
+#    t.column :card_type,                         :string
+#
+#    t.column :postal_address_id,                 :integer
+#    t.column :credit_card_token,                 :string
+#
+#    t.timestamps
+#  end
+#########################################################
+
 class CreditCard < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 
-  require 'attr_encrypted'
-  
-  belongs_to  :postal_address
-  has_one     :credit_card_account_party_role, :dependent => :destroy
+  tracks_created_by_updated_by
+
+  belongs_to :postal_address
+  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.'}
@@ -15,13 +32,24 @@ class CreditCard < ActiveRecord::Base
 
   #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 => Rails.application.config.erp_commerce.encryption_key, :marshall => true, :attribute => :crypted_private_card_number
+  attr_encrypted :private_card_number, :key => Rails.application.config.erp_commerce.encryption_key, :attribute => :crypted_private_card_number
+  attr_encrypted :private_cvc, :key => Rails.application.config.erp_commerce.encryption_key, :attribute => :crypted_private_cvc
 
   # 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
   # painfully obvious when any coder is using the private_card_number, which should
   # be used only in limited circumstances.
 
+  #these two methods allow us to assign instance level attributes that are not persisted.  These are used for validators
+  def instance_attributes
+    @instance_attrs.nil? ? {} : @instance_attrs
+  end
+
+  def add_instance_attribute(k, v)
+    @instance_attrs = {} if @instance_attrs.nil?
+    @instance_attrs[k] = v
+  end
+
   def card_number
     if self.private_card_number
       CreditCard.mask_number(self.private_card_number)
@@ -30,29 +58,36 @@ class CreditCard < ActiveRecord::Base
     end
   end
 
-  # Note that the setter method allows the same variable to be set, and delegates through
-  # the encryption process
-  
+  def last_4
+    card_number[card_number.length-4..card_number.length]
+  end
+
+  def expires
+    "#{expiration_month}/#{expiration_year}"
+  end
+
+  def cvc=(cvc)
+    self.private_cvc=cvc
+  end
+
   def card_number=(num)
     self.private_card_number=num
   end
-  
+
   def to_label
     "#{card_type}:  #{card_number}"
   end
-  
+
   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
+    if self.credit_card_account_party_role
+      self.credit_card_account_party_role.party
+    end
   end
-  
+
   def before_create
     token = CreditCardToken.new
     self.credit_card_token = token.cc_token.strip
@@ -63,7 +98,7 @@ class CreditCard < ActiveRecord::Base
       'XXXX-XXXX-XXXX-' + number[number.length-4..number.length]
     end
   end
- 
+
 end
 
 

data/app/models/credit_card_account.rb

@@ -1,3 +1,9 @@
+### Table Definition ###############################
+#  create_table :credit_card_accounts do |t|
+#    t.timestamps
+#  end
+####################################################
+
 class CreditCardAccount < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 
@@ -34,7 +40,6 @@ class CreditCardAccount < ActiveRecord::Base
   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?
@@ -58,7 +63,6 @@ class CreditCardAccount < ActiveRecord::Base
   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?
@@ -71,6 +75,29 @@ class CreditCardAccount < ActiveRecord::Base
     result
   end
 
+  # purchase with credit card associated to this CreditCardAccount
+  def purchase_with_existing_card(financial_txn, gateway_wrapper, gateway_options={})
+    result = gateway_wrapper.purchase_with_existing_card(self.credit_card, financial_txn.money.amount, 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
+
+  # purchase with credit card associated to this CreditCardAccount
+  def refund(financial_txn, gateway_wrapper, gateway_options={}, amount=nil)
+    if amount.nil?
+      amount = financial_txn.money.amount
+    end
+
+    gateway_wrapper.refund(financial_txn.most_recent_payment, amount, gateway_options)
+  end
+
   #params
   #financial_txn
   #cvv
@@ -83,7 +110,7 @@ class CreditCardAccount < ActiveRecord::Base
     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])
+    payment = Payment.where("current_state = ? and success = ? and financial_txn_id = ?",'authorized', 1, financial_txn.id).order('created_at desc').first
     #only capture this payment if it was authorized
     if !payment.nil? && payment.current_state.to_sym == :authorized
       gateway_options[:debug] = true
@@ -104,7 +131,7 @@ class CreditCardAccount < ActiveRecord::Base
     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])
+    payment = Payment.where("current_state = ? and success = ? and financial_txn_id = ?",'authorized', 1, financial_txn.id).order('created_at desc').first
     #only reverse this payment if it was authorized
     if !payment.nil? && payment.current_state.to_sym == :authorized
       gateway_options[:debug] = true
@@ -118,10 +145,6 @@ class CreditCardAccount < ActiveRecord::Base
     # implement a void transaction of a transaction
   end
 
-  def refund
-    # implement a refund on a card
-  end
-
   #params
   #financial_txn
   #gateway_wrapper
@@ -134,7 +157,6 @@ class CreditCardAccount < ActiveRecord::Base
     credit_card_to_use = self.credit_card unless credit_card_to_use
     result = {:success => true}
 
-    gateway_options[:debug] = true
     if money_amount == nil
       money_amount = financial_txn.money.amount
     end

data/app/models/credit_card_account_party_role.rb

@@ -1,3 +1,20 @@
+### Table Definition #####################################
+#  create_table :credit_card_account_party_roles do |t|
+#    t.column :credit_card_account_id, :integer
+#    t.column :role_type_id,           :integer
+#    t.column :party_id,               :integer
+#    t.column :credit_card_id,         :integer
+#
+#    t.timestamps
+#  end
+#
+#  add_index :credit_card_account_party_roles, :credit_card_account_id
+#  add_index :credit_card_account_party_roles, :role_type_id
+#  add_index :credit_card_account_party_roles, :party_id
+#  add_index :credit_card_account_party_roles, :credit_card_id
+#
+##########################################################
+
 class CreditCardAccountPartyRole < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 

data/app/models/credit_card_account_purpose.rb

@@ -1,3 +1,27 @@
+### Table Definition #####################################
+#  create_table :credit_card_account_purposes do |t|
+#
+#    t.column  :parent_id,    :integer
+#    t.column  :lft,          :integer
+#    t.column  :rgt,          :integer
+#
+#    #custom columns go here
+#
+#    t.column  :description,         :string
+#    t.column  :comments,            :string
+#
+#    t.column 	:internal_identifier, :string
+#    t.column 	:external_identifier, :string
+#    t.column 	:external_id_source, 	:string
+#
+#    t.timestamps
+#  end
+#
+#  add_index :credit_card_account_purposes, :parent_id
+#  add_index :credit_card_account_purposes, :lft
+#  add_index :credit_card_account_purposes, :rgt
+#########################################################
+
 class CreditCardAccountPurpose < ActiveRecord::Base
   attr_protected :created_at, :updated_at
 

data/app/models/extensions/financial_txn.rb

@@ -1,4 +1,65 @@
 FinancialTxn.class_eval do
   has_many :payments
-  has_many :payment_applications, :dependent => :destroy
+
+  def has_captured_payment?
+    has_payments? and self.payments.last.current_state == 'captured'
+  end
+
+  def has_pending_payment?
+    has_payments? and self.payments.last.current_state == 'pending'
+  end
+
+  def is_pending?
+    self.is_scheduled? || self.has_pending_payment?
+  end
+
+  def is_scheduled?
+    ((self.apply_date > Date.today) or (!self.has_payments?))
+  end
+
+  def has_payments?
+    !self.payments.empty?
+  end
+
+  def most_recent_payment
+    Payment.order('created_at DESC').where('financial_txn_id = ?', self.id).first
+  end
+
+  def refund(gateway_wrapper, gateway_options={})
+    begin
+      ActiveRecord::Base.transaction do
+        # make sure we have payments and they are captured
+        if has_payments? && has_captured_payment?
+          result = {success: true}
+
+          if txn_type.internal_identifier == 'credit_card_payment'
+            result = CreditCardAccount.new.refund(self, gateway_wrapper, gateway_options)
+
+          else
+            payment = most_recent_payment
+            payment.refund
+            payment.save
+
+            result[:message] = 'Payment Refunded'
+          end
+
+          # if the refund was a success un-apply the payments
+          if result[:success]
+            payment_applications.each do |payment_application|
+              payment_application.unapply_payment
+            end
+          end
+
+          result
+
+        end
+      end
+    rescue => ex
+      Rails.logger.error(ex.message)
+      Rails.logger.error(ex.backtrace.join("\n"))
+
+      {success: false, message: 'Could not refund'}
+    end
+  end
+
 end

data/app/models/extensions/order_txn.rb

@@ -1,3 +1,51 @@
+# create_table :order_txns do |t|
+#   t.column    :state_machine,   		:string
+#   t.column    :description,     		:string
+#   t.column		:order_txn_type_id, 	:integer
+#
+#   # Multi-table inheritance info
+#   t.column    :order_txn_record_id,   :integer
+#   t.column    :order_txn_record_type, :string
+#
+#   # Contact Information
+#   t.column 		:email,              :string
+#   t.column 		:phone_number,       :string
+#
+#   # Shipping Address
+#   t.column 		:ship_to_first_name,     :string
+#   t.column 		:ship_to_last_name,      :string
+#   t.column 		:ship_to_address_line_1, :string
+#   t.column 		:ship_to_address_line_2, :string
+#   t.column 		:ship_to_city,           :string
+#   t.column    :ship_to_state,          :string
+#   t.column 		:ship_to_postal_code,    :string
+#   t.column 		:ship_to_country,        :string
+#
+#   # Billing Address
+#   t.column 		:bill_to_first_name,     :string
+#   t.column 		:bill_to_last_name,      :string
+#   t.column 		:bill_to_address_line_1, :string
+#   t.column 		:bill_to_address_line_2, :string
+#   t.column 		:bill_to_city,           :string
+#   t.column    :bill_to_state,          :string
+#   t.column 		:bill_to_postal_code,    :string
+#   t.column 		:bill_to_country,        :string
+#
+#   # Private parts
+#   t.column 		:customer_ip, 			    :string
+#   t.column    :order_number,          :integer
+#   t.column 		:status,                :string
+#   t.column 		:error_message, 		    :string
+#
+#   t.timestamps
+# end
+#
+# add_index :order_txns, :order_txn_type_id
+# add_index :order_txns, [:order_txn_record_id, :order_txn_record_type], :name => 'order_txn_record_idx'
+#
+# add_index :order_txns, :order_txn_type_id
+# add_index :order_txns, [:order_txn_record_id, :order_txn_record_type], :name => 'order_txn_record_idx'
+
 OrderTxn.class_eval do
   acts_as_priceable
 end

data/app/models/extensions/party.rb

@@ -1,8 +1,8 @@
 Party.class_eval do
 
   #credit cards
-	has_many :credit_card_account_party_roles, :dependent => :destroy
-  
+  has_many :credit_card_account_party_roles, :dependent => :destroy
+
   # return primary credit card
   def primary_credit_card
     return get_credit_card('primary')
@@ -10,20 +10,33 @@ Party.class_eval do
 
   # return credit card by credit card account purpose using internal identifier
   def get_credit_card(internal_identifier)
+    credit_card = nil
+
     self.credit_card_account_party_roles.each do |ccapr|
       if ccapr.credit_card_account.credit_card_account_purpose.internal_identifier.eql?(internal_identifier)
-        return ccapr.credit_card
+        credit_card = ccapr.credit_card
       end
-    end 
-    return nil  
+    end
+
+    credit_card
+  end
+
+  def credit_cards
+    credit_cards = []
+
+    self.credit_card_account_party_roles.each do |ccapr|
+      credit_cards << ccapr.credit_card
+    end
+
+    credit_cards
   end
 
   def credit_card_accounts
-     self.accounts.where('biz_txn_acct_type = ?', 'CreditCardAccount').all.collect(&:account)
+    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)
+    self.accounts.where('biz_txn_acct_type = ?', 'BankAccount').all.collect(&:account)
   end
 
   def payment_accounts
@@ -35,12 +48,12 @@ Party.class_eval do
   #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'}
+      {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|