elastomer-client 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf9d0a11b76b72579a70e136001f120d2e7b6ff6
-  data.tar.gz: af19933f50777d3200c75b53078399e86fa82cca
+  metadata.gz: e0ff6e4010e81c9d42f412ac93cda3448bf3207f
+  data.tar.gz: da3742dd0d0724df7ab5b51b7ab2aa7ce9bca9e6
 SHA512:
-  metadata.gz: 8c0f968a4fd443e7348ee39dd9dac33b4d7cffd51de59f8371b95227ccc0c8edeee54e22e9735bca1b6de6011d8fd9dbc1f65ee15e21eb39fa493efdd7f7acfa
-  data.tar.gz: 1a7979eea4e56f99a95b0b8b99a58755bcdfc16cef073e1633db3ccc6ed07512dc1096eb8dc77bc0cab21b79c6805f92c3ce88ae8838c65a2027affb63b86844
+  metadata.gz: 251b9765f805d5f01dfd66f49e1899b80301ce2c0dfefce8e026657978335bf95ce2551acca5a3548a9c70098cd4f8da336bb674e671a57080d61b4346933af5
+  data.tar.gz: 2f397fe5deafd4bcdf17a8826715e2ab3f86870008ae0bfe63d1809aa45c49d1da53fb68f276f750327e5653bbf24d1ceeb250ce568392a7e355f8dfb304a0ba

data/.gitignore

@@ -7,3 +7,4 @@
 /coverage
 Gemfile.lock
 *.gem
+tags

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 2.1.1 (2016-01-02)
+## 2.2.0 (2017-04-29)
+- Added a `clear_scroll` API
+- JSON timestamps include millisecodns by default
+- Removing Fixnum usage
+
+## 2.1.1 (2016-09-02)
 - Bulk index only rejects documents larger than the maximum request size
 
 ## 2.1.0 (2016-01-02)

data/elastomer-client.gemspec

@@ -19,16 +19,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "addressable", "~> 2.3"
+  spec.add_dependency "addressable", "~> 2.5"
   spec.add_dependency "faraday",     "~> 0.8"
-  spec.add_dependency "multi_json",  "~> 1.7"
-  spec.add_dependency "semantic",    "~> 1.3"
+  spec.add_dependency "multi_json",  "~> 1.12"
+  spec.add_dependency "semantic",    "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  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","~> 1.21"
+  spec.add_development_dependency "minitest",      "~> 4.7"
+  spec.add_development_dependency "webmock",       "~> 2.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "overcommit"
-  spec.add_development_dependency "rubocop"
 end

data/lib/elastomer/client.rb

@@ -223,15 +223,19 @@ module Elastomer
       body = params.delete :body
       return if body.nil?
 
-      case body
-      when String
-        body
-      when Array
-        body << nil unless body.last.nil?
-        body.join "\n"
-      else
-        MultiJson.dump body
-      end
+      body =
+        case body
+        when String
+          body
+        when Array
+          body << nil unless body.last.nil?
+          body.join "\n"
+        else
+          MultiJson.dump body
+        end
+
+      # Prevent excon from changing the encoding (see https://github.com/github/elastomer-client/issues/138)
+      body.freeze
     end
 
     # Internal: Apply path expansions to the `path` and append query

data/lib/elastomer/client/errors.rb

@@ -85,8 +85,9 @@ module Elastomer
 
     # Provide some nice errors for common Elasticsearch exceptions. These are
     # all subclasses of the more general RequestError
-    IndexNotFoundError = Class.new RequestError
-    QueryParsingError  = Class.new RequestError
+    IndexNotFoundError   = Class.new RequestError
+    QueryParsingError    = Class.new RequestError
+    SearchContextMissing = Class.new RequestError
 
     ServerError.fatal      = false
     TimeoutError.fatal     = false

data/lib/elastomer/client/index.rb

@@ -340,12 +340,18 @@ module Elastomer
       # can be retrieved with parameters.
       #
       # params - Parameters Hash
+      #   :stats - a single stats value or an Array of stats values
+      #
+      # Examples
+      #
+      #   stats(stats: "docs")
+      #   stats(stats: %w[flush merge])
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
       #
       # Returns the response body as a Hash
       def stats( params = {} )
-        response = client.get "{/index}/_stats", update_params(params, :action => "index.stats")
+        response = client.get "{/index}/_stats{/stats}", update_params(params, :action => "index.stats")
         response.body
       end
 

data/lib/elastomer/client/scroller.rb

@@ -53,7 +53,7 @@ module Elastomer
     # 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
+    #   :body        - the query to scroll as a Hash or JSON encoded String
     #   :index       - the name of the index to search
     #   :type        - the document type to search
     #   :scroll      - the keep alive time of the scrolling request (5 minutes by default)
@@ -62,7 +62,7 @@ module Elastomer
     #
     # Examples
     #
-    #   h = client.start_scroll('{"query":{"match_all":{}},"sort":{"created":"desc"}}', :index => 'test')
+    #   h = client.start_scroll(:body => '{"query":{"match_all":{}},"sort":{"created":"desc"}}', :index => 'test')
     #   scroll_id = h['_scroll_id']
     #   h['hits']['hits'].each { |doc| ... }
     #
@@ -87,7 +87,7 @@ module Elastomer
     #
     # Examples
     #
-    #   scroll_id = client.start_scroll('{"query":{"match_all":{}}}', :index => 'test')['_scroll_id']
+    #   scroll_id = client.start_scroll(:body => '{"query":{"match_all":{}}}', :index => 'test')['_scroll_id']
     #
     #   h = client.continue_scroll scroll_id   # scroll to get the next set of results
     #   scroll_id = h['_scroll_id']            # and store the scroll_id to use later
@@ -101,6 +101,24 @@ module Elastomer
     def continue_scroll( scroll_id, scroll = "5m" )
       response = get "/_search/scroll", :body => scroll_id, :scroll => scroll, :action => "search.scroll"
       response.body
+    rescue RequestError => err
+      if err.error && err.error["caused_by"]["type"] == "search_context_missing_exception" \
+      || err.message =~ /SearchContextMissingException/
+        raise SearchContextMissing, "No search context found for scroll ID #{scroll_id.inspect}"
+      else
+        raise err
+      end
+    end
+
+    # Delete one or more scroll IDs.
+    # see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html#_clear_scroll_api
+    #
+    # scroll_id - One or more scroll IDs
+    #
+    # Returns the response body as a Hash.
+    def clear_scroll( scroll_ids )
+      response = delete "/_search/scroll", :body => {scroll_id: Array(scroll_ids)}, :action => "search.clear_scroll"
+      response.body
     end
 
     DEFAULT_OPTS = {

data/lib/elastomer/client/template.rb

@@ -24,8 +24,9 @@ module Elastomer
       attr_reader :client, :name
 
       # Returns true if the template already exists on the cluster.
-      def exists?
-        client.cluster.templates.key? name
+      def exists?( params = {} )
+        response = client.head "/_template/{template}", update_params(params, action: "template.exists")
+        response.success?
       end
       alias_method :exist?, :exists?
 

data/lib/elastomer/core_ext/time.rb

@@ -2,6 +2,6 @@ require "time"
 
 class Time
   def to_json(ignore = nil)
-    %Q["#{self.iso8601}"]
+    %Q["#{self.iso8601(3)}"]
   end
 end

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 
   def self.version
     VERSION

data/script/bootstrap

@@ -7,5 +7,3 @@ if bundle check 1>/dev/null 2>&1; then
 else
     exec bundle install --binstubs --path vendor/gems "$@"
 fi
-
-overcommit --install

data/test/client/bulk_test.rb

@@ -85,7 +85,7 @@ describe Elastomer::Client::Bulk do
     end
     items = h["items"]
 
-    assert_instance_of Fixnum, h["took"]
+    assert_kind_of Integer, h["took"]
 
     assert_bulk_index h["items"].first
     assert_bulk_create h["items"].last
@@ -130,7 +130,7 @@ describe Elastomer::Client::Bulk do
     end
     items = h["items"]
 
-    assert_instance_of Fixnum, h["took"]
+    assert_kind_of Integer, h["took"]
 
     assert_bulk_index h["items"].first
     assert_bulk_create h["items"].last
@@ -259,7 +259,7 @@ describe Elastomer::Client::Bulk do
       b.index document, params
     end
 
-    assert_instance_of Fixnum, response["took"]
+    assert_kind_of Integer, response["took"]
 
     items = response["items"]
     assert_bulk_index(items[0])
@@ -276,7 +276,7 @@ describe Elastomer::Client::Bulk do
       b.index doc2, { "id" => "bar", "type" => "tweet" }
     end
 
-    assert_instance_of Fixnum, response["took"]
+    assert_kind_of Integer, response["took"]
 
     items = response["items"]
     assert_bulk_index(items[0])
@@ -294,7 +294,7 @@ describe Elastomer::Client::Bulk do
       b.index document, params
     end
 
-    assert_instance_of Fixnum, response["took"]
+    assert_kind_of Integer, response["took"]
 
     items = response["items"]
     assert_bulk_index(items[0])
@@ -311,7 +311,7 @@ describe Elastomer::Client::Bulk do
       b.index document, params
     end
 
-    assert_instance_of Fixnum, response["took"]
+    assert_kind_of Integer, response["took"]
 
     items = response["items"]
     assert_bulk_index(items[0])

data/test/client/scroller_test.rb

@@ -93,6 +93,20 @@ describe Elastomer::Client::Scroller do
     assert_equal 1, counts["book"]
   end
 
+  it "clears one or more scroll IDs" do
+    h = $client.start_scroll \
+      body: {query: {match_all: {}}},
+      index: @index.name,
+      type: "tweet",
+      scroll: "1m",
+      size: 10
+
+    refute_nil h["_scroll_id"], "response is missing a scroll ID"
+
+    response = $client.clear_scroll(h["_scroll_id"])
+    assert_empty response
+  end
+
   def populate!
     h = @index.bulk do |b|
       50.times { |num|

data/test/client_test.rb

@@ -97,6 +97,20 @@ describe Elastomer::Client do
       body = $client.extract_body :body => {:query => {:match_all => {}}}
       assert_equal '{"query":{"match_all":{}}}', body
     end
+
+    it "returns frozen strings" do
+      body = $client.extract_body :body => '{"query":{"match_all":{}}}'
+      assert_equal '{"query":{"match_all":{}}}', body
+      assert body.frozen?, "the body string should be frozen"
+
+      body = $client.extract_body :body => %w[foo bar baz]
+      assert_equal "foo\nbar\nbaz\n", body
+      assert body.frozen?, "Array body strings should be frozen"
+
+      body = $client.extract_body :body => {:query => {:match_all => {}}}
+      assert_equal '{"query":{"match_all":{}}}', body
+      assert body.frozen?, "JSON encoded body strings should be frozen"
+    end
   end
 
   describe "when validating parameters" do

data/test/core_ext/time_test.rb

@@ -31,7 +31,7 @@ describe "JSON conversions for Time" do
 
   it "generates ISO8601 formatted time strings" do
     time = Time.utc(2013, 5, 3, 10, 1, 31)
-    assert_equal '"2013-05-03T10:01:31Z"', MultiJson.encode(time)
+    assert_equal '"2013-05-03T10:01:31.000Z"', MultiJson.encode(time)
   end
 
   it "indexes time fields" do
@@ -41,6 +41,6 @@ describe "JSON conversions for Time" do
     assert_created(h)
 
     doc = @docs.get(:type => "doc1", :id => h["_id"])
-    assert_equal "2013-05-03T10:01:31Z", doc["_source"]["created_at"]
+    assert_equal "2013-05-03T10:01:31.000Z", doc["_source"]["created_at"]
   end
 end

data/test/test_helper.rb

@@ -25,7 +25,7 @@ require "elastomer/client"
 # we are going to use the same client instance everywhere!
 # the client should always be stateless
 $client_params = {
-  :port => ENV["BOXEN_ELASTICSEARCH_PORT"] || 9200,
+  :port => 9200,
   :read_timeout => 10,
   :open_timeout => 1,
   :opaque_id => false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -45,42 +45,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,34 +137,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   Elastomer is a low level API client for the
                             Elasticsearch HTTP interface.
@@ -268,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Elasticsearch