Module: EasyPost::Util

Defined in:
lib/easypost/util.rb

Class Method Summary collapse

Class Method Details

.convert_to_easypost_object(response, api_key, parent = nil, name = nil) ⇒ Object 



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
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
 
# File 'lib/easypost/util.rb', line 18

def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
  types = {
    'Address' => Address,
    'ScanForm' => ScanForm,
    'CustomsItem' => CustomsItem,
    'CustomsInfo' => CustomsInfo,
    'Parcel' => Parcel,
    'Shipment' => Shipment,
    'Rate' => Rate,
    'Refund' => Refund,
    'Event' => Event,
    'Batch' => Batch,
    'Tracker' => Tracker,
    'Item' => Item,
    'Insurance' => Insurance,
    'Order' => Order,
    'Pickup' => Pickup,
    'PickupRate' => PickupRate,
    'PostageLabel' => PostageLabel,
    'Printer' => Printer,
    'PrintJob' => PrintJob,
    'CarrierAccount' => CarrierAccount,
    'User' => User,
    'Report' => Report,
    'ShipmentReport' => Report,
    'PaymentLogReport' => Report,
    'TrackerReport' => Report,
    'Webhook' => Webhook
  }

  prefixes = {
    'adr' => Address,
    'sf' => ScanForm,
    'cstitem' => CustomsItem,
    'cstinfo' => CustomsInfo,
    'prcl' => Parcel,
    'shp' => Shipment,
    'rate' => Rate,
    'rfnd' => Refund,
    'evt' => Event,
    'batch' => Batch,
    'trk' => Tracker,
    'item' => Item,
    'ins' => Insurance,
    'order' => Order,
    'pickup' => Pickup,
    'pickuprate' => PickupRate,
    'pl' => PostageLabel,
    'printer' => Printer,
    'printjob' => PrintJob,
    'ca' => CarrierAccount,
    'user' => User,
    'shprep' => Report,
    'plrep' => Report,
    'trkrep' => Report,
    'hook' => Webhook
  }

  case response
  when Array
    return response.map { |i| convert_to_easypost_object(i, api_key, parent) }
  when Hash
    if cls_name = response[:object]
      cls = types[cls_name]
    elsif response[:id]
      if response[:id].index('_').nil?
        cls = EasyPostObject
      elsif cls_prefix = response[:id][0..response[:id].index('_')]
        cls = prefixes[cls_prefix[0..-2]]
      end
    elsif response['id']
      if response['id'].index('_').nil?
        cls = EasyPostObject
      elsif cls_prefix = response['id'][0..response['id'].index('_')]
        cls = prefixes[cls_prefix[0..-2]]
      end
    end

    cls ||= EasyPostObject
    return cls.construct_from(response, api_key, parent, name)
  else
    return response
  end
end

.flatten_params(params, parent_key = nil) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/easypost/util.rb', line 123

def self.flatten_params(params, parent_key=nil)
  result = []
  if params.is_a?(Hash)
    params.each do |k, v|
      calculated_key = parent_key ? "#{parent_key}[#{url_encode(k)}]" : url_encode(k)
      if v.is_a?(Hash) or v.is_a?(Array)
        result += flatten_params(v, calculated_key)
      else
        result << [calculated_key, v]
      end
    end
  elsif params.is_a?(Array)
    params.each_with_index do |v, i|
      calculated_key = parent_key ? "#{parent_key}[#{i}]" : i
      if v.is_a?(Hash) or v.is_a?(Array)
        result += flatten_params(v, calculated_key)
      else
        result << [calculated_key, v]
      end
    end
  end
  return result
end

.objects_to_ids(obj) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/easypost/util.rb', line 3

def self.objects_to_ids(obj)
  case obj
  when Resource
    return {:id => obj.id}
  when Hash
    result = {}
    obj.each { |k, v| result[k] = objects_to_ids(v) unless v.nil? }
    return result
  when Array
    return obj.map { |v| objects_to_ids(v) }
  else
    return obj
  end
end

.symbolize_names(obj) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/easypost/util.rb', line 103

def self.symbolize_names(obj)
  case obj
  when Hash
    result = {}
    obj.each do |k, v|
      k = (k.to_sym rescue k) || k
      obj[k] = symbolize_names(v)
    end
    return result
  when Array
    return obj.map { |v| symbolize_names(v) }
  else
    return obj
  end
end

.url_encode(key) ⇒ Object 



119
120
121
 
# File 'lib/easypost/util.rb', line 119

def self.url_encode(key)
  URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
end