elasticsearch-node 0.6.0

data/.gitignore

@@ -0,0 +1,4 @@
+*/logs/*
+*/data/*
+pkg/*
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+env:
+  - ES_VERSION=0.18.7
+  - ES_VERSION=0.19.1
+before_script: "bin/install_elasticsearch"

data/COPYING.md

@@ -0,0 +1,27 @@
+ElasticSearch
+Copyright 2009-2011 Elastic Search and Shay Banon
+
+See full details in elasticsearch/LICENSE.txt and elasticsearch/NOTICE.txt.
+
+Ruby portions are licensed under MIT:
+
+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/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'riot'
+gem 'faraday'
+gem 'rake'
+

data/README.md

@@ -0,0 +1,93 @@
+# elasticsearch-node
+
+[![Build Status](https://secure.travis-ci.org/Asquera/elasticsearch-node.png?branch=master)](http://travis-ci.org/Asquera/elasticsearch-node)
+
+`elasticsearch-node` is a Ruby library to start, manipulate and shutdown elasticsearch nodes in a controlled fashion. On JRuby, it also provides a native binding to this functionality. Its very handy in testing environments.
+
+## Installation
+
+```
+gem install elasticsearch-node
+```
+
+After installation, make sure to run:
+
+```
+install_elasticsearch
+```
+
+For legacy versions, use:
+
+```
+ES_VERSION=0.18.7
+```
+
+## Usage
+
+```
+require 'elasticsearch-node/external'
+require 'elasticsearch-node/embedded'
+require 'elasticsearch-node/remote'
+
+external = ElasticSearch::Node::External "gateway.type" => "none"
+embedded = ElasticSearch::Node::Embedded "gateway.type" => "none"
+remote   = ElasticSearch::Node::Remote '127.0.0.1', 9200
+
+[external, embedded, remote].each do |node|
+  puts node.ip
+  puts node.port
+end
+
+embedded.client
+```
+
+`elasticsearch-node` provides 3 types of nodes: `External`, `Embedded` and `Remote`. They differ in capabilities:
+
+* `External` nodes are started as an external process and can be started, configured and shut down
+* `Embedded` nodes are only available on JRuby and start and embedded Elasticsearch instance. In addition to the capabilities of external nodes, embedded nodes expose the `client` method, which returns a vanilla Elasticsearch client
+* `Remote` nodes a standin for nodes not under control by this process: they are only configured using port and ip and have not further capabilities.
+
+## Clients
+
+`elasticsearch-node` also provides a protocol to associate clients with nodes. See this example:
+
+```
+n = ElasticSearch::Node::External.new do
+  def client
+    conn = Faraday.new(:url => "http://#{self.ip}:#{self.port}") do |builder|
+      builder.adapter :net_http
+    end
+  end
+end
+
+n.client #=> <#Faraday::Connection...
+
+# or alternatively:
+
+module HTTPClient
+  def client
+    conn = Faraday.new(:url => "http://#{self.ip}:#{self.port}") do |builder|
+      builder.adapter :net_http
+    end
+  end
+end
+
+n = ElasticSearch::Node::External.new :client_module => HTTPClient
+```
+
+This allows client implementations to be independent of which kind of nodes they run on (as long as they don't rely on those features).
+
+## Final Remarks
+
+Please be aware that this library does not add any `at_exit`-hooks to your application. Shutdown must be taken care of, as elasticsearch takes some seconds to shut down and killing it can lead to data corruption. In most cases, its as easy as:
+
+    at_exit { node.close }
+
+## Flaws
+
+* No windows support at the moment.
+* No 1.8 support at the moment.
+
+### License
+
+See `COPYING.md` for all details.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems' unless defined?(Gem)
+require 'rubygems/specification'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("elasticsearch-node.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.libs << "test"
+  test.pattern = 'test/**/*_test.rb'
+
+  test.verbose = true
+end
+
+task :default => :test

data/bin/install_elasticsearch

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+es_version = ENV['ES_VERSION'] || "0.19.1"
+
+puts "Installing elasticsearch-#{es_version}. 
+To install a different version, specify it using the ES_VERSION environment variable.
+    ES_VERSION=0.18.7 install_elasticsearch"
+
+Dir.chdir(File.dirname(File.dirname(__FILE__)))
+
+`curl https://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-#{es_version}.tar.gz -L -o elasticsearch.tar.gz`
+`tar xvf elasticsearch.tar.gz`
+#mv elasticsearch-$ES_VERSION elasticsearch
+File.unlink "elasticsearch.tar.gz"

