elastomer-client 0.8.1 → 0.9.0

data/lib/elastomer/client/multi_search.rb

@@ -8,7 +8,7 @@ module Elastomer
     # the method will perform an API call, and it requires a bulk request
     # body and optional request parameters.
     #
-    # See http://www.elasticsearch.org/guide/reference/api/multi-search/
+    # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
     #
     # body   - Request body as a String (required if a block is not given)
     # params - Optional request parameters as a Hash
@@ -49,7 +49,7 @@ module Elastomer
     # The MultiSearch class is a helper for accumulating and submitting
     # multi_search API requests. Instances of the MultiSearch class
     # accumulate searches and then issue a single API request to
-    # ElasticSearch, which runs all accumulated searches in parallel
+    # Elasticsearch, which runs all accumulated searches in parallel
     # and returns each result hash aggregated into an array of result
     # hashes.
     #

data/lib/elastomer/client/nodes.rb

@@ -45,7 +45,7 @@ module Elastomer
       #   info(:info => "os")
       #   info(:info => %w[os jvm process])
       #
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
       #
       # Returns the response as a Hash
       def info( params = {} )
@@ -65,7 +65,7 @@ module Elastomer
       #   stats(:stats => "thread_pool")
       #   stats(:stats => %w[os process])
       #
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
       #
       # Returns the response as a Hash
       def stats( params = {} )
@@ -83,7 +83,7 @@ module Elastomer
       #   :interval - sampling interval [default is 500ms]
       #   :type     - the type to sample: "cpu", "wait", or "block"
       #
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
       #
       # Returns the response as a String
       def hot_threads( params = {} )
@@ -97,7 +97,7 @@ module Elastomer
       # params - Parameters Hash
       #   :node_id - a single node ID or Array of node IDs
       #
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html
       #
       # Returns the response as a Hash
       def shutdown( params = {} )

data/lib/elastomer/client/repository.rb

@@ -20,7 +20,7 @@ module Elastomer
       attr_reader :client, :name
 
       # Check for the existence of the repository.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # params - Parameters Hash
       #
@@ -38,7 +38,7 @@ module Elastomer
       alias_method :exist?, :exists?
 
       # Create the repository.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # body   - The repository type and settings as a Hash or a JSON encoded String
       # params - Parameters Hash
@@ -50,7 +50,7 @@ module Elastomer
       end
 
       # Get repository type and settings.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # params - Parameters Hash
       #
@@ -61,7 +61,7 @@ module Elastomer
       end
 
       # Get status information on snapshots in progress.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # params - Parameters Hash
       #
@@ -72,7 +72,7 @@ module Elastomer
       end
 
       # Update the repository.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # body   - The repository type and settings as a Hash or a JSON encoded String
       # params - Parameters Hash
@@ -84,7 +84,7 @@ module Elastomer
       end
 
       # Delete the repository.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
       #
       # params - Parameters Hash
       #

data/lib/elastomer/client/scroller.rb

@@ -48,7 +48,7 @@ module Elastomer
     end
 
     # Begin scrolling a query.
-    # See http://www.elasticsearch.org/guide/reference/api/search/scroll/
+    # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
     #
     # opts   - Options Hash
     #   :query       - the query to scroll as a Hash or JSON encoded String
@@ -78,7 +78,7 @@ module Elastomer
     end
 
     # Continue scrolling a query.
-    # See http://www.elasticsearch.org/guide/reference/api/search/scroll/
+    # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
     #
     # scroll_id - The current scroll ID as a String
     # scroll    - The keep alive time of the scrolling request (5 minutes by default)
@@ -113,8 +113,8 @@ module Elastomer
       # returned by the `query`. The Scroller supports both the 'scan' and the
       # 'scroll' search types.
       #
-      # See http://www.elasticsearch.org/guide/reference/api/search/scroll/
-      # and the "Scan" section of http://www.elasticsearch.org/guide/reference/api/search/search-type/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
+      # and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-search-type.html#scan
       #
       # client - Elastomer::Client used for HTTP requests to the server
       # query  - The query to scan as a Hash or a JSON encoded String

data/lib/elastomer/client/snapshot.rb

