desi 0.2.0 → 0.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/README.md

@@ -1,4 +1,6 @@
-# Desi
+Desi
+====
+[![Build Status](https://secure.travis-ci.org/AF83/desi.png)](http://travis-ci.org/AF83/desi)
 
 Desi (Developper ElasticSearch Installer) is very simple tool to quickly set up
 an [Elastic Search](http://www.elasticsearch.org/) local install for
@@ -51,6 +53,24 @@ will be spun up by (`desi start`)
   Desi::LocalInstall.new.releases.detect(&:current?).version #=> "0.19.9"
   ```
 
+### Start a node instance and get the cluster's status
+
+  * command-line
+
+  ```shell
+  $ desi start
+   * Elastic Search 0.19.9 started
+  $ desi status
+  OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status yellow
+  ```
+
+
+  * library
+
+  ```ruby
+  Desi::ProcessManager.new.start.status #=> "OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status green"
+  ```
+
 
 ### List and delete some indices
 
@@ -65,7 +85,7 @@ will be spun up by (`desi start`)
     bar
     baz
 
-  $ # List all indices on remote cluster 129.168.1.42, reachable on port 9800
+  $ # List all indices with "foo" in their name on remote cluster 129.168.1.42, port 9800
   $ desi indices --host 129.168.1.42:9800 foo
     Indices from host http://192.168.1.42:9800 matching the pattern /foo/
 
@@ -86,16 +106,16 @@ will be spun up by (`desi start`)
   # All local indices
   Desi::IndexManager.new.list #=> ["foo", "bar", "baz"]
 
-  # All local indices whose name starts with `b`
+  # All local indices whose name starts with "b"
   Desi::IndexManager.new.list("^b") #=> ["bar", "baz"]
 
   # All indices from distant cluster
   Desi::IndexManager.new(host: "192.168.1.42:9800").list #=> ["remotefoo1", "remotefoo2"]
 
-  # Delete all local indices whose name starts with `ba`
+  # Delete all local indices whose name starts with "ba"
   Desi::IndexManager.new.delete!("^ba") #=> nil
 
-  # The indices actually disappeared
+  # The indices actually disappeared! \o/
   Desi::IndexManager.new.list #=> ["foo"]
   ```
 

data/Rakefile

@@ -2,3 +2,6 @@
 require "bundler/gem_tasks"
 
 FileList['tasks/**/*.rake'].each { |task| import task }
+
+desc 'Default: run all specs'
+task :default => :spec

data/lib/desi/index_manager.rb

@@ -20,7 +20,7 @@ module Desi
     #
     # @note The +:http_client_factory+ should return an instance that responds
     #       to #get and #delete
-    # @return [undefined]
+    # @return [void]
     #
     # @api public
     def initialize(opts = {})
@@ -60,7 +60,7 @@ module Desi
     # Delete all indices matching the specified pattern
     #
     # @param   [#to_s]          pattern  Regexp pattern used to restrict the selection
-    # @return  [undefined]
+    # @return  [void]
     #
     # @note No confirmation is needed, so beware!
     #
@@ -77,7 +77,7 @@ module Desi
       @outputter.puts "The following indices from host #{@host} are now deleted" if @verbose
 
       indices(Regexp.new(pattern)).each do |index|
-        @client.delete(index)
+        @client.delete("/#{index}")
         @outputter.puts " * #{index}" if @verbose
       end
     end
@@ -85,7 +85,7 @@ module Desi
     # Empty (remove all records) from indices matching the specified pattern
     #
     # @param   [#to_s]          pattern  Regexp pattern used to restrict the selection
-    # @return  [undefined]
+    # @return  [void]
     #
     # @note No confirmation is needed, so beware!
     #
@@ -102,7 +102,7 @@ module Desi
       @outputter.puts "The following indices from host #{@host} are now emptied" if @verbose
 
       indices(Regexp.new(pattern)).each do |index|
-        @client.delete("#{index}/_query?q=*")
+        @client.delete("/#{index}/_query?q=*")
         @outputter.puts " * #{index}" if @verbose
       end
     end
@@ -110,7 +110,7 @@ module Desi
     private
 
     def indices(pattern)
-      JSON.parse(@client.get('_status').body)["indices"].keys.select {|i|
+      JSON.parse(@client.get('/_status').body)["indices"].keys.select {|i|
               i =~ pattern
       }
     end

data/lib/desi/process_manager.rb

@@ -7,6 +7,19 @@ require "desi/http_client"
 require "desi/local_install"
 
 module Desi
+
+  # The ProcessManager will start, stop and restart a local Elastic Search node
+  # instance, in addition to reporting its status
+  #
+  # @example Start up the instance and check its status
+  #   Desi::ProcessManager.new.start.status #=> "OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status green"
+  #
+  # @example Retrieve the currently running cluster's version
+  #   Desi::ProcessManager.new.running_version #=> "0.19.9"
+  #
+  # @example Retrieve a distant cluster's version
+  #   Desi::ProcessManager.new(host: "http://somewhere.com:9200").running_version #=> "0.18.5"
+  #
   class ProcessManager
 
     def initialize(opts = {})
@@ -16,6 +29,16 @@ module Desi
       @client = opts.fetch(:http_client_factory, Desi::HttpClient).new(@host)
     end
 
+    # Start the cluster
+    #
+    # This will be a no-op if the cluster is already started.
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @return [self]
+    #
+    # @api  public
     def start
       if cluster_ready?
         puts "ES cluster is already running" if @verbose
@@ -23,15 +46,39 @@ module Desi
         start_cluster
         puts " * Elastic Search #{running_version} started" if @verbose
       end
-    end
-
+      self
+    end
+
+    # Restart the cluster
+    #
+    # Stop the cluster (if its up) and start it again.
+    #
+    # @note We use the pidfile to determine if the cluster is up. If a node was
+    #       started with another tool, you may end up with more than 1 node
+    #       running.
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @return [self]
+    #
+    # @api  public
     def restart
       puts " * (Re)starting cluster" if @verbose
       stop if has_pid?
       start_cluster
       puts " * Elastic Search #{running_version} started" if @verbose
+      self
     end
 
+    # Stop the cluster
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @return [self]
+    #
+    # @api  public
     def stop
       if pid
         puts " * Will stop instance with pid #{pid}" if @verbose
@@ -39,13 +86,19 @@ module Desi
       else
         puts " * No pidfile detected!. Won't stop" if @verbose
       end
-    end
-
-    def restart
-      stop
-      start
-    end
-
+      self
+    end
+
+    # Get information about the cluster's status
+    #
+    #   Desi::ProcessManager.new.status #=> "OK. Elastic Search cluster 'elasticsearch' (v0.19.9) is running on 1 node(s) with status green"
+    #
+    # @note This method will also output its result on STDOUT if +@verbose+ is
+    #       true
+    #
+    # @return [String]
+    #
+    # @api  public
     def status
       if version = running_version
         msg = "OK. Elastic Search cluster '#{cluster_health.cluster_name}' (v#{version}) is running on #{cluster_health.number_of_nodes} node(s) with status #{cluster_health.status}"
@@ -56,14 +109,27 @@ module Desi
       msg
     end
 
+    # Whether the pidfile actually holds a PID
+    #
+    # @return [Boolean]
     def has_pid?
       pid && !pid.empty?
     end
 
+    # PID as retrieved from the pidfile
+    #
+    # @return [String]
     def pid
       @pid ||= File.read(pidfile) if pidfile.exist?
     end
 
+    # Release number of the currently running cluster
+    #
+    # @example
+    #   Desi::ProcessManager.new.running_version #=> "0.19.9"
+    #
+    #
+    # @return [String,nil]
     def running_version
       begin
         JSON.parse(@client.get('/').body)["version"]["number"]
@@ -72,6 +138,21 @@ module Desi
       end
     end
 
+    protected
+
+    # Return cluster health data straight from the cluster
+    #
+    # see
+    # http://www.elasticsearch.org/guide/reference/api/admin-cluster-health.html
+    # for further information on the response's structure
+    #
+    # @return [Hash]
+    def cluster_health
+      @cluster_health ||= OpenStruct.new(JSON.parse(@client.get('/_cluster/health').body))
+    end
+
+    private
+
     def wait_until_cluster_becomes_ready(max_wait = 10, step = 0.5)
       wait_for(max_wait, step) { cluster_ready? }
     end
@@ -80,8 +161,6 @@ module Desi
       wait_for(max_wait, step) { !cluster_ready? }
     end
 
-    private
-
     def start_cluster
       line = Cocaine::CommandLine.new(@local_install.launcher.to_s, "-p :pidfile", pidfile: pidfile.to_s)
       line.run
@@ -124,9 +203,6 @@ module Desi
       delay < max_wait
     end
 
-    def cluster_health
-      @cluster_health ||= OpenStruct.new(JSON.parse(@client.get('/_cluster/health').body))
-    end
 
   end
 end

data/lib/desi/version.rb

@@ -1,3 +1,3 @@
 module Desi
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/desi/index_manager_spec.rb

@@ -18,7 +18,7 @@ describe Desi::IndexManager do
   end
 
   def stub_indices(*names)
-    stub_request(:get, '_status', {"indices" => Hash[Array(names).zip]})
+    stub_request(:get, '/_status', {"indices" => Hash[Array(names).zip]})
   end
 
   before do
@@ -63,7 +63,7 @@ describe Desi::IndexManager do
     end
 
     it "deletes all matching indices" do
-      http_client.should_receive(:delete).with("foo")
+      http_client.should_receive(:delete).with("/foo")
       http_client.should_not_receive(:delete).with("bar")
 
       subject.delete!('f.*')
@@ -96,7 +96,7 @@ describe Desi::IndexManager do
     end
 
     it "deletes all matching indices" do
-      http_client.should_receive(:delete).with("foo/_query?q=*")
+      http_client.should_receive(:delete).with("/foo/_query?q=*")
       http_client.should_not_receive(:delete).with("bar")
 
       subject.empty!('f.*')

data/tasks/spec.rake

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: desi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
@@ -168,6 +168,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - Guardfile
@@ -189,6 +190,7 @@ files:
 - lib/desi/version.rb
 - spec/desi/index_manager_spec.rb
 - spec/spec_helper.rb
+- tasks/spec.rake
 - tasks/yard.rake
 homepage: https://github.com/AF83/desi/
 licenses: []
@@ -204,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1725098947325688636
+      hash: 3454323007955509059
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -213,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1725098947325688636
+      hash: 3454323007955509059
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24