elastomer-client 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ff6e4010e81c9d42f412ac93cda3448bf3207f
-  data.tar.gz: da3742dd0d0724df7ab5b51b7ab2aa7ce9bca9e6
+  metadata.gz: efb8ef5cb70b5ee2dff9d968876ec9b2412650f2
+  data.tar.gz: ef5a5fab5b54be5581cddef9e0741f0cae962341
 SHA512:
-  metadata.gz: 251b9765f805d5f01dfd66f49e1899b80301ce2c0dfefce8e026657978335bf95ce2551acca5a3548a9c70098cd4f8da336bb674e671a57080d61b4346933af5
-  data.tar.gz: 2f397fe5deafd4bcdf17a8826715e2ab3f86870008ae0bfe63d1809aa45c49d1da53fb68f276f750327e5653bbf24d1ceeb250ce568392a7e355f8dfb304a0ba
+  metadata.gz: d3d7c0fe1ef38202642a185670511ad10e99bacd8a57c8f02ab03adefa0133fad0485511cb9a7d70251533b58031987454686783930340060dc641914c21a05d
+  data.tar.gz: b2f69a64ad1e5c6de4f2a6ded6c00f4dbf3c639340bab1003cd7ad9fc80cfef8522df9bfe0be5c9f1e27fb00f7295c194f331c83228c2881ea60f36bdd99eb5f

data/.travis.yml

@@ -1,16 +1,25 @@
 language: ruby
 rvm:
-  - 2.1.1
+  - 2.3.3
+env:
+  # NOTE: Ancient versions of Elasticsearch have different download URLs
+  - ES_VERSION=2.3.5 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/${ES_VERSION}/elasticsearch-${ES_VERSION}.tar.gz
+  - ES_VERSION=5.6.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
 
-addons:
-  apt:
-    sources:
-      elasticsearch-2.x
-    packages:
-      elasticsearch
+matrix:
+  allow_failures:
+    - env: ES_VERSION=5.6.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
 
-services:
-  - elasticsearch
+# Configure a specific version of Elasticsearch
+# See: https://docs.travis-ci.com/user/database-setup/#Installing-ElasticSearch-on-trusty-container-based-infrastructure
+install:
+  - wget ${ES_DOWNLOAD_URL}
+  - tar -xzf elasticsearch-${ES_VERSION}.tar.gz
+  - ./elasticsearch-${ES_VERSION}/bin/elasticsearch &
+  - bundle install
+  - wget --quiet --waitretry=1 --retry-connrefused --timeout=10 --output-document=- http://127.0.0.1:9200
+
+script: bundle exec rake test
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 2.3.0 (2017-11-29)
+- Remove Elasticsearch 1.x and earlier code paths
+- Fix CI and configure an Elasticsearch 5.6 build
+
 ## 2.2.0 (2017-04-29)
 - Added a `clear_scroll` API
-- JSON timestamps include millisecodns by default
+- JSON timestamps include milliseconds by default
 - Removing Fixnum usage
 
 ## 2.1.1 (2016-09-02)

data/README.md

@@ -1,4 +1,4 @@
-# Elastomer Client [![Build Status](https://travis-ci.org/github/elastomer-client.svg)](https://travis-ci.org/github/elastomer-client)
+# Elastomer Client [![Build Status](https://travis-ci.org/github/elastomer-client.svg?branch=master)](https://travis-ci.org/github/elastomer-client)
 
 Making a stupid simple Elasticsearch client so your project can be smarter!
 
@@ -10,7 +10,7 @@ Get started by cloning and running a few scripts:
 $ git clone https://github.com/github/elastomer-client.git
 $ cd elastomer-client
 $ script/bootstrap
