readis 0.2.0

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2012 Matthew King, Lance Lakey
+
+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,6 @@
+Read-only Redis Utilities
+
+    $ readis -h
+    Usage: readis <command> [options]
+    Available commands: inspect, monitor, help
+

data/bin/readis

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# set up loadpath
+here = File.dirname(__FILE__)
+READIS_ROOT = File.expand_path("#{here}/..")
+$LOAD_PATH.unshift("#{READIS_ROOT}/lib")
+
+require "readis"
+
+command_name = ARGV.shift
+
+if command_name == "help"
+  actual_command = ARGV.shift
+  puts Readis.command_runner(actual_command).help
+else
+  Readis.command_runner(command_name).run
+end
+

data/lib/readis/inspect.rb

@@ -0,0 +1,75 @@
+class Readis
+  class Inspect < Readis
+
+    WHITELIST = %w[
+      keys
+      exists get hexists hget hgetall hkeys hlen hmget hvals
+      info lindex llen lrange mget randomkey scard sdiff
+      sinter sismember smembers srandmember strlen sunion
+      ttl type zcard zcount zrange zrangebyscore zrank
+      zrevrange zrevrangebyscore zrevrank zscore
+    ]
+
+    def initialize(*args)
+      super
+      @redis = Redis.new(:host => self.options[:host], :port => self.options[:port])
+    end
+
+    def parser
+      optparser = super
+      optparser.banner = <<-BANNER
+
+Usage: readis inspect [options]
+
+      BANNER
+      optparser
+    end
+
+    def run
+      loop do
+        print "readis #{self.options[:host]}:#{self.options[:port]}> "
+        input_string = gets.chomp
+        # TODO: tab completion.  Example implementation in automatthew/flipper
+        # https://github.com/automatthew/flipper/blob/master/lib/flipper.rb
+        # Inititally, we should only try to complete using the list of command
+        # names, but we may later consider adding keys, fields, member names, etc.
+        # discovered through commands issued.
+        begin
+          out = execute_command(input_string)
+          case out
+          when nil
+            # do nothing
+          else
+            # TODO: consider the formatting.  Do we want to mimic
+            # the redis-cli output?
+            puts out.inspect
+          end
+        rescue => error
+          puts "Error: #{error.message}"
+        end
+      end
+    end
+  
+    def execute_command(input_string)
+      parts = input_string.split(" ")
+      redis_command = parts.shift
+  
+      if redis_command
+        redis_command.downcase!
+      end
+  
+      case redis_command
+      when nil
+        # do nothing
+      when *WHITELIST
+        @redis.send(redis_command, *parts)
+      when "exit", "quit"
+        exit
+      else
+        raise ArgumentError, "Unknown or unsupported command"
+      end
+    end
+
+  end
+end
+

data/lib/readis/monitor.rb

