redis_web_manager 0.1.6

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

@@ -0,0 +1,6 @@
+<div class="row my-4">
+  <div class="col-12">
+    <%= @url %>
+    <%= @status %>
+  </div>
+</div>

data/bin/rails

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/redis_web_manager/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails'
+# Pick the frameworks you want:
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RedisWebManager::Engine.routes.draw do
+  # Configuration
+  get :configuration, to: 'configuration#index'
+
+  # Information
+  get :information, to: 'information#index'
+
+  # Clients
+  get :clients, to: 'clients#index'
+
+  # Actions
+  delete :flushdb, to: 'actions#flushdb'
+  delete :flushall, to: 'actions#flushall'
+
+  # Root
+  root 'dashboard#index'
+end

data/gemfiles/Gemfile-5-2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 5.2'

data/gemfiles/Gemfile-6-0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0'

data/lib/redis_web_manager.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'redis_web_manager/engine'
+require 'redis_web_manager/base'
+require 'redis_web_manager/action'
+require 'redis_web_manager/connection'
+require 'redis_web_manager/info'
+require 'redis_web_manager/data'
+require 'redis'
+
+module RedisWebManager
+  mattr_accessor :redis, default: ::Redis.new
+  mattr_accessor :authenticate, default: nil
+  mattr_accessor :lifespan, default: 15.days
+
+  class << self
+    def configure
+      yield self if block_given?
+      check_attrs
+    end
+
+    private
+
+    def check_attrs
+      unless redis.is_a?(::Redis)
+        raise ArgumentError, 'Invalid Redis instance, use like that Redis.new'
+      end
+      unless lifespan.is_a?(::ActiveSupport::Duration)
+        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
+    end
+  end
+end

data/lib/redis_web_manager/action.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Action < Base
+    def flushall
+      redis.flushall
+    end
+
+    def flushdb
+      redis.flushdb
+    end
+
+    def del(key)
+      redis.del(key)
+    end
+
+    def rename(old_name, new_name)
+      redis.rename(old_name, new_name)
+    end
+  end
+end

data/lib/redis_web_manager/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Base
+    private
+
+    def redis
+      @redis ||= RedisWebManager.redis
+    end
+  end
+end

data/lib/redis_web_manager/connection.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Connection < Base
+    def host
+      @host ||= connection[:host]
+    end
+
+    def port
+      @port ||= connection[:port]
+    end
+
+    def db
+      @db ||= connection[:db]
+    end
+
+    def id
+      @id ||= connection[:id]
+    end
+
+    def location
+      @location ||= connection[:location]
+    end
+
+    private
+
+    def connection
+      @connection ||= redis.connection
+    end
+  end
+end

data/lib/redis_web_manager/data.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Data < Base
+    BASE = 'RedisWebManager'
+
+    def perform
+      now = Time.now.to_i
+      seconds = (now + lifespan.to_i) - now
+      redis.setex("#{BASE}_#{now}", seconds, serialize.to_json)
+    end
+
+    private
+
+    def serialize
+      {
+        date: Time.now,
+        memory: memory,
+        client: client,
+        cpu: cpu
+      }
+    end
+
+    def memory
+      {
+        used_memory: stats[:used_memory],
+        used_memory_rss: stats[:used_memory_rss],
+        used_memory_peak: stats[:used_memory_peak],
+        used_memory_overhead: stats[:used_memory_overhead],
+        used_memory_startup: stats[:used_memory_startup],
+        used_memory_dataset: stats[:used_memory_dataset]
+      }
+    end
+
+    def client
+      {
+        connected_clients: stats[:connected_clients],
+        blocked_clients: stats[:blocked_clients]
+      }
+    end
+
+    def cpu
+      {
+        used_cpu_sys: stats[:used_cpu_sys],
+        used_cpu_user: stats[:used_cpu_user],
+        used_cpu_sys_children: stats[:used_cpu_sys_children],
+        used_cpu_user_children: stats[:used_cpu_user_children]
+      }
+    end
+
+    def stats
+      @stats ||= redis.info.symbolize_keys
+    end
+  end
+end

data/lib/redis_web_manager/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Engine < ::Rails::Engine
+    isolate_namespace RedisWebManager
+
+    path = Engine.root.join('app', 'assets', 'config')
+    config.assets.precompile << "#{path}/redis_web_manager_manifest.js"
+
+    config.generators do |generate|
+      # Don't generate assets
+      generate.assets false
+
+      # Don't generate helper
+      generate.helper false
+
+      # Rspec
+      generate.test_framework :rspec
+    end
+  end
+end

