elasticshell 0.0.4 → 0.0.5

data/README.rdoc

@@ -244,11 +244,14 @@ that has the +response+ and +request+ variables in scope.  You can be
 even more free by just piping without any Ruby code, which will leave
 you in a Ruby (Pry) shell with the same binding.
 
-GET /my_index$ _search /tmp/query_that_needs_interaction.json | 
->> response
-=> {"took"=>1, "timed_out"=>false, ... }
->> request
-=> {:verb=>"GET", :path=>"/_search", :query_options=>{}, :body=>""}
+  GET /my_index$ _search /tmp/query_that_needs_interaction.json | 
+  >> response
+  => {"took"=>1, "timed_out"=>false, ... }
+  >> request
+  => {:verb=>"GET", :path=>"/_search", :query_options=>{}, :body=>""}
+
+Hit CTRL-D to get out of this new interactive Ruby shell and back to
+Elasticshell.
 
 === Requests from the command line
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/bin/es

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 
 require 'elasticshell'
+require 'elasticshell/runner'
 Elasticshell.start

data/lib/elasticshell.rb

@@ -4,24 +4,6 @@ require 'configliere'
 
 require 'elasticshell/utils'
 
-Settings.use(:commandline)
-
-Settings.define(:servers, :description => "A comma-separated list of Elasticsearch servers to connect to.", :type => Array, :default => 'http://localhost:9200')
-Settings.define(:only,    :description => "A dot-separated hierarchical key to extract from the output scope.")
-Settings.define(:pretty,  :description => "Pretty-print all output. ", :default => false, :type => :boolean)
-Settings.define(:verb,    :description => "Set the default HTTP verb. ", :default => "GET")
-Settings.define(:version, :description => "Print Elasticshell version and exit. ", :default => false, :type => :boolean)
-Settings.define(:scope,   :description => "The default scope to start the shell in.", :default => "/")
-Settings.description = <<-DESC
-Elasticshell is a command-line shell for interacting with an
-Elasticsearch database.  It has the following start-up options.
-DESC
-
-def Settings.usage
-  "usage: #{File.basename($0)} [OPTIONS] [REQUEST]"
-end
-Settings.resolve!
-
 module Elasticshell
 
   autoload :Client,   'elasticshell/client'
@@ -33,32 +15,10 @@ module Elasticshell
 
   def self.version
     @version ||= begin
-                   File.read(File.expand_path('../../VERSION', __FILE__)).chomp
-                 rescue => e
-                   'unknown'
-                 end
-  end
-  
-  def self.start *args
-    begin
-      case
-      when Settings[:version]
-        puts version
-        exit()
-      when Settings[:only] && Settings.rest.empty?
-        raise ArgumentError.new("Starting with the --only option requires a request argument (like `/_cluster/health')")
-        exit(1)
-      when (! Settings.rest.empty?)
-        es = Shell.new(Settings.merge(:log_requests => false))
-        es.connect
-        es.eval_line(Settings.rest.first)
-        exit()
-      else
-        Shell.new(Settings).run
-      end
-    rescue Elasticshell::Error => e
-      $stderr.puts e.message
-      exit(2)
+      File.read(File.expand_path('../../VERSION', __FILE__)).chomp
+    rescue => e
+      'unknown'
     end
   end
+  
 end

data/lib/elasticshell/client.rb

@@ -1,4 +1,5 @@
 require 'rubberband'
+require 'timeout'
 
 module Elasticshell
 
@@ -9,11 +10,21 @@ module Elasticshell
     end
 
     def connect options={}
-      servers = (options.merge(@options)[:servers] || Settings[:servers].to_s.split(","))
+      servers = (@options.merge(options)[:servers] || Settings[:servers].to_s.split(","))
+      raise ClientError.new("Must provide at least one server to connect to.") if servers.empty?
       begin
