eson-http 0.7.0

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Florian Gilcher <florian.gilcher@asquera.de>, Felix Gilcher <felix.gilcher@asquera.de>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# eson-http. A HTTP client for elasticsearch
+
+Eson provides a fairly complete implementation of the elasticsearch HTTPAPI for ruby.
+
+It tries to keep the language of the ES API as intact as possible.
+
+## Usage
+
+    require 'eson-http'
+
+    c = Eson::HTTP::Client.new(:server => 'http://localhost:9200')
+    
+    doc = {
+      :user => "kimchy",
+      :post_date => "2009-11-15T14:12:12",
+      :message => "trying out Elastic Search"
+    }
+
+    c.index :index    => "twitter",
+            :type     => "tweet",
+            :id       => 1,
+            :document => doc
+
+    c.get :type => "tweet", :id => 1 # returns the document
+
+    c.search :q => "message:trying"
+
+    c.count :q => "*"
+
+## Building requests by hand
+
+The client has an additional mode that does not call elasticsearch  immediately, but returns the request object instead.
+
+    require 'echolon/http'
+
+    c = Eson::HTTP::Client.new(:server => 'http://localhost:9200',
+                               :auto_call => false)
+    
+    doc = {
+      :user => "kimchy",
+      :post_date => "2009-11-15T14:12:12",
+      :message => "trying out Elastic Search"
+    }
+
+    index_request = c.index
+    index_request.index = "twitter"
+    index_request.type  = "tweet"
+    index_request.id    = 1
+    index_request.doc   = doc
+
+    index_request.call
+
+    # or:
+
+    index_request = c.index
+    index_request.params = {
+      :index => "twitter",
+      :type  => "tweet"
+      :id    => 1,
+      :doc   => doc
+    }
+
+    # or:
+
+    index_request = c.index :index => "twitter",
+                            :type  => "tweet"
+                            :id    => 1,
+                            :doc   => doc
+
+## Bulk Requests
+
+`bulk` and `msearch` requests can be constructed by calling the respective client methods on them:
+
+
+```
+c.bulk do |b|
+  b.index :index => "default",
+          :type => "bar"
+          :doc => {"foo" => "bar"}
+  b.delete :index => "default",
+           :id => '134'
+end
+
+c.msearch do |s|
+  s.search #....
+end
+```
+
+## The shell
+
+Eson-HTTP comes with a quick-and-dirty shell, if you have pry installed:
+
+    $ elshell 127.0.0.1:9200
+    pry(#<ElasticSearch::Client:0x000001014f4078>)> node
+    => "127.0.0.1:9200"
+
+    pry(#<ElasticSearch::Client:0x000001014f4078>)> index_name
+    => "twitter"
+
+    pry(#<ElasticSearch::Client:0x000001014f4078>)> get :type => 'tweet', :id => 2
+    => {"_index"=>"twitter", "_type"=>"tweet", "_id"=>"2", "_version"=>1, "_source"=>{"user"=>"kimchy", "post_date"=>"2009-11-15T14:12:12", "message"=>"You know, for Search"}}
+    
+
+## TODO
+
+* Test suite needs to be reordered. Its the oldest part of the project and a bit messy.
+* Filters in aliases are not supported
+
+## See also
+
+* Tire

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("eson-http.gemspec")
+    ::Gem::Specification.load(file)
+  end
+end
+
+desc "Validates the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end
+
+task :package => :gemspec
+
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/*_test.rb'
+  
+  test.verbose = true
+end
+
+task :seed do
+  require './test/seeds/seeds'
+end

data/bin/elshell

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(File.dirname(__FILE__)), "lib")
+
+require 'echolon-http'
+require 'echolon-search'
+
+require 'elsearch-node'
+
+require 'node/external'
+
+require 'rest-client'
+require 'addressable/template'
+
+require 'pry'
+
+c = Eson::HTTP::Client.new(:server => ARGV.first || 'http://localhost:9200',
+                                    :logger => Logger.new($stdout))
+
+c.pry

data/eson-http.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+#require "./lib/elsearch"
+
+Gem::Specification.new do |s|
+  s.name        = "eson-http"
+  s.version     = "0.7.0" #Echolon::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Florian Gilcher"]
+  s.email       = ["florian.gilcher@asquera.de"]
+  s.homepage    = ""
+  s.summary     = %q{A modular client for Eson - HTTP interface}
+  s.description = %q{A modular client for Eson. It provides
+  an implementation of the Query language as well as multiple client implementations
+  for HTTP and native access.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  #s.add_dependency "typhoeus"
+  s.add_dependency "faraday", "~> 0.7.0"
+  s.add_dependency "addressable"
+  s.add_dependency "eson-core"
+  s.add_development_dependency "elasticsearch-node"
+  s.add_development_dependency "riot"
+end

data/lib/eson-http.rb

@@ -0,0 +1,55 @@
+require 'eson-core'
+
+require 'addressable/template'
+
+require 'eson/http'
+
+require 'eson/modules/status_handler'
+require 'eson/modules/response_parser'
+
+require 'eson/http/client'
+require 'eson/http/request'
+require 'eson/http/api'
+
+require 'eson/http/core/index'
+require 'eson/http/core/get'
+require 'eson/http/core/delete'
+require 'eson/http/core/search'
+require 'eson/http/core/delete_by_query'
+require 'eson/http/core/count'
+require 'eson/http/core/bulk'
+require 'eson/http/core/percolate'
+require 'eson/http/core/simple_search'
+require 'eson/http/core/more_like_this'
+require 'eson/http/core/msearch'
+require 'eson/http/core/mget'
+
+require 'eson/http/cluster/health'
+require 'eson/http/cluster/state'
+require 'eson/http/cluster/nodes'
+require 'eson/http/cluster/stats'
+require 'eson/http/cluster/shutdown'
+
+require 'eson/http/indices/aliases'
+require 'eson/http/indices/analyze'
+require 'eson/http/indices/clear_cache'
+require 'eson/http/indices/close_index'
+require 'eson/http/indices/create_index'
+require 'eson/http/indices/delete_index'
+require 'eson/http/indices/delete_mapping'
+require 'eson/http/indices/flush'
+require 'eson/http/indices/get_mapping'
+require 'eson/http/indices/get_settings'
+require 'eson/http/indices/open_index'
+require 'eson/http/indices/optimize'
+require 'eson/http/indices/put_mapping'
+require 'eson/http/indices/refresh'
+require 'eson/http/indices/snapshot'
+require 'eson/http/indices/status'
+require 'eson/http/indices/put_template'
+require 'eson/http/indices/get_template'
+require 'eson/http/indices/delete_template'
+require 'eson/http/indices/update_settings'
+require 'eson/http/indices/exists'
+require 'eson/http/indices/stats'
+require 'eson/http/indices/segments'

data/lib/eson/http.rb

@@ -0,0 +1,16 @@
+module Eson
+  module HTTP
+    def self.logger=(logger)
+      if String === logger
+        require 'logger'
+        @logger = Logger.new(logger)
+      else
+        @logger = logger
+      end
+    end
+
+    def self.logger
+      @logger
+    end
+  end
+end

data/lib/eson/http/api.rb

@@ -0,0 +1,13 @@
+module Eson
+  module HTTP
+    module API
+      include Eson::API
+      
+      def request_method(method)
+        define_method :request_method do
+          @request_method || method
+        end
+      end
+    end
+  end
+end

data/lib/eson/http/client.rb

@@ -0,0 +1,24 @@
+module Eson
+  module HTTP
+    class Client < Eson::Client
+      DEFAULT_OPTS = {
+                       :server => "http://localhost:9200",
+                       :protocol => Eson::HTTP
+                     }
+
+      def initialize(opts = {})
+        opts = DEFAULT_OPTS.merge(:plugins => default_plugins).merge(opts)
+        super(opts)
+      end
+      
+      private
+        def default_plugins
+          [Eson::StatusHandler, Eson::ResponseParser].tap do |plugins|
+            if defined? Eson::QueryPlugin
+              plugins.unshift(Eson::QueryPlugin)
+            end
+          end
+        end
+    end
+  end
+end

data/lib/eson/http/cluster/health.rb

@@ -0,0 +1,15 @@
+module Eson
+  module HTTP
+    module Health
+      include Shared::Health
+      extend API
+      
+      request_method :get
+             
+      def path
+        '/_cluster/health/{-list|,|indices}'
+      end
+      
+    end
+  end
+end

data/lib/eson/http/cluster/nodes.rb

@@ -0,0 +1,14 @@
+module Eson
+  module HTTP
+    module Nodes
+      include Shared::Nodes
+      extend API
+      
+      request_method :get
+    
+      def path
+        '/_cluster/nodes/{-list|,|nodes}'
+      end
+    end
+  end
+end

data/lib/eson/http/cluster/shutdown.rb

@@ -0,0 +1,15 @@
+module Eson
+  module HTTP
+    module Shutdown
+      #TODO fully implement and test this
+      include Shared::Shutdown
+      extend API
+      
+      request_method :post
+      
+      def path
+        '/_cluster/nodes/{-list|,|nodes}/_shutdown'
+      end
+    end
+  end
+end

data/lib/eson/http/cluster/state.rb

@@ -0,0 +1,16 @@
+module Eson
+  module HTTP
+    module State
+      include Shared::State
+      extend API
+      #TODO implement filter_indices correctly
+      
+      request_method :get
+             
+      def path
+        '/_cluster/state'
+      end
+      
+    end
+  end
+end

data/lib/eson/http/cluster/stats.rb

@@ -0,0 +1,18 @@
+module Eson
+  module HTTP
+    module Stats
+      include Shared::Stats
+      extend API
+      
+      request_method :get
+    
+      def path
+        if nodes.empty?
+          '/_cluster/nodes/stats'
+        else
+          '/_cluster/nodes/{-list|,|nodes}/stats'
+        end
+      end
+    end
+  end
+end

data/lib/eson/http/core/bulk.rb

@@ -0,0 +1,33 @@
+module Eson
+  module HTTP
+    module Bulk
+      include Shared::Bulk
+      extend API
+      
+      request_method :put
+      
+      def path
+        '/_bulk'
+      end
+      
+      def source
+        bulk.map {|r| serialize_request(r)}.join
+      end
+      
+      def serialize_request(request)
+        case request
+        when Eson::HTTP::Index
+          MultiJson.encode({ "index" => to_params_hash(request) }) << "\n" << request.source << "\n"
+        when Eson::HTTP::Delete
+          MultiJson.encode({ "delete" => to_params_hash(request) }) << "\n"
+        else
+          warn("Unserializable request #{request.inspect}")
+        end
+      end
+      
+      def to_params_hash(r)
+        { "_index" => r.index, "_type" => r.type, "_id" => r.id }
+      end
+    end
+  end
+end