data/configs/testing/config/elasticsearch.yml

@@ -0,0 +1,32 @@
+# The cluster name
+#cluster.name: elasticsearch
+
+gateway.type: none
+
+# Path Settings
+#path.conf: "/Users/skade/Code/elsearch/elsearch-node/configs/testing/config"
+#path.data: /path/to/data
+#path.work: /path/to/work
+#path.logs: /path/to/logs
+
+# Force all memory to be locked, forcing the JVM to never swap
+#bootstrap.mlockall: true
+
+# Gateway Settings
+#   Controls when to start the initial recovery process when starting a new cluster
+#   allowing for better reused of existing data during recovery.
+#gateway.recover_after_nodes: 1
+#gateway.recover_after_time: 5m
+#gateway.expected_nodes: 2
+
+# Controls the minimum number of master eligible nodes this node should "see"
+# in order to operate within the cluster.
+#   Set this to a higher value (2-4) when running more than 2 nodes in the cluster
+#discovery.zen.minimum_master_nodes: 1
+
+# The time to wait for ping responses from other nodes when doing node discovery
+#discovery.zen.ping.timeout: 3s
+
+# Unicast Discovery (disable multicast)
+#discovery.zen.ping.multicast.enabled: false
+#discovery.zen.ping.unicast.hosts: ["host1", "host2"]

data/configs/testing/config/logging.yml

@@ -0,0 +1,31 @@
+rootLogger: INFO, console, file
+logger:
+  # log action execution errors for easier debugging
+  action: DEBUG
+  # reduce the logging for aws, too much is logged under the default INFO
+  com.amazonaws: WARN
+
+  # gateway
+  gateway: DEBUG
+  index.gateway: DEBUG
+
+  # peer shard recovery
+  index.shard.recovery: DEBUG
+
+  # discovery
+  discovery: TRACE
+
+appender:
+  console:
+    type: console
+    layout:
+      type: consolePattern
+      conversionPattern: "[%d{ISO8601}][%-5p][%-25c] %m%n"
+
+  file:
+    type: dailyRollingFile
+    file: ${path.logs}/${cluster.name}.log
+    datePattern: "'.'yyyy-MM-dd"
+    layout:
+      type: pattern
+      conversionPattern: "[%d{ISO8601}][%-5p][%-25c] %m%n"

data/elasticsearch-node.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "elasticsearch-node/version"
+
+Gem::Specification.new do |s|
+  s.name        = "elasticsearch-node"
+  s.version     = Elsearch::Node::VERSION
+  s.authors     = ["Florian Gilcher"]
+  s.email       = ["florian.gilcher@asquera.de"]
+  s.homepage    = "http://github.com/Asquera/elasticsearch-node"
+  s.summary     = %q{Helper gem to install and start an elasticsearch node}
+  s.description = %q{Helper gem to install and start an elasticsearch node}
+
+  s.rubyforge_project = "elasticsearch-node"
+
+  s.files         = (
+                      `git ls-files`.split("\n") + 
+                      Dir["elasticsearch/{bin,config,lib,README.textile,NOTICE.txt,LICENSE.txt}"]
+                    ).uniq
+  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_development_dependency "riot"
+  s.add_development_dependency "faraday"
+end

data/fetch_es.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+es_version = ENV['ES_VERSION'] || "0.19.1"
+
+`curl https://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-#{es_version}.tar.gz -L -o elasticsearch.tar.gz`
+`tar xvf elasticsearch.tar.gz`
+#mv elasticsearch-$ES_VERSION elasticsearch
+File.unlink "elasticsearch-#{es_version}.tar.gz"

data/lib/elasticsearch-node/client_provider.rb

@@ -0,0 +1,22 @@
+module ElasticSearch
+  module ClientProvider
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      attr_accessor :default_client_module
+    end
+    
+    def initialize(opts = {}, &block)
+      if block
+        mod = Module.new(&block)
+        extend mod
+      elsif opts[:client_module]
+        extend opts[:client_module]
+      elsif self.class.default_client_module
+        extend self.class.default_client_module
+      end
+    end
+  end
+end

data/lib/elasticsearch-node/embedded.rb