-        @client = ElasticSearch::Client.new(servers)
+        Elasticshell.debug("Connecting to Elasticsearch servers: #{servers.join(', ')}")
+        begin
+          timeout(5) do
+            @client = ElasticSearch::Client.new(servers)
+          end
+        rescue Timeout::Error => e
+          Elasticshell.error("Could not connect to Elasticsearch servers: #{servers.join(', ')}")
+          return
+        end
+        Elasticshell.info("Connected to Elasticsearch servers: #{servers.join(', ')}")
       rescue ElasticSearch::ConnectionFailed => e
-        raise ClientError.new("Could not connect to Elasticsearch server(s) at #{servers.join(',')}")
+        raise ClientError.new("Could not connect to Elasticsearch server: #{servers.join(', ')}")
       end
     end
 
@@ -45,16 +56,16 @@ module Elasticshell
     end
 
     def log_request verb, params, options={}
-      begin
+      # begin
         # FIXME digging way too deep into rubberband here...is it really
-        # necessary?
+      # necessary?
         uri   = @client.instance_variable_get('@connection').send(:generate_uri, params)
         query = @client.instance_variable_get('@connection').send(:generate_query_string, options)
         path  = [uri, query].reject { |s| s.nil? || s.strip.empty? }.join("?").gsub(Regexp.new("^/+"), "/")
-        Elasticshell.log("#{verb.to_s.upcase} #{path}".strip)
-      rescue
-        Elasticshell.log("#{verb.to_s.upcase} #{params.inspect} #{options.inspect}".strip)
-      end
+        Elasticshell.request(verb, @client.current_server, path)
+      # rescue
+      #   Elasticshell.info(verb, path, "#{verb.to_s.upcase} #{params.inspect} #{options.inspect}".strip)
+      # end
     end
 
     def safely verb, params={}, options={}, body=''

data/lib/elasticshell/command.rb

@@ -14,7 +14,7 @@ module Elasticshell
     end
 
     def be_connected!
-      raise ClientError.new("Not connected to any Elasticsearch servers.") unless shell.connected?
+      raise ClientError.new("Not connected to any Elasticsearch servers.  Try running\n\n\t#{shell.prompt}connect URI [URI] ...\n\n") unless shell.connected?
     end
 
     def evaluate!
@@ -24,7 +24,7 @@ module Elasticshell
 
   module Commands
     PRIORITY = [].tap do |priority|
-      %w[cd pwd df connect help ls pretty set_verb blank request unknown].each do |command_name|
+      %w[cd pwd df connect help ls pretty set_verb exit blank request unknown].each do |command_name|
         klass_name = command_name.split("_").map(&:capitalize).join("")
         autoload klass_name.to_sym, "elasticshell/commands/#{command_name}"
         priority << klass_name

data/lib/elasticshell/commands/connect.rb

@@ -13,18 +13,30 @@ module Elasticshell
         if servers.empty?
           shell.client.connect()
         else
