Module: Octobat::Util

Defined in:
lib/octobat/util.rb

Class Method Summary collapse

Class Method Details

.convert_to_octobat_object(resp, api_key, parent_resource = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/octobat/util.rb', line 83

def self.convert_to_octobat_object(resp, api_key, parent_resource = nil)
  case resp
  when Array
    resp.map { |i| convert_to_octobat_object(i, api_key, parent_resource) }
  when Hash
    # Try converting to a known object class.  If none available, fall back to generic OctobatObject
    obj = object_classes.fetch(resp[:object], OctobatObject).construct_from(resp, api_key)
    obj.parent_obj = parent_resource if parent_resource && obj.respond_to?(:parent_obj)
    obj
  else
    resp
  end
end

.expand_nested_objects(h) ⇒ Object 



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

def self.expand_nested_objects(h)
  case h
  when Hash
    res = {}
    h.each { |k, v| res[k] = expand_nested_objects(v) unless v.nil? }
    res
  when Array
    if !h.empty? && h.first.is_a?(Hash)
      res = {'' => h.map{|v| expand_nested_objects(v)}}
    else
      res = h
    end
    res
  else
    h
  end
end

.file_readable(file) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/octobat/util.rb', line 97

def self.file_readable(file)
  # This is nominally equivalent to File.readable?, but that can
  # report incorrect results on some more oddball filesystems
  # (such as AFS)
  begin
    File.open(file) { |f| }
  rescue
    false
  else
    true
  end
end

.flatten_params(params, parent_key = nil) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/octobat/util.rb', line 130

def self.flatten_params(params, parent_key=nil)
  result = []
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
    if value.is_a?(Hash)
      result += flatten_params(value, calculated_key)
    elsif value.is_a?(Array)
      result += flatten_params_array(value, calculated_key)
    else
      result << [calculated_key, value]
    end
  end
  result
end

.flatten_params_array(value, calculated_key) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/octobat/util.rb', line 145

def self.flatten_params_array(value, calculated_key)
  result = []
  value.each do |elem|
    if elem.is_a?(Hash)
      result += flatten_params(elem, calculated_key)
    elsif elem.is_a?(Array)
      result += flatten_params_array(elem, calculated_key)
    else
      result << ["#{calculated_key}[]", elem]
    end
  end
  result
end

.object_classes ⇒ Object 



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

def self.object_classes
  @object_classes ||= {
    # data structures
    'list' => ListObject,

    # business objects
    'payment_recipient' => PaymentRecipient,
    'payment_recipient_reference' => PaymentRecipientReference,
    'payment_source' => PaymentSource,
    'invoice_numbering_sequence' => InvoiceNumberingSequence,
    'credit_note_numbering_sequence' => CreditNoteNumberingSequence,
    'invoice' => Invoice,
    'credit_note' => CreditNote,
    'item' => Item,
    'purchase_item' => PurchaseItem,
    'customer' => Customer,
    'customer_balance_transaction' => CustomerBalanceTransaction,
    'supplier' => Supplier,
    'self_billing_invoice' => SelfBillingInvoice,
    'payout' => Payout,
    'balance_transaction' => BalanceTransaction,
    'document_template' => DocumentTemplate,
    'document_language' => DocumentLanguage,
    'checkout' => Checkout,
    'coupon' => Coupon,
    'order' => Order,
    'product' => Product,
    'proforma_invoice' => ProformaInvoice,
    'tax_region_setting' => TaxRegionSetting,
    'tax_id' => TaxId,
    'transaction' => Transaction,
    'tax_evidence' => TaxEvidence,
    'tax_evidence_request' => TaxEvidenceRequest,
    'document_email_template' => DocumentEmailTemplate,
    'exports_setting' => ExportsSetting,
    'document' => Document,
    'emails_setting' => EmailsSetting,
    'subscription' => Subscription,
    'usage_item' => UsageItem,
    'file' => FileUpload,
    'file_link' => FileLink,
    'beanie.session' => Beanie::Session,
    'reporting.report_type' => Reporting::ReportType,
    'reporting.report_run' => Reporting::ReportRun
  }
end

.objects_to_ids(h) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/octobat/util.rb', line 21

def self.objects_to_ids(h)
  case h
  when APIResource
    h.id
  when Hash
    res = {}
    h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
    res
  when Array
    h.map { |v| objects_to_ids(v) }
  else
    h
  end
end

.parse_opts(opts) ⇒ Object

The secondary opts argument can either be a string or hash Turn this value into an api_key and a set of headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/octobat/util.rb', line 161

def self.parse_opts(opts)
  case opts
  when NilClass
    return nil, {}
  when String
    return opts, {}
  when Hash
    headers = opts.clone
    headers.delete(:api_key)

    if opts[:idempotency_key]
      headers[:idempotency_key] = opts[:idempotency_key]
    end
    if opts[:octobat_account]
      headers[:octobat_account] = opts[:octobat_account]
    end
    return opts[:api_key], headers
  else
    raise TypeError.new("parse_opts expects a string or a hash")
  end
end

.symbolize_names(object) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/octobat/util.rb', line 110

def self.symbolize_names(object)
  case object
  when Hash
    new_hash = {}
    object.each do |key, value|
      key = (key.to_sym rescue key) || key
      new_hash[key] = symbolize_names(value)
    end
    new_hash
  when Array
    object.map { |value| symbolize_names(value) }
  else
    object
  end
end

.url_encode(key) ⇒ Object 



126
127
128
 
# File 'lib/octobat/util.rb', line 126

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