redis_web_manager 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a061b03c469a48d07ac3adf06ee448e86d36ad2a135103588e7ccbe181def86
-  data.tar.gz: 5ae9e1e12c3a5700f8d10744a70008818915ddf4534e9cd3f472823de4f1d93a
+  metadata.gz: e48c79b5d3723da1e569b6ab98470b268a694b6f3d39a08666945a4349c09666
+  data.tar.gz: f92ce3f1270fdfbf2c41744aa0c6f6c210dc4bd015ed44b645e924d814ffc3f8
 SHA512:
-  metadata.gz: 04fe5ddf7a965b48333dd9da4ebc9b3fb1e0c4077d071cca9aa6629063ebdb5982363f383fc9151ef4f05c7cd52b02c2fc6863d366ffbfefda0d0db2c3198b64
-  data.tar.gz: ee93576a04f0e09290d6fbc17569a34f496e363023722b153e73e755e9871d6909a87a589935c5ac895c586cc4395ab43e187c7ccb27b9094a712db4f8fd9cc5
+  metadata.gz: d2246f99e9a53f9bc9cec38b06e95b967250cbab37104544f80f058d06402c6130d7d1f010e7b52cd71428a8c7d45a7d1c806f6628a372a368929119b4d7c8d4
+  data.tar.gz: eac5fb2aea1185697a9ae819b06817b206db4adba61371462a182e5ab3ccf5d9430ddb4a03de80f1045bd4a7d33fa605d7958e07311146f605c4052644bab538

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: A7Nr6g7XhQgiadtP7z5SZjlMYWVTFt0rx

data/.travis.yml

@@ -7,6 +7,7 @@ services:
 rvm:
   - 2.5.5
   - 2.6.3
+  - 2.7.0
 gemfile:
   - gemfiles/Gemfile-5-2
   - gemfiles/Gemfile-6-0

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    redis_web_manager (0.1.5)
+    redis_web_manager (0.1.6)
+      pagy (~> 3.7)
       rails (>= 5.2, < 7)
       redis (~> 4.1.0)
 
@@ -65,13 +66,21 @@ GEM
       zeitwerk (~> 2.2)
     builder (3.2.4)
     concurrent-ruby (1.1.5)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     crass (1.0.6)
     diff-lcs (1.3)
+    docile (1.3.2)
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
+    json (2.3.0)
     loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -87,6 +96,7 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
