Class: FriendlyShipping::Services::ShipEngine::ParseLabelResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/friendly_shipping/services/ship_engine/parse_label_response.rb

Overview

Parses the labels API response.

Class Method Summary collapse

Class Method Details

.call(request:, response:) ⇒ ApiResult<Array<Label>] the parsed labels (ShipEngine only returns one label at a time)

Returns ApiResult] the parsed labels (ShipEngine only returns one label at a time).

Parameters:

  • request (Request) —

    the request to attach to the API result

  • response (Response) —

    the response to parse

Returns:

  • (ApiResult<Array<Label>] the parsed labels (ShipEngine only returns one label at a time)) —

    ApiResult] the parsed labels (ShipEngine only returns one label at a time)



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/friendly_shipping/services/ship_engine/parse_label_response.rb', line 11

def self.call(request:, response:)
  parsed_json = JSON.parse(response.body)

  label_uri_string = parsed_json['label_download']['href']
  label_data = nil
  label_url = nil
  if label_uri_string.starts_with?('data')
    # This URI has the following form:
    # data:application/zpl;base64,XlhBDQpeTEwxMjE4....
    # We don't know the content type here, but we can assume Base64
    # encoding.
    # This next line splits the URI at the first occurrence of ";base64,",
    # giving us the desired base64 encoded string.
    _, base64_encoded = label_uri_string.split(";base64,", 2)
    label_data = Base64.decode64(base64_encoded)
  else
    label_url = label_uri_string
  end

  currency = parsed_json.dig('shipment_cost', 'currency')
  cents = parsed_json.dig('shipment_cost', 'amount') * 100
  shipment_cost = Money.new(cents, currency)

  label = FriendlyShipping::Label.new(
    id: parsed_json['label_id'],
    shipment_id: parsed_json['shipment_id'],
    tracking_number: parsed_json['tracking_number'],
    service_code: parsed_json['service_code'],
    label_href: label_url,
    label_data: label_data,
    label_format: parsed_json['label_format'].to_sym,
    shipment_cost: shipment_cost,
    cost: shipment_cost,
    data: parsed_json
  )

  ApiResult.new([label], original_request: request, original_response: response)
end