-          servers.each do |server|
+          uris = servers.map do |raw|
+            has_port = raw =~ /:\d+/
+            cooked  = (raw =~ /^http:\/\// ? raw : 'http://' + raw)
+            cooked += '/' unless cooked =~ /\/$/
             begin
-              uri = URI.parse(server + "/")
+              uri = URI.parse(cooked)
+              if uri.path == '/'
+                uri.port = 9200 unless has_port
+                uri.to_s
+              else
+                Elasticshell.warn("#{raw} is not a valid URI for an ElasticSearch server")
+                nil
+              end
             rescue => e
-              raise ArgumentError.new("#{server} is not a valid URI")
+              Elasticshell.warn("#{raw} is not a valid URI")
+              nil
             end
-            raise ArgumentError.new("#{server} is not a valid URI for an ElasticSearch server") unless uri.path == '/'
-          end
-          shell.client.connect(:servers => servers)
+          end.compact
+          shell.client.connect(:servers => uris)
         end
       end
 
+      
+
     end
   end
 end

data/lib/elasticshell/commands/exit.rb

@@ -0,0 +1,15 @@
+module Elasticshell
+  module Commands
+    class Exit < Command
+
+      def self.matches? input
+        input =~ /^(quit|exit|bye)$/i
+      end
+
+      def evaluate!
+        exit(0)
+      end
+      
+    end
+  end
+end

data/lib/elasticshell/commands/ls.rb

@@ -40,21 +40,21 @@ module Elasticshell
           when scope.class == Scopes::Index && scope.mappings.include?(scope_name)
             shell.print("m                          \e[32m%s\e[0m" % [scope_name])
           else
-            shell.print shell.format(:scope_long_format, "%s", scope_name)
+            shell.print Elasticshell.format(:scope_long_format, "%s", scope_name)
           end
         end
         sort(scope.request_names).each do |request|
-          shell.print shell.format(:request_long_format, "%r", request)
+          shell.print Elasticshell.format(:request_long_format, "%r", request)
         end
       end
 
       def ls!
         output = []
         sort(scope.scopes).map do |scope|
-          output << shell.format(:scope_format, "%s", scope)
+          output << Elasticshell.format(:scope_format, "%s", scope)
         end
         sort(scope.request_names).map do |request|
-          output << shell.format(:request_format, "%r", request)
+          output << Elasticshell.format(:request_format, "%r", request)
         end
         shell.print output.join(' ')
       end

data/lib/elasticshell/commands/request_parser.rb

@@ -60,7 +60,7 @@ module Elasticshell
           when raw_body.nil?
             ''
           when raw_body == '-'
-            command.shell.error.puts("Reading request body from STDIN.  Press `C-d' to terminate input...")
+            Elasticshell.info("Reading request body from STDIN.  Press `C-d' to terminate input...")
             command.shell.input_stream.gets(nil)
           when File.exist?(raw_body)
             File.read(raw_body)

data/lib/elasticshell/runner.rb

@@ -0,0 +1,58 @@
+module Elasticshell
+
+  ORIG_ARGV = ARGV.dup.freeze
+
+  Settings.use(:commandline)
+  Settings.define(:servers, :description => "A comma-separated list of Elasticsearch servers to connect to.", :type => Array, :default => ['localhost:9200'])
+  Settings.define(:config,  :description => "Path to an Elasticsearch config file to read settings from", :default => '/etc/elasticsearch/elasticsearch.yml')
+  Settings.define(:only,    :description => "A dot-separated hierarchical key to extract from the output scope.")
+  Settings.define(:pretty,  :description => "Pretty-print all output. ", :default => false, :type => :boolean)
+  Settings.define(:verb,    :description => "Set the default HTTP verb. ", :default => "GET")
+  Settings.define(:version, :description => "Print Elasticshell version and exit. ", :default => false, :type => :boolean)
+  Settings.define(:scope,   :description => "The default scope to start the shell in.", :default => "/")
+  Settings.define(:eval,    :description => "Evaluate given Ruby code on response.")
+  Settings.description = <<-DESC
+Elasticshell is a command-line shell for interacting with an
+Elasticsearch database.  It has the following start-up options.
+DESC
+
+  def Settings.usage
+    "usage: #{File.basename($0)} [OPTIONS] [REQUEST]"
+  end
+
+  def self.overrode_servers_on_command_line?
+    ORIG_ARGV.any? { |arg| arg =~ /--servers/ }
+  end
+
+  def self.find_servers_from_config_file! path=nil
+    return if overrode_servers_on_command_line?
+    file = ElasticsearchConfigFile.new(path || Settings[:config])
+    Settings[:servers] = file.hosts if file.readable? && (!file.hosts.empty?)
+  end
+  
+  def self.start *args
+    begin
+      Settings.resolve!
+      find_servers_from_config_file!
+      case
+      when Settings[:version]
+        puts version
+        exit()
+      when (Settings[:only] || Settings[:eval]) && Settings.rest.empty?
+        raise ArgumentError.new("Starting with the --only or --eval options requires a request argument (like `/_cluster/health')")
+        exit(1)
+      when (! Settings.rest.empty?)
+        es = Shell.new(Settings.merge(:log_requests => false))
+        es.connect
+        es.eval_line(Settings.rest.first)
+        exit()
+      else
+        Shell.new(Settings).run
+      end
+    rescue Elasticshell::Error => e
+      Elasticshell.error(e.message)
+      exit(2)
+    end
+  end
+
+end

data/lib/elasticshell/scopes/global.rb

@@ -14,7 +14,8 @@ module Elasticshell
       def self.requests
         @requests ||= {
           "GET" => {
-            '_status'  => "Retreive the status of all indices in the cluster."
+            '_status'  => "Retreive the status of all indices in the cluster.",
+            '_count'   => "Count all records."
           }
         }
       end

data/lib/elasticshell/scopes/index.rb

@@ -21,6 +21,7 @@ module Elasticshell
             "_status"  => "Retrieve the status of this index.",
             "_stats"   => "Retrieve usage stats for this index.",
             "_search"  => "Search records within this index.",
+            "_count"   => "Count records within this index."
           }
         }
       end