@@ -29,7 +29,7 @@ module Elastomer
       attr_reader :client, :repository, :name
 
       # Check for the existence of the snapshot.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # params - Parameters Hash
       #
@@ -47,7 +47,7 @@ module Elastomer
       alias_method :exist?, :exists?
 
       # Create the snapshot.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # body   - The snapshot options as a Hash or a JSON encoded String
       # params - Parameters Hash
@@ -59,7 +59,7 @@ module Elastomer
       end
 
       # Get snapshot progress information.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # params - Parameters Hash
       #
@@ -72,7 +72,7 @@ module Elastomer
       end
 
       # Get detailed snapshot status.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # params - Parameters Hash
       #
@@ -83,7 +83,7 @@ module Elastomer
       end
 
       # Restore the snapshot.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # body   - The restore options as a Hash or a JSON encoded String
       # params - Parameters Hash
@@ -95,7 +95,7 @@ module Elastomer
       end
 
       # Delete the snapshot.
-      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
       #
       # params - Parameters Hash
       #

data/lib/elastomer/client/template.rb

@@ -30,7 +30,7 @@ module Elastomer
       alias_method :exist?, :exists?
 
       # Get the template from the cluster.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html#getting
       #
       # params - Parameters Hash
       #
@@ -41,7 +41,7 @@ module Elastomer
       end
 
       # Create the template on the cluster.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
       #
       # template - The template as a Hash or a JSON encoded String
       # params   - Parameters Hash
@@ -53,7 +53,7 @@ module Elastomer
       end
 
       # Delete the template from the cluster.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html#delete
       #
       # params - Parameters Hash
       #

data/lib/elastomer/client/warmer.rb

@@ -17,7 +17,7 @@ module Elastomer
       attr_reader :client, :index_name, :name
 
       # Create a warmer.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
       #
       # query  - The query the warmer should run
       # params - Parameters Hash
@@ -33,7 +33,7 @@ module Elastomer
       end
 
       # Delete a warmer.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html#removing
       #
       # params   - Parameters Hash
       #
@@ -44,7 +44,7 @@ module Elastomer
       end
 
       # Get a warmer.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html#warmer-retrieving
       #
       # params   - Parameters Hash
       #

data/lib/elastomer/middleware/opaque_id.rb

@@ -4,7 +4,7 @@ module Elastomer
   module Middleware
 
     # This Faraday middleware implements the "X-Opaque-Id" request / response
-    # headers for ElasticSearch. The X-Opaque-Id header, when provided on the
+    # headers for Elasticsearch. The X-Opaque-Id header, when provided on the
     # request header, will be returned as a header in the response. This is
     # useful in environments which reuse connections to ensure that cross-talk
     # does not occur between two requests.
@@ -15,7 +15,7 @@ module Elastomer
     # `Elastomer::Client::OpaqueIdError` is raised. In this case no response
     # will be returned.
     #
-    # See [ElasticSearch "X-Opaque-Id"
+    # See [Elasticsearch "X-Opaque-Id"
     # header](https://github.com/elasticsearch/elasticsearch/issues/1202)
     # for more details.
     class OpaqueId < ::Faraday::Middleware

data/lib/elastomer/notifications.rb

@@ -4,13 +4,13 @@ require "elastomer/client"
 
 module Elastomer
 
-  # So you want to get notifications from your ElasticSearch client? Well,
+  # So you want to get notifications from your Elasticsearch client? Well,
   # you've come to the right place!
   #
   #   require 'elastomer/notifications'
   #
   # Requiring this module will add ActiveSupport notifications to all
-  # ElasticSearch requests. To subscribe to those requests ...
+  # Elasticsearch requests. To subscribe to those requests ...
   #
   #   ActiveSupport::Notifications.subscribe('request.client.elastomer') do |name, start_time, end_time, _, payload|
   #     duration = end_time - start_time
@@ -45,7 +45,7 @@ module Elastomer
     # Internal: Execute the given block and provide instrumentation info to
     # subscribers. The name we use for subscriptions is
     # `request.client.elastomer` and a supplemental payload is provided with
