Module: Mirakl::Util

Defined in:
lib/mirakl/util.rb

Constant Summary collapse

OPTS_USER_SPECIFIED =

Options that a user is allowed to specify.

Set[
  :api_key,
].freeze
OPTS_COPYABLE =

Options that should be copyable from one StripeObject to another including options that may be internal.

(
  OPTS_USER_SPECIFIED + Set[:api_base]
).freeze
OPTS_PERSISTABLE =

Options that should be persisted between API requests. This includes client, which is an object containing an HTTP client to reuse.

(
  OPTS_USER_SPECIFIED + Set[:client]
).freeze

Class Method Summary collapse

Class Method Details

.check_api_key!(key) ⇒ Object

Raises:

  • (TypeError) 


166
167
168
169
 
# File 'lib/mirakl/util.rb', line 166

def self.check_api_key!(key)
  raise TypeError, "api_key must be a string" unless key.is_a?(String)
  key
end

.check_string_argument!(key) ⇒ Object

Raises:

  • (TypeError) 


161
162
163
164
 
# File 'lib/mirakl/util.rb', line 161

def self.check_string_argument!(key)
  raise TypeError, "argument must be a string" unless key.is_a?(String)
  key
end

.convert_to_mirakl_object(data, opts = {}) ⇒ Object

Converts a hash of fields or an array of hashes into a MiraklObject or array of MiraklObjects.

Attributes

  • data - Hash of fields and values to be converted into a MiraklObject.

  • opts - Options for MiraklObject like an API key that will be reused on subsequent API calls.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mirakl/util.rb', line 33

def self.convert_to_mirakl_object(data, opts = {})
  opts = normalize_opts(opts)

  case data
  when Array
    data.map { |i| convert_to_mirakl_object(i, opts) }
  when Hash
    data
    # Try converting to a known object class.  If none available, fall back
    # to generic StripeObject
    # MiraklObject.construct_from(data, opts)
  else
    data
  end
end

.encode_parameters(params) ⇒ Object

Encodes a hash of parameters in a way that’s suitable for use as query parameters in a URI or as form parameters in a request body. This mainly involves escaping special characters from parameter keys and values (e.g. ‘&`).



98
99
100
101
 
# File 'lib/mirakl/util.rb', line 98

def self.encode_parameters(params)
  Util.flatten_params(params)
      .map { |k, v| "#{url_encode(k)}=#{url_encode(v)}" }.join("&")
end

.flatten_params(params, parent_key = nil) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/mirakl/util.rb', line 114

def self.flatten_params(params, parent_key = nil)
  result = []

  # do not sort the final output because arrays (and arrays of hashes
  # especially) can be order sensitive, but do sort incoming parameters
  params.each do |key, value|
    calculated_key = parent_key ? "#{parent_key}[#{key}]" : key.to_s
    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 



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/mirakl/util.rb', line 133

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

.log_debug(message, data = {}) ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/mirakl/util.rb', line 66

def self.log_debug(message, data = {})
  if !Mirakl.logger.nil? ||
     !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_DEBUG
    log_internal(message, data, color: :blue, level: Mirakl::LEVEL_DEBUG,
                                logger: Mirakl.logger, out: $stdout)
  end
end

.log_error(message, data = {}) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/mirakl/util.rb', line 50

def self.log_error(message, data = {})
  if !Mirakl.logger.nil? ||
     !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_ERROR
    log_internal(message, data, color: :cyan, level: Mirakl::LEVEL_ERROR,
                                logger: Mirakl.logger, out: $stderr)
  end
end

.log_info(message, data = {}) ⇒ Object 



58
59
60
61
62
63
64
 
# File 'lib/mirakl/util.rb', line 58

def self.log_info(message, data = {})
  if !Mirakl.logger.nil? ||
     !Mirakl.log_level.nil? && Mirakl.log_level <= Mirakl::LEVEL_INFO
    log_internal(message, data, color: :cyan, level: Mirakl::LEVEL_INFO,
                                logger: Mirakl.logger, out: $stdout)
  end
end

.normalize_headers(headers) ⇒ Object

Normalizes header keys so that they’re all lower case and each hyphen-delimited section starts with a single capitalized letter. For example, ‘request-id` becomes `Request-Id`. This is useful for extracting certain key values when the user could have set them with a variety of diffent naming schemes.



176
177
178
179
180
181
182
183
 
# File 'lib/mirakl/util.rb', line 176

def self.normalize_headers(headers)
  headers.each_with_object({}) do |(k, v), new_headers|
    k = k.to_s.tr("_", "-") if k.is_a?(Symbol)
    k = k.split("-").reject(&:empty?).map(&:capitalize).join("-")

    new_headers[k] = v
  end
end

.normalize_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



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/mirakl/util.rb', line 149

def self.normalize_opts(opts)
  case opts
  when String
    { api_key: opts }
  when Hash
    check_api_key!(opts.fetch(:api_key)) if opts.key?(:api_key)
    opts.clone
  else
    raise TypeError, "normalize_opts expects a string or a hash"
  end
end

.symbolize_names(object) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mirakl/util.rb', line 74

def self.symbolize_names(object)
  case object
  when Hash
    new_hash = {}
    object.each do |key, value|
      key = (begin
               key.to_sym
             rescue StandardError
               key
             end) || 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

Encodes a string in a way that makes it suitable for use in a set of query parameters in a URI or in a set of form parameters in a request body.



106
107
108
109
110
111
112
 
# File 'lib/mirakl/util.rb', line 106

def self.url_encode(key)
  CGI.escape(key.to_s).
    # Don't use strict form encoding by changing the square bracket control
    # characters back to their literals. This is fine by the server, and
    # makes these parameter strings easier to read.
    gsub("%5B", "[").gsub("%5D", "]")
end