elastics-client 1.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 by Domizio Demichelis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# elastics-client
+
+[![Gem Version](https://badge.fury.io/rb/elastics-client.png)](http://badge.fury.io/rb/elastics-client)
+
+Provides the core infrastructure and the lower level functionality:
+
+* HTTP clients
+* elasticsearch API methods
+* Templating System
+* Cascading Variables Management
+* Result Extenders
+* Logging & Debugging
+* Self-documenting tool
+* Rake Tasks
+
+## Links
+
+- __Gem-Specific Documentation__
+  - [elastics-client](http://elastics.github.io/elastics/doc/2-elastics-client)
+
+## Credits
+
+Special thanks for their sponsorship to [Escalate Media](http://www.escalatemedia.com) and [Barquin International](http://www.barquin.com).
+
+## Copyright
+
+Copyright (c) 2012-2013 by [Domizio Demichelis](mailto://dd.nexus@gmail.com)<br>
+See [LICENSE](https://github.com/elastics/elastics/blob/master/elastics-client/LICENSE) for details.

data/VERSION

@@ -0,0 +1 @@
+1.0.4

data/elastics-client.gemspec

@@ -0,0 +1,33 @@
+require 'date'
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.name                      = 'elastics-client'
+  s.summary                   = 'Client gem for elasticsearch'
+  s.description               = 'Core gem used by all the elastics gems.'
+  s.homepage                  = 'http://elastics.github.io/elastics'
+  s.authors                   = ['Domizio Demichelis']
+  s.email                     = 'dd.nexus@gmail.com'
+  s.require_paths             = %w[lib]
+  s.files                     = `git ls-files -z`.split("\0")
+  s.version                   = version
+  s.date                      = Date.today.to_s
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rdoc_options              = %w[--charset=UTF-8]
+  s.license                   = 'MIT'
+  s.post_install_message      = <<EOM
+________________________________________________________________________________
+
+                             ELASTICS INSTALLATION NOTES
+________________________________________________________________________________
+
+New Documentation:  http://elastics.github.io/elastics
+
+Upgrading Tutorial: http://elastics.github.io/elastics/doc/7-Tutorials/2-Migrate-from-0.x.html
+
+________________________________________________________________________________
+EOM
+  s.add_runtime_dependency     'multi_json',  '>= 1.3.4'
+  s.add_runtime_dependency     'progressbar', '>= 0.11.0', '~> 0.12.0'
+  s.add_runtime_dependency     'dye',         '~> 0.1.4'
+end

data/lib/elastics.rb

@@ -0,0 +1,108 @@
+require 'dye'
+require 'yaml'
+require 'ostruct'
+require 'erb'
+require 'multi_json'
+require 'elastics/logger'
+require 'elastics/errors'
+require 'elastics/utils'
+
+require 'elastics/struct/prunable'
+require 'elastics/struct/symbolize'
+require 'elastics/struct/hash'
+require 'elastics/struct/array'
+
+require 'elastics/variables'
+
+require 'elastics/result'
+require 'elastics/struct/paginable'
+require 'elastics/result/document'
+require 'elastics/result/search'
+require 'elastics/result/multi_get'
+require 'elastics/result/bulk'
+
+require 'elastics/template/common'
+require 'elastics/template/partial'
+require 'elastics/template/logger'
+require 'elastics/template'
+require 'elastics/template/search'
+require 'elastics/template/slim_search'
+require 'elastics/template/tags'
+
+require 'elastics/class_proxy/base'
+require 'elastics/class_proxy/templates/search'
+require 'elastics/class_proxy/templates/doc'
+
+require 'elastics/class_proxy/templates'
+
+require 'elastics/templates'
+
+require 'elastics/http_clients/base'
+require 'elastics/http_clients/loader'
+require 'elastics/configuration'
+require 'elastics/utility_methods'
+
+require 'progressbar'
+require 'elastics/prog_bar'
+require 'elastics/deprecation'
+
+require 'elastics/api_stubs'
+require 'elastics/tasks'
+
+module Elastics
+
+  VERSION   = File.read(File.expand_path('../../VERSION', __FILE__)).strip
+  LIB_PATHS = [ File.dirname(__FILE__) ]
+
+
+  include ApiStubs
+
+  include Templates
+  elastics.load_source File.expand_path('../elastics/api_templates/core_api.yml'   , __FILE__)
+  elastics.load_source File.expand_path('../elastics/api_templates/indices_api.yml', __FILE__)
+  elastics.load_source File.expand_path('../elastics/api_templates/cluster_api.yml', __FILE__)
+
+  extend self
+  extend UtilityMethods
+
+  elastics.wrap :post_bulk_string, :bulk do |*vars|
+    vars = Vars.new(*vars)
+    return if vars[:bulk_string].nil? || vars[:bulk_string].empty?
+    super vars
+  end
+
+  # get a document without using the get API (which doesn't support fields '*')
+  elastics.wrap :search_by_id do |*vars|
+    vars   = Vars.new(*vars)
+    result = super(vars)
+    doc    = result['hits']['hits'].first
+    class << doc; self end.class_eval do
+      define_method(:raw_result){ result }
+    end
+    doc
+  end
+
+  # support for live-reindex
+  elastics.wrap :store, :put_store, :post_store do |*vars|
+    vars         = Vars.new(*vars)
+    vars[:index] = LiveReindex.prefix_index(vars[:index]) if LiveReindex.should_prefix_index?
+    result = super(vars)
+    if LiveReindex.should_track_change?
+      vars.delete(:data)
+      LiveReindex.track_change(:index, dump_one(vars))
+    end
+    result
+  end
+
+  # support for live-reindex
+  elastics.wrap :delete, :remove do |*vars|
+    vars         = Vars.new(*vars)
+    vars[:index] = LiveReindex.prefix_index(vars[:index]) if LiveReindex.should_prefix_index?
+    if LiveReindex.should_track_change?
+      vars.delete(:data)
+      LiveReindex.track_change(:delete, dump_one(vars))
+    end
+    super(vars)
+  end
+
+end

data/lib/elastics/api_stubs.rb

@@ -0,0 +1,1268 @@
+module Elastics
+  module ApiStubs
+
+    # The following lines are autogenerated by Elastics.doc
+
+    ######################## Core API ########################
+
+    #  ########## Elastics.store ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  store:
+    #  - PUT
+    #  - /<<index>>/<<type>>/<<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.store :id    => id,    # required
+    #                 :type  => nil,
+    #                 :index => "elastics_test_index"
+    #
+    def Elastics.store(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_store ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_store:
+    #  - PUT
+    #  - /<<index>>/<<type>>/<<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_store :id    => id,    # required
+    #                     :type  => nil,
+    #                     :index => "elastics_test_index"
+    #
+    def Elastics.put_store(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.post_store ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  post_store:
+    #  - POST
+    #  - /<<index>>/<<type>>
+    #
+    #
+    #  Usage:
+    #  Elastics.post_store :index => "elastics_test_index",
+    #                      :type  => nil
+    #
+    def Elastics.post_store(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete:
+    #  - DELETE
+    #  - /<<index>>/<<type>>/<<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete :id    => id,    # required
+    #                  :type  => nil,
+    #                  :index => "elastics_test_index"
+    #
+    def Elastics.delete(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.remove ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  remove:
+    #  - DELETE
+    #  - /<<index>>/<<type>>/<<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.remove :id    => id,    # required
+    #                  :type  => nil,
+    #                  :index => "elastics_test_index"
+    #
+    def Elastics.remove(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get:
+    #  - GET
+    #  - /<<index>>/<<type>>/<<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.get :id    => id,    # required
+    #               :type  => nil,
+    #               :index => "elastics_test_index"
+    #
+    def Elastics.get(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_source ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_source:
+    #  - GET
+    #  - /<<index>>/<<type>>/<<id>>/_source
+    #
+    #
+    #  Usage:
+    #  Elastics.get_source :id    => id,    # required
+    #                      :type  => nil,
+    #                      :index => "elastics_test_index"
+    #
+    def Elastics.get_source(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.multi_get ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  multi_get:
+    #  - GET
+    #  - /<<index>>/<<type>>/_mget
+    #  - ids: << ids >>
+    #
+    #
+    #  Usage:
+    #  Elastics.multi_get :ids   => ids,   # required
+    #                     :type  => nil,
+    #                     :index => "elastics_test_index"
+    #
+    def Elastics.multi_get(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.update ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  update:
+    #  - POST
+    #  - /<<index>>/<<type>>/<<id>>/_update
+    #
+    #
+    #  Usage:
+    #  Elastics.update :id    => id,    # required
+    #                  :type  => nil,
+    #                  :index => "elastics_test_index"
+    #
+    def Elastics.update(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.percolate ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  percolate:
+    #  - GET
+    #  - /<<index>>/<<type>>/_percolate
+    #
+    #
+    #  Usage:
+    #  Elastics.percolate :index => "elastics_test_index",
+    #                     :type  => nil
+    #
+    def Elastics.percolate(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_percolator ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_percolator:
+    #  - PUT
+    #  - /_percolator/<<index>>/<<percolator>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_percolator :percolator => percolator,  # required
+    #                          :index      => "elastics_test_index"
+    #
+    def Elastics.put_percolator(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_percolator ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_percolator:
+    #  - DELETE
+    #  - /_percolator/<<index>>/<<percolator>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_percolator :percolator => percolator,  # required
+    #                             :index      => "elastics_test_index"
+    #
+    def Elastics.delete_percolator(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.post_bulk_string ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  post_bulk_string:
+    #  - POST
+    #  - /_bulk
+    #  - << bulk_string >>
+    #
+    #
+    #  Usage:
+    #  Elastics.bulk :bulk_string => bulk_string  # required
+    #
+    def Elastics.post_bulk_string(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.count ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  count:
+    #  - GET
+    #  - /<<index>>/<<type>>/_count
+    #
+    #
+    #  Usage:
+    #  Elastics.count :index => "elastics_test_index",
+    #                 :type  => nil
+    #
+    def Elastics.count(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_by_query ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_by_query:
+    #  - DELETE
+    #  - /<<index>>/<<type>>/_query
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_by_query :index => "elastics_test_index",
+     #                          :type  => nil
+    #
+    def Elastics.delete_by_query(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.more_like_this ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  more_like_this:
+    #  - GET
+    #  - /<<index>>/<<type>>/<<id>>/_mlt
+    #
+    #
+    #  Usage:
+    #  Elastics.more_like_this :id    => id,    # required
+    #                          :type  => nil,
+    #                          :index => "elastics_test_index"
+    #
+    def Elastics.more_like_this(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.mlt ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  mlt:
+    #  - GET
+    #  - /<<index>>/<<type>>/<<id>>/_mlt
+    #
+    #
+    #  Usage:
+    #  Elastics.mlt :id    => id,    # required
+    #               :type  => nil,
+    #               :index => "elastics_test_index"
+    #
+    def Elastics.mlt(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.validate ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  validate:
+    #  - GET
+    #  - /<<index>>/<<type>>/_validate/query
+    #
+    #
+    #  Usage:
+    #  Elastics.validate :index => "elastics_test_index",
+    #                    :type  => nil
+    #
+    def Elastics.validate(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.explain ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  explain:
+    #  - GET
+    #  - /<<index>>/<<type>>/<<id>>/_explain
+    #
+    #
+    #  Usage:
+    #  Elastics.explain :id    => id,    # required
+    #                   :type  => nil,
+    #                   :index => "elastics_test_index"
+    #
+    def Elastics.explain(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.match_all ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  match_all:
+    #  - GET
+    #  - /<<index>>/<<type>>/_search
+    #  - query:
+    #      match_all: {}
+    #
+    #
+    #  Usage:
+    #  Elastics.match_all :index => "elastics_test_index",
+    #                     :type  => nil
+    #
+    def Elastics.match_all(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.search_by_id ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  search_by_id:
+    #  - GET
+    #  - /<<index>>/<<type>>/_search
+    #  - query:
+    #      term:
+    #        _id: <<id>>
+    #
+    #
+    #  Usage:
+    #  Elastics.search_by_id :id      => id,    # required
+    #                        :type    => nil,
+    #                        :index   => "elastics_test_index",
+    #
+    def Elastics.search_by_id(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    ######################## Indices API ########################
+
+    #  ########## Elastics.post_index_aliases ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  post_index_aliases:
+    #  - POST
+    #  - /_aliases
+    #
+    #
+    #  Usage:
+    #  Elastics.post_index_aliases
+    #
+    def Elastics.post_index_aliases(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_aliases ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_aliases:
+    #  - GET
+    #  - /<<index>>/_aliases
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_aliases :index => "elastics_test_index"
+    #
+    def Elastics.get_index_aliases(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.add_index_alias ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  add_index_alias:
+    #  - PUT
+    #  - /<<index>>/_alias/<<alias>>
+    #
+    #
+    #  Usage:
+    #  Elastics.add_index_alias :alias => alias,  # required
+    #                           :index => "elastics_test_index"
+    #
+    def Elastics.add_index_alias(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_index_alias ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_index_alias:
+    #  - DELETE
+    #  - /<<index>>/_alias/<<alias>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_index_alias :alias => alias,  # required
+    #                              :index => "elastics_test_index"
+    #
+    def Elastics.delete_index_alias(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_alias ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_alias:
+    #  - GET
+    #  - /<<index>>/_alias/<<alias= '*' >>
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_alias :index => "elastics_test_index",
+    #                           :alias => "*"
+    #
+    def Elastics.get_index_alias(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.analyze_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  analyze_index:
+    #  - GET
+    #  - /<<index>>/_analyze
+    #
+    #
+    #  Usage:
+    #  Elastics.analyze_index :index => "elastics_test_index"
+    #
+    def Elastics.analyze_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_index:
+    #  - PUT
+    #  - /<<index>>
+    #  - settings:
+    #      number_of_shards: <<number_of_shards= 5 >>
+    #      number_of_replicas: <<number_of_replicas= 1 >>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_index :index              => "elastics_test_index",
+    #                     :number_of_shards   => 5,
+    #                     :number_of_replicas => 1
+    #
+    def Elastics.put_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.create_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  create_index:
+    #  - PUT
+    #  - /<<index>>
+    #  - settings:
+    #      number_of_shards: <<number_of_shards= 5 >>
+    #      number_of_replicas: <<number_of_replicas= 1 >>
+    #
+    #
+    #  Usage:
+    #  Elastics.create_index :index              => "elastics_test_index",
+    #                        :number_of_shards   => 5,
+    #                        :number_of_replicas => 1
+    #
+    def Elastics.create_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.post_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  post_index:
+    #  - POST
+    #  - /<<index>>
+    #  - settings:
+    #      number_of_shards: <<number_of_shards= 5 >>
+    #      number_of_replicas: <<number_of_replicas= 1 >>
+    #
+    #
+    #  Usage:
+    #  Elastics.post_index :index              => "elastics_test_index",
+    #                      :number_of_shards   => 5,
+    #                      :number_of_replicas => 1
+    #
+    def Elastics.post_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_index:
+    #  - DELETE
+    #  - /<<index>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_index :index => "elastics_test_index"
+    #
+    def Elastics.delete_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.close_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  close_index:
+    #  - POST
+    #  - /<<index>>/_close
+    #
+    #
+    #  Usage:
+    #  Elastics.close_index :index => "elastics_test_index"
+    #
+    def Elastics.close_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.open_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  open_index:
+    #  - POST
+    #  - /<<index>>/_close
+    #
+    #
+    #  Usage:
+    #  Elastics.open_index :index => "elastics_test_index"
+    #
+    def Elastics.open_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_settings ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_settings:
+    #  - GET
+    #  - /<<index>>/_settings
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_settings :index => "elastics_test_index"
+    #
+    def Elastics.get_index_settings(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_settings ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_settings:
+    #  - GET
+    #  - /<<index>>/_settings
+    #
+    #
+    #  Usage:
+    #  Elastics.get_settings :index => "elastics_test_index"
+    #
+    def Elastics.get_settings(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_mapping:
+    #  - GET
+    #  - /<<index>>/<<type>>/_mapping
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_mapping :index => "elastics_test_index",
+    #                             :type  => nil
+    #
+    def Elastics.get_index_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_mapping:
+    #  - GET
+    #  - /<<index>>/<<type>>/_mapping
+    #
+    #
+    #  Usage:
+    #  Elastics.get_mapping :index => "elastics_test_index",
+    #                       :type  => nil
+    #
+    def Elastics.get_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_index_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_index_mapping:
+    #  - PUT
+    #  - /<<index>>/<<type>>/_mapping
+    #  - <<type>>:
+    #      properties: <<properties>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_index_mapping :properties => properties,  # required
+    #                             :type       => nil,
+    #                             :index      => "elastics_test_index"
+    #
+    def Elastics.put_index_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_mapping:
+    #  - PUT
+    #  - /<<index>>/<<type>>/_mapping
+    #  - <<type>>:
+    #      properties: <<properties>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_mapping :properties => properties,  # required
+    #                       :type       => nil,
+    #                       :index      => "elastics_test_index"
+    #
+    def Elastics.put_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_index_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_index_mapping:
+    #  - DELETE
+    #  - /<<index>>/<<type>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_index_mapping :index => "elastics_test_index",
+    #                                :type  => nil
+    #
+    def Elastics.delete_index_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_mapping ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_mapping:
+    #  - DELETE
+    #  - /<<index>>/<<type>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_mapping :index => "elastics_test_index",
+    #                          :type  => nil
+    #
+    def Elastics.delete_mapping(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.refresh_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  refresh_index:
+    #  - POST
+    #  - /<<index>>/_refresh
+    #
+    #
+    #  Usage:
+    #  Elastics.refresh_index :index => "elastics_test_index"
+    #
+    def Elastics.refresh_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.optimize_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  optimize_index:
+    #  - POST
+    #  - /<<index>>/_optimize
+    #
+    #
+    #  Usage:
+    #  Elastics.optimize_index :index => "elastics_test_index"
+    #
+    def Elastics.optimize_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.flush_index ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  flush_index:
+    #  - POST
+    #  - /<<index>>/_flush
+    #
+    #
+    #  Usage:
+    #  Elastics.flush_index :index => "elastics_test_index"
+    #
+    def Elastics.flush_index(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.gateway_snapshot ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  gateway_snapshot:
+    #  - POST
+    #  - /<<index>>/_gateway/snapshot
+    #
+    #
+    #  Usage:
+    #  Elastics.gateway_snapshot :index => "elastics_test_index"
+    #
+    def Elastics.gateway_snapshot(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.update_index_settings ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  update_index_settings:
+    #  - PUT
+    #  - /<<index>>/_settings
+    #
+    #
+    #  Usage:
+    #  Elastics.update_index_settings :index => "elastics_test_index"
+    #
+    def Elastics.update_index_settings(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_index_template ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_index_template:
+    #  - PUT
+    #  - /_template/<<template>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_index_template :template => template  # required
+    #
+    def Elastics.put_index_template(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_index_template ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_index_template:
+    #  - DELETE
+    #  - /_template/<<template>>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_index_template :template => template  # required
+    #
+    def Elastics.delete_index_template(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_template ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_template:
+    #  - GET
+    #  - /_template/<<template>>
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_template :template => template  # required
+    #
+    def Elastics.get_index_template(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_index_warmer ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_index_warmer:
+    #  - PUT
+    #  - /<<index>>/<<type>>/_warmer/<<warmer>>
+    #
+    #
+    #  Usage:
+    #  Elastics.put_index_warmer :warmer => warmer,  # required
+    #                            :type   => nil,
+    #                            :index  => "elastics_test_index"
+    #
+    def Elastics.put_index_warmer(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.delete_index_warmer ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  delete_index_warmer:
+    #  - DELETE
+    #  - /<<index>>/_warmer/<<warmer= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.delete_index_warmer :index  => "elastics_test_index",
+    #                               :warmer => nil
+    #
+    def Elastics.delete_index_warmer(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_index_warmer ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_index_warmer:
+    #  - GET
+    #  - /<<index>>/_warmer/<<warmer= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.get_index_warmer :index  => "elastics_test_index",
+    #                            :warmer => nil
+    #
+    def Elastics.get_index_warmer(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.index_stats ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  index_stats:
+    #  - GET
+    #  - /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.index_stats :index    => "elastics_test_index",
+    #                       :endpoint => nil,
+    #                       :names    => nil
+    #
+    def Elastics.index_stats(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.stats ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  stats:
+    #  - GET
+    #  - /<<index>>/_stats/<<endpoint= ~ >>/<<names= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.stats :index    => "elastics_test_index",
+    #                 :endpoint => nil,
+    #                 :names    => nil
+    #
+    def Elastics.stats(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.index_status ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  index_status:
+    #  - GET
+    #  - /<<index>>/_status
+    #
+    #
+    #  Usage:
+    #  Elastics.index_status :index => "elastics_test_index"
+    #
+    def Elastics.index_status(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.index_segments ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  index_segments:
+    #  - GET
+    #  - /<<index>>/_segments
+    #
+    #
+    #  Usage:
+    #  Elastics.index_segments :index => "elastics_test_index"
+    #
+    def Elastics.index_segments(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.index_clearcache ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  index_clearcache:
+    #  - POST
+    #  - /<<index>>/_cache/clear
+    #
+    #
+    #  Usage:
+    #  Elastics.index_clearcache :index => "elastics_test_index"
+    #
+    def Elastics.index_clearcache(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.indices_exists ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  indices_exists:
+    #  - HEAD
+    #  - /<<index>>
+    #
+    #
+    #  Usage:
+    #  Elastics.indices_exists :index => "elastics_test_index"
+    #
+    def Elastics.indices_exists(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.exist? ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  exist?:
+    #  - HEAD
+    #  - /<<index>>
+    #
+    #
+    #  Usage:
+    #  Elastics.exist? :index => "elastics_test_index"
+    #
+    def Elastics.exist?(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.types_exists ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  types_exists:
+    #  - HEAD
+    #  - /<<index>>/<<type>>
+    #
+    #
+    #  Usage:
+    #  Elastics.types_exists :index => "elastics_test_index",
+    #                        :type  => nil
+    #
+    def Elastics.types_exists(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+
+    ######################## Cluster API ########################
+
+    #  ########## Elastics.cluster_health ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_health:
+    #  - GET
+    #  - /_cluster/health/<<index>>
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_health :index => "elastics_test_index"
+    #
+    def Elastics.cluster_health(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_state ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_state:
+    #  - GET
+    #  - /_cluster/state
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_state
+    #
+    def Elastics.cluster_state(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.put_cluster_settings ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  put_cluster_settings:
+    #  - PUT
+    #  - /_cluster/settings
+    #
+    #
+    #  Usage:
+    #  Elastics.put_cluster_settings
+    #
+    def Elastics.put_cluster_settings(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.get_cluster_settings ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  get_cluster_settings:
+    #  - GET
+    #  - /_cluster/settings
+    #
+    #
+    #  Usage:
+    #  Elastics.get_cluster_settings
+    #
+    def Elastics.get_cluster_settings(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_nodes_info ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_nodes_info:
+    #  - GET
+    #  - /_nodes/<<nodes= ~ >>/<<endpoint= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_nodes_info :nodes    => nil,
+    #                              :endpoint => nil
+    #
+    def Elastics.cluster_nodes_info(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_nodes_stats ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_nodes_stats:
+    #  - GET
+    #  - /_nodes/<<nodes= ~ >>/stats/<<endpoint= ~ >>
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_nodes_stats :nodes    => nil,
+    #                               :endpoint => nil
+    #
+    def Elastics.cluster_nodes_stats(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_nodes_shutdown ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_nodes_shutdown:
+    #  - POST
+    #  - /_cluster/nodes/<<nodes= ~ >>/_shutdown
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_nodes_shutdown :nodes => nil
+    #
+    def Elastics.cluster_nodes_shutdown(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_nodes_hot_threads ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_nodes_hot_threads:
+    #  - GET
+    #  - /_nodes/<<nodes= ~ >>/hot_threads
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_nodes_hot_threads :nodes => nil
+    #
+    def Elastics.cluster_nodes_hot_threads(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+    #  ########## Elastics.cluster_reroute ##########
+    #  --------------
+    #  Elastics::Template
+    #  ---
+    #  cluster_reroute:
+    #  - POST
+    #  - /_cluster/reroute
+    #
+    #
+    #  Usage:
+    #  Elastics.cluster_reroute
+    #
+    def Elastics.cluster_reroute(*vars)
+      ## this is a stub, used for reference
+      super
+    end
+
+
+  end
+end