data/lib/redis_web_manager/info.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  class Info < Base
+    def status
+      @status ||= redis.ping == 'PONG'
+    end
+
+    def stats
+      @stats ||= redis.info
+    end
+
+    def keys
+      @keys ||= redis.keys
+    end
+
+    def search(query)
+      redis.scan_each(match: "*#{query.downcase}*").to_a
+    end
+
+    def type(key)
+      redis.type(key)
+    end
+
+    def expire(key)
+      redis.ttl(key)
+    end
+
+    def memory_usage(key)
+      redis.memory(:usage, key)
+    end
+
+    def get(key)
+      redis.get(key)
+    end
+
+    def llen(key)
+      redis.llen(key)
+    end
+
+    def lrange(key, start, stop)
+      redis.lrange(key, start, stop)
+    end
+
+    def smembers(key)
+      redis.smembers(key)
+    end
+
+    def zrange(key, start, stop, options = {})
+      redis.zrange(key, start, stop, options)
+    end
+
+    def hgetall(key)
+      redis.hgetall(key)
+    end
+
+    def dbsize
+      @dbsize ||= redis.dbsize
+    end
+
+    def configuration
+      @configuration ||= redis.config(:get, '*')
+    end
+
+    def clients
+      @clients ||= redis.client(:list)
+    end
+  end
+end

data/lib/redis_web_manager/version.rb

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

data/redis_web_manager.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'redis_web_manager/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = 'redis_web_manager'
+  spec.version     = RedisWebManager::VERSION
+
+  spec.authors     = ['Boris BRESCIANI', 'Benjamin DARCET', 'Olivier DUMAS', 'Sylvain KRAISIN']
+  spec.email       = %w[boris2bresciani@gmail.com
+                        b.darcet@gmail.com
+                        dumas.olivier@outlook.fr
+                        sylvain.kraisin@gmail.com]
+
+  spec.summary     = 'Manage your Redis instance (See keys, memory used, connected client, etc...)'
+  spec.description = 'Manage your Redis instance (See keys, memory used, connected client, configuration, information)'
+  spec.homepage    = 'https://github.com/OpenGems/redis_web_manager'
+  spec.license     = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+                     .reject { |f| f.match(%r{^(test|spec|features|images)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.test_files = Dir['spec/**/*']
+
+  spec.add_development_dependency 'rspec-rails', '= 4.0.0.beta3'
+
+  spec.add_dependency 'rails', '>= 5.2', '< 7'
+  spec.add_dependency 'redis', '~> 4.1.0'
+end

data/spec/controllers/redis_web_manager/actions_controller_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::ActionsController, type: :controller do
+  routes { RedisWebManager::Engine.routes }
+
+  describe 'DELETE #flushdb' do
+  end
+
+  describe 'DELETE #flushall' do
+  end
+end

data/spec/controllers/redis_web_manager/application_controller_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::ApplicationController, type: :controller do
+  describe 'Methods' do
+    it 'returns a raise value (authenticated?)' do
+      expect do
+        controller.send(:authenticated?)
+      end.to raise_error(LocalJumpError)
+    end
+
+    it 'returns a nil value (authenticate)' do
+      expect(controller.send(:authenticate)).to eql(nil)
+    end
+
+    it 'returns a Info class (info)' do
+      expect(controller.send(:info)).to be_a_kind_of(RedisWebManager::Info)
+    end
+
+    it 'returns a Connection class (connection)' do
+      expect(controller.send(:connection)).to be_a_kind_of(RedisWebManager::Connection)
+    end
+
+    it 'returns a Action class (action)' do
+      expect(controller.send(:action)).to be_a_kind_of(RedisWebManager::Action)
+    end
+  end
+end

data/spec/controllers/redis_web_manager/clients_controller_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::ClientsController, type: :controller do
+  routes { RedisWebManager::Engine.routes }
+
+  describe 'GET #index' do
+    it 'returns a success response' do
+      get :index
+      expect(response).to be_successful
+    end
+  end
+end

data/spec/controllers/redis_web_manager/configuration_controller_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::ConfigurationController, type: :controller do
+  routes { RedisWebManager::Engine.routes }
+
+  describe 'GET #index' do
+    it 'returns a success response' do
+      get :index
+      expect(response).to be_successful
+    end
+  end
+end

data/spec/controllers/redis_web_manager/dashboard_controller_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::DashboardController, type: :controller do
+  routes { RedisWebManager::Engine.routes }
+
+  describe 'GET #index' do
+    it 'returns a success response' do
+      get :index
+      expect(response).to be_successful
+    end
+  end
+end