elasticsearch-api 1.0.4 → 1.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGU5ZjdkZWQ4MmQ3NDhiMzhmY2VjYjE4ZTk3N2NhNDkwMGJhOGMzMw==
+    N2IwM2IzMzU4M2YzNWEzNzk3NTJmNmEwMjBlN2QxMzQ0OGY2NjMxNw==
   data.tar.gz: !binary |-
-    NWRmOGJjYTZlZDY3Zjk5ZWQ0NmFlOTI1M2NjNzczMzY2NDRkNWI3Yw==
+    NjYxZDkwNTBlN2Q5MDIwYjVmNWY2YWQzYjIyMDJmZDgwZTc1N2Y4MQ==
 SHA512:
   metadata.gz: !binary |-
-    NDc5ZDcxNzhiNjJjNzcwNWQyZjEwMmFmMWY1NzA3OWUyNWVlNGYyNjRmMGEz
-    MGI5ZTQwZTI2OGJmNGJlNzQzZTY0ZTdjNTM0ZWU4MzI4NTJjNzkzOTA3N2My
-    YjI5MzAxMTlhOTg1OGFiMTZlZGU1Mzk5MDQ2MWRmMTI3YmFjOGU=
+    N2Q2MzJhNDllNjkzZmZlNjRjNzZkZDk1YTVkOTg4MDg1MjdmOGU2NzI1ODNl
+    ZDBkMWYzMjc1NDgxYWU3NGNlYTM0YmE1NmJiZDdjMDRkNDE2ZTM3ODA1NTkx
+    ZGMxZmY3NzZmNDU3MmU5MGI5MDYzMzc4MDAyMmFhOWI5YWNhYTY=
   data.tar.gz: !binary |-
-    YzZjODYyMWU1YTgxMmEwYTc3NDdjMjA3YWMyOGUyOGM0ZDE3ZDZjNTdiNmZh
-    OWM4NjA4MTE4ZmU5ZDdiMmUyYzY4NzBhMzlmMjRiYzExMTc4YTQ0MDNiYWRj
-    OGE4ZWZjNGMwNjY0YzYwMDI1OTFiZDAzNWU5NmNmZjUzYzgxZTk=
+    NzM3MTNhNjY4YWE2YTM4OWI5ZDM4NGM4YTFjYzdhNjQ5MzM4OTFmZDZiNGQ2
+    MTU1N2U4OGJmNWVjNDI4ODNiN2VjNjE0NzIwMTVmYzgxYjc2OWMwYWQ0MjE1
+    ZWRiNmVjYzU4ZDc0MTQ1YTdmYzQ3ZTYyODY5MWE1ZTQyZDA2ZjU=

data/README.md

@@ -16,7 +16,7 @@ The library is compatible with Ruby 1.8.7 or higher.
 
 The library is compatible with Elasticsearch 0.90 and 1.0 -- you have to install and use a matching version, though.
 