@@ -0,0 +1,199 @@
+class Readis
+  class Monitor < Readis
+
+    def initialize(*args)
+      super
+      if options[:includes] && options[:excludes]
+        raise ArgumentError, "Define either --includes or --excludes, but not both."
+      end
+    end
+
+    def run
+      @redis.monitor do |line|
+        if formatted = format(line)
+          print formatted
+          puts
+        end
+      end
+    end
+
+    def options
+      @options ||= super.merge(
+        :colorized => false
+      )
+    end
+
+    def parser
+      optparser = super
+      optparser.banner = <<-BANNER
+
+Usage: readis monitor [options]
+
+      BANNER
+      optparser.on("-c", "--color", "enable syntax coloring") do |color|
+        options[:colorized] = true
+      end
+      optparser.on("-i", "--include COMMANDS",
+        "comma separated list of Redis commands to include") do |includes|
+        options[:includes] = includes.split(",").map {|c| c.upcase}
+      end
+      optparser.on("-e", "--exclude COMMANDS",
+        "comma separated list of Redis commands to exclude") do |excludes|
+        options[:excludes] = excludes.split(",").map {|c| c.upcase}
+      end
+      # TODO: options for
+      # * compact vs. spacey
+      # * timestamp on/off
+      optparser
+    end
+
+
+    # 1325296232.698537 "set" "monkey" "shines"
+    def format(line)
+      if timestamp = line.slice!(/^[\d.]+ "/)
+        timestamp.chomp!(' "')
+      end
+      parts = line.split('" "').map {|p| p.chomp('"') }
+
+      command = parts[0].upcase
+      return if filtered?(command)
+
+      out = [ format_command(command) ]
+
+      one_channel_one_message = %w(PUBLISH)
+      one_key_one_value = %w(APPEND GETSET LPUSHX RPUSHX SET SETNX)
+      one_key_one_argument = %w(DECRBY EXPIRE EXPIREAT GETBIT INCRBY LINDEX MOVE RENAME RENAMENX)
+      one_key_one_field = %w(HEXISTS HGET)
+      one_key_one_field_one_value = %w(HSET HSETNX)
+
+      # TODO: add the rest of the redis commands
+      case command
+      when *one_channel_one_message
+        # one channel, one message
+        out << format_channel(parts[1])
+        out << format_message(parts[2])
+      when *one_key_one_value
+        # one key, one value
+        out << format_key(parts[1])
+        out << format_value(parts[2])
+      when *one_key_one_argument
+        # one key, one arg
+        out << format_key(parts[1])
+        out << format_argument(parts[2])
+      when "BLPOP"
+        # variable number of keys, last part is an arg
+        parts.slice(1..-2).each do |part|
+          out << format_key(part)
+        end
+        out << format_argument(parts[-1])
+      when "LPUSH", "RPUSH", "ZREM"
+        # one key, rest are values
+        out << format_key(parts[1])
+        parts.slice(2..-1).each do |part|
+          out << format_value(part)
+        end
+      when "ZRANGE", "ZRANGEBYSCORE", "ZREMRANGEBYSCORE",
+        "ZREMRANGEBYRANK", "ZCOUNT", "ZREVRANK", "ZREVRANGE"
+        # one key, rest are arguments
+        out << format_key(parts[1])
+        parts.slice(2..-1).each do |part|
+          out << format_argument(part)
+        end
+      when *one_key_one_field_one_value
+        # key, field, value
+        out << format_key(parts[1])
+        out << format_field(parts[2])
+        out << format_value(parts[3])
+      when *one_key_one_field
+        # key, field
+        out << format_key(parts[1])
+        out << format_field(parts[2])
+      when "ZADD", "ZINCRBY"
+        # ZADD score member [score] [member]
+        out << format_key(parts[1])
+        parts.slice(2..-1).each_slice(2) do |pair|
+          out << format_argument(pair.first)
+          out << format_value(pair.last)
+        end
+      else
+        # all keys
+        if rest = parts.slice(1..-1)
+          parts.slice(1..-1).each do |part|
+            out << format_key(part)
+          end
+        end
+      end
+      "#{colorize(:underscore, timestamp)} #{out}"
+    end
+
+    # Wraps the command in the appropriate ANSI color codes
+    def format_command(string)
+      case string
+      when "MULTI", "EXEC", "WATCH"
+        colorize(:red, string + " ")
+
+      when /SUBSCRIBE/, "PUBLISH"
+        colorize(:yellow, string + " ")
+      else
+        colorize(:green, string + " ")
+      end
+    end
+
+    def format_channel(string)
+      colorize(:cyan, string + " ")
+    end
+
+    def format_key(string)
+      colorize(:cyan, string + " ")
+    end
+
+    def format_argument(string)
+      colorize(:magenta, string + " ")
+    end
+
+    def format_field(string)
+      colorize(:blue, string + " ")
+    end
+
+    def format_message(string)
+      begin
+        string.gsub!(/\\/, "")
+        object = JSON.parse(string)
+        out = "\n" + JSON.pretty_generate(object)
+      rescue
+        out = string + " "
+      end
+      out
+    end
+
+    def format_value(string)
+      begin
+        string.gsub!(/\\/, "")
+        object = JSON.parse(string)
+        out = "\n" + JSON.pretty_generate(object)
+      rescue
+        out = string + " "
+      end
+      out
+    end
+
+    def filtered?(command)
+      if list = @options[:includes]
+        !list.include?(command)
+      elsif list = @options[:excludes]
+        list.include?(command)
+      end
+    end
+
+    def colorize(name, string)
+      if @options[:colorized]
+        [Term::ANSIColor.send(name), string, Term::ANSIColor.reset].join
+      else
+        string
+      end
+    end
+
+
+
+  end
+end

data/lib/readis.rb

@@ -0,0 +1,58 @@
+require "optparse"
+
+require "rubygems"
+require "redis"
+require "json"
+require "term/ansicolor"
+
+class Readis 
+
+  def self.command_runner(name)
+    case name
+    when "inspect"
+      Readis::Inspect.new
+    when "monitor"
+      Readis::Monitor.new
+    else
+      puts "Usage: readis <command> [options]"
+      puts "Usage: readis help <command>"
+      puts "Available commands: inspect, monitor"
+      exit
+    end
+  end
+
+  def initialize
+    self.parser.parse!
+    @redis = Redis.new(:host => self.options[:host], :port => self.options[:port])
+  end
+
+  def options
+    @options ||= {
+      :host => "127.0.0.1",
+      :port => "6379",
+    }
+  end
+
+  def parser
+    OptionParser.new do |parser|
+      parser.on("-h", "--host=HOST",
+        "redis host. Defaults to '127.0.0.1'") do |name|
+        self.options[:host] = name
+      end
+      parser.on("-p", "--port=PORT",
+        "redis port. Defaults to '6379'") do |name|
+        self.options[:port] = name
+      end
+    end
+  end
+
+  def help
+    parser.help
+  end
+
+end
+
+
+require "readis/inspect"
+require "readis/monitor"
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: readis
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matthew King
+- Lance Lakey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: 
+executables: 
+- readis
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/readis/inspect.rb
+- lib/readis/monitor.rb
+- lib/readis.rb
+- LICENSE
+- Readme.md
+- bin/readis
+has_rdoc: true
+homepage: https://github.com/lancelakey/readis
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Read-only Redis Utilities
+test_files: []
+