erp_orders 3.0.0

data/app/models/order_txn.rb

@@ -0,0 +1,381 @@
+class OrderTxn < ActiveRecord::Base
+  acts_as_biz_txn_event
+
+	belongs_to :order_txn_record, :polymorphic => true, :dependent => :destroy
+  has_many   :order_line_items, :dependent => :destroy
+  has_many   :charge_lines, :as => :charged_item
+
+	alias :line_items :order_line_items
+
+  # validation
+  validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :update, :allow_nil => true
+
+  #find a order by given biz txn party role iid and party
+  def self.find_by_party_role(biz_txn_party_role_type_iid, party)
+    biz_txn_party_roles = BizTxnPartyRole.find(
+      :all,
+      :conditions => ['party_id = ? and biz_txn_party_role_type_id = ?', party.id, BizTxnPartyRoleType.find_by_internal_identifier(biz_txn_party_role_type_iid).id])
+
+    biz_txn_party_roles.collect{|item| item.biz_txn_event.biz_txn_record}
+  end
+
+  # get the total charges for an order.
+  # The total will be returned as Money.
+  # There may be multiple Monies assocated with an order, such as points and
+  # dollars. To handle this, the method should return an array of Monies
+  #
+  def get_total_charges
+    # get all of the charge lines associated with the order and order_lines
+    total_hash = Hash.new
+    all_charges = get_all_charge_lines
+    # loop through all of the charges and combine charges for each money type
+    all_charges.each do |charge|
+      cur_money = charge.money
+      cur_total = total_hash[cur_money.currency.internal_identifier]
+      if (cur_total.nil?)
+        cur_total = cur_money.clone
+      else
+        cur_total.amount = 0 if cur_total.amount.nil?
+        cur_total.amount += cur_money.amount if !cur_money.amount.nil?
+      end
+      total_hash[cur_money.currency.internal_identifier] = cur_total
+    end
+    return total_hash.values
+  end
+
+  #get all charge lines on order and order line items
+  def get_all_charge_lines
+    all_charges = []
+    all_charges.concat(charge_lines)
+    order_line_items.each do |line_item|
+      all_charges.concat(line_item.charge_lines)
+    end
+    all_charges
+  end
+
+  def submit
+    #Template Method
+  end
+
+  #add product_type or product_instance line item
+  def add_line_item(object, reln_type = nil, to_role = nil, from_role = nil)
+    class_name = object.class.name
+    if object.is_a?(Array)
+	    class_name = object.first.class.name
+	  else
+	    class_name = object.class.name
+	  end
+
+	  case class_name
+    when 'ProductType'
+      return add_product_type_line_item(object, reln_type, to_role, from_role)
+    when 'ProductInstance'
+      return add_product_instance_line_item(object, reln_type, to_role, from_role)
+	  end
+  end
+
+	def add_product_type_line_item(product_type, reln_type = nil, to_role = nil, from_role = nil)
+
+    li = OrderLineItem.new
+
+    if(product_type.is_a?(Array))
+      if (product_type.size == 0)
+        return
+      elsif (product_type.size == 1)
+        product_type_for_line_item = product_type[0]
+      else # more than 1 in the array, so it's a package
+        product_type_for_line_item = ProductType.new
+        product_type_for_line_item.description = to_role.description
+
+        product_type.each do |product|
+          # make a product-type-reln
+          reln = ProdTypeReln.new
+          reln.prod_type_reln_type = reln_type
+          reln.role_type_id_from = from_role.id
+          reln.role_type_id_to = to_role.id
+
+          #associate package on the "to" side of reln
+          reln.prod_type_to = product_type_for_line_item
+
+          #assocation product_type on the "from" side of the reln
+          reln.prod_type_from = product
+          reln.save
+        end
+      end
+    else
+      product_type_for_line_item = product_type
+    end
+
+    li.product_type = product_type_for_line_item
+    self.line_items << li
+    li.save
+    return li
+	end
+
+  def add_product_instance_line_item(product_instance, reln_type = nil, to_role = nil, from_role = nil)
+
+    li = OrderLineItem.new
+
+    if(product_instance.is_a?(Array))
+      if (product_instance.size == 0)
+        return
+      elsif (product_instance.size == 1)
+        product_instance_for_line_item = product_instance[0]
+      else # more than 1 in the array, so it's a package
+        product_instance_for_line_item = ProductInstance.new
+        product_instance_for_line_item.description = to_role.description
+        product_instance_for_line_item.save
+
+        product_instance.each do |product|
+          # make a product-type-reln
+          reln = ProdInstanceReln.new
+          reln.prod_instance_reln_type = reln_type
+          reln.role_type_id_from = from_role.id
+          reln.role_type_id_to = to_role.id
+
+          #associate package on the "to" side of reln
+          reln.prod_instance_to = product_instance_for_line_item
+
+          #assocation product_instance on the "from" side of the reln
+          reln.prod_instance_from = product
+          reln.save
+        end
+      end
+    else
+      product_instance_for_line_item = product_instance
+    end
+
+    li.product_instance = product_instance_for_line_item
+    self.line_items << li
+    li.save
+    return li
+  end
+
+  def find_party_by_role(role_type_iid)
+    party = nil
+
+    tpr = self.root_txn.biz_txn_party_roles.find(:first, :include => :biz_txn_party_role_type, :conditions => ['biz_txn_party_role_types.internal_identifier = ?',role_type_iid])
+    party = tpr.party unless tpr.nil?
+
+    party
+  end
+
+  def set_shipping_info(party)
+    self.ship_to_first_name = party.business_party.current_first_name
+    self.ship_to_last_name = party.business_party.current_last_name
+    shipping_address = party.find_contact_with_purpose(PostalAddress, ContactPurpose.shipping) || party.find_contact_with_purpose(PostalAddress, ContactPurpose.default)
+    unless shipping_address.nil?
+      shipping_address = shipping_address.contact_mechanism
+      self.ship_to_address_line_1 = shipping_address.address_line_1
+      self.ship_to_address_line_2 = shipping_address.address_line_2
+      self.ship_to_city = shipping_address.city
+      self.ship_to_state = shipping_address.state
+      self.ship_to_postal_code = shipping_address.zip
+      #self.ship_to_country_name = shipping_address.country_name
+      #self.ship_to_country = shipping_address.country
+    end
+  end
+
+  def set_billing_info(party)
+    self.email = party.find_contact_mechanism_with_purpose(EmailAddress, ContactPurpose.billing).email_address unless party.find_contact_mechanism_with_purpose(EmailAddress, ContactPurpose.billing).nil?
+    self.phone_number = party.find_contact_mechanism_with_purpose(PhoneNumber, ContactPurpose.billing).phone_number unless party.find_contact_mechanism_with_purpose(PhoneNumber, ContactPurpose.billing).nil?
+
+    self.bill_to_first_name = party.business_party.current_first_name
+    self.bill_to_last_name = party.business_party.current_last_name
+    billing_address = party.find_contact_with_purpose(PostalAddress, ContactPurpose.billing) || party.find_contact_with_purpose(PostalAddress, ContactPurpose.default)
+    unless billing_address.nil?
+      billing_address = billing_address.contact_mechanism
+      self.bill_to_address_line_1 = billing_address.address_line_1
+      self.bill_to_address_line_2 = billing_address.address_line_2
+      self.bill_to_city = billing_address.city
+      self.bill_to_state = billing_address.state
+      self.bill_to_postal_code = billing_address.zip
+      #self.bill_to_country_name = billing_address.country_name
+      #self.bill_to_country = billing_address.country
+    end
+  end
+
+  def determine_txn_party_roles
+    #Template Method
+  end
+
+  def determine_charge_elements
+    #Template Method
+  end
+
+  def determine_charge_accounts
+    #Template Method
+  end
+
+  ###############################################################################
+  #BizTxnEvent Overrides
+  ###############################################################################
+  def create_dependent_txns
+	  #Template Method
+	end
+
+  ################################################################
+  ################################################################
+  # Payment methods
+  # these methods are used to capture payments on orders
+  ################################################################
+  ################################################################
+
+  def authorize_payments(financial_txns, credit_card, gateway, gateway_options={}, use_delayed_jobs=true)
+    all_txns_authorized = true
+    authorized_txns = []
+    gateway_message = nil
+
+    #check if we are using delayed jobs or not
+    unless use_delayed_jobs
+      financial_txns.each do |financial_txn|
+        financial_txn.authorize(credit_card, gateway, gateway_options)
+        if financial_txn.payments.empty?
+          all_txns_authorized = false
+          gateway_message = 'Unknown Gateway Error'
+          break
+        elsif !financial_txn.payments.first.success
+          all_txns_authorized = false
+          gateway_message = financial_txn.payments.first.payment_gateways.first.response
+          break
+        else
+          authorized_txns << financial_txn
+        end
+      end
+    else
+      financial_txns.each do |financial_txn|
+        #push into delayed job so we can fire off more payments if needed
+        ErpTxnsAndAccts::DelayedJobs::PaymentGatewayJob.start(financial_txn, gateway, :authorize, gateway_options, credit_card)
+      end
+      #wait till all payments are complete
+      #wait a max of 120 seconds 2 minutes
+      wait_counter = 0
+      while !all_payment_jobs_completed?(financial_txns, :authorized)
+        break if wait_counter == 40
+        sleep 3
+        wait_counter += 1
+      end
+
+      result, gateway_message, authorized_txns = all_payment_jobs_successful?(financial_txns)
+
+      unless result
+        all_txns_authorized = false
+      end
+    end
+    return all_txns_authorized, authorized_txns, gateway_message
+  end
+
+  def capture_payments(authorized_txns, credit_card, gateway, gateway_options={}, use_delayed_jobs=true)
+    all_txns_captured = true
+    gateway_message = nil
+
+    #check if we are using delayed jobs or not
+    unless use_delayed_jobs
+      authorized_txns.each do |financial_txn|
+        result = financial_txn.capture(credit_card, gateway, gateway_options)
+        unless(result[:success])
+          all_txns_captured = false
+          gateway_message   = result[:gateway_message]
+          break
+        end
+      end
+    else
+      authorized_txns.each do |financial_txn|
+        #push into delayed job so we can fire off more payments if needed
+        ErpTxnsAndAccts::DelayedJobs::PaymentGatewayJob.start(financial_txn, gateway, :capture, gateway_options, credit_card)
+      end
+
+      #wait till all payments are complete
+      #wait a max of 120 seconds 2 minutes
+      wait_counter = 0
+      while !all_payment_jobs_completed?(authorized_txns, :captured)
+        break if wait_counter == 40
+        sleep 3
+        wait_counter += 1
+      end
+
+      result, gateway_message, authorized_txns = all_payment_jobs_successful?(authorized_txns)
+
+      unless result
+        all_txns_captured = false
+      end
+    end
+
+    return all_txns_captured, gateway_message
+  end
+
+  def rollback_authorizations(authorized_txns, credit_card, gateway, gateway_options={}, use_delayed_jobs=true)
+    all_txns_rolledback = true
+
+    #check if we are using delayed jobs or not
+    unless use_delayed_jobs
+      authorized_txns.each do |financial_txn|
+        result = financial_txn.reverse_authorization(credit_card, gateway, gateway_options)
+        unless(result[:success])
+          all_txns_rolledback = false
+        end
+      end
+    else
+      authorized_txns.each do |financial_txn|
+        #push into delayed job so we can fire off more payments if needed
+        ErpTxnsAndAccts::DelayedJobs::PaymentGatewayJob.start(financial_txn, gateway, :reverse_authorization, gateway_options, credit_card)
+      end
+
+      #wait till all payments are complete
+      #wait a max of 120 seconds 2 minutes
+      wait_counter = 0
+      while !all_payment_jobs_completed?(authorized_txns, :authorization_reversed)
+        break if wait_counter == 40
+        sleep 3
+        wait_counter += 1
+      end
+
+      result, gateway_message, authorized_txns = all_payment_jobs_successful?(authorized_txns)
+
+      unless result
+        all_txns_rolledback = false
+      end
+    end
+
+    all_txns_rolledback
+  end
+
+  def all_payment_jobs_completed?(financial_txns, state)
+    result = true
+
+    #check the financial txns as they come back
+    financial_txns.each do |financial_txn|
+      payments = financial_txn.payments(true)
+      if payments.empty? || payments.first.current_state.to_sym != state
+        result = false
+        break
+      end
+    end
+
+    result
+  end
+
+  def all_payment_jobs_successful?(financial_txns)
+    result = true
+    message = nil
+    authorized_txns = []
+
+    #check the financial txns to see all were successful, if not get message
+    financial_txns.each do |financial_txn|
+      payments = financial_txn.payments(true)
+      if payments.empty? || !payments.first.success
+        result = false
+        unless payments.empty?
+          message = financial_txn.payments.first.payment_gateways.first.response
+        else
+          message = "Unknown Protobase Error"
+        end
+      else
+        authorized_txns << financial_txn
+      end
+    end
+
+    return result, message, authorized_txns
+  end
+
+end

