Class: Zanders::Order

Inherits:
SoapClient show all
Defined in:
lib/zanders/order.rb

Constant Summary

Constants inherited from SoapClient

SoapClient::NAMESPACES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

connect

Constructor Details

#initialize(options = {}) ⇒ Order

Public: Initialize a new Order

options - Hash of username, password, and address information

Returns an Order service interface



26
27
28
29
30
31
32
33
34
 
# File 'lib/zanders/order.rb', line 26

def initialize(options = {})
  requires!(options, :username, :password)

  @username = options[:username]
  @password = options[:password]
  @testing  = options.fetch(:testing, false)

  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Order Service

Return Codes 0: Success 1: Username and/or Password were incorrect 2: There was a problem creating the order 5: Cannot create order with no items 9: Order not created because all items not available and not to be back ordered 10: Ship date cannot be before today 11: Ship date cannoy be more than 30days in the future 21: The order number is NOT connected to your customer number 31: Can NOT add item with quantity of less than 1 41: The item number requested is NOT connected to this order



19
20
21
 
# File 'lib/zanders/order.rb', line 19

def options
  @options
end

#password ⇒ Object (readonly)

Order Service

Return Codes 0: Success 1: Username and/or Password were incorrect 2: There was a problem creating the order 5: Cannot create order with no items 9: Order not created because all items not available and not to be back ordered 10: Ship date cannot be before today 11: Ship date cannoy be more than 30days in the future 21: The order number is NOT connected to your customer number 31: Can NOT add item with quantity of less than 1 41: The item number requested is NOT connected to this order



19
20
21
 
# File 'lib/zanders/order.rb', line 19

def password
  @password
end

#username ⇒ Object (readonly)

Order Service

Return Codes 0: Success 1: Username and/or Password were incorrect 2: There was a problem creating the order 5: Cannot create order with no items 9: Order not created because all items not available and not to be back ordered 10: Ship date cannot be before today 11: Ship date cannoy be more than 30days in the future 21: The order number is NOT connected to your customer number 31: Can NOT add item with quantity of less than 1 41: The item number requested is NOT connected to this order



19
20
21
 
# File 'lib/zanders/order.rb', line 19

def username
  @username
end

Instance Method Details

#create_order(items, address, purchase_order_number, details = {}) ⇒ Object

Public: Create a new order

items - Array of hashes containing item_number and quantity address - Hash of address purchase_order - internal identifier for the order

Returns an order_number



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
112
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
151
152
153
154
155
 
# File 'lib/zanders/order.rb', line 43

def create_order(items, address, purchase_order_number, details = {})
  order = build_order_data
  order_items   = Array.new
  order[:order] = Hash.new
  shipping_information = Array.new

  items.each do |item|
    order_items.push(item: [
      {
        key: 'itemNumber',
        value: item[:item_number],
        attributes!: { key: { 'xsi:type' => 'xsd:string' }, value: { 'xsi:type' => 'xsd:string' } }
      }, {
        key: 'quantity',
        value: item[:quantity],
        attributes!: { key: { 'xsi:type' => 'xsd:string' }, value: { 'xsi:type' => 'xsd:string' } }
      }, {
        key: 'allowBackOrder',
        value: false,
        attributes!: { key: { 'xsi:type' => 'xsd:string' }, value: { 'xsi:type' => 'xsd:boolean' } }
      }
    ])
  end

  shipping_code = case @options[:account]
  when :accessory
    'UM'
  when :firearm
    'UG'
  when :default
    'BW'
  end

  shipping_information.push(*[
    { key: 'shipDate', value: Time.now.strftime("%Y-%m-%d") },
    { key: 'shipViaCode', value: shipping_code },
    { key: 'purchaseOrderNumber', value: purchase_order_number }
  ])

  if address == nil
    shipping_information.push({key: 'shipToNo', value: '0001'})
  elsif address[:fflno].present?
    ship_to_number = Zanders::Address.ship_to_number(address, @options)

    if ship_to_number[:success]
      shipping_information.push({key: 'shipToNo', value: ship_to_number[:ship_to_number] })
    else
      return { success: false, error_code: ship_to_number[:error_code], error_message: ship_to_number[:error_message] }
    end
  else
    shipping_information.push(*[
      { key: 'shipToName',     value: address[:name]     },
      { key: 'shipToAddress1', value: address[:address1] },
      { key: 'shipToAddress2', value: address[:address2] },
      { key: 'shipToCity',     value: address[:city]     },
      { key: 'shipToState',    value: address[:state]    },
      { key: 'shipToZip',      value: address[:zip]      }
    ])
  end

  if details[:name]
    shipping_information.push(
      { key: 'shipInstructions', value: format_shipping_instructions(details[:name], details[:phone_number]) }
    )
  end

  order[:order][:item] = shipping_information

  # NOTE-david
  # order(ns2 map)
  #   item
  #     key
  #     value(ns2map)
  #       item  - order item
  #       item  - order item
  #   item
  #     "
  #
  order_items = {item: order_items, attributes!: { item: { "xsi:type" => "ns2:Map"} }}

  order[:order][:item].push({
    key: 'items',
    value: order_items,
    attributes!: {
      key: {
        "xsi:type" => "xsd:string"
      },
      value: {
        "enc:itemType"  => "ns2:Map[#{order_items.count}]",
        "enc:arraySize" => order_items.count.to_s,
        "xsi:type"      => "enc:Array"
      }
    }
  })

  soap_response = soap_client(ORDER_API_URL).call(:create_order, message: order)
  hash = soap_response.body[:create_order_response][:return][:item]

  if hash.first[:value] == "0"
    {
      success:       true,
      order_number:  hash.find { |h| h[:key] == 'orderNumber' }&.dig(:value),
      removed_items: hash.find { |h| h[:key] == 'removedItems' }&.dig(:value, :item),
      raw_xml:       soap_response.to_xml
    }
  else
    {
      success:       false,
      error_code:    hash.first[:value],
      error_message: hash.last[:value]
    }
  end