@@ -0,0 +1,57 @@
+require 'elasticsearch-node'
+require 'jruby'
+
+Dir["#{ElasticSearch::Node.lib}/*.jar"].each do |jar|
+  require jar
+end
+
+module ElasticSearch
+  module Node
+    class Embedded
+      include ElasticSearch::ClientProvider
+
+      def initialize(opts = {})
+        node_builder = org.elasticsearch.node.NodeBuilder.nodeBuilder.loadConfigSettings(true)
+        settings_builder = org.elasticsearch.common.settings.ImmutableSettings.settingsBuilder
+        
+        if opts[:config]
+          settings_builder.put("path.home", opts[:config])
+        end
+        
+        settings_builder.put(opts[:settings]) if opts[:settings]
+        
+        tuple = org.elasticsearch.node.internal.InternalSettingsPerparer.prepareSettings(settings_builder.build, true)
+        org.elasticsearch.common.logging.log4j.LogConfigurator.configure(tuple.v1());
+        @node = node_builder.settings(settings_builder).node
+        super(opts)
+      end
+
+      def port
+        Integer(socket_address.port)
+      end
+
+      def ip
+        socket_address.host_string
+      end
+
+      def client
+        @node.client
+      end
+      
+      def close
+        @node.close
+      end
+
+      private
+
+        def http_server
+          @node.injector.getInstance(org.elasticsearch.http.HttpServer.java_class)
+        end
+
+        def socket_address
+          http_server.info.address.publishAddress.address
+        end
+    end
+  end
+  
+end

data/lib/elasticsearch-node/external.rb

@@ -0,0 +1,73 @@
+require 'elasticsearch-node'
+
+module ElasticSearch
+  module Node
+    class External
+      include ElasticSearch::ClientProvider
+
+      attr_accessor :pid
+
+      def initialize(opts = {})
+        if opts[:config]
+          ENV["ES_HOME"] = ElasticSearch::Node.config(opts[:config])
+        end
+
+        commandline = opts.map {|opt,value| "-Des.#{opt}=#{value}" }.join(" ")
+
+        capture_ip_and_port do
+          self.pid = Kernel.spawn("#{Node.binary} -f #{commandline}", :out => :out, :err => :err)
+        end
+
+        super(opts)
+      end
+
+      def port
+        unless @port
+          parse_ip_and_port
+        end
+
+        @port
+      end
+
+      def ip
+        unless @ip
+          parse_ip_and_port
+        end
+
+        @ip
+      end
+
+      def close
+        $stderr.puts "Killing ElasticSearch node: #{pid}"
+        Process.kill 15, pid
+        begin
+          Process.waitpid pid
+        rescue Errno::ECHILD
+          # Possible, if process is already gone
+        end
+      end
+
+      private
+        def capture_ip_and_port(&block)
+          read, write = IO.pipe
+
+          old_stdout = $stdout.dup
+          $stdout.reopen(write)
+
+          yield
+
+          read.each do |line|
+            old_stdout << line
+
+            if line =~ /\[http\s*\].*\/(.*):([0-9]+)/
+              @ip = $1
+              @port = Integer($2)
+              break
+            end
+          end
+
+          $stdout.reopen(old_stdout)
+        end
+    end
+  end
+end

data/lib/elasticsearch-node/remote.rb

@@ -0,0 +1,24 @@
+module ElasticSearch
+  module Node
+    class Remote
+      include ElasticSearch::ClientProvider
+      
+      attr_accessor :port, :ip
+      
+      def initialize(port, ip)
+        this.port = port
+        this.ip   = ip
+      end
+
+      def port
+        Integer(@port)
+      end
+
+      def close
+        raise "Remote Nodes cannot be closed directly, please use a shutdown request"
+      end
+
+    end
+  end
+  
+end

data/lib/elasticsearch-node/version.rb

@@ -0,0 +1,5 @@
+module Elsearch
+  module Node
+    VERSION = "0.6.0"
+  end
+end

data/lib/elasticsearch-node.rb

