redis-browser 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5c55541ef0598f88bd75115276f396a8dc6015
-  data.tar.gz: 8c87fcd43152e51de0966a69a6ad384d6c8eedb4
+  metadata.gz: 37d0ff56203919cb9c9410c192224e8f2cad3ab6
+  data.tar.gz: 5f47d5d2485446e8a6567c29bfbd57097ea48030
 SHA512:
-  metadata.gz: 95348fcb6e2cb9ca61c334e662f8d77f5259e54d0817fafd5e28382c8b888a5e5a6964c77e3610cdbad43626af831df28f0ab6f600c345d55ba52246f3363a94
-  data.tar.gz: c3b2cb623f3cb6d9edabcb032af665dd0c7da8de9a511d8407f1b2b81c5487d1cad39cfaed7c23a4976f64d98b59136aea56c58f83e8b5d079dd443eff41d61f
+  metadata.gz: 7278bff64d5fdba0cc39611901501745a78dac6e801ccc722a52f425c6074384acf052b544d1f1a5db78e7e231bf590093b626e446a3604dba94ea0c881c0238
+  data.tar.gz: 6b1a36d1da3440e536d988a03b5281362b9899ae3f68d4d5fe21864f52b5bc1f3cace4c9dfa5aa91f75d08ed5ed0d9d3e47c470876f357c78694eb0d6ea4edf9

data/LICENSE.txt

@@ -1,22 +1,20 @@
-Copyright (c) 2013 Tymon Tobolski
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2013-2014 Monterail.com LLC
 
-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:
+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 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.
+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

@@ -7,7 +7,7 @@
 * List pagination
 * Pretty print json values
 * Search keys
-
+* Can be mounted to Rails applications as engine
 
 ## Installation
 
@@ -17,10 +17,26 @@ $ gem install redis-browser
 
 ## Usage
 
+### Standalone
+
 ```bash
 $ redis-browser
 ```
 