-    # more information about the specific ElasticSearch request.
+    # more information about the specific Elasticsearch request.
     #
     # path   - The full request path as a String
     # body   - The request body as a String or `nil`

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 
   def self.version
     VERSION

data/test/client/index_test.rb

@@ -288,7 +288,25 @@ describe Elastomer::Client::Index do
 
   describe "when an index exists" do
     before do
-      @index.create(nil)
+      @index.create(
+        :settings => { :number_of_shards => 1, :number_of_replicas => 0 },
+        :mappings => {
+          :doco => {
+            :_source => { :enabled => false },
+            :_all    => { :enabled => false },
+            :properties => {
+              :title   => { :type => "string", :analyzer => "standard" },
+              :author  => { :type => "string", :index => "not_analyzed" },
+              :suggest => {
+                :type            => "completion",
+                :index_analyzer  => "simple",
+                :search_analyzer => "simple",
+                :payloads        => false
+              }
+            }
+          }
+        }
+      )
       wait_for_index(@name)
     end
 
@@ -392,20 +410,20 @@ describe Elastomer::Client::Index do
     it "performs multi percolate queries" do
       @index.docs.index \
         :_id    => 1,
-        :_type  => "doc2",
+        :_type  => "doco",
         :title  => "the author of logging",
         :author => "pea53"
 
       @index.docs.index \
         :_id    => 2,
-        :_type  => "doc2",
+        :_type  => "doco",
         :title  => "the author of rubber-band",
         :author => "grantr"
 
       @index.percolator("1").create :query => { :match_all => { } }
       @index.percolator("2").create :query => { :match => { :author => "pea53" } }
 
-      h = @index.multi_percolate(:type => "doc2") do |m|
+      h = @index.multi_percolate(:type => "doco") do |m|
         m.percolate :author => "pea53"
         m.percolate :author => "grantr"
         m.count({}, { :author => "grantr" })
@@ -416,5 +434,33 @@ describe Elastomer::Client::Index do
       assert_equal ["1"], response2["matches"].map { |match| match["_id"] }.sort
       assert_equal 1, response3["total"]
     end
+
+    it "performs suggestion queries" do
+      @index.docs.index \
+        :_id     => 1,
+        :_type   => "doco",
+        :title   => "the magnificent",
+        :author  => "greg",
+        :suggest => {:input => %w[Greg greg], :output => "Greg", :weight => 2}
+
+      @index.docs.index \
+        :_id    => 2,
+        :_type  => "doco",
+        :title  => "the author of rubber-band",
+        :author => "grant",
+        :suggest => {:input => %w[Grant grant], :output => "Grant", :weight => 1}
+
+      @index.refresh
+      response = @index.suggest({:name => {:text => "gr", :completion => {:field => :suggest}}})
+
+      assert response.key?("name")
+      hash = response["name"].first
+      assert_equal "gr", hash["text"]
+
+      options = hash["options"]
+      assert_equal 2, options.length
+      assert_equal "Greg", options.first["text"]
+      assert_equal "Grant", options.last["text"]
+    end
   end
 end

data/test/test_helper.rb

@@ -1,10 +1,11 @@
+require "rubygems" unless defined? Gem
+require "bundler"
+Bundler.require(:default, :development)
+
 require "webmock/minitest"
 WebMock.allow_net_connect!
 
 require "securerandom"
-require "rubygems" unless defined? Gem
-require "bundler"
-Bundler.require(:default, :development)
 
 if ENV["COVERAGE"] == "true"
   require "simplecov"
@@ -31,7 +32,7 @@ $client_params = {
 }
 $client = Elastomer::Client.new $client_params
 
-# ensure we have an ElasticSearch server to test with
+# ensure we have an Elasticsearch server to test with
 raise "No server available at #{$client.url}" unless $client.available?
 
 puts "Elasticsearch version is #{$client.version}"
@@ -102,7 +103,7 @@ def es_version_always_returns_aliases?
   $client.semantic_version >= "1.4.3"
 end
 
-# ElasticSearch 1.3 added the `search_shards` API endpoint.
+# Elasticsearch 1.3 added the `search_shards` API endpoint.
 def es_version_supports_search_shards?
   $client.semantic_version >= "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Elasticsearch