elasticsearch-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 247c30ecf7755b5a5d22ce3c300937ef7c177e94
+  data.tar.gz: 88f090eda370aa8f3abe42fc23e662cb97e5543b
+SHA512:
+  metadata.gz: 080f1aeb5a2c3e8ab6db4b0ef19dbf3fea7c4a6d5ad06298cb04d1210088fbc4d45248bd4e8be64b00c66817ad72a5f326fbd2218afb254dae7fd08b85009540
+  data.tar.gz: 442f18f9075381f6a7fe5c3ad6b8f07c952396c36e22d57c73be6df0a5b110935bfe295bb444dc997081a6d8ce76bee0135e592bbc60bda5238c5ab93f36f323

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticsearch-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2013 Elasticsearch
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,160 @@
+# Elasticsearch::API
+
+**This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package;
+please refer to it, unless you want to use this library standalone.**
+
+----
+
+The `elasticsearch-api` library provides a Ruby implementation of
+the [Elasticsearch](http://elasticsearch.org) REST API.
+
+It does not provide an Elasticsearch client; see the
+[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport)
+library.
+
+The library is compatible with Ruby 1.8.7 or higher.
+
+## Installation
+
+Install the package from [Rubygems](https://rubygems.org):
+
+    gem install elasticsearch-api
+
+To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
+
+    gem 'elasticsearch-api', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
+
+or install it from a source code checkout:
+
+    git clone https://github.com/elasticsearch/elasticsearch-ruby.git
+    cd elasticsearch-ruby/elasticsearch-api
+    bundle install
+    rake install
+
+## Usage
+
+The library is designed as a group of standalone Ruby modules, which can be mixed into a class
+providing connection to Elasticsearch -- an Elasticsearch client.
+
+**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package,
+the library modules have been already included**, so you just call the API methods:
+
+```ruby
+require 'elasticsearch'
+
+client = Elasticsearch::Client.new log: true
+
+client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
+# => {"ok"=>true, "_index"=>"myindex", ...}
+
+client.search body: { query: { match: { title: 'test' } } }
+# => {"took"=>2, ..., "hits"=>{"total":5, ...}}
+```
+
+When you want to mix the library into you own client, it must conform to a following _contract_:
+
+* It responds to a `perform_request(method, path, params, body)` method,
+* the method returns an object with `status`, `body` and `headers` methods.
+
+A simple client could look like this:
+
+```ruby
+require 'multi_json'
+require 'faraday'
+require 'elasticsearch/api'
+
+class MySimpleClient
+  include Elasticsearch::API
+
+  CONNECTION = ::Faraday::Connection.new url: 'http://localhost:9200'
+
+  def perform_request(method, path, params, body)
+    puts "--> #{method.upcase} #{path} #{params} #{body}"
+
+    CONNECTION.run_request \
+      method.downcase.to_sym,
+      path,
+      ( body ? MultiJson.dump(body): nil ),
+      {'Content-Type' => 'application/json'}
+  end
+end
+
+client = MySimpleClient.new
+
+p client.cluster.health
+# --> GET _cluster/health {}
+# => "{"cluster_name":"elasticsearch" ... }"
+
+p client.index index: 'myindex', type: 'mytype', id: 'custom', body: { title: "Indexing from my client" }
+# --> PUT myindex/mytype/custom {} {:title=>"Indexing from my client"}
+# => "{"ok":true, ... }"
+```
+
+## Using JSON Builders
+
+Instead of passing the `:body` argument as a Ruby _Hash_, you can pass it as a _String_, potentially
+taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jbuilder) or
+[Jsonify](https://github.com/bsiggelkow/jsonify):
+
+```ruby
+require 'jbuilder'
+
+json = Jbuilder.encode do |json|
+  json.query do
+    json.match do
+      json.title do
+        json.query    'test 1'
+        json.operator 'and'
+      end
+    end
+  end
+end
+
+client.search index: 'myindex', body: json
+
+# 2013-06-25 09:56:05 +0200: GET http://localhost:9200/myindex/_search [status:200, request:0.015s, query:0.011s]
+# 2013-06-25 09:56:05 +0200: > {"query":{"match":{"title":{"query":"test 1","operator":"and"}}}}
+# ...
+# => {"took"=>21, ..., "hits"=>{"total"=>1, "hits"=>[{ "_source"=>{"title"=>"Test 1", ...}}]}}
+```
+
+## Using Hash Wrappers
+
+For a more comfortable access to response properties, you may wrap it in one of the _Hash_ "object access"
+wrappers, such as [`Hashie::Mash`](https://github.com/intridea/hashie):
+
+```ruby
+require 'hashie'
+
+response = client.search index: 'myindex',
+                         body: {
+                           query: { match: { title: 'test' } },
+                           facets: { tags: { terms: { field: 'tags' } } }
+                         }
+
+mash = Hashie::Mash.new response
+
+mash.hits.hits.first._source.title
+# => 'Test'
+
+response.facets.tags.terms.first
+# => #<Hashie::Mash count=3 term="z">
+```
+
+## License
+
+This software is licensed under the Apache 2 license, quoted below.
+
+    Copyright (c) 2013 Elasticsearch <http://www.elasticsearch.org>
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/Rakefile

@@ -0,0 +1,62 @@
+require "bundler/gem_tasks"
+
+desc "Run unit tests"
+task :default => 'test:unit'
+task :test    => 'test:unit'
+
+# ----- Test tasks ------------------------------------------------------------
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    # test.verbose = true
+    # test.warning = true
+  end
+
+  Rake::TestTask.new(:integration) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/integration/yaml_test_runner.rb", "test/integration/**/*_test.rb"]
+  end
+
+  Rake::TestTask.new(:all) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+  end
+
+  namespace :server do
+    desc "Start Elasticsearch nodes for tests"
+    task :start do
+      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
+      require 'elasticsearch/transport'
+      require 'elasticsearch/transport/extensions/test_cluster'
+      Elasticsearch::TestCluster.start
+    end
+
+    desc "Stop Elasticsearch nodes for tests"
+    task :stop do
+      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
+      require 'elasticsearch/transport'
+      require 'elasticsearch/transport/extensions/test_cluster'
+      Elasticsearch::TestCluster.stop
+    end
+  end
+end
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown |
+end
+
+# ----- Code analysis tasks ---------------------------------------------------
+
+if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+  require 'cane/rake_task'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 15
+    cane.no_style = true
+  end
+end

data/elasticsearch-api.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/api/version'
+
+Gem::Specification.new do |s|
+  s.name          = "elasticsearch-api"
+  s.version       = Elasticsearch::API::VERSION
+  s.authors       = ["Karel Minarik"]
+  s.email         = ["karel.minarik@elasticsearch.org"]
+  s.summary       = "Ruby API for Elasticsearch."
+  s.homepage      = "https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api"
+  s.license       = "Apache 2"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.add_dependency "multi_json"
+
+  s.add_development_dependency "bundler", "> 1"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "elasticsearch-transport"
+
+  s.add_development_dependency "ansi"
+  s.add_development_dependency "shoulda-context"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "turn"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "ruby-prof"
+
+  s.add_development_dependency "multi_json"
+  s.add_development_dependency "jbuilder"
+  s.add_development_dependency "jsonify"
+  s.add_development_dependency "hashie"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "simplecov"
+    s.add_development_dependency "cane"
+    s.add_development_dependency "require-prof"
+  end
+
+  s.description = <<-DESC.gsub(/^    /, '')
+    Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
+  DESC
+end

data/lib/elasticsearch-api

@@ -0,0 +1 @@
+require 'elasticsearch/api'

data/lib/elasticsearch/api.rb

@@ -0,0 +1,23 @@
+require "multi_json"
+
+require "elasticsearch/api/version"
+require "elasticsearch/api/namespace/common"
+require "elasticsearch/api/utils"
+
+Dir[ File.expand_path('../api/actions/**/*.rb', __FILE__) ].each   { |f| require f }
+Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require f }
+
+module Elasticsearch
+  module API
+
+    # Auto-include all namespaces in the receiver
+    #
+    def self.included(base)
+      base.send :include,
+                Elasticsearch::API::Common,
+                Elasticsearch::API::Actions,
+                Elasticsearch::API::Cluster,
+                Elasticsearch::API::Indices
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Perform multiple index, delete or update operations in a single request.
+      #
+      # Pass the operations in the `:body` option as an array of hashes, following Elasticsearch conventions.
+      # For operations which take data, pass them as the `:data` option in the operation hash.
+      #
+      # @example Perform three operations in a single request
+      #
+      #     client.bulk body: [
+      #       { index:  { _index: 'myindex', _type: 'mytype', _id: 1, data: { title: 'foo' } } },
+      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2, data: { doc: { title: 'foo' } } } },
+      #       { delete: { _index: 'myindex', _type: 'mytype', _id: 3  },
+      #     ]
+      #
+      # @example Perform a script-based bulk update
+      #
+      #     client.bulk body: [
+      #       { update: { _index: 'myindex', _type: 'mytype', _id: 1,
+      #                  data: {
+      #                   script: "ctx._source.counter += value",
+      #                   lang: 'js',
+      #                   params: { value: 1 }, upsert: { counter: 0 } }
+      #                 }},
+      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2,
+      #                  data: {
+      #                   script: "ctx._source.counter += value",
+      #                   lang: 'js',
+      #                   params: { value: 42 }, upsert: { counter: 0 } }
+      #                  }}
+      #
+      #     ]
+      #
+      # @option arguments [String] :index Default index for items which don't provide one
+      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [Array<Hash>] :body An array of operations to perform, each operation is a Hash
+      # @option arguments [String] :consistency Explicit write consistency setting for the operation (options: one, quorum, all)
+      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
+      # @option arguments [String] :replication Explicitely set the replication type (options: sync, async)
+      # @option arguments [String] :type Default document type for items which don't provide one
+      #
+      # @return [Hash] Deserialized Elasticsearch response
+      #
+      # @see http://elasticsearch.org/guide/reference/api/bulk/
+      #
+      def bulk(arguments={})
+        method = 'POST'
+        path   = [arguments[:index], arguments[:type], '_bulk'].compact.join('/')
+        params = arguments.select do |k,v|
+          [ :consistency,
+            :refresh,
+            :replication,
+            :type ].include?(k)
+        end
+        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+        params = Hash[params] unless params.is_a?(Hash)
+        body   = arguments[:body]
+
+        if body.is_a? Array
+          payload = Utils.__bulkify(body)
+        else
+          payload = body
+        end
+
+        perform_request(method, path, params, payload).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -0,0 +1,21 @@
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+
+        # Get the cluster settings (previously set with {Cluster::Actions#put_settings})
+        #
+        # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
+        #
+        def get_settings(arguments={})
+          method = 'GET'
+          path   = "_cluster/settings"
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end