+### As engine
+
+Add to gemfile
+
+```ruby
+gem 'redis-browser'
+```
+
+And to routes.rb
+
+```ruby
+mount RedisBrowser::Web => '/redis-browser'
+```
+
 ## Screenshots
 
 ![Browse keys](https://dl.dropboxusercontent.com/u/70986/redis-browser/2.png)

data/bin/redis-browser

@@ -4,6 +4,6 @@ $:.unshift File.expand_path('../../lib', File.symlink?(__FILE__) ? File.readlink
 
 require 'rubygems' unless Object.const_defined?(:Gem)
 
-require "redis-browser/app"
+require "redis-browser"
 
-App.run! :port => 4567
+RedisBrowser::Web.run! :port => 4569

data/lib/redis-browser.rb

@@ -0,0 +1,10 @@
+require 'sinatra/base'
+require 'multi_json'
+require 'sinatra/json'
+require 'slim'
+require 'coffee-script'
+require 'redis'
+require 'redis-browser/version'
+require 'redis-browser/browser'
+require 'redis-browser/web'
+

data/lib/redis-browser/browser.rb

@@ -0,0 +1,153 @@
+module RedisBrowser
+  class Browser
+    def initialize(conn = nil, db = 0)
+      @conn = conn
+      @db = db
+    end
+
+    def split_key(key)
+      if key =~ /^(.+?)(:+|\/+|\.+).+$/
+        [$1, $2]
+      else
+        [key, nil]
+      end
+    end
+
+    def keys(namespace = nil)
+      if namespace.to_s.strip.empty?
+        pattern = "*"
+        namespace = ""
+      else
+        pattern = namespace + "*"
+      end
+
+      redis.keys(pattern).inject({}) do |acc, key|
+        key.slice!(namespace) if namespace
+
+        ns, sep = split_key(key)
+
+        unless ns.strip.empty?
+          acc[ns] ||= {
+            :name => ns,
+            :full => namespace + ns + sep.to_s,
+            :count => 0
+          }
+          acc[ns][:count] += 1
+        end
+
+        acc
+      end.values.sort_by {|e| e[:name] }
+    end
+
+    def item_type(e)
+      begin
+        ["json", MultiJson.decode(e)]
+      rescue MultiJson::LoadError => ex
+        ["string", e]
+      end
+    end
+
+    def get_list(key, opts = {})
+      start = opts[:start] ? opts[:start].to_i : 0
+      stop  = opts[:stop] ? opts[:stop].to_i : 99
+
+      length = redis.llen(key)
+      values = redis.lrange(key, start, stop).map.with_index do |e, i|
+        type, value = item_type(e)
+        {:type => type, :value => value, :index => start + i}
+      end
+
+      {:length => length, :values => values}
+    end
+
+    def get_set(key)
+      values = redis.smembers(key).map do |e|
+        type, value = item_type(e)
+        {:type => type, :value => value}
+      end
+
+      {:values => values }
+    end
+
+    def get_zset(key)
+      values = redis.zrange(key, 0, -1, :withscores => true).map do |e, score|
+        type, value = item_type(e)
+        {:type => type, :value => value, :score => score}
+      end
+
+      {:values => values }
+    end
+
+    def get_hash(key)
+      value = Hash[redis.hgetall(key).map do |k,v|
+        type, value = item_type(v)
+        [k, {:type => type, :value => value}]
+      end]
+
+      {:value => value}
+    end
+
+    def get_keys(key)
+      key << "*" unless key.end_with?("*")
+
+      values = redis.keys(key).map do |k|
+        {:name => k, :full => k}
+      end
+
+      {:values => values}
+    end
+
+    def delete(pattern)
+      redis.del(redis.keys(pattern))
+    end
+
+    def get(key, opts = {})
+      type = redis.type(key)
+      data = case type
+      when "string"
+        type, value = item_type(redis.get(key))
+        {:value => value, :type => type}
+      when "list"
+        get_list(key, opts)
+      when "set"
+        get_set(key)
+      when "zset"
+        get_zset(key)
+      when "hash"
+        get_hash(key)
+      else
+        get_keys(key)
+      end
+
+      {
+        :full => key,
+        :type => type
+      }.merge(data)
+    end
+
+    def ping
+      redis.ping == "PONG"
+      {:ok => 1}
+    rescue => ex
+      {:error => ex.message}
+    end
+
+    def redis
+      @redis ||= begin
+        conn = @conn || "127.0.0.1:6379"
+        db = @db || 0
+
+        opts = if conn.start_with?("/")
+          {:path => conn}
+        else
+          host, port = conn.split(":", 2)
+          {:host => host, :port => port}
+        end
+
+        r = Redis.new(opts)
+        r.select(db)
+        r
+      end
+    end
+  end
+end

data/lib/redis-browser/templates/coffee/app.coffee

@@ -22,19 +22,19 @@ app.factory 'API', ['$http', ($http) ->
   (connection, database) ->
     ps = {connection: connection, database: database}
     {
-      ping: () -> $http.get("/ping.json", {
+      ping: () -> $http.get("#{jsEnv.root_path}ping.json", {
         params: ps
       }).then (e) -> e.data,
 
-      keys: (namespace) -> $http.get("/keys.json", {
+      keys: (namespace) -> $http.get("#{jsEnv.root_path}keys.json", {
         params: angular.extend({}, ps, {namespace: namespace})
       }).then (e) -> e.data,
 
-      get: (params) -> $http.get("/key.json", {
+      get: (params) -> $http.get("#{jsEnv.root_path}key.json", {
         params: angular.extend({}, ps, params)
       }).then (e) -> e.data
 
-      delete: (params) -> $http.delete("/key.json", {
+      delete: (params) -> $http.delete("#{jsEnv.root_path}key.json", {
         params: angular.extend({}, ps, params)
       })
     }

data/lib/redis-browser/templates/index.slim

@@ -3,13 +3,16 @@ html ng-app="browser"
   head
     title Redis Browser
 
-    script type="text/javascript" src="/js/angular.min.js"
-    script type="text/javascript" src="/js/ui-bootstrap-tpls-0.2.0.min.js"
-    script type="text/javascript" src="/js/localStorageModule.js"
-    script type="text/javascript" src="/js/app.js"
+    script type="text/javascript" src="#{root_path}js/angular.min.js"
+    script type="text/javascript" src="#{root_path}js/ui-bootstrap-tpls-0.2.0.min.js"
+    script type="text/javascript" src="#{root_path}js/localStorageModule.js"
+    script type="text/javascript" src="#{root_path}js/app.js"
 
-    link rel="stylesheet" href="/css/bootstrap.min.css"
-    link rel="stylesheet" href="/css/app.css"
+    link rel="stylesheet" href="#{root_path}css/bootstrap.min.css"
+    link rel="stylesheet" href="#{root_path}css/app.css"
+
+    script type="text/javascript"
+      == js_env
 
     script type="text/ng-template" id="nav-tree-item.html"
       span ng-show="key.count > 1"

data/lib/redis-browser/version.rb

@@ -1,3 +1,3 @@
 module RedisBrowser
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/redis-browser/web.rb

@@ -0,0 +1,61 @@
+module RedisBrowser
+  module WebHelpers
+    def root_path
+      "#{env['SCRIPT_NAME']}/"
+    end
+
+    def js_env
+      jsEnv = {
+        root_path: "#{root_path}"
+      }
+
+      "jsEnv = #{MultiJson.dump(jsEnv)};"
+    end
+  end
+
+  class CoffeeHandler < Sinatra::Base
+    set :views, File.dirname(__FILE__) + '/templates/coffee'
+
+    get "/js/app.js" do
+      coffee :app
+    end
+  end
+
+  class Web < Sinatra::Base
+    helpers Sinatra::JSON, WebHelpers
+    use CoffeeHandler
+
+    set :public_dir, File.dirname(__FILE__) + '/public'
+    set :views, File.dirname(__FILE__) + '/templates'
+
+    get '/' do
+      slim :index
+    end
+
+    get '/ping.json' do
+      json browser.ping
+    end
+
+    get '/keys.json' do
+      json browser.keys(params[:namespace])
+    end
+
+    get '/key.json' do
+      json browser.get(params[:key], params)
+    end
+
+    delete '/key.json' do
+      browser.delete(params[:key])
+      json :ok => true
+    end
+
+    def browser
+      connection = if ENV['REDIS_URL']
+        ENV['REDIS_URL'].sub(/\Aredis:\/\//, '')
+      else
+        params[:connection]
+      end
+      @browser ||= Browser.new(connection, params[:database])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-browser
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tymon Tobolski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,8 @@ files:
 - README.md
 - Rakefile
 - bin/redis-browser
-- lib/redis-browser/app.rb
+- lib/redis-browser.rb
+- lib/redis-browser/browser.rb
 - lib/redis-browser/public/css/app.css
 - lib/redis-browser/public/css/bootstrap.min.css
 - lib/redis-browser/public/img/glyphicons-halflings-white.png
@@ -161,6 +162,7 @@ files:
 - lib/redis-browser/templates/coffee/app.coffee
 - lib/redis-browser/templates/index.slim
 - lib/redis-browser/version.rb
+- lib/redis-browser/web.rb
 - redis-browser.gemspec
 homepage: http://github.com/teamon/redis-browser
 licenses:
@@ -182,9 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Redis browser
 test_files: []
-has_rdoc: 

data/lib/redis-browser/app.rb

@@ -1,201 +0,0 @@
-require File.expand_path("../version", __FILE__)
-require 'sinatra/base'
-require 'multi_json'
-require 'sinatra/json'
-require 'slim'
-require 'coffee-script'
-require 'redis'
-
-
-class CoffeeHandler < Sinatra::Base
-  set :views, File.dirname(__FILE__) + '/templates/coffee'
-
-  get "/js/app.js" do
-    coffee :app
-  end
-end
-
-class Browser
-  def initialize(conn = nil, db = 0)
-    @conn = conn
-    @db = db
-  end
-
-  def split_key(key)
-    if key =~ /^(.+?)(:+|\/+|\.+).+$/
-      [$1, $2]
-    else
-      [key, nil]
-    end
-  end
-
-  def keys(namespace = nil)
-    if namespace.to_s.strip.empty?
-      pattern = "*"
-      namespace = ""
-    else
-      pattern = namespace + "*"
-    end
-
-    redis.keys(pattern).inject({}) do |acc, key|
-      key.slice!(namespace) if namespace
-
-      ns, sep = split_key(key)
-
-      unless ns.strip.empty?
-        acc[ns] ||= {
-          :name => ns,
-          :full => namespace + ns + sep.to_s,
-          :count => 0
-        }
-        acc[ns][:count] += 1
-      end
-
-      acc
-    end.values.sort_by {|e| e[:name] }
-  end
-
-  def item_type(e)
-    begin
-      ["json", MultiJson.decode(e)]
-    rescue MultiJson::LoadError => ex
-      ["string", e]
-    end
-  end
-
-  def get_list(key, opts = {})
-    start = opts[:start] ? opts[:start].to_i : 0
-    stop  = opts[:stop] ? opts[:stop].to_i : 99
-
-    length = redis.llen(key)
-    values = redis.lrange(key, start, stop).map.with_index do |e, i|
-      type, value = item_type(e)
-      {:type => type, :value => value, :index => start + i}
-    end
-
-    {:length => length, :values => values}
-  end
-
-  def get_set(key)
-    values = redis.smembers(key).map do |e|
-      type, value = item_type(e)
-      {:type => type, :value => value}
-    end
-
-    {:values => values }
-  end
-
-  def get_zset(key)
-    values = redis.zrange(key, 0, -1, :withscores => true).map do |e, score|
-      type, value = item_type(e)
-      {:type => type, :value => value, :score => score}
-    end
-
-    {:values => values }
-  end
-
-  def get_hash(key)
-    value = Hash[redis.hgetall(key).map do |k,v|
-      type, value = item_type(v)
-      [k, {:type => type, :value => value}]
-    end]
-
-    {:value => value}
-  end
-
-  def get_keys(key)
-    key << "*" unless key.end_with?("*")
-
-    values = redis.keys(key).map do |k|
-      {:name => k, :full => k}
-    end
-
-    {:values => values}
-  end
-
-  def delete(pattern)
-    redis.del(redis.keys(pattern))
-  end
-
-  def get(key, opts = {})
-    type = redis.type(key)
-    data = case type
-    when "string"
-      type, value = item_type(redis.get(key))
-      {:value => value, :type => type}
-    when "list"
-      get_list(key, opts)
-    when "set"
-      get_set(key)
-    when "zset"
-      get_zset(key)
-    when "hash"
-      get_hash(key)
-    else
-      get_keys(key)
-    end
-
-    {
-      :full => key,
-      :type => type
-    }.merge(data)
-  end
-
-  def ping
-    redis.ping == "PONG"
-    {:ok => 1}
-  rescue => ex
-    {:error => ex.message}
-  end
-
-  def redis
-    @redis ||= begin
-      conn = @conn || "127.0.0.1:6379"
-      db = @db || 0
-
-      opts = if conn.start_with?("/")
-        {:path => conn}
-      else
-        host, port = conn.split(":", 2)
-        {:host => host, :port => port}
-      end
-
-      r = Redis.new(opts)
-      r.select(db)
-      r
-    end
-  end
-end
-
-class App < Sinatra::Base
-  helpers Sinatra::JSON
-  use CoffeeHandler
-
-  set :public_dir, File.dirname(__FILE__) + '/public'
-  set :views, File.dirname(__FILE__) + '/templates'
-
-  get '/' do
-    slim :index
-  end
-
-  get '/ping.json' do
-    json browser.ping
-  end
-
-  get '/keys.json' do
-    json browser.keys(params[:namespace])
-  end
-
-  get '/key.json' do
-    json browser.get(params[:key], params)
-  end
-
-  delete '/key.json' do
-    browser.delete(params[:key])
-    json :ok => true
-  end
-
-  def browser
-    @browser ||= Browser.new(params[:connection], params[:database])
-  end
-end