redis_web_manager 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86bc056117baa21f9a5250ab975091e3720b41dd605c4b30fb0b912cd369355b
-  data.tar.gz: 34cd1179bed9486e1360c31aee643e73ec33fa152df4aff66e8f73e56657189b
+  metadata.gz: a2c1a155b9755c60298027f28029841cdcf6e347fb6b4be7a959c62922a5ccf6
+  data.tar.gz: 203f63d9ce3d1284825cc55d428bf82430076e3858078849768651b21ab99ad8
 SHA512:
-  metadata.gz: '09ed0be81f6301190f52985ce7a3aac07f6274804804ad3032a68f4dc423ed267c632e1e7d31518f0930d914b546e28393170b1909864b9df6908ab9f165a09d'
-  data.tar.gz: 250051b8e37bc16dbc374472de6bcec4a86a4bc6eae7004f682edf689036bea291eb25db803b4d3d1c54ec87d6cb666b5f7d88e3b629237909444bc4d74158bb
+  metadata.gz: c9ba53415f30c8374fb7bbdaa2a0f3ee6437dda8ecfc7986584613b61603eb1a87bd0c742e9bfa47b524b798ec239cf524c0f0769d70af091417fd26838d892c
+  data.tar.gz: c224c72c7e3b3d5b006a6009de3e5ee4a2f02914da2059376a58bae3e0b1a8e112a85a74f8d6e1262abb465973c7b54161bc1f616e8fc48e8bd4201a2ea5b55e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis_web_manager (0.1.9)
+    redis_web_manager (0.2.1)
       pagy (~> 3.7)
       rails (>= 5.2, < 7)
       redis (~> 4.1.0)
@@ -94,7 +94,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
-    nokogiri (1.10.8)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     pagy (3.7.3)
     rack (2.2.2)
@@ -169,7 +169,7 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
-    zeitwerk (2.2.2)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -56,7 +56,10 @@ You can configure RedisWebManager:
 # initializers/redis_web_manager.rb
 
 RedisWebManager.configure do |config|
-  config.redis = Redis.new(db: 1) # Default Redis.new (Instance of Redis)
+  config.redises = {
+    default: Redis.new(db: 1),
+    production: Redis.new(url: 'XXX')
+  } # Default { default: Redis.new } (Hash with instance(s) 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|
@@ -70,10 +73,19 @@ end
 
 In order to have data on your dashboard you must collect the data like this:
 ```ruby
-data = RedisWebManager::Data.new
+data = RedisWebManager::Data.new(:default)
 data.perform
 ```
 
+or 
+
+```ruby
+RedisWebManager.redises.keys.each do |instance|
+  data = RedisWebManager::Data.new(instance)
+  data.perform
+end
+```
+
 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:
@@ -88,6 +100,21 @@ class DashboardWorker
 end
 ```
 
+or
+
+```ruby
+class DashboardWorker
+  include Sidekiq::Worker
+
+  def perform
+    RedisWebManager.redises.keys.each do |instance|
+      data = RedisWebManager::Data.new(instance)
+      data.perform
+    end
+  end
+end
+```
+
 Sucker Punch exemple:
 ```ruby
 class DashboardJob
