elasticshell 0.0.2 → 0.0.4

data/lib/elasticshell/scopes/nodes.rb

@@ -1,5 +1,3 @@
-require 'elasticshell/scopes'
-
 module Elasticshell
 
   module Scopes
@@ -10,25 +8,18 @@ module Elasticshell
         super("/_nodes", options)
       end
 
-      def commands
-        {
-          'info'  => "Retreive info about the cluster's ndoes.",
-          'stats' => "Retreive stats for the cluter's nodes.",
+      def self.requests
+        @requests ||= {
+          "GET" => {
+            'info'  => "Retreive info about the cluster's nodes.",
+            'stats' => "Retreive stats for the cluter's nodes.",
+          }
         }
       end
 
       def exists?
         true
       end
-
-      def execute command, shell
-        case
-        when command?(command)
-          shell.request(:get, :index => '_nodes')
-        else
-          super(command, shell)
-        end
-      end
       
     end
   end

data/lib/elasticshell/shell.rb

@@ -1,23 +1,68 @@
 require 'readline'
 require 'uri'
 
-require 'elasticshell/command'
-require 'elasticshell/scopes'
-require 'elasticshell/client'
-
 module Elasticshell
 
   class Shell
 
-    VERBS = %w[GET POST PUT DELETE]
+    Settings.define(:passive_http_verb_format,
+                    :description => "Format string for the passive HTTP verb GET.  The string `%v' will be replaced by the verb.",
+                    :default     => "\e[34m%v",
+                    :internal    => true)
+    
+    Settings.define(:active_http_verb_format,
+                    :description => "Format string for the active HTTP verbs PUT, POST, and DELETE.  The string `%v' will be replaced by the verb.",
+                    :default     => "\e[31m%v",
+                    :internal    => true)
+    
+    Settings.define(:existing_scope_format,
+                    :description => "Format string for an existing scope.  The string `%s' will be replaced by the scope name.",
+                    :default     => "\e[32m%s",
+                    :internal    => true)
+    
+    Settings.define(:missing_scope_format,
+                    :description => "Format string for scope which doesn't exist.  The string `%s' will be replaced by the scope name.",
+                    :default     => "\e[33m%s",
+                    :internal    => true)
+    
+    Settings.define(:prompt_format,
+                    :description => "Format string for the prompt.  The strings `%v' and `%s' will be replaced by the (already-formatted) HTTP verb and current scope name.",
+                    :default     => "\e[1m%v %s$ \e[0m",
+                    :internal    => true)
+    
+    Settings.define(:pretty_prompt_format,
+                    :description => "Format string for the prompt when in pretty-mode.  The strings `%v' and `%s' will be replaced by the (already-formatted) HTTP verb and current scope name.",
+                    :default     => "\e[1m%v %s$$ \e[0m",
+                    :internal    => true)
+    
+    Settings.define(:scope_long_format,
+                    :description => "Format string for displaying a scope in a long (`ll') listing.  The string `%s' will be replaced by the scope name.",
+                    :default     => "s                          \e[32m%s\e[0m",
+                    :internal    => true)
+
+    Settings.define(:index_long_format,
+                    :description => "Format string for displaying an index in a long (`ll') listing.  The string `%n' will be replaced by the index name, `%T' with the total number of shards, `%S' with the number of successful shards, `%F' with the number of failed shards, `%s' with the size in bytes, `%h' with the human-readable size",
+                    :default     => "d  %S/%F  %h  \e[32m%n\e[0m",
+                    :internal    => true)
     
-    attr_accessor :client, :input, :command, :state, :only
+    Settings.define(:request_long_format,
+                    :description => "Format string for displaying a request in a long (`ll') listing.  The string `%r' will be replaced by the request name.",
+                    :default     => "-                          %r",
+                    :internal    => true)
+    
+    Settings.define(:scope_format,
+                    :description => "Format string for displaying a scope in a listing.  The string `%s' will be replaced by the scope name.",
+                    :default     => "\e[32m%s\e[0m",
+                    :internal    => true)
+    
+    Settings.define(:request_format,
+                    :description => "Format string for displaying a request in a listing.  The string `%r' will be replaced by the request name.",
+                    :default     => "%r",
+                    :internal    => true)
+    
+    include Elasticshell::HasVerb
 
-    attr_reader :verb
-    def verb= v
-      raise ArgumentError.new("'#{v}' is not a valid HTTP verb.  Must be one of: #{VERBS.join(', ')}") unless VERBS.include?(v.upcase)
-      @verb = v.upcase
-    end
+    attr_accessor :client, :state, :only, :input, :cache, :output, :error, :line, :input_stream
 
     attr_reader :scope
     def scope= scope
@@ -25,35 +70,61 @@ module Elasticshell
       proc = scope.completion_proc
       Readline.completion_proc = Proc.new do |prefix|
         self.state = :completion
-        proc.call(prefix)
+        proc.call(self, prefix)
       end
     end
 
+    def path
+      scope.path
+    end
+
+    def connected?
+      client.connected?
+    end
+
     def initialize options={}
+      @interactive = false
       self.state  = :init
       self.client = Client.new(options)
+      self.cache  = {}
+      @initial_servers = (options[:servers] || [])
       self.verb   = (options[:verb] || 'GET')
-      self.scope  = Scopes.from_path((options[:scope] || '/'), :client => self.client)
+      self.scope  = scope_from_path(options[:scope] || '/')
       self.only   = options[:only]
+      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]
     end
 