data/app/models/order_txn_type.rb

@@ -0,0 +1,4 @@
+class OrderTxnType < ActiveRecord::Base
+  acts_as_nested_set
+  include ErpTechSvcs::Utils::DefaultNestedSetMethods
+end

data/app/views/layouts/erp_orders/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ErpOrders</title>
+  <%= stylesheet_link_tag    "erp_orders/application" %>
+  <%= javascript_include_tag "erp_orders/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,14 @@
+ErpOrders::Engine.routes.draw do
+  #Desktop Applications
+  #
+  #order_manager
+  match '/erp_app/desktop/order_manager(/:action(/:id))' => 'erp_app/desktop/order_manager/base'
+
+
+  #Organizer Applications
+  #
+  #order_management
+  match '/erp_app/organizer/order_management(/:action(/:id))' => 'erp_app/organizer/order_management/base'
+end
+
+

data/db/data_migrations/20110605231556_create_order_party_roles.rb

@@ -0,0 +1,23 @@
+class CreateOrderPartyRoles
+  
+  def self.up
+    order_roles = BizTxnPartyRoleType.create(
+      :description => 'Order Roles',
+      :internal_identifier => 'order_roles'
+    )
+
+    buyor_role = BizTxnPartyRoleType.create(
+      :description => 'Payor',
+      :internal_identifier => 'payor'
+    )
+
+    buyor_role.move_to_child_of(order_roles)
+    buyor_role.save
+  end
+  
+  def self.down
+    BizTxnPartyRoleType.find_by_internal_identifier('payor').destroy
+    BizTxnPartyRoleType.find_by_internal_identifier('order_roles').destroy
+  end
+
+end

data/db/data_migrations/20110728201731_create_desktop_app_order_manager.rb

@@ -0,0 +1,25 @@
+class CreateDesktopAppOrderManager
+  def self.up
+    app = DesktopApplication.create(
+      :description => 'Orders',
+      :icon => 'icon-package',
+      :javascript_class_name => 'Compass.ErpApp.Desktop.Applications.OrderManager',
+      :internal_identifier => 'order_manager',
+      :shortcut_id => 'order_manager-win'
+    )
+    
+    pt = PreferenceType.iid('desktop_shortcut')
+    pt.preferenced_records << app
+    pt.save
+
+    pt = PreferenceType.iid('autoload_application')
+    pt.preferenced_records << app
+    pt.save
+
+    app.save
+  end
+
+  def self.down
+    DesktopApplication.destroy_all(:conditions => ['internal_identifier = ?','hello_world'])
+  end
+end

data/db/data_migrations/20110728201732_create_organizer_app_order_management.rb

@@ -0,0 +1,14 @@
+class CreateOrganizerAppOrderManagement
+  def self.up
+    OrganizerApplication.create(
+      :description => 'Orders',
+      :icon => 'icon-package',
+      :javascript_class_name => 'Compass.ErpApp.Organizer.Applications.OrderManagement.Base',
+      :internal_identifier => 'order_management'
+    )
+  end
+
+  def self.down
+    OrganizerApplication.destroy_all(:conditions => ['internal_identifier = ?','order_management'])
+  end
+end

data/db/migrate/20080805000060_base_orders.rb

@@ -0,0 +1,175 @@
+class BaseOrders < ActiveRecord::Migration
+  def self.up
+    
+    unless table_exists?(:order_txns)
+      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 
+		    # MTI implemented using Rails' polymorphic associations    
+		    # 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
+		    # Private parts 
+		    t.column 		:customer_ip, 			    :string 
+		    t.column    :order_number,          :integer
+		    t.column 		:status,                :string 
+		    t.column 		:error_message, 		    :string
+		    t.column    :order_txn_record_id,   :integer
+		    t.column    :order_txn_record_type, :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'
+    end
+    
+    unless table_exists?(:order_txn_types)
+      create_table :order_txn_types 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 :order_txn_types, :parent_id
+    end
+    
+
+    unless table_exists?(:order_line_items)
+      create_table :order_line_items do |t|
+        t.column  	:order_txn_id,      		        :integer
+        t.column  	:order_line_item_type_id,       :integer
+        t.column  	:product_id,      			        :integer
+        t.column  	:product_description,		        :string
+        t.column    :product_instance_id,           :integer
+        t.column    :product_instance_description,  :string
+        t.column    :product_type_id,               :integer
+        t.column    :product_type_description,      :string
+        t.column  	:sold_price, 				            :float
+        t.column	  :sold_price_uom, 			          :integer
+        t.column  	:sold_amount, 				          :integer
+        t.column    :sold_amount_uom, 		          :integer
+        t.column    :product_offer_id,      	      :integer
+        t.timestamps
+      end
+
+      add_index :order_line_items, :order_txn_id
+      add_index :order_line_items, :order_line_item_type_id
+      add_index :order_line_items, :product_id
+      add_index :order_line_items, :product_instance_id
+      add_index :order_line_items, :product_type_id
+      add_index :order_line_items, :product_offer_id
+    end
+    
+    unless table_exists?(:order_line_item_types)
+      create_table :order_line_item_types 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 :order_line_item_types, :parent_id
+    end
+    
+    unless table_exists?(:order_line_item_pty_roles)
+      create_table :order_line_item_pty_roles do |t|
+        t.column  :description,               :string 
+        t.column  :order_line_item_id,      	:integer  
+        t.column  :party_id,                  :integer    
+        t.column  :line_item_role_type_id,    :integer
+        t.column  :biz_txn_acct_root_id,      :integer 	#optional for splitting orders across accounts
+        t.timestamps
+      end
+
+      add_index :order_line_item_pty_roles, :order_line_item_id
+      add_index :order_line_item_pty_roles, :party_id
+      add_index :order_line_item_pty_roles, :line_item_role_type_id
+      add_index :order_line_item_pty_roles, :biz_txn_acct_root_id
+    end
+        
+    unless table_exists?(:line_item_role_types)
+      create_table :line_item_role_types 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 :line_item_role_types, :parent_id
+    end
+    
+    unless table_exists?(:charge_lines)
+      create_table :charge_lines do |t|
+        t.string      :sti_type
+        t.references  :money
+        t.string      :description     #could be expanded to include type information, etc.
+        t.string      :external_identifier
+        t.string      :external_id_source
+        
+        #polymorphic
+        t.references :charged_item, :polymorphic => true
+
+        t.timestamps
+      end
+
+      add_index :charge_lines, [:charged_item_id, :charged_item_type], :name => 'charged_item_idx'
+    end
+    
+    unless table_exists?(:charge_line_payment_txns)
+      create_table :charge_line_payment_txns do |t|
+        t.column :charge_line_id, :integer
+        
+        #polymorphic
+        t.references :payment_txn, :polymorphic => true
+
+        t.timestamps
+      end
+
+      add_index :charge_line_payment_txns, [:payment_txn_id, :payment_txn_type], :name => 'payment_txn_idx'
+      add_index :charge_line_payment_txns, :charge_line_id
+    end
+  end
+
+  def self.down
+    [
+      :charge_lines, :charge_line_payment_txns, :line_item_role_types, :order_line_item_pty_roles,
+      :order_line_item_types, :order_line_items, :order_txn_types, 
+      :order_txns
+    ].each do |tbl|
+      if table_exists?(tbl)
+        drop_table tbl
+      end
+    end    
+  end
+  
+end