@@ -100,11 +127,26 @@ class DashboardJob
 end
 ```
 
+or
+
+```ruby
+class DashboardJob
+  include SuckerPunch::Job
+
+  def perform
+    RedisWebManager.redises.keys.each do |instance|
+      data = RedisWebManager::Data.new(instance)
+      data.perform
+    end
+  end
+end
+```
+
+
 
 
 ## Todo
 * [ ] 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

data/app/controllers/redis_web_manager/application_controller.rb

@@ -5,6 +5,9 @@ module RedisWebManager
     protect_from_forgery with: :exception
 
     before_action :authenticated?, if: :authenticate
+    before_action :valid_instance?
+    helper_method :redises
+    helper_method :instance
 
     private
 
@@ -17,19 +20,36 @@ module RedisWebManager
     end
 
     def info
-      @info ||= RedisWebManager::Info.new
+      @info ||= RedisWebManager::Info.new(instance)
     end
 
     def connection
-      @connection ||= RedisWebManager::Connection.new
+      @connection ||= RedisWebManager::Connection.new(instance)
     end
 
     def action
-      @action ||= RedisWebManager::Action.new
+      @action ||= RedisWebManager::Action.new(instance)
     end
 
     def data
-      @data ||= RedisWebManager::Data.new
+      @data ||= RedisWebManager::Data.new(instance)
+    end
+
+    def default_url_options(options = {})
+      options.merge(instance: instance)
+    end
+
+    def valid_instance?
+      default_instance = redises.keys[0]
+      redirect_to dashboard_url(instance: default_instance) if instance.nil?
+    end
+
+    def instance
+      @instance ||= params[:instance].presence
+    end
+
+    def redises
+      @redises ||= RedisWebManager.redises
     end
   end
 end

data/app/views/redis_web_manager/shared/_header.html.erb

@@ -1,13 +1,26 @@
 <nav class="navbar navbar-expand-lg navbar-light bg-light shadow-sm">
   <div class="container">
-    <%= link_to 'Redis Web Manager', root_path, title: 'Redis Web Manager', class: 'navbar-brand' %>
+    <%= link_to 'Redis Web Manager', dashboard_path, title: 'Redis Web Manager', class: 'navbar-brand' %>
     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Redis Web Manager">
       <span class="navbar-toggler-icon"></span>
     </button>
     <div class="collapse navbar-collapse" id="navbarSupportedContent">
       <ul class="navbar-nav mr-auto">
+          <li class="nav-item dropdown mr-3">
+            <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+              <%= instance.humanize.capitalize %>
+            </a>
+            <div class="dropdown-menu" aria-labelledby="navbarDropdown">
+              <% redises.each do |k, v| %>
+                <%= link_to v.connection[:id],
+                            dashboard_path(instance: k),
+                            title: k,
+                            class: instance == k.to_s ? 'dropdown-item active' : 'dropdown-item'  %>
+              <% end %>
+            </div>
+          </li>
         <li class="nav-item">
-          <%= link_to 'Dashboard', root_path, title: 'Dashboard', class: 'nav-link' %>
+          <%= link_to 'Dashboard', dashboard_path, title: 'Dashboard', class: 'nav-link' %>
         </li>
         <li class="nav-item">
           <%= link_to 'Clients', clients_path, title: 'Clients', class: 'nav-link' %>

data/config/routes.rb

@@ -1,26 +1,32 @@
 # frozen_string_literal: true
 
 RedisWebManager::Engine.routes.draw do
-  # Configuration
-  get :configuration, to: 'configuration#index'
+  redises_keys = RedisWebManager.redises.keys
+  scope ':instance', instance: /#{redises_keys.join('|')}/ do
+    # Configuration
+    get :configuration, to: 'configuration#index'
 
-  # Information
-  get :information, to: 'information#index'
+    # Information
+    get :information, to: 'information#index'
 
-  # Keys
-  get 'keys' => 'keys#index'
-  get 'key' => 'keys#show'
-  get 'key/edit' => 'keys#edit', as: :edit_key
-  put 'keys' => 'keys#update', as: :update_key
-  delete 'keys' => 'keys#destroy', as: :destroy_key
+    # Dashboard
+    get :dashboard, to: 'dashboard#index'
 
-  # Clients
-  get :clients, to: 'clients#index'
+    # Keys
+    get 'keys' => 'keys#index'
+    get 'key' => 'keys#show'
+    get 'key/edit' => 'keys#edit', as: :edit_key
+    put 'keys' => 'keys#update', as: :update_key
+    delete 'keys' => 'keys#destroy', as: :destroy_key
 
-  # Actions
-  delete :reset, to: 'actions#reset'
-  delete :flushdb, to: 'actions#flushdb'
-  delete :flushall, to: 'actions#flushall'
+    # Clients
+    get :clients, to: 'clients#index'
+
+    # Actions
+    delete :reset, to: 'actions#reset'
+    delete :flushdb, to: 'actions#flushdb'
+    delete :flushall, to: 'actions#flushall'
+  end
 
   # Root
   root 'dashboard#index'

data/lib/redis_web_manager.rb

@@ -9,7 +9,7 @@ require 'redis_web_manager/data'
 require 'redis'
 
 module RedisWebManager
-  mattr_accessor :redis, default: ::Redis.new
+  mattr_accessor :redises, default: { default: ::Redis.new }
   mattr_accessor :lifespan, default: 15.days
   mattr_accessor :authenticate, default: nil
 
@@ -22,14 +22,19 @@ module RedisWebManager
     private
 
     def check_attrs
-      unless redis.is_a?(::Redis)
-        raise ArgumentError, 'Invalid Redis instance, use like that Redis.new'
+      unless redises.is_a?(::Hash)
+        raise(ArgumentError, 'Invalid redises hash, use like that { test: Redis.new }')
+      end
+      redises.each do |k, v|
+        unless v.is_a?(::Redis)
+          raise(ArgumentError, "Invalid Redis instance for #{k}, use like that Redis.new")
+        end
       end
       unless lifespan.is_a?(::ActiveSupport::Duration)
-        raise ArgumentError, 'Invalid lifespan, use like that 15.days, 15.minutes etc'
+        raise(ArgumentError, 'Invalid lifespan, use like that 15.days, 15.minutes etc')
       end
       valid = lifespan.to_i.positive?
-      raise ArgumentError, 'Invalid lifespan, value must be greater than 0' unless valid
+      raise(ArgumentError, 'Invalid lifespan, value must be greater than 0') unless valid
     end
   end
 end

data/lib/redis_web_manager/base.rb

@@ -2,10 +2,20 @@
 
 module RedisWebManager
   class Base
+    attr_accessor :instance
+
+    def initialize(instance)
+      @instance = instance || redises.keys[0]
+    end
+
     private
 
     def redis
-      @redis ||= RedisWebManager.redis
+      @redis ||= redises[instance.to_sym]
+    end
+
+    def redises
+      @redises ||= RedisWebManager.redises
     end
   end
 end

data/lib/redis_web_manager/data.rb

@@ -11,7 +11,7 @@ module RedisWebManager
     def perform
       now = Time.now.to_i
       seconds = (now + lifespan.to_i) - now
-      redis.setex("#{BASE}_#{now}", seconds, serialize.to_json)
+      redis.setex("#{instance}_#{BASE}_#{now}", seconds, serialize.to_json)
     end
 
     def flush
@@ -21,7 +21,7 @@ module RedisWebManager
     private
 
     def data
-      @data ||= redis.scan_each(match: "#{BASE}_*").to_a
+      @data ||= redis.scan_each(match: "#{instance}_#{BASE}_*").to_a
     end
 
     def lifespan

data/lib/redis_web_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedisWebManager
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/controllers/redis_web_manager/actions_controller_spec.rb

@@ -5,23 +5,27 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::ActionsController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'DELETE #reset' do
     it 'returns a success response' do
-      delete :reset
+      delete :reset, params: { instance: default.to_s }
       expect(response).to be_redirect
     end
   end
 
   describe 'DELETE #flushdb' do
     it 'returns a success response' do
-      delete :flushdb
+      delete :flushdb, params: { instance: default.to_s }
       expect(response).to be_redirect
     end
   end
 
   describe 'DELETE #flushall' do
     it 'returns a success response' do
-      delete :flushall
+      delete :flushall, params: { instance: default.to_s }
       expect(response).to be_redirect
     end
   end

data/spec/controllers/redis_web_manager/clients_controller_spec.rb

@@ -5,9 +5,13 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::ClientsController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'GET #index' do
     it 'returns a success response' do
-      get :index
+      get :index, params: { instance: default.to_s }
       expect(response).to be_successful
     end
   end

data/spec/controllers/redis_web_manager/configuration_controller_spec.rb

@@ -5,9 +5,13 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::ConfigurationController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'GET #index' do
     it 'returns a success response' do
-      get :index
+      get :index, params: { instance: default.to_s }
       expect(response).to be_successful
     end
   end

data/spec/controllers/redis_web_manager/dashboard_controller_spec.rb

@@ -5,9 +5,13 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::DashboardController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'GET #index' do
     it 'returns a success response' do
-      get :index
+      get :index, params: { instance: default.to_s }
       expect(response).to be_successful
     end
   end

data/spec/controllers/redis_web_manager/information_controller_spec.rb

@@ -5,9 +5,13 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::InformationController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'GET #index' do
     it 'returns a success response' do
-      get :index
+      get :index, params: { instance: default.to_s }
       expect(response).to be_successful
     end
   end

data/spec/controllers/redis_web_manager/keys_controller_spec.rb

@@ -8,19 +8,23 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
     ::Redis.new
   end
 
+  let(:default) do
+    RedisWebManager.redises.keys[0]
+  end
+
   describe 'GET #index' do
     it 'returns a success response' do
-      get :index
+      get :index, params: { instance: default.to_s }
       expect(response).to be_successful
-      get :index, params: { query: 'test' }
+      get :index, params: { query: 'test', instance: default.to_s }
       expect(response).to be_successful
-      get :index, params: { type: 'string' }
+      get :index, params: { type: 'string', instance: default.to_s }
       expect(response).to be_successful
-      get :index, params: { expiry: '-1' }
+      get :index, params: { expiry: '-1', instance: default.to_s }
       expect(response).to be_successful
-      get :index, params: { expiry: '3600' }
+      get :index, params: { expiry: '3600', instance: default.to_s }
       expect(response).to be_successful
-      get :index, params: { memory: '1000' }
+      get :index, params: { memory: '1000', instance: default.to_s }
       expect(response).to be_successful
     end
   end
@@ -28,7 +32,7 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
   describe 'GET #show' do
     it 'returns a success response' do
       redis.set('test', 'test')
-      get :show, params: { key: 'test' }
+      get :show, params: { key: 'test', instance: default.to_s }
       expect(response).to be_successful
     end
   end
@@ -36,7 +40,7 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
   describe 'GET #edit' do
     it 'returns a success response' do
       redis.set('test', 'test')
-      get :edit, params: { key: 'test' }
+      get :edit, params: { key: 'test', instance: default.to_s }
       expect(response).to be_successful
     end
   end
@@ -44,7 +48,7 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
   describe 'GET #update' do
     it 'returns a success response' do
       redis.set('test', 'test')
-      put :update, params: { old_name: 'test', new_name: 'testtest' }
+      put :update, params: { old_name: 'test', new_name: 'testtest', instance: default.to_s }
       expect(response).to be_redirect
     end
   end
@@ -52,7 +56,7 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
   describe 'GET #destroy' do
     it 'returns a success response' do
       redis.set('test', 'test')
-      delete :destroy, params: { key: 'test' }
+      delete :destroy, params: { key: 'test', instance: default.to_s }
       expect(response).to be_redirect
     end
   end