-    def prompt
-      "\e[1m#{prompt_verb_color}#{verb} #{prompt_scope_color}#{scope.path} #{prompt_prettiness_indicator} \e[0m"
-    end
-
-    def prompt_scope_color
-      scope.exists? ? "\e[32m" : "\e[33m"
+    def scope_from_path path
+      if cache[path]
+        cache[path]
+      else
+        cache[path] = Scopes.from_path(path, :client => self.client)
+      end
     end
 
-    def prompt_verb_color
-      verb == "GET" ? "\e[34m" : "\e[31m"
+    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
     end
 
-    def prompt_prettiness_indicator
-      pretty? ? '$' : '>'
+    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])
     end
-  
+    
     def pretty?
       @pretty
     end
@@ -66,6 +137,10 @@ module Elasticshell
       @pretty = false
     end
 
+    def interactive?
+      @interactive
+    end
+
     def setup
       trap("INT") do
         int
@@ -73,62 +148,87 @@ module Elasticshell
 
       Readline.completer_word_break_characters = " \t\n\"\\'`$><=|&{("
       
-      puts <<EOF
+      print <<EOF
 Elasticshell v. #{Elasticshell.version}
 Type "help" for contextual help.
 EOF
+      @interactive = true
+
+      self.line = 1
     end
 
     def run
       setup
+      connect
       loop
     end
 
+    def connect
+      eval_line("connect #{@initial_servers.join(',')}")
+    end
+
     def loop
       self.state = :read
       while line = Readline.readline(prompt, true)
         eval_line(line)
       end
+      die
     end
 
     def eval_line line
       begin
-        self.input   = line.strip
-        self.command = Command.new(self, input)
         self.state = :eval
-        self.command.evaluate!
+        self.input = line.strip
+        command.evaluate!
       rescue ::Elasticshell::Error => e
-        $stderr.puts e.message
+        error.puts e.message
       end
       self.state = :read
+      self.line += 1
+      self
     end
 
+    def command
+      matching_command_class_name = Commands::PRIORITY.detect do |command_class_name|
+        Commands.const_get(command_class_name).matches?(input)
+      end
+      
+      # We should never hit the following ArgumentError as there
+      # exists a catch-all command: Unknown
+      raise ArgumentError.new("Could not parse command: '#{input}'") unless matching_command_class_name
+      
+      Commands.const_get(matching_command_class_name).new(self, input)
+    end
+    
     def print obj, ignore_only=false
-      if self.only && !ignore_only
-        if self.only == true
-          print(obj, true)
-        else
-          only_parts = self.only.to_s.split('.')
-          obj_to_print = obj
-          while obj_to_print && only_parts.size > 0
-            this_only = only_parts.shift
-            obj_to_print = (obj_to_print || {})[this_only]
-          end
-          print(obj_to_print, true)
-        end
+      self.output.puts(format_output(obj, ignore_only))
+    end
+
+    def format_output obj, ignore_only=false
+      case
+      when self.only == true && !ignore_only
+        format_output(obj, true)
+      when self.only && !ignore_only
+        format_only_part_of(obj)
+      when obj.nil?
+        nil
+      when String, Fixnum
+        obj
+      when pretty?
+        JSON.pretty_generate(obj)
       else