data/db/migrate/20110602194707_update_order_txn_ship_to_bill_to.rb

@@ -0,0 +1,25 @@
+class UpdateOrderTxnShipToBillTo < ActiveRecord::Migration
+  def self.up
+    unless columns(:order_txns).collect {|c| c.name}.include?('bill_to_address_line_1')
+      rename_column :order_txns, :bill_to_address, :bill_to_address_line_1
+      add_column :order_txns, :bill_to_address_line_2, :string
+    end
+
+    unless columns(:order_txns).collect {|c| c.name}.include?('ship_to_address_line_1')
+      rename_column :order_txns, :ship_to_address, :ship_to_address_line_1
+      add_column :order_txns, :ship_to_address_line_2, :string
+    end
+  end
+
+  def self.down
+    if columns(:order_txns).collect {|c| c.name}.include?('bill_to_address_line_1')
+      rename_column :order_txns, :bill_to_address_line_1, :bill_to_address
+      remove_column :order_txns, :bill_to_address_line_2
+    end
+
+    if columns(:order_txns).collect {|c| c.name}.include?('ship_to_address_line_1')
+      rename_column :order_txns, :ship_to_address_line_1, :ship_to_address
+      remove_column :order_txns, :ship_to_address_line_2
+    end
+  end
+end

data/lib/erp_orders/engine.rb

@@ -0,0 +1,13 @@
+module ErpOrders
+  class Engine < Rails::Engine
+    isolate_namespace ErpOrders
+    
+    initializer "erp_orders_assets.merge_public" do |app|
+      app.middleware.insert_before Rack::Lock, ::ActionDispatch::Static, "#{root}/public"
+    end
+	  
+	  ActiveSupport.on_load(:active_record) do
+      include ErpOrders::Extensions::ActiveRecord::ActsAsOrderTxn
+    end
+  end
+end