end

#get_order(order_number) ⇒ Object

Public: Get order info

order_number - The String order number

Returns Hash containing order information, or an error code if the call failed



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/zanders/order.rb', line 163

def get_order(order_number)
  order = build_order_data.merge({ ordernumber: order_number })

  response = soap_client(ORDER_API_URL).call(:get_order_info, message: order)
  response = response.body[:get_order_info_response][:return][:item]

  # Successful call return_code is 0
  if response.first[:value] == "0"
    info = Hash.new

    # Just use the order number we already have
    info[:order_number] = order_number

    # Transform the response into a ruby-ish hash
    response.each do |part|
      case part[:key]
      when "purchaseOrderNumber"
        info[:purchase_order_number] = part[:value]
      when "orderDate"
        info[:order_date] = part[:value]
      when "orderEnteredDate"
        info[:ordered_entered_date] = part[:value]
      when "orderShipDate"
        info[:order_ship_date] = part[:value]
      when "subtotal"
        info[:subtotal] = part[:value]
      when "freight"
        info[:freight] = part[:value]
      when "miscFee"
        info[:misc_fee] = part[:value]
      when "selectionCode"
        info[:selection_code] = part[:value]
      when "datePicked"
        info[:date_picked] = part[:value]
      when "grandTotal"
        info[:grand_total] = part[:value]
      end
    end

    info[:success] = true

    info
  else
    { success: false, error_code: response.first[:value] }
  end
end

#get_shipments(order_number) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
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
 
# File 'lib/zanders/order.rb', line 210

def get_shipments(order_number)
  order = build_order_data.merge({ ordernumber: { "@xsi:type" => "xsd:string", :content! => order_number } })

  response = soap_client(ORDER_API_URL).call(:get_tracking_info, message: order)
  response = response.body[:get_tracking_info_response][:return][:item]

  if response.first[:value] == "0"
    info = { shipments: [] }

    info[:number_of_shipments] = response.find { |i| i[:key] == "numberOfShipments" }[:value].to_i

    if info[:number_of_shipments] > 0
      tracking_numbers = response.find { |i| i[:key] == "trackingNumbers" }[:value]

      if info[:number_of_shipments] == 1
        shipment_list = [tracking_numbers[:item]]
      elsif info[:number_of_shipments] > 1
        shipment_list = tracking_numbers[:item]
      end

      shipment_list.each do |part|
        part = part[:item]
        shipment = Hash.new

        part.each do |datum|
          case datum[:key]
          when 'shipCompany'
            shipment[:company] = datum[:value]
          when 'shipVia'
            shipment[:via] = datum[:value]
          when 'trackingNumber'
            shipment[:tracking_number] = datum[:value]
          when 'url'
            shipment[:url] = datum[:value]
          end
        end

        info[:shipments] << shipment
      end

      info[:success] = true
      return info
    else
      { success: false, error_code: response.first[:value], error_message: "No present tracking information" }
    end
  else
    { success: false, error_code: response.first[:value] }
  end
end