-        case obj
-        when nil
-        when String, Fixnum
-          puts obj
-        else
-          if pretty?
-            puts JSON.pretty_generate(obj)
-          else
-            puts obj.to_json
-          end
-        end
+        obj.to_json
+      end
+    end
+
+    def format_only_part_of obj
+      only_parts = self.only.to_s.split('.')
+      obj_to_print = obj
+      while obj_to_print && only_parts.size > 0
+        this_only = only_parts.shift
+        obj_to_print = (obj_to_print || {})[this_only]
       end
+      format_output(obj_to_print, true)
     end
 
     def int
@@ -140,51 +240,13 @@ EOF
       end
     end
 
-    def clear_line
-      while Readline.point > 0
-        $stdin.write("\b \b")
-      end
-    end
-
     def die
-      puts "C-d"
-      print("C-d...quitting")
-      exit()
+      raise ShellError.new("C-d...quitting")
     end
 
-    def command_and_query_and_body command
-      parts = command.split
-      
-      c_and_q = parts[0]
-      c, q = c_and_q.split('?')
-      o = {}
-      URI.decode_www_form(q || '').each do |k, v|
-        o[k] = v
-      end
-
-      path = parts[1]
-      case
-      when path && File.exist?(path) && File.readable?(path)
-        b = File.read(path)
-      when path && path == '-'
-        b = $stdin.gets(nil)
-      when path
-        b = path
-      else
-        # b = (command.split(' ', 2).last || '')
-        b = ''
-      end
-      
-      [c, o, b]
-    end
-    
-    def request verb, params={}
-      c, o, b = command_and_query_and_body(input)
-      body    = (params.delete(:body) || b || '')
-      print(client.request(verb, params.merge(:op => c), o, b))
+    def log_requests?
+      @log_requests
     end
 
   end
-  
 end
-

data/lib/elasticshell/utils.rb

@@ -0,0 +1,10 @@
+require 'elasticshell/utils/error'
+require 'elasticshell/utils/log'
+
+module Elasticshell
+
+  autoload :HasName,        'elasticshell/utils/has_name'
+  autoload :HasVerb,        'elasticshell/utils/has_verb'
+  autoload :RecognizesVerb, 'elasticshell/utils/recognizes_verb'
+  
+end

data/lib/elasticshell/{error.rb → utils/error.rb}

@@ -4,5 +4,6 @@ module Elasticshell
   ArgumentError       = Class.new(Error)
   NotImplementedError = Class.new(Error)
   ClientError         = Class.new(Error)
+  ShellError          = Class.new(Error)
 
 end

data/lib/elasticshell/utils/has_name.rb

@@ -0,0 +1,14 @@
+module Elasticshell
+  module HasName
+
+    FORBIDDEN_NAME_CHARS = %r![/\s]!
+
+    attr_reader :name
+
+    def name= new_name
+      raise ArgumentError.new("Invalid index name: '#{new_name}'") if new_name =~ FORBIDDEN_NAME_CHARS
+      @name = new_name
+    end
+    
+  end
+end

data/lib/elasticshell/utils/has_verb.rb

@@ -0,0 +1,15 @@
+module Elasticshell
+  module HasVerb
+
+    VERBS = %w[HEAD GET POST PUT DELETE]
+
+    def verb
+      @verb ||= "GET"
+    end
+
+    def verb= new_verb
+      @verb = new_verb.to_s.upcase if VERBS.include?(new_verb.to_s.upcase)
+    end
+    
+  end
+end

data/lib/elasticshell/{log.rb → utils/log.rb}

@@ -1,7 +1,7 @@
 module Elasticshell
 
   def self.log msg
-    $stderr.puts("\n" + msg + "\n")
+    $stderr.puts(msg)
   end
   
 end

data/lib/elasticshell/utils/recognizes_verb.rb

@@ -0,0 +1,25 @@
+module Elasticshell
+  module RecognizesVerb
+
+    VERB_RE = "(?:HEAD|GET|PUT|POST|DELETE)"
+
+    def verb_re
+      RecognizesVerb::VERB_RE
+    end
+
+    def canonicalize_verb v
+      case v.to_s
+      when /^G/i  then "GET"
+      when /^PO/i then "POST"
+      when /^PU/i then "PUT"
+      when /^D/i  then "DELETE"
+      when /^H/i  then "HEAD"
+      end
+    end
+    
+    def is_http_verb? s
+      s =~ Regexp.new("^" + verb_re + "$", true)
+    end
+    
+  end
+end