Class: OrderTxn

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/order_txn.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.find_by_party_role(biz_txn_party_role_type_iid, party) ⇒ Object

find a order by given biz txn party role iid and party



16
17
18
 
# File 'app/models/order_txn.rb', line 16

def self.find_by_party_role(biz_txn_party_role_type_iid, party)
  BizTxnPartyRole.where('party_id = ? and biz_txn_party_role_type_id = ?', party.id, BizTxnPartyRoleType.find_by_internal_identifier(biz_txn_party_role_type_iid).id).all.collect{|item| item.biz_txn_event.biz_txn_record}
end

Instance Method Details

#add_line_item(object, reln_type = nil, to_role = nil, from_role = nil) ⇒ Object

add product_type or product_instance line item



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'app/models/order_txn.rb', line 59

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

#add_product_instance_line_item(product_instance, reln_type = nil, to_role = nil, from_role = nil) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'app/models/order_txn.rb', line 113

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

#add_product_type_line_item(product_type, reln_type = nil, to_role = nil, from_role = nil) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'app/models/order_txn.rb', line 75

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

#all_payment_jobs_completed?(financial_txns, state) ⇒ Boolean

Returns:

  • (Boolean) 


341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'app/models/order_txn.rb', line 341

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

#all_payment_jobs_successful?(financial_txns) ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'app/models/order_txn.rb', line 356

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

#authorize_payments(financial_txns, credit_card, gateway, gateway_options = {}, use_delayed_jobs = true) ⇒ Object

Payment methods these methods are used to capture payments on orders



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'app/models/order_txn.rb', line 222

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

#capture_payments(authorized_txns, credit_card, gateway, gateway_options = {}, use_delayed_jobs = true) ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'app/models/order_txn.rb', line 266

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

#create_dependent_txns ⇒ Object

BizTxnEvent Overrides



211
212
213
 
# File 'app/models/order_txn.rb', line 211

def create_dependent_txns
  #Template Method
end

#determine_charge_accounts ⇒ Object 



204
205
206
 
# File 'app/models/order_txn.rb', line 204

def determine_charge_accounts
  #Template Method
end

#determine_charge_elements ⇒ Object 



200
201
202
 
# File 'app/models/order_txn.rb', line 200

def determine_charge_elements
  #Template Method
end

#determine_txn_party_roles ⇒ Object 



196
197
198
 
# File 'app/models/order_txn.rb', line 196

def determine_txn_party_roles
  #Template Method
end

#find_party_by_role(role_type_iid) ⇒ Object 



152
153
154
155
156
157
158
159
 
# File 'app/models/order_txn.rb', line 152

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

#get_all_charge_lines ⇒ Object

get all charge lines on order and order line items



45
46
47
48
49
50
51
52
 
# File 'app/models/order_txn.rb', line 45

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

#get_total_charges ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app/models/order_txn.rb', line 25

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

#rollback_authorizations(authorized_txns, credit_card, gateway, gateway_options = {}, use_delayed_jobs = true) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'app/models/order_txn.rb', line 305

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

#set_billing_info(party) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'app/models/order_txn.rb', line 177

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

#set_shipping_info(party) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'app/models/order_txn.rb', line 161

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

#submit ⇒ Object 



54
55
56
 
# File 'app/models/order_txn.rb', line 54

def submit
  #Template Method
end