@@ -0,0 +1,40 @@
+require "elasticsearch-node/version"
+require 'elasticsearch-node/client_provider'
+
+module ElasticSearch 
+  module Node
+    attr_accessor :version
+    
+    def self.root(*args)
+      File.join(File.dirname(__FILE__), "..", *args)
+    end
+  
+    def self.path
+      File.expand_path(File.join(root, "elasticsearch-#{version}"))
+    end
+    
+    def self.binary
+      File.join(path, 'bin', 'elasticsearch')
+    end
+
+    def self.version
+      `#{binary} -v`
+    end
+
+    def self.lib
+      File.join(path, 'lib')
+    end
+    
+    def self.config(name)
+      root('configs', name.to_s, "config")
+    end
+    
+    def self.default_config(name)
+      ENV["ES_JAVA_OPTS"] = "-Des.path.conf=#{self.config(name)}"
+    end
+    
+    def self.version
+      @version || ENV["ES_VERSION"] || "0.19.1"
+    end
+  end
+end

data/test/nodes/client_provider_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+require 'elasticsearch-node/external'
+
+module DefaultClient
+  def client
+    conn = Faraday.new(:url => "http://#{self.ip}:#{self.port}") do |builder|
+      builder.adapter :net_http
+    end
+  end
+end
+
+context "An external node" do
+  context "with inline client definition" do
+    setup do
+      ElasticSearch::Node::External.new do
+        def client
+          conn = Faraday.new(:url => "http://#{self.ip}:#{self.port}") do |builder|
+            builder.adapter :net_http
+          end
+        end
+      end
+    end
+    
+    teardown do
+      topic.close
+    end
+    
+    asserts(:client).kind_of?(Faraday::Connection)
+  end
+  
+  context "with client module as option" do
+    setup do
+      ElasticSearch::Node::External.new(:client_module => DefaultClient)
+    end
+    
+    teardown do
+      topic.close
+    end
+    
+    asserts(:client).kind_of?(Faraday::Connection)
+  end
+  
+  context "with default module" do
+    setup do
+      ElasticSearch::Node::External.default_client_module = DefaultClient
+      ElasticSearch::Node::External.new
+    end
+    
+    teardown do
+      ElasticSearch::Node::External.default_client_module = nil
+      topic.close
+    end
+    
+    asserts(:client).kind_of?(Faraday::Connection)
+  end
+end

data/test/nodes/embedded_test.rb

@@ -0,0 +1,17 @@
+if 'jruby' == RUBY_ENGINE
+  require 'test_helper'
+  require 'elasticsearch-node/embedded'
+  
+  context "An embedded node" do
+    setup do
+      ElasticSearch::Node::Embedded.new(:config => File.expand_path('configs/testing'))
+    end
+    
+    teardown do
+      topic.close
+    end
+     
+    asserts(:ip).kind_of?(String)
+    asserts(:port).kind_of?(Integer)
+  end
+end

data/test/nodes/external_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'elasticsearch-node/external'
+
+context "An external node" do
+  setup do
+    ElasticSearch::Node::External.new
+  end
+
+  teardown do
+    topic.close
+  end
+
+  asserts(:ip).kind_of?(String)
+  asserts(:port).kind_of?(Integer)
+end
+
+context "A configured external node" do
+  setup do
+    ElasticSearch::Node::External.new("node.name" => "foobar", "http.port" => 10000)
+  end
+
+  teardown do
+    topic.close
+  end
+
+  asserts(:ip).kind_of?(String)
+  asserts(:port).kind_of?(Integer)
+  asserts(:port).equals(10000)
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'riot'
+require 'faraday'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch-node
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Florian Gilcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &2165532760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165532760
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &2165532100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165532100
+description: Helper gem to install and start an elasticsearch node
+email:
+- florian.gilcher@asquera.de
+executables:
+- install_elasticsearch
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- COPYING.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/install_elasticsearch
+- configs/testing/config/elasticsearch.yml
+- configs/testing/config/logging.yml
+- elasticsearch-node.gemspec
+- fetch_es.rb
+- lib/elasticsearch-node.rb
+- lib/elasticsearch-node/client_provider.rb
+- lib/elasticsearch-node/embedded.rb
+- lib/elasticsearch-node/external.rb
+- lib/elasticsearch-node/remote.rb
+- lib/elasticsearch-node/version.rb
+- test/nodes/client_provider_test.rb
+- test/nodes/embedded_test.rb
+- test/nodes/external_test.rb
+- test/test_helper.rb
+homepage: http://github.com/Asquera/elasticsearch-node
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: elasticsearch-node
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Helper gem to install and start an elasticsearch node
+test_files:
+- test/nodes/client_provider_test.rb
+- test/nodes/embedded_test.rb
+- test/nodes/external_test.rb
+- test/test_helper.rb