-$ script/test
+$ rake test
 ```
 
 ## Client

data/docs/notifications.md

@@ -41,7 +41,6 @@ The event namespace is `request.client.elastomer`.
 - docs.explain
 - docs.get
 - docs.index
-- docs.more_like_this
 - docs.multi_get
 - docs.multi_termvectors
 - docs.search
@@ -57,7 +56,6 @@ The event namespace is `request.client.elastomer`.
 - index.create
 - index.delete
 - index.delete_alias
-- index.delete_mapping
 - index.exists
 - index.flush
 - index.get_alias
@@ -69,9 +67,7 @@ The event namespace is `request.client.elastomer`.
 - index.recovery
 - index.refresh
 - index.segments
-- index.snapshot
 - index.stats
-- index.status
 - index.update_mapping
 - index.update_settings
 - nodes.hot_threads

data/elastomer-client.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json",  "~> 1.12"
   spec.add_dependency "semantic",    "~> 1.6"
 
-  spec.add_development_dependency "bundler",       "~> 1.14"
-  spec.add_development_dependency "activesupport", ">= 3.0"
-  spec.add_development_dependency "minitest",      "~> 4.7"
-  spec.add_development_dependency "webmock",       "~> 2.3"
+  spec.add_development_dependency "bundler",            "~> 1.14"
+  spec.add_development_dependency "activesupport",      ">= 3.0"
+  spec.add_development_dependency "minitest",           "~> 5.10"
+  spec.add_development_dependency "minitest-fail-fast", "~> 0.1.0"
+  spec.add_development_dependency "webmock",            "~> 2.3"
+  spec.add_development_dependency "awesome_print",      "~> 1.8"
   spec.add_development_dependency "rake"
 end

data/lib/elastomer/client/cluster.rb

@@ -34,7 +34,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def health( params = {} )
-        response = client.get "/_cluster/health{/index}", params.merge(:action => "cluster.health")
+        response = client.get "/_cluster/health{/index}", params.merge(action: "cluster.health")
         response.body
       end
 
@@ -52,7 +52,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def state( params = {} )
-        response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(:action => "cluster.state")
+        response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(action: "cluster.state")
         response.body
       end
 
@@ -67,7 +67,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def stats( params = {} )
-        response = client.get "/_cluster/stats", params.merge(:action => "cluster.stats")
+        response = client.get "/_cluster/stats", params.merge(action: "cluster.stats")
         response.body
       end
 
@@ -80,7 +80,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def pending_tasks( params = {} )
-        response = client.get "/_cluster/pending_tasks", params.merge(:action => "cluster.pending_tasks")
+        response = client.get "/_cluster/pending_tasks", params.merge(action: "cluster.pending_tasks")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def get_settings( params = {} )
-        response = client.get "/_cluster/settings", params.merge(:action => "cluster.get_settings")
+        response = client.get "/_cluster/settings", params.merge(action: "cluster.get_settings")
         response.body
       end
       alias_method :settings, :get_settings
@@ -117,7 +117,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def update_settings( body, params = {} )
-        response = client.put "/_cluster/settings", params.merge(:body => body, :action => "cluster.update_settings")
+        response = client.put "/_cluster/settings", params.merge(body: body, action: "cluster.update_settings")
         response.body
       end
 
@@ -131,16 +131,16 @@ module Elastomer
       #
       # Examples
       #
-      #   reroute(:move => { :index => 'test', :shard => 0, :from_node => 'node1', :to_node => 'node2' })
+      #   reroute(move: { index: 'test', shard: 0, from_node: 'node1', to_node: 'node2' })
       #
       #   reroute([
-      #     { :move     => { :index => 'test', :shard => 0, :from_node => 'node1', :to_node => 'node2' }},
-      #     { :allocate => { :index => 'test', :shard => 1, :node => 'node3' }}
+      #     { move:     { index: 'test', shard: 0, from_node: 'node1', to_node: 'node2' }},
+      #     { allocate: { index: 'test', shard: 1, node: 'node3' }}
       #   ])
       #
-      #   reroute(:commands => [
-      #     { :move     => { :index => 'test', :shard => 0, :from_node => 'node1', :to_node => 'node2' }},
-      #     { :allocate => { :index => 'test', :shard => 1, :node => 'node3' }}
+      #   reroute(commands: [
+      #     { move:     { index: 'test', shard: 0, from_node: 'node1', to_node: 'node2' }},
+      #     { allocate: { index: 'test', shard: 1, node: 'node3' }}
       #   ])
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
@@ -152,12 +152,12 @@ module Elastomer
         elsif commands.is_a?(Hash)
           # Array() on a Hash does not do what you think it does - that is why
           # we are explicitly wrapping the Hash via [commands] here.
-          body = {:commands => [commands]}
+          body = {commands: [commands]}
         else
-          body = {:commands => Array(commands)}
+          body = {commands: Array(commands)}
         end
 
-        response = client.post "/_cluster/reroute", params.merge(:body => body, :action => "cluster.reroute")
+        response = client.post "/_cluster/reroute", params.merge(body: body, action: "cluster.reroute")
         response.body
       end
 
@@ -170,7 +170,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def shutdown( params = {} )
-        response = client.post "/_shutdown", params.merge(:action => "cluster.shutdown")
+        response = client.post "/_shutdown", params.merge(action: "cluster.shutdown")
         response.body
       end
 
@@ -185,13 +185,13 @@ module Elastomer
       # Examples
       #
       #   get_aliases
-      #   get_aliases( :index => 'users' )
+      #   get_aliases( index: 'users' )
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
       #
       # Returns the response body as a Hash
       def get_aliases( params = {} )
-        response = client.get "{/index}/_aliases", params.merge(:action => "cluster.get_aliases")
+        response = client.get "{/index}/_aliases", params.merge(action: "cluster.get_aliases")
         response.body
       end
       alias_method :aliases, :get_aliases
@@ -199,18 +199,18 @@ module Elastomer
       # Perform an aliases action on the cluster. We are just a teensy bit
       # clever here in that a single action can be given or an array of
       # actions. This API method will wrap the request in the appropriate
-      # {:actions => [...]} body construct.
+      # {actions: [...]} body construct.
       #
       # actions - An action Hash or an Array of action Hashes
       # params  - Parameters Hash
       #
       # Examples
       #
-      #   update_aliases(:add => { :index => 'users-1', :alias => 'users' })
+      #   update_aliases(add: { index: 'users-1', alias: 'users' })
       #
       #   update_aliases([
-      #     { :remove => { :index => 'users-1', :alias => 'users' }},
-      #     { :add    => { :index => 'users-2', :alias => 'users' }}
+      #     { remove: { index: 'users-1', alias: 'users' }},
+      #     { add:    { index: 'users-2', alias: 'users' }}
       #   ])
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
@@ -222,12 +222,12 @@ module Elastomer
         elsif actions.is_a?(Hash)
           # Array() on a Hash does not do what you think it does - that is why
           # we are explicitly wrapping the Hash via [actions] here.
-          body = {:actions => [actions]}
+          body = {actions: [actions]}
         else
-          body = {:actions => Array(actions)}
+          body = {actions: Array(actions)}
         end
 
-        response = client.post "/_aliases", params.merge(:body => body, :action => "cluster.update_aliases")
+        response = client.post "/_aliases", params.merge(body: body, action: "cluster.update_aliases")
         response.body
       end
 
@@ -236,18 +236,7 @@ module Elastomer
       #
       # Returns the template definitions as a Hash
       def templates
-        # ES 1.x supports state filtering via a path segment called metrics.
-        # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= "1.0.0"
-          h = state(:metrics => "metadata")
-        else
-          h = state(
-            :filter_blocks        => true,
-            :filter_nodes         => true,
-            :filter_routing_table => true,
-          )
-        end
-        h["metadata"]["templates"]
+        state(metrics: "metadata").dig("metadata", "templates")
       end
 
       # List all indices currently defined. This is just a convenience method
@@ -255,18 +244,7 @@ module Elastomer
       #
       # Returns the indices definitions as a Hash
       def indices
-        # ES 1.x supports state filtering via a path segment called metrics.
-        # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= "1.0.0"
-          h = state(:metrics => "metadata")
-        else
-          h = state(
-            :filter_blocks        => true,
-            :filter_nodes         => true,
-            :filter_routing_table => true,
-          )
-        end
-        h["metadata"]["indices"]
+        state(metrics: "metadata").dig("metadata", "indices")
       end
 
       # List all nodes currently part of the cluster. This is just a convenience
@@ -275,18 +253,7 @@ module Elastomer
       #
       # Returns the nodes definitions as a Hash
       def nodes
-        # ES 1.x supports state filtering via a path segment called metrics.
-        # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= "1.0.0"
-          h = state(:metrics => "nodes")
-        else
-          h = state(
-            :filter_blocks        => true,
-            :filter_metadata      => true,
-            :filter_routing_table => true,
-          )
-        end
-        h["nodes"]
+        state(metrics: "nodes").dig("nodes")
       end
 
     end

data/lib/elastomer/client/docs.rb

@@ -331,33 +331,6 @@ module Elastomer
 Percolate
 =end
 
-      # Deprecated - use the More Like This query: https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-mlt-query.html
-      # Search for documents similar to a specific document. The
-      # document :id is provided as part of the params hash. If the _all field
-      # is not enabled, :mlt_fields must be passed. A query cannot be present in
-      # the query body, but other fields like :size and :facets are allowed.
-      #
-      # params - Parameters Hash
-      #   :id - the ID of the document
-      #
-      # Examples
-      #
-      #   more_like_this(:mlt_fields => "title", :min_term_freq => 1, :type => "doc1", :id => 1)
-      #
-      #   # with query hash
-      #   more_like_this({:from => 5, :size => 10}, :mlt_fields => "title",
-      #                   :min_term_freq => 1, :type => "doc1", :id => 1)
-      #
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-more-like-this.html
-      #
-      # Returns the response body as a hash
-      def more_like_this( query, params = nil )
-        query, params = extract_params(query) if params.nil?
-
-        response = client.get "/{index}/{type}/{id}/_mlt", update_params(params, :body => query, :action => "docs.more_like_this")
-        response.body
-      end
-
       # Compute a score explanation for a query and a specific document. This
       # can give useful feedback about why a document matched or didn't match
       # a query. The document :id is provided as part of the params hash.

data/lib/elastomer/client/index.rb

@@ -54,7 +54,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create( body, params = {} )
-        response = client.post "/{index}", update_params(params, :body => body, :action => "index.create")
+        response = client.put "/{index}", update_params(params, :body => body, :action => "index.create")
         response.body
       end
 
@@ -130,7 +130,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_mapping( params = {} )
-        response = client.get "/{index}{/type}/_mapping", update_params(params, :action => "index.get_mapping")
+        response = client.get "/{index}/_mapping{/type}", update_params(params, :action => "index.get_mapping")
         response.body
       end
       alias_method :mapping, :get_mapping
@@ -145,29 +145,11 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def update_mapping( type, body, params = {} )
-        response = client.put "/{index}/{type}/_mapping", update_params(params, :body => body, :type => type, :action => "index.update_mapping")
+        response = client.put "/{index}/_mapping/{type}", update_params(params, :body => body, :type => type, :action => "index.update_mapping")
         response.body
       end
       alias_method :put_mapping, :update_mapping
 
-      # DEPRECATED: It is no longer possible to delete the mapping for a type.
-      # Instead you should delete the index and recreate it with new mappings.
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-delete-mapping.html
-      #
-      # Delete the mapping identified by `type`. This deletes all documents of
-      # that type from the index.
-      #
-      # type   - Name of the mapping to update as a String
-      # params - Parameters Hash
-      #
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html
-      #
-      # Returns the response body as a Hash
-      def delete_mapping( type, params = {} )
-        response = client.delete "/{index}/{type}", update_params(params, :type => type, :action => "index.delete_mapping")
-        response.body
-      end
-
       # Return the aliases associated with this index.
       #
       # params - Parameters Hash
@@ -293,22 +275,6 @@ module Elastomer
         response.body
       end
 
-      # Deprecated: Explicitly snapshot (backup) one or more indices to the
-      # gateway. By default this happens periodically (every 1 second) but the
-      # period can be changed or disabled completely.
-      #
-      # This API was removed in ES 1.2.
-      #
-      # params - Parameters Hash
-      #
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html
-      #
-      # Returns the response body as a Hash
-      def snapshot( params = {} )
-        response = client.post "{/index}/_gateway/snapshot", update_params(params, :action => "index.snapshot")
-        response.body
-      end
-
       # Provides insight into ongoing index shard recoveries. Recovery status
       # may be reported for specific indices, or cluster-wide.
       #
@@ -355,21 +321,6 @@ module Elastomer
         response.body
       end
 
-      # Deprecated: Retrieve the status of one or more indices. Recovery and
-      # snapshot status can be retrieved with parameters.
-      #
-      # This API was deprecated in 1.2 and is slated for removal.
-      #
-      # params - Parameters Hash
-      #
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
-      #
-      # Returns the response body as a Hash
-      def status( params = {} )
-        response = client.get "{/index}/_status", update_params(params, :action => "index.status")
-        response.body
-      end
-
       # Retrieve low level Lucene segments information for shards of one
       # or more indices.
       #