data/lib/elasticshell/scopes/mapping.rb

@@ -19,6 +19,7 @@ module Elasticshell
           "GET" => {
             "_search"  => "Search records within this mapping.",
             "_mapping" => "Retrieve the mapping settings for this mapping.",
+            "_count"   => "Count records within this mapping.",
           }
         }
       end

data/lib/elasticshell/shell.rb

@@ -62,7 +62,7 @@ module Elasticshell
     
     include Elasticshell::HasVerb
 
-    attr_accessor :client, :state, :only, :input, :cache, :output, :error, :line, :input_stream
+    attr_accessor :client, :state, :only, :ruby_code, :input, :cache, :output, :line, :input_stream
 
     attr_reader :scope
     def scope= scope
@@ -91,9 +91,9 @@ module Elasticshell
       self.verb   = (options[:verb] || 'GET')
       self.scope  = scope_from_path(options[:scope] || '/')
       self.only   = options[:only]
+      self.ruby_code = options[:eval]
       self.input_stream  = (options[:input]  || $stdin)
       self.output = (options[:output] || $stdout)
-      self.error  = (options[:error]  || $stderr)
       self.line   = 0
       @log_requests = (options[:log_requests] == false ? false : true)
       pretty! if options[:pretty]
@@ -107,22 +107,14 @@ module Elasticshell
       end
     end
 
-    def format name, codes, values
-      cs = [codes].flatten
-      vs = [values].flatten
-      raise ArgumentError.new("Must provide the same number of format codes as value strings.") unless cs.length == vs.length
-      Settings[name].dup.tap do |s|
-        cs.each_with_index do |c, index|
-          v = vs[index]
-          s.gsub!(c, v)
-        end
-      end
+    def prompt
+      verb_string  = self.class.formatted_verb(verb)
+      scope_string = Elasticshell.format((scope.exists? ? :existing_scope_format : :missing_scope_format), "%s", scope.path)
+      Elasticshell.format((pretty? ? :pretty_prompt_format : :prompt_format), ["%s", "%v"], [scope_string, verb_string])
     end
 
-    def prompt
-      verb_string  = format((verb =~ /^(?:G|H)/i ? :passive_http_verb_format : :active_http_verb_format), "%v", verb)
-      scope_string = format((scope.exists? ? :existing_scope_format : :missing_scope_format), "%s", scope.path)
-      format((pretty? ? :pretty_prompt_format : :prompt_format), ["%s", "%v"], [scope_string, verb_string])
+    def self.formatted_verb verb
+      Elasticshell.format((verb.to_s =~ /^(?:G|H)/i ? :passive_http_verb_format : :active_http_verb_format), "%v", verb.to_s.upcase)
     end
     
     def pretty?
@@ -164,7 +156,7 @@ EOF
     end
 
     def connect
-      eval_line("connect #{@initial_servers.join(',')}")
+      eval_line("connect #{@initial_servers.join(' ')}")
     end
 
     def loop
@@ -181,7 +173,7 @@ EOF
         self.input = line.strip
         command.evaluate!
       rescue ::Elasticshell::Error => e
-        error.puts e.message
+        Elasticshell.error e.message
       end
       self.state = :read
       self.line += 1
@@ -212,7 +204,7 @@ EOF
         format_only_part_of(obj)
       when obj.nil?
         nil
-      when String, Fixnum
+      when obj.is_a?(String) || obj.is_a?(Fixnum)
         obj
       when pretty?
         JSON.pretty_generate(obj)