+    pagy (3.7.2)
     rack (2.1.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -135,6 +145,11 @@ GEM
       rspec-mocks (~> 3.8)
       rspec-support (~> 3.8)
     rspec-support (3.9.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -142,8 +157,13 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
+    tins (1.24.0)
+      sync
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
     websocket-driver (0.7.1)
@@ -155,8 +175,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls (~> 0.8)
   redis_web_manager!
   rspec-rails (= 4.0.0.beta3)
+  simplecov (~> 0.16)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,9 +1,28 @@
 # RedisWebManager
 
-Short description and motivation.
+[![Gem Version](https://badge.fury.io/rb/redis_web_manager.svg)](https://badge.fury.io/rb/redis_web_manager)
+[![Maintainability](https://api.codeclimate.com/v1/badges/55600fe789679fe62d8b/maintainability)](https://codeclimate.com/github/OpenGems/redis_web_manager/maintainability)
+[![Build Status](https://travis-ci.org/OpenGems/redis_web_manager.svg?branch=master)](https://travis-ci.org/OpenGems/redis_web_manager)
+[![security](https://hakiri.io/github/OpenGems/redis_web_manager/master.svg)](https://hakiri.io/github/OpenGems/redis_web_manager/master)
+![Gem](https://img.shields.io/gem/dt/redis_web_manager)
+[![Coverage Status](https://coveralls.io/repos/github/OpenGems/redis_web_manager/badge.svg?branch=master)](https://coveralls.io/github/OpenGems/redis_web_manager?branch=master)
 
-## Usage
-How to use my plugin.
+Web interface that allows you to manage easily your Redis instance (see keys, memory used, connected client, etc...). 
+
+### Check your stats 
+The Dashboard allows you tu check the Memory usage, CPU and Redis clients.
+
+![RedisWebManager Dashboard](images/images_dashboard.png)
+
+### Manage your redis keys
+You can easily edit and delete any keys stored in your redis database.
+
+![RedisWebManager Keys](images/images_keys.png)
+
+### Keep an eye on your redis clients
+Check how many clients are connected and their infos.
+
+![RedisWebManager Clients](images/images_clients.png)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -22,8 +41,80 @@ Or install it yourself as:
 $ gem install redis_web_manager
 ```
 
+Add the custom route in your `routes.rb`:
+```
+mount RedisWebManager::Engine => '/redis_web_manager'
+```
+
+Access to RedisWebManager at `/redis_web_manager`
+
+## Configuration
+
+You can configure RedisWebManager: 
+
+```ruby
+# initializers/redis_web_manager.rb
+
+RedisWebManager.configure do |config|
+  config.redis = Redis.new(db: 1) # Default Redis.new (Instance of Redis)
+  config.lifespan = 2.days # Default 15.days (Lifespan of each keys for dashboard)
+  config.authenticate = proc {
+                           authenticate_or_request_with_http_basic do |username, password|
+                              username == 'TEST' && password == 'TEST'
+                            end
+                          } # Default nil (Authenticate method to secure tools)
+end
+```
+
+## Collect data for dashboard
+
+In order to have data on your dashboard you must collect the data like this:
+```ruby
+data = RedisWebManager::Data.new
+data.perform
+```
+
+If you are using a system to run background tasks in your application (like Sidekiq, Sucker Punch or ActiveJob), you can write your own background task to update the dashboard statistics.
+
+Sidekiq exemple:
+```ruby
+class DashboardWorker
+  include Sidekiq::Worker
+
+  def perform
+    data = RedisWebManager::Data.new
+    data.perform
+  end
+end
+```
+
+Sucker Punch exemple:
+```ruby
+class DashboardJob
+  include SuckerPunch::Job
+
+  def perform
+    data = RedisWebManager::Data.new
+    data.perform
+  end
+end
+```
+
+
+
+## Todo
+* [ ] Add filters to redis keys (filter by type, by expiration date...)
+* [ ] Add graph for most used commands
+* [ ] Manage multiple redis instances
+* [ ] Real time chart update
+* [ ] Alert system (ex: triggered when memory is peaking)
+* [ ] Command line interface to manage your redis database
+* [ ] Logs interface
+
+
 ## Contributing
-Contribution directions go here.
+Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/redis_web_manager. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -25,4 +25,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/app/controllers/redis_web_manager/actions_controller.rb

@@ -2,10 +2,22 @@
 
 module RedisWebManager
   class ActionsController < ApplicationController
+    # DELETE /reset
+    def reset
+      data.flush
+      redirect_to root_url
+    end
+
     # DELETE /flushdb
-    def flushdb; end
+    def flushdb
+      action.flushdb
+      redirect_to root_url
+    end
 
     # DELETE /flushall
-    def flushall; end
+    def flushall
+      action.flushall
+      redirect_to root_url
+    end
   end
-end
+end

data/app/controllers/redis_web_manager/application_controller.rb

@@ -27,5 +27,9 @@ module RedisWebManager
     def action
       @action ||= RedisWebManager::Action.new
     end
+
+    def data
+      @data ||= RedisWebManager::Data.new
+    end
   end
 end

data/app/controllers/redis_web_manager/clients_controller.rb

@@ -9,4 +9,4 @@ module RedisWebManager
       @clients = info.clients.map(&:symbolize_keys)
     end
   end
-end
+end

data/app/controllers/redis_web_manager/configuration_controller.rb

@@ -9,4 +9,4 @@ module RedisWebManager
       @url = connection.id
     end
   end
-end
+end

data/app/controllers/redis_web_manager/dashboard_controller.rb

@@ -4,11 +4,31 @@ module RedisWebManager
   class DashboardController < ApplicationController
     # GET /dashboard
     def index
+      @information = stats.map { |k, v| { name: k.to_s.humanize, value: v } }
       @status = info.status
       @url = connection.id
-      @memory = []
-      @cpu = []
-      @client = []
+      @memory = keys_by_type(data.keys, :memory)
+      @cpu = keys_by_type(data.keys, :cpu)
+      @client = keys_by_type(data.keys, :client)
+    end
+
+    private
+
+    def stats
+      @stats ||= info.stats.symbolize_keys.slice(:redis_version,
+                                                 :redis_mode,
+                                                 :arch_bits,
+                                                 :process_id,
+                                                 :os,
+                                                 :role,
+                                                 :connected_clients,
+                                                 :blocked_clients,
+                                                 :uptime_in_days,
+                                                 :used_memory_human)
+    end
+
+    def keys_by_type(keys, value)
+      keys.map { |key| key.slice(:date, value) }.sort_by { |key| key[:date] }
     end
   end
 end

data/app/controllers/redis_web_manager/information_controller.rb

@@ -15,4 +15,4 @@ module RedisWebManager
       @stats ||= info.stats.symbolize_keys
     end
   end
-end
+end

data/app/controllers/redis_web_manager/keys_controller.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'pagy'
+require 'pagy/extras/array'
+require 'pagy/extras/bootstrap'
+
+module RedisWebManager
+  class KeysController < ApplicationController
+    include ::Pagy::Backend
+
+    # GET /keys
+    def index
+      query = params[:query].presence
+      @keys = if query.present?
+                info.search(query).map { |key| format_key(key) }
+              else
+                info.keys.map { |key| format_key(key) }
+              end
+      @status = info.status
+      @url = connection.id
+      @pagy, @keys = pagy_array(@keys)
+    end
+
+    # GET /key/:key
+    def show
+      key = params[:key].presence
+      redirect_to keys_url if key.nil?
+      @key = format_key(key)
+    end
+
+    # GET /key/:key
+    def edit
+      key = params[:key].presence
+      redirect_to keys_url if key.nil?
+      @key = format_key(key)
+    end
+
+    # PUT /key/:key
+    def update
+      old_key = params[:old_name].presence
+      new_name = params[:new_name].presence
+      redirect_to keys_url if old_key.nil? || new_name.nil?
+      action.rename(old_key, new_name)
+      redirect_to keys_url
+    end
+
+    # DELETE /key/:key
+    def destroy
+      key = params[:key].presence
+      redirect_to keys_url if key.nil?
+      action.del(key)
+      redirect_to keys_url
+    end
+
+    private
+
+    def item_type(value)
+      ['json', JSON.parse(value)]
+    rescue JSON::ParserError
+      ['string', value]
+    end
+
+    # Get values for Redis List type
+    def get_list(key)
+      start = 0
+      stop  = 99
+
+      length = info.llen(key)
+      values = info.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
+
+    # Get values for Redis Set type
+    def get_set(key)
+      values = info.smembers(key).map do |e|
+        type, value = item_type(e)
+        { type: type, value: value }
+      end
+
+      { values: values }
+    end
+
+    # Get values for Redis Zset type
+    def get_zset(key)
+      values = info.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
+
+    # Get values for Redis Hash type
+    def get_hash(key)
+      value = Hash[info.hgetall(key).map do |k, v|
+        type, value = item_type(v)
+        [k, { type: type, value: value }]
+      end]
+
+      { value: value }
+    end
+
+    def get_value(key)
+      type = info.type(key)
+      case type
+      when 'string'
+        { value: info.get(key) }
+      when 'list'
+        get_list(key)
+      when 'set'
+        get_set(key)
+      when 'zset'
+        get_zset(key)
+      when 'hash'
+        get_hash(key)
+      else
+        { value: 'Not found' }
+      end
+    end
+
+    def format_key(key)
+      {
+        key: key,
+        expire: info.expire(key),
+        node: get_value(key),
+        type: info.type(key),
+        memory: info.memory_usage(key)
+      }
+    end
+  end
+end