Module: Elasticsearch::API::Utils
Overview
Generic utility methods
Instance Method Summary collapse
-
#__bulkify(payload) ⇒ Object
Convert an array of payloads into Elasticsearch ‘headerndata` format.
-
#__escape(string) ⇒ Object
private
URL-escape a string.
- #__extract_params(arguments, params = [], options = {}) ⇒ Object
-
#__extract_parts(arguments, valid_parts = []) ⇒ Array<String>
private
Extracts the valid parts of the URL from the arguments.
-
#__listify(*list) ⇒ Object
private
Create a “list” of values from arguments, ignoring nil values and encoding special characters.
-
#__pathify(*segments) ⇒ Object
private
Create a path (URL part) from arguments, ignoring nil values and empty strings.
- #__report_unsupported_method(name) ⇒ Object
- #__report_unsupported_parameters(arguments, params = []) ⇒ Object
-
#__rescue_from_not_found {|block| ... } ⇒ Object
private
Calls the given block, rescuing from ‘StandardError`.
-
#__validate_and_extract_params(arguments, params = [], options = {}) ⇒ Hash
private
Validates the argument Hash against common and valid API parameters.
- #__validate_params(arguments, valid_params = []) ⇒ Object
Instance Method Details
#__bulkify(payload) ⇒ Object
Convert an array of payloads into Elasticsearch ‘headerndata` format
Supports various different formats of the payload: Array of Strings, Header/Data pairs, or the conveniency “combined” format where data is passed along with the header in a single item.
Elasticsearch::API::Utils.__bulkify [
{ :index => { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
{ :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } }
]
# => {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}}
# => {"title":"Test"}
# => {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
# => {"doc":{"title":"Update"}}
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 |
# File 'lib/elasticsearch/api/utils.rb', line 83 def __bulkify(payload) operations = %w[index create delete update] case # Hashes with `:data` when payload.any? { |d| d.is_a?(Hash) && d.values.first.is_a?(Hash) && operations.include?(d.keys.first.to_s) && (d.values.first[:data] || d.values.first['data']) } payload = payload. inject([]) do |sum, item| operation, = item.to_a.first = .clone data = .delete(:data) || .delete('data') sum << { operation => } sum << data if data sum end. map { |item| Elasticsearch::API.serializer.dump(item) } payload << '' unless payload.empty? # Array of strings when payload.all? { |d| d.is_a? String } payload << '' # Header/Data pairs else payload = payload.map { |item| Elasticsearch::API.serializer.dump(item) } payload << '' end payload = payload.join("\n") end |
#__escape(string) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
URL-escape a string
15 16 17 18 |
# File 'lib/elasticsearch/api/utils.rb', line 15 def __escape(string) return string if string == '*' defined?(EscapeUtils) ? EscapeUtils.escape_url(string.to_s) : CGI.escape(string.to_s) end |
#__extract_params(arguments, params = [], options = {}) ⇒ Object
159 160 161 162 163 164 |
# File 'lib/elasticsearch/api/utils.rb', line 159 def __extract_params(arguments, params=[], ={}) result = arguments.select { |k,v| COMMON_QUERY_PARAMS.include?(k) || params.include?(k) } result = Hash[result] unless result.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour result = Hash[result.map { |k,v| v.is_a?(Array) ? [k, __listify(v, )] : [k,v] }] # Listify Arrays result end |
#__extract_parts(arguments, valid_parts = []) ⇒ Array<String>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Mutates the ‘arguments` argument, to prevent failures in `__validate_and_extract_params`.
Extracts the valid parts of the URL from the arguments
182 183 184 185 186 187 188 |
# File 'lib/elasticsearch/api/utils.rb', line 182 def __extract_parts(arguments, valid_parts=[]) parts = Hash[arguments.select { |k,v| valid_parts.include?(k) }] parts = parts.reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v } arguments.delete_if { |k,v| valid_parts.include? k } return parts end |
#__listify(*list) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Create a “list” of values from arguments, ignoring nil values and encoding special characters.
35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/elasticsearch/api/utils.rb', line 35 def __listify(*list) = list.last.is_a?(Hash) ? list.pop : {} escape = [:escape] Array(list). flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }. flatten. compact. map { |e| escape == false ? e : __escape(e) }. join(',') end |
#__pathify(*segments) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Create a path (URL part) from arguments, ignoring nil values and empty strings.
# @example Encode special characters
__pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam'
59 60 61 62 63 64 65 |
# File 'lib/elasticsearch/api/utils.rb', line 59 def __pathify(*segments) Array(segments).flatten. compact. reject { |s| s.to_s.strip.empty? }. join('/'). squeeze('/') end |
#__report_unsupported_method(name) ⇒ Object
253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/elasticsearch/api/utils.rb', line 253 def __report_unsupported_method(name) = "[!] You are using unsupported method [#{name}]" if source = caller && caller.last += " in `#{source}`" end += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release. Suppress this warning by the `-WO` command line flag." if STDERR.tty? Kernel.warn "\e[31;1m#{}\e[0m" else Kernel.warn end end |
#__report_unsupported_parameters(arguments, params = []) ⇒ Object
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 |
# File 'lib/elasticsearch/api/utils.rb', line 211 def __report_unsupported_parameters(arguments, params=[]) = [] unsupported_params = params.select {|d| d.is_a?(Hash) ? arguments.include?(d.keys.first) : arguments.include?(d) } unsupported_params.each do |param| name = case param when Symbol param when Hash param.keys.first else raise ArgumentError, "The param must be a Symbol or a Hash" end explanation = if param.is_a?(Hash) ". #{param.values.first[:explanation]}." else ". This parameter is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release." end = "[!] You are using unsupported parameter [:#{name}]" if source = caller && caller.last += " in `#{source}`" end += explanation << end unless .empty? << "Suppress this warning by the `-WO` command line flag." if STDERR.tty? Kernel.warn .map { |m| "\e[31;1m#{m}\e[0m" }.join("\n") else Kernel.warn .join("\n") end end end |
#__rescue_from_not_found {|block| ... } ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Calls the given block, rescuing from ‘StandardError`.
Primary use case is the ‘:ignore` parameter for API calls.
Returns ‘false` if exception contains NotFound in its class name or message, else re-raises the exception.
201 202 203 204 205 206 207 208 209 |
# File 'lib/elasticsearch/api/utils.rb', line 201 def __rescue_from_not_found(&block) yield rescue StandardError => e if e.class.to_s =~ /NotFound/ || e. =~ /Not\s*Found/i false else raise e end end |
#__validate_and_extract_params(arguments, params = [], options = {}) ⇒ Hash
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Validates the argument Hash against common and valid API parameters
143 144 145 146 147 148 149 150 |
# File 'lib/elasticsearch/api/utils.rb', line 143 def __validate_and_extract_params(arguments, params=[], ={}) if [:skip_parameter_validation] || Elasticsearch::API.settings[:skip_parameter_validation] arguments else __validate_params(arguments, params) __extract_params(arguments, params, .merge(:escape => false)) end end |
#__validate_params(arguments, valid_params = []) ⇒ Object
152 153 154 155 156 157 |
# File 'lib/elasticsearch/api/utils.rb', line 152 def __validate_params(arguments, valid_params=[]) arguments.each do |k,v| raise ArgumentError, "URL parameter '#{k}' is not supported" \ unless COMMON_PARAMS.include?(k) || COMMON_QUERY_PARAMS.include?(k) || valid_params.include?(k) end end |