data/lib/elasticshell/utils.rb

@@ -1,5 +1,6 @@
 require 'elasticshell/utils/error'
 require 'elasticshell/utils/log'
+require 'elasticshell/utils/es_config'
 
 module Elasticshell
 

data/lib/elasticshell/utils/es_config.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+
+module Elasticshell
+
+  class ElasticsearchConfigFile
+
+    attr_accessor :path
+
+    def initialize path
+      self.path = path
+    end
+
+    def readable?
+      File.exist?(path) && File.readable?(path)
+    end
+
+    def config
+      @config ||= YAML.load(File.new(path))
+    end
+
+    def hosts
+      return @hosts if @hosts
+      Elasticshell.debug("Looking for Elasticsearch hosts in #{path}...")
+      unicast_hosts   = (config["discovery"]["zen"]["ping"]["unicast"]["hosts"] rescue nil)
+      unicast_hosts ||= (config["discovery"]["zen"]["ping"]["unicast.hosts"]    rescue nil)
+      unicast_hosts ||= (config["discovery"]["zen"]["ping.unicast.hosts"]       rescue nil)
+      unicast_hosts ||= (config["discovery"]["zen.ping.unicast.hosts"]          rescue nil)
+      unicast_hosts ||= (config["discovery"]["zen.ping.unicast.hosts"]          rescue nil)
+      unicast_hosts ||= (config["discovery.zen.ping.unicast.hosts"]             rescue nil)
+      @hosts = case unicast_hosts
+      when String then unicast_hosts.split(',').map(&:strip)
+      when Array  then unicast_hosts.map(&:to_s).map(&:strip)
+      else
+        []
+      end.map do |unicast_host|
+        host(unicast_host)
+      end
+    end
+
+    def http_port
+      return @http_port if @http_port
+      port_string   = (config["http"]["port"] rescue nil)
+      port_string ||= (config["http.port"]    rescue nil)
+      @http_port = case port_string
+      when String, Fixnum then port_string.to_i
+      else 9200
+      end
+    end
+    
+    private
+
+    def host string
+      case string
+      when /^(.+)\[(.+)-(.+)\]$/ then [$1, $2].join(':')
+      when /^(.+):(.+)$/         then [$1, $2].join(':')
+      else
+        [string, http_port].map(&:to_s).join(':')
+      end
+    end
+
+
+  end
+end

data/lib/elasticshell/utils/log.rb

@@ -1,9 +1,85 @@
+require 'logger'
+
 module Elasticshell
+  
+  Settings.define(:log,       :description => "Path to a log file (defaults to STDERR)", :env_var => "ES_LOG", :default => STDERR)
+  Settings.define(:log_level, :description => "Log level", :default => "info",            :env_var => "ES_LOG_LEVEL")
+
+  Settings.define(:http_request_format,
+                  :description => "Format string for an HTTP request.  The string `%v' will be replaced by the (formatted) verb, `%h' by the host, `%p' by the path.",
+                  :default     => "  \e[1m=> %v \e[0m\e[39m%h\e[1m%p\e[0m",
+                  :internal    => true)
+
+  Settings.define(:debug_format,
+                  :description => "Format string for a a DEBUG log message.  The string `%m' will be replaced by the message",
+                  :default     => "\e[1m\e[32mDEBUG:\e[0m %m",
+                  :internal    => true)
+
+  Settings.define(:info_format,
+                  :description => "Format string for a a INFO log message.  The string `%m' will be replaced by the message",
+                  :default     => "\e[1m\e[34mINFO:\e[0m %m",
+                  :internal    => true)
+  
+  Settings.define(:warn_format,
+                  :description => "Format string for a a WARN log message.  The string `%m' will be replaced by the message",
+                  :default     => "\e[1m\e[35mWARN:\e[0m %m",
+                  :internal    => true) 
+  
+  Settings.define(:error_format,
+                  :description => "Format string for a a ERROR log message.  The string `%m' will be replaced by the message",
+                  :default     => "\e[1m\e[31mERROR:\e[0m %m",
+                  :internal    => true) 
+ 
+  def self.log
+    @log ||= default_logger
+  end
+
+  def self.default_logger
+    Logger.new(Settings[:log]).tap do |l|
+      begin
+        l.level = Logger::Severity.const_get(Settings[:log_level].to_s.upcase)
+      rescue NameError => e
+        STDERR.puts "WARN: Log severity must be one of #{Logger::Severity.map(&:to_s).join(', ')}.  Setting severity to \"info\""
+        l.level = Logger::Severity::INFO
+      end
+      l.formatter = proc do |severity, datetime, progname, msg|
+        msg + "\n"
+      end
+    end
+  end
+
+  def self.format name, codes, values
+    cs = [codes].flatten
+    vs = [values].flatten
+    raise ArgumentError.new("Must provide the same number of format codes as value strings.") unless cs.length == vs.length
+    Settings[name].dup.tap do |s|
+      cs.each_with_index do |c, index|
+        v = vs[index]
+        s.gsub!(c, v)
+      end
+    end
+  end
 
