module Elasticsearch::API::Utils
Generic utility methods
Public Instance Methods
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"}}
# File lib/elasticsearch/api/utils.rb, line 99 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, meta = item.to_a.first meta = meta.clone data = meta.delete(:data) || meta.delete('data') sum << { operation => meta } 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
URL-escape a string
@example
__escape('foo/bar') # => 'foo%2Fbar' __escape('bar^bam') # => 'bar%5Ebam'
@api private
# File lib/elasticsearch/api/utils.rb, line 31 def __escape(string) return string if string == '*' ERB::Util.url_encode(string.to_s) end
Extracts the valid parts of the URL from the arguments
@note Mutates the ‘arguments` argument, to prevent failures in `__validate_and_extract_params`.
@param arguments [Hash] Hash of arguments to verify and extract, **with symbolized keys** @param valid_parts [Array<Symbol>] An array of symbol with valid keys
@return [Array<String>] Valid parts of the URL as an array of strings
@example Extract parts
__extract_parts { :foo => true }, [:foo, :bar] # => [:foo]
@api private
# File lib/elasticsearch/api/utils.rb, line 153 def __extract_parts(arguments, valid_parts=[]) Hash[arguments].reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v } end
Create a “list” of values from arguments, ignoring nil values and encoding special characters.
@example Create a list from array
__listify(['A','B']) # => 'A,B'
@example Create a list from arguments
__listify('A','B') # => 'A,B'
@example Escape values
__listify('foo','bar^bam') # => 'foo,bar%5Ebam'
@example Do not escape the values
__listify('foo','bar^bam', escape: false) # => 'foo,bar^bam'
@api private
# File lib/elasticsearch/api/utils.rb, line 51 def __listify(*list) options = list.last.is_a?(Hash) ? list.pop : {} escape = options[:escape] Array(list). flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }. flatten. compact. map { |e| escape == false ? e : __escape(e) }. join(',') end
Create a path (URL part) from arguments, ignoring nil values and empty strings.
@example Create a path from array
__pathify(['foo', '', nil, 'bar']) # => 'foo/bar'
@example Create a path from arguments
__pathify('foo', '', nil, 'bar') # => 'foo/bar'
# @example Encode special characters
__pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam'
@api private
# File lib/elasticsearch/api/utils.rb, line 75 def __pathify(*segments) Array(segments).flatten. compact. reject { |s| s.to_s.strip.empty? }. join('/'). squeeze('/') end
# File lib/elasticsearch/api/utils.rb, line 220 def __report_unsupported_method(name) message = "[!] You are using unsupported method [#{name}]" if source = caller && caller.last message += " in `#{source}`" end message += ". 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#{message}\e[0m" else Kernel.warn message end end
# File lib/elasticsearch/api/utils.rb, line 178 def __report_unsupported_parameters(arguments, params=[]) messages = [] 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 message = "[!] You are using unsupported parameter [:#{name}]" if source = caller && caller.last message += " in `#{source}`" end message += explanation messages << message end unless messages.empty? messages << "Suppress this warning by the `-WO` command line flag." if STDERR.tty? Kernel.warn messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n") else Kernel.warn messages.join("\n") end end end
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.
@yield [block] A block of code to be executed with exception handling.
@api private
# File lib/elasticsearch/api/utils.rb, line 168 def __rescue_from_not_found(&block) yield rescue StandardError => e if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found/i false else raise e end end
# File lib/elasticsearch/api/utils.rb, line 132 def process_params(arguments) arguments = Hash[arguments] unless arguments.is_a?(Hash) Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, __listify(v, { escape: false })] : [k, v] }] # Listify Arrays end