-The 1.x versions and the master branch are compatible with **Elasticsearch 1.0** API.
+The 1.x versions and the master branch are compatible with **Elasticsearch 1.x** API.
 
 To use the **Elasticsearch 0.90** API, install the **0.4.x** gem version or use the corresponding
 [`0.4`](https://github.com/elasticsearch/elasticsearch-ruby/tree/0.4) branch.

data/elasticsearch-api.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
   s.add_development_dependency "pry"
-  s.add_development_dependency "ci_reporter"
+  s.add_development_dependency "ci_reporter", "~> 1.9"
 
   # Gems for testing integrations
   s.add_development_dependency "jsonify"
@@ -60,7 +60,6 @@ Gem::Specification.new do |s|
     s.add_development_dependency "simplecov-rcov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-    s.add_development_dependency "coveralls"
   end
 
   s.description = <<-DESC.gsub(/^    /, '')

data/lib/elasticsearch/api/actions/delete_script.rb

@@ -0,0 +1,24 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Remove an indexed script from Elasticsearch
+      #
+      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :lang Script language (*Required*)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html
+      #
+      def delete_script(arguments={})
+        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
+        method = 'DELETE'
+        path   = "_scripts/#{arguments[:lang]}/#{arguments[:id]}"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/delete_template.rb

@@ -0,0 +1,21 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Retrieve an indexed template from Elasticsearch
+      #
+      # @option arguments [String] :id Template ID
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
+      #
+      def delete_template(arguments={})
+        method = 'DELETE'
+        path   = "_search/template/#{arguments[:id]}"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/get_script.rb

@@ -0,0 +1,24 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Retrieve an indexed script from Elasticsearch
+      #
+      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :lang Script language (*Required*)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
+      #
+      def get_script(arguments={})
+        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
+        method = 'GET'
+        path   = "_scripts/#{arguments[:lang]}/#{arguments[:id]}"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/get_template.rb

@@ -0,0 +1,23 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Retrieve an indexed script from Elasticsearch
+      #
+      # @option arguments [String] :id Template ID (*Required*)
+      # @option arguments [Hash] :body The document
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
+      #
+      def get_template(arguments={})
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+        method = 'GET'
+        path   = "_search/template/#{arguments[:id]}"
+        params = {}
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/delete.rb

@@ -21,11 +21,10 @@ module Elasticsearch
         #
         # @example Delete all indices
         #
-        #     client.indices.delete
         #     client.indices.delete index: '_all'
         #
         # @option arguments [List] :index A comma-separated list of indices to delete;
-        #                                 use `_all` or leave empty to delete all indices
+        #                                 use `_all` to delete all indices
         # @option arguments [Time] :timeout Explicit operation timeout
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/

data/lib/elasticsearch/api/actions/indices/get_template.rb

@@ -16,14 +16,20 @@ module Elasticsearch
         # @note Use the {Cluster::Actions#state} API to get a list of all templates.
         #
         # @option arguments [String] :name The name of the template (supports wildcards)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
         #
         def get_template(arguments={})
+          valid_params = [ :flat_settings, :local ]
+
           method = 'GET'
           path   = Utils.__pathify '_template', Utils.__escape(arguments[:name])
-          params = {}
-          body = nil
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
 
           perform_request(method, path, params, body).body
         end

data/lib/elasticsearch/api/actions/put_script.rb

@@ -0,0 +1,43 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Store a script in an internal index (`.scripts`), to be able to reference them
+      # in search definitions (with dynamic scripting disabled)
+      #
+      # @example Storing an Mvel script in Elasticsearch and using it in function score
+      #
+      #     client.put_script lang: 'groovy', id: 'my_score', body: { script: 'log(_score * factor)' }
+      #
+      #     client.search body: {
+      #       query: {
+      #         function_score: {
+      #           query: { match: { title: 'foo' } },
+      #           functions: [ { script_score: { script_id: 'my_score', params: { factor: 3 } } } ]
+      #         }
+      #       }
+      #     }
+      #
+      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :lang Script language (*Required*)
+      # @option arguments [Hash]   :body A JSON document containing the script (*Required*)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
+      #
+      def put_script(arguments={})
+        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        method = 'PUT'
+        path   = "_scripts/#{arguments[:lang]}/#{arguments[:id]}"
+
+        params = {}
+
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/put_template.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Store a template for the search definition in Elasticsearch,
+      # to be later used with the `search_template` method
+      #
+      # @option arguments [String] :id Template ID (*Required*)
+      # @option arguments [Hash] :body The document (*Required*)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html
+      #
+      def put_template(arguments={})
+        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        method = 'PUT'
+        path   = "_search/template/#{arguments[:id]}"
+        params = {}
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/search.rb

@@ -22,6 +22,15 @@ module Elasticsearch
       #                     facets: { tags: { terms: { field: 'tags' } } }
       #                   }
       #
+      # @example Paginating results: return 10 documents, beginning from the 10th
+      #
+      #     client.search index: 'myindex',
+      #                   body: {
+      #                     query: { match: { title: 'test' } },
+      #                     from: 10,
+      #                     size: 10
+      #                   }
+      #
       # @example Passing the search definition as a `String`, built with a JSON builder
       #
       #     require 'jbuilder'

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

data/test/unit/delete_script_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class DeleteScriptTest < ::Test::Unit::TestCase
+
+      context "Delete script" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'DELETE', method
+            assert_equal '_scripts/groovy/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.delete_script :lang => "groovy", :id => "foo"
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/delete_template_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class DeleteTemplateTest < ::Test::Unit::TestCase
+
+      context "Delete template" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'DELETE', method
+            assert_equal '_search/template/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.delete_template :id => "foo"
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/get_script_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class GetScriptTest < ::Test::Unit::TestCase
+
+      context "Get script" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal '_scripts/groovy/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.get_script :lang => "groovy", :id => 'foo'
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/get_template_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class GetTemplateTest < ::Test::Unit::TestCase
+
+      context "Get template" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal '_search/template/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.get_template :id => "foo"
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/put_script_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class PutScriptTest < ::Test::Unit::TestCase
+
+      context "Put script" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_scripts/groovy/foo', url
+            assert_equal Hash.new, params
+            assert_equal 'bar', body[:script]
+            true
+          end.returns(FakeResponse.new)
+
+          subject.put_script :lang => 'groovy', :id => 'foo', :body => { :script => 'bar' }
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/put_template_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class PutTemplateTest < ::Test::Unit::TestCase
+
+      context "Put template" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_search/template/foo', url
+            assert_equal Hash.new, params
+            assert_equal Hash.new, body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.put_template :id => 'foo', :body => {}
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -196,16 +196,16 @@ dependencies:
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: jsonify
   requirement: !ruby/object:Gem::Requirement
@@ -332,20 +332,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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: ! 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
 
 '
@@ -393,10 +379,14 @@ files:
 - lib/elasticsearch/api/actions/create.rb
 - lib/elasticsearch/api/actions/delete.rb
 - lib/elasticsearch/api/actions/delete_by_query.rb
+- lib/elasticsearch/api/actions/delete_script.rb
+- lib/elasticsearch/api/actions/delete_template.rb
 - lib/elasticsearch/api/actions/exists.rb
 - lib/elasticsearch/api/actions/explain.rb
 - lib/elasticsearch/api/actions/get.rb
+- lib/elasticsearch/api/actions/get_script.rb
 - lib/elasticsearch/api/actions/get_source.rb
+- lib/elasticsearch/api/actions/get_template.rb
 - lib/elasticsearch/api/actions/index.rb
 - lib/elasticsearch/api/actions/indices/analyze.rb
 - lib/elasticsearch/api/actions/indices/clear_cache.rb
@@ -447,6 +437,8 @@ files:
 - lib/elasticsearch/api/actions/nodes/stats.rb
 - lib/elasticsearch/api/actions/percolate.rb
 - lib/elasticsearch/api/actions/ping.rb
+- lib/elasticsearch/api/actions/put_script.rb
+- lib/elasticsearch/api/actions/put_template.rb
 - lib/elasticsearch/api/actions/scroll.rb
 - lib/elasticsearch/api/actions/search.rb
 - lib/elasticsearch/api/actions/search_shards.rb
@@ -501,10 +493,14 @@ files:
 - test/unit/create_document_test.rb
 - test/unit/delete_by_query_test.rb
 - test/unit/delete_document_test.rb
+- test/unit/delete_script_test.rb
+- test/unit/delete_template_test.rb
 - test/unit/exists_document_test.rb
 - test/unit/explain_document_test.rb
 - test/unit/get_document_source_test.rb
 - test/unit/get_document_test.rb
+- test/unit/get_script_test.rb
+- test/unit/get_template_test.rb
 - test/unit/hashie_test.rb
 - test/unit/index_document_test.rb
 - test/unit/indices/analyze_test.rb
@@ -557,6 +553,8 @@ files:
 - test/unit/nodes/stats_test.rb
 - test/unit/percolate_test.rb
 - test/unit/ping_test.rb
+- test/unit/put_script_test.rb
+- test/unit/put_template_test.rb
 - test/unit/scroll_test.rb
 - test/unit/search_shards_test.rb
 - test/unit/search_template_test.rb
@@ -630,10 +628,14 @@ test_files:
 - test/unit/create_document_test.rb
 - test/unit/delete_by_query_test.rb
 - test/unit/delete_document_test.rb
+- test/unit/delete_script_test.rb
+- test/unit/delete_template_test.rb
 - test/unit/exists_document_test.rb
 - test/unit/explain_document_test.rb
 - test/unit/get_document_source_test.rb
 - test/unit/get_document_test.rb
+- test/unit/get_script_test.rb
+- test/unit/get_template_test.rb
 - test/unit/hashie_test.rb
 - test/unit/index_document_test.rb
 - test/unit/indices/analyze_test.rb
@@ -686,6 +688,8 @@ test_files:
 - test/unit/nodes/stats_test.rb
 - test/unit/percolate_test.rb
 - test/unit/ping_test.rb
+- test/unit/put_script_test.rb
+- test/unit/put_template_test.rb
 - test/unit/scroll_test.rb
 - test/unit/search_shards_test.rb
 - test/unit/search_template_test.rb