-  def self.log msg
-    $stderr.puts(msg)
+  def self.request verb, host, path
+    log.info(format(:http_request_format, ["%v", "%h", "%p"], [Shell.formatted_verb(verb), host, path]))
   end
   
-end
+  def self.debug msg
+    log.debug(format(:debug_format, "%m", msg))
+  end
 
+  def self.info msg
+    log.info(format(:info_format, "%m", msg))
+  end
+  
+  def self.warn msg
+    log.warn(format(:warn_format, "%m", msg))
+  end
   
+  def self.error msg
+    log.error(format(:error_format, "%m", msg))
+  end
+  
+end
+
+

data/spec/elasticshell/commands/cd_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Commands::Cd do
 
   before do
-    @shell  = Shell.new(:output => FakeOutput.new, :error => FakeOutput.new)
+    @shell  = Shell.new(:output => FakeOutput.new)
   end
   
   it "should change scope when given an argument" do

data/spec/elasticshell/commands/connect_spec.rb

@@ -13,7 +13,7 @@ describe Commands::Connect do
   end
 
   it "should start a connection to the given comma-separated servers" do
-    @shell.client.should_receive(:connect).with(:servers => %w[http://123.123.123.123:9200 http://321.321.321.321:9200])
+    @shell.client.should_receive(:connect).with(:servers => %w[http://123.123.123.123:9200/ http://321.321.321.321:9200/])
     expect(@shell.eval_line("connect http://123.123.123.123:9200 http://321.321.321.321:9200"))
   end
   

data/spec/elasticshell/commands/request_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Commands::Request do
 
   before do
-    @shell  = Shell.new(:output => FakeOutput.new, :error => FakeOutput.new, :input => FakeOutput.new )
+    @shell  = Shell.new(:output => FakeOutput.new, :input => FakeOutput.new )
     @shell.stub!(:connected?).and_return(true)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticshell
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,6 +125,7 @@ files:
 - lib/elasticshell/scopes/index.rb
 - lib/elasticshell/scopes/nodes.rb
 - lib/elasticshell/commands/help.rb
+- lib/elasticshell/commands/exit.rb
 - lib/elasticshell/commands/connect.rb
 - lib/elasticshell/commands/pretty.rb
 - lib/elasticshell/commands/pwd.rb
@@ -137,11 +138,13 @@ files:
 - lib/elasticshell/commands/blank.rb
 - lib/elasticshell/commands/ls.rb
 - lib/elasticshell/command.rb
+- lib/elasticshell/runner.rb
 - lib/elasticshell/shell.rb
 - lib/elasticshell/client.rb
 - lib/elasticshell/scopes.rb
 - lib/elasticshell/utils/log.rb
 - lib/elasticshell/utils/recognizes_verb.rb
+- lib/elasticshell/utils/es_config.rb
 - lib/elasticshell/utils/has_name.rb
 - lib/elasticshell/utils/has_verb.rb
 - lib/elasticshell/utils/error.rb
@@ -184,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2162304866060905026
+      hash: 4595416963629376856
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: