elastomer-client 0.4.1 → 0.5.0

data/test/client/stubbed_client_test.rb

@@ -30,7 +30,7 @@ describe 'stubbed client tests' do
       @stubs.post('/_cluster/nodes/_all/_shutdown')  { [200, {'Content-Type' => 'application/json'}, '{"nodes":{"1":{"name":"Node1"}}}'] }
       @stubs.post('/_cluster/nodes/node2/_shutdown') { [200, {'Content-Type' => 'application/json'}, '{"nodes":{"2":{"name":"Node2"}}}'] }
 
-      h = @client.nodes.shutdown
+      h = @client.nodes("_all").shutdown
       assert_equal "Node1", h['nodes']['1']['name']
 
       h = @client.nodes('node2').shutdown

data/test/client_test.rb

@@ -55,6 +55,44 @@ describe Elastomer::Client do
     }
   end
 
+  describe 'when extracting and converting :body params' do
+    it 'deletes the :body from the params (or it gets the hose)' do
+      params = { :body => nil, :q => "what what?" }
+      body = $client.extract_body params
+
+      assert_nil body
+      assert_equal({:q => "what what?"}, params)
+    end
+
+    it 'leaves String values unchanged' do
+      body = $client.extract_body :body => '{"query":{"match_all":{}}}'
+      assert_equal '{"query":{"match_all":{}}}', body
+
+      body = $client.extract_body :body => 'not a JSON string, but who cares!'
+      assert_equal 'not a JSON string, but who cares!', body
+    end
+
+    it 'joins Array values' do
+      body = $client.extract_body :body => %w[foo bar baz]
+      assert_equal "foo\nbar\nbaz\n", body
+
+      body = $client.extract_body :body => [
+        'the first entry',
+        'the second entry',
+        nil
+      ]
+      assert_equal "the first entry\nthe second entry\n", body
+    end
+
+    it 'converts values to JSON' do
+      body = $client.extract_body :body => true
+      assert_equal "true", body
+
+      body = $client.extract_body :body => {:query => {:match_all => {}}}
+      assert_equal '{"query":{"match_all":{}}}', body
+    end
+  end
+
   describe 'when validating parameters' do
     it 'rejects nil values' do
       assert_raises(ArgumentError) { $client.assert_param_presence nil }
@@ -92,4 +130,26 @@ describe Elastomer::Client do
       assert_equal '9', $client.assert_param_presence(9)
     end
   end
+
+  describe 'top level actions' do
+    it 'pings the cluster' do
+      assert_equal true, $client.ping
+      assert_equal true, $client.available?
+    end
+
+    it 'gets cluster info' do
+      h = $client.info
+      assert h.key?('name'), 'expected cluster name to be returned'
+      assert h.key?('status'), 'expected cluster info status to be returned'
+    end
+
+    it 'gets cluster version' do
+      assert_match /[\d\.]+/, $client.version
+    end
+
+    it 'gets semantic version' do
+      version_string = $client.version
+      assert_equal Semantic::Version.new(version_string), $client.semantic_version
+    end
+  end
 end

data/test/notifications_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../test_helper', __FILE__)
+require 'elastomer/notifications'
+
+describe Elastomer::Notifications do
+  before do
+    @name = 'elastomer-notifications-test'
+    @index = $client.index @name
+    @index.delete if @index.exists?
+    @events = []
+    @subscriber = ActiveSupport::Notifications.subscribe do |*args|
+      @events << ActiveSupport::Notifications::Event.new(*args)
+    end
+  end
+
+  after do
+    ActiveSupport::Notifications.unsubscribe(@subscriber)
+    @index.delete if @index.exists?
+  end
+
+  it "instruments timeouts" do
+    $client.stub :connection, lambda { raise Faraday::Error::TimeoutError } do
+      assert_raises(Elastomer::Client::TimeoutError) { $client.info }
+      event = @events.detect { |e| e.payload[:action] == 'cluster.info' }
+      exception = event.payload[:exception]
+      assert_equal 'Elastomer::Client::TimeoutError', exception[0]
+      assert_match 'timeout', exception[1]
+    end
+  end
+
+  it 'instruments cluster actions' do
+    $client.ping; assert_action_event('cluster.ping')
+    $client.info; assert_action_event('cluster.info')
+  end
+
+  it 'instruments node actions' do
+    nodes = $client.nodes
+    nodes.info; assert_action_event('nodes.info')
+    nodes.stats; assert_action_event('nodes.stats')
+    nodes.hot_threads; assert_action_event('nodes.hot_threads')
+  end
+
+  it 'instruments node shutdown' do
+    client = stub_client(:post, '/_cluster/nodes/_shutdown')
+    client.nodes.shutdown; assert_action_event('nodes.shutdown')
+  end
+
+  it 'instruments index actions' do
+    @index.exists?; assert_action_event('index.exists')
+    @index.create('number_of_replicas' => 0)
+    assert_action_event('index.create')
+    @index.get_settings; assert_action_event('index.get_settings')
+    @index.update_settings('number_of_replicas' => 0)
+    assert_action_event('index.get_settings')
+    @index.close; assert_action_event('index.close')
+    @index.open; assert_action_event('index.open')
+    @index.delete; assert_action_event('index.delete')
+  end
+
+  def assert_action_event(action)
+    assert @events.detect { |e| e.payload[:action] == action }, "expected #{action} event"
+  end
+
+  def stub_client(method, url, status=200, body='{"acknowledged":true}')
+    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.send(method, url) { |env| [status, {}, body]}
+    end
+    Elastomer::Client.new($client_params.merge(:opaque_id => false, :adapter => [:test, stubs]))
+  end
+end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-require 'tmpdir'
+require 'securerandom'
 require 'rubygems' unless defined? Gem
 require 'bundler'
 Bundler.require(:default, :development)
@@ -11,6 +11,8 @@ if ENV['COVERAGE'] == 'true'
   end
 end
 
+ENV['SNAPSHOT_DIR'] ||= '/tmp/elastomer-client-snapshot-test'
+
 require 'minitest/spec'
 require 'minitest/autorun'
 
@@ -31,6 +33,8 @@ $client = Elastomer::Client.new $client_params
 # 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}"
+
 # remove any lingering test indices from the cluster
 MiniTest::Unit.after_tests do
   $client.cluster.indices.keys.each do |name|
@@ -87,6 +91,21 @@ def es_version_1_x?
   $client.semantic_version >= '1.0.0'
 end
 
+# Elasticsearch 1.4 changed the response body for interacting with index
+# alaises. If an index does not contain any aliases, then an "alises" key is no
+# longer returned in the resopsne.
+#
+# Reeturns `true` if the response contains an "alises" key.
+def es_version_always_returns_aliases?
+  $client.semantic_version <= '1.4.0' ||
+  $client.semantic_version >= '1.4.3'
+end
+
+# ElasticSearch 1.3 added the `search_shards` API endpoint.
+def es_version_supports_search_shards?
+  $client.semantic_version >= '1.3.0'
+end
+
 # Elasticsearch 1.2 removed support for gateway snapshots.
 #
 # Returns true if Elasticsearch version supports gateway snapshots.
@@ -94,19 +113,43 @@ def es_version_supports_gateway_snapshots?
   $client.semantic_version <= '1.2.0'
 end
 
+def create_repo(name, settings = {})
+  default_settings = {:type => 'fs', :settings => {:location => ENV['SNAPSHOT_DIR']}}
+  $client.repository(name).create(default_settings.merge(settings))
+end
 
-def with_tmp_repo(&block)
-  Dir.mktmpdir do |dir|
-    @repo.create({:type => 'fs', :settings => {:location => dir}})
-    yield @repo
-    @repo.delete if @repo.exists?
+def delete_repo(name)
+  repo = $client.repository(name)
+  repo.delete if repo.exists?
+end
+
+def delete_repo_snapshots(name)
+  repo = $client.repository(name)
+  if repo.exists?
+    response = repo.snapshots.get
+    response["snapshots"].each do |snapshot_info|
+      repo.snapshot(snapshot_info["snapshot"]).delete
+    end
   end
 end
 
-def with_tmp_snapshot(&block)
-  with_tmp_repo do
-    @snapshot.create
-    yield @snapshot
-    @snapshot.delete if @snapshot.exists?
+def with_tmp_repo(name = SecureRandom.uuid, &block)
+  begin
+    create_repo(name)
+    yield $client.repository(name)
+  ensure
+    delete_repo_snapshots(name)
+    delete_repo(name)
+  end
+end
+
+def create_snapshot(repo, name = SecureRandom.uuid)
+  repo.snapshot(name).create({}, :wait_for_completion => true)
+end
+
+def with_tmp_snapshot(name = SecureRandom.uuid, &block)
+  with_tmp_repo do |repo|
+    create_snapshot(repo, name)
+    yield repo.snapshot(name), repo
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +123,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.8
 description: |-
   Elastomer is a low level API client for the
                             Elasticsearch HTTP interface.
@@ -134,13 +134,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/README.md
+- docs/bulk_indexing.md
+- docs/client.md
+- docs/cluster.md
+- docs/docs.md
+- docs/index.md
+- docs/multi_search.md
 - docs/notifications.md
+- docs/scan_scroll.md
+- docs/snapshots.md
+- docs/templates.md
+- docs/warmers.md
 - elastomer-client.gemspec
 - lib/elastomer/client.rb
 - lib/elastomer/client/bulk.rb
@@ -151,7 +162,7 @@ files:
 - lib/elastomer/client/multi_search.rb
 - lib/elastomer/client/nodes.rb
 - lib/elastomer/client/repository.rb
-- lib/elastomer/client/scan.rb
+- lib/elastomer/client/scroller.rb
 - lib/elastomer/client/snapshot.rb
 - lib/elastomer/client/template.rb
 - lib/elastomer/client/warmer.rb
@@ -164,7 +175,7 @@ files:
 - script/bootstrap
 - script/cibuild
 - script/console
-- script/testsuite
+- script/test
 - test/assertions.rb
 - test/client/bulk_test.rb
 - test/client/cluster_test.rb
@@ -174,7 +185,7 @@ files:
 - test/client/multi_search_test.rb
 - test/client/nodes_test.rb
 - test/client/repository_test.rb
-- test/client/scan_test.rb
+- test/client/scroller_test.rb
 - test/client/snapshot_test.rb
 - test/client/stubbed_client_test.rb
 - test/client/template_test.rb
@@ -184,6 +195,7 @@ files:
 - test/middleware/encode_json_test.rb
 - test/middleware/opaque_id_test.rb
 - test/middleware/parse_json_test.rb
+- test/notifications_test.rb
 - test/test_helper.rb
 homepage: https://github.com/github/elastomer-client
 licenses:
@@ -205,10 +217,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A library for interacting with the GitHub Search infrastructure
+summary: A library for interacting with Elasticsearch
 test_files:
 - test/assertions.rb
 - test/client/bulk_test.rb
@@ -219,7 +231,7 @@ test_files:
 - test/client/multi_search_test.rb
 - test/client/nodes_test.rb
 - test/client/repository_test.rb
-- test/client/scan_test.rb
+- test/client/scroller_test.rb
 - test/client/snapshot_test.rb
 - test/client/stubbed_client_test.rb
 - test/client/template_test.rb
@@ -229,4 +241,5 @@ test_files:
 - test/middleware/encode_json_test.rb
 - test/middleware/opaque_id_test.rb
 - test/middleware/parse_json_test.rb
+- test/notifications_test.rb
 - test/test_helper.rb

data/.ruby-version

@@ -1 +0,0 @@
-2.1.0-github

data/lib/elastomer/client/scan.rb

@@ -1,161 +0,0 @@
-module Elastomer
-  class Client
-
-    # Create a new Scan instance for scrolling all results from a `query`.
-    #
-    # query  - The query to scan as a Hash or a JSON encoded String
-    # opts   - Options Hash
-    #   :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)
-    #   :size   - the number of documents per shard to fetch per scroll
-    #
-    # Examples
-    #
-    #   scan = client.scan('{"query":{"match_all":{}}}', :index => 'test')
-    #   scan.each_document do |document|
-    #     document['_id']
-    #     document['_source']
-    #   end
-    #
-    # Returns a new Scan instance
-    def scan( query, opts = {} )
-      Scan.new self, query, opts
-    end
-
-    # Continue scrolling a scan query.
-    # See http://www.elasticsearch.org/guide/reference/api/search/scroll/
-    #
-    # scroll_id - The current scroll ID as a String
-    # scroll    - The keep alive time of the scrolling request (5 minutes by default)
-    #
-    # Examples
-    #
-    #   scroll_id = client.scan('{"query":{"match_all":{}}}', :index => 'test').scroll_id
-    #
-    #   h = client.scroll scroll_id   # scroll to get the next set of results
-    #   scroll_id = h['_scroll_id']   # and store the scroll_id to use later
-    #
-    #   h = client.scroll scroll_id   # scroll again to get the next set of results
-    #   scroll_id = h['_scroll_id']   # and store the scroll_id to use later
-    #
-    #   # repeat until the results are empty
-    #
-    # Returns the response body as a Hash.
-    def scroll( scroll_id, scroll = '5m' )
-      response = get '/_search/scroll', :body => scroll_id, :scroll => scroll, :action => 'search.scroll'
-      response.body
-    end
-
-
-    class Scan
-      # Create a new scan client that can be used to iterate over all the
-      # documents returned by the `query`.
-      #
-      # 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/
-      #
-      # client - Elastomer::Client used for HTTP requests to the server
-      # query  - The query to scan as a Hash or a JSON encoded String
-      # opts   - Options Hash
-      #   :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)
-      #   :size   - the number of documents per shard to fetch per scroll
-      #
-      # Examples
-      #
-      #   scan = Scan.new(client, {:query => {:match_all => {}}}, :index => 'test-1')
-      #   scan.each_document { |doc|
-      #     doc['_id']
-      #     doc['_source']
-      #   }
-      #
-      def initialize( client, query, opts = {} )
-        @client = client
-        @query  = query
-
-        @index  = opts.fetch(:index, nil)
-        @type   = opts.fetch(:type, nil)
-        @scroll = opts.fetch(:scroll, '5m')
-        @size   = opts.fetch(:size, 50)
-
-        @offset = 0
-      end
-
-      attr_reader :client, :query, :index, :type, :scroll, :size
-
-      # Iterate over all the search results from the scan query.
-      #
-      # block  - The block will be called for each set of matching documents
-      #          returned from executing the scan query.
-      #
-      # Yields a hits Hash containing the 'total' number of hits, current
-      # 'offset' into that total, and the Array of 'hits' document Hashes.
-      #
-      # Examples
-      #
-      #   scan.each do |hits|
-      #     hits['total']
-      #     hits['offset']
-      #     hits['hits'].each { |document| ... }
-      #   end
-      #
-      # Returns this Scan instance.
-      def each
-        loop do
-          body = client.scroll scroll_id, scroll
-          @scroll_id = body['_scroll_id']
-
-          hits = body['hits']
-          break if hits['hits'].empty?
-
-          hits['offset'] = @offset
-          @offset += hits['hits'].length
-
-          yield hits
-        end
-
-        self
-      end
-
-      # Iterate over each document from the scan query. This method is just a
-      # convenience wrapper around the `each` method; it iterates the Array of
-      # documents and passes them one by one to the block.
-      #
-      # block  - The block will be called for each document returned from
-      #          executing the scan query.
-      #
-      # Yields a document Hash.
-      #
-      # Examples
-      #
-      #   scan.each_document do |document|
-      #     document['_id']
-      #     document['_source']
-      #   end
-      #
-      # Returns this Scan instance.
-      def each_document( &block )
-        each { |hits| hits['hits'].each(&block) }
-      end
-
-      # Internal: Returns the current scroll ID as a String.
-      def scroll_id
-        return @scroll_id if defined? @scroll_id
-
-        response = client.get '{/index}{/type}/_search',
-                              :action      => 'search.scan',
-                              :search_type => 'scan',
-                              :scroll      => scroll,
-                              :size        => size,
-                              :index       => index,
-                              :type        => type,
-                              :body        => query
-
-        @scroll_id = response.body['_scroll_id']
-      end
-
-    end  # Scan
-  end  # Client
-end  # Elastomer