redis_data_viewer 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c75143df0dae336a78e145642e7ab0aa7628761
+  data.tar.gz: 943ed98ebbd28d08edfc1973d7d16a3122ac8374
+SHA512:
+  metadata.gz: f0464eda9a9a60d6a0a66016603eb05c00abcb0e009a570c83194b50e530a0ee88ca3928e84c6220ca81b5ee27f69701bac17763170cf52bd38a917891470345
+  data.tar.gz: 07c7902dc2b641501fbde358cc1a5dfba298359751b5a9c9e4d3875b5a044d558746aa0b9e4dd4c262bf59b4af2725ae30461c69206cb2bb03eb1c5c91775a20

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Manjit
+
+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,45 @@
+# RedisDataViewer
+A gem that lets you see redis data in your rails application. It helps you view the data in your redis in a readonly mode. This prevents accidental changes in your datastore.
+
+Visit the [Homepage](https://manjitborah2710.github.io/redis_data_viewer/)
+
+## Usage
+How to use my plugin.
+
+- Open you rails app and go to the path /redis. In the UI, enter the db and key to search for and hit fetch.
+
+!['image not found'](https://github.com/manjitborah2710/redis_data_viewer/blob/8783c45be6a7e5c0ff0683d2fb9d3f79953c6ca8/images/sample.png)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_data_viewer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install redis_data_viewer
+```
+
+Execute the following in your rails app root directory
+```bash
+rails g redis_data_viewer install
+```
+
+Visit this to get a sample configuration that needs to be added to config/initializers/redis_data_viewer.rb in your rails application
+https://gist.github.com/manjitborah2710/80042165479c512c61d21984c25c6bf6
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+### Planned for future release
+- Able to configure multiple redis hosts rather than one

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RedisDataViewer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/redis_data_viewer_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/redis_data_viewer .js
+//= link_directory ../stylesheets/redis_data_viewer .css

data/app/assets/javascripts/redis_data_viewer/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require_tree .

data/app/assets/javascripts/redis_data_viewer/viewer.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/redis_data_viewer/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/redis_data_viewer/viewer.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/redis_data_viewer/application_controller.rb

@@ -0,0 +1,5 @@
+module RedisDataViewer
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/redis_data_viewer/viewer_controller.rb

@@ -0,0 +1,42 @@
+require_dependency "redis_data_viewer/application_controller"
+
+module RedisDataViewer
+  class ViewerController < ApplicationController
+    extend RedisDataViewer
+    def show_data
+      
+    end
+
+    def get_data
+      result = {
+        "data" => read_only_search(params[:db], params[:key])
+      }
+      render json: result
+    end
+
+    private
+
+    def read_only_search(db, key)
+      redis = RedisDataViewer.redis_client
+      redis.select(db.to_i)
+      value = ""
+      case redis.type(key)
+        when "none"
+          value = "No key found"
+        when "set"
+          value = redis.smembers(key)
+        when "hash"
+          value = redis.hgetall(key)
+        when "string"
+          value = redis.get(key)
+        when "list"
+          value = redis.lrange(key, 0, -1)
+        when "zset"
+          value = (redis.zrange(key, 0, -1, with_scores: true) || []).to_h
+        else
+          value = "No key found"
+      end
+      value
+    end
+  end
+end

data/app/helpers/redis_data_viewer/application_helper.rb

@@ -0,0 +1,4 @@
+module RedisDataViewer
+  module ApplicationHelper
+  end
+end

data/app/helpers/redis_data_viewer/viewer_helper.rb

@@ -0,0 +1,4 @@
+module RedisDataViewer
+  module ViewerHelper
+  end
+end

data/app/jobs/redis_data_viewer/application_job.rb

@@ -0,0 +1,4 @@
+module RedisDataViewer
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/redis_data_viewer/application_mailer.rb

@@ -0,0 +1,6 @@
+module RedisDataViewer
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/redis_data_viewer/application_record.rb

@@ -0,0 +1,5 @@
+module RedisDataViewer
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/redis_data_viewer/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Redis data viewer</title>
+  <%= stylesheet_link_tag    "redis_data_viewer/application", media: "all" %>
+  <%= javascript_include_tag "redis_data_viewer/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/redis_data_viewer/viewer/show_data.html.erb

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="utf-8">
+	<title>Result</title>
+	<style type="text/css">
+		#container-div{
+			margin: 10px auto;
+			padding: 20px;
+		}
+		#f{
+			text-align: center;
+		}
+		#result{
+			display: block;
+			height: 300px;
+			width: 100%;
+			overflow-y: scroll;
+			resize: none;
+			margin-top: 15px;
+		}
+		#title{
+			width: 100%;
+			text-align: center;
+		}
+	</style>
+</head>
+<body>
+	<div id="container-div">
+		<h2 id="title">Redis Database</h2>
+		<%= form_tag(get_data_path, method: :get, id: 'f') do %>
+			<%= label_tag :key, "Key to search"%>
+			<%= text_field_tag :key %>
+
+			<%= label_tag :db, "Redis DB index"%>
+			<%= number_field :redis, :db, :min => 0 %>
+
+			<%= submit_tag "Fetch" %>
+		<% end %>
+		<hr>
+		<%= text_area_tag :result, '',:readonly => true %>
+	</div>
+
+	<script type="text/javascript">
+		$('#f').on('submit', (e) =>{
+			e.preventDefault();
+			callAction();
+		})
+
+		function callAction(){
+			$.ajax({
+				type: "get",
+				url: "<%= get_data_path %>",
+				contentType: "application/json; charset=utf-8",
+				data: {key: $('#key').val(), db: $('#redis_db').val()},
+				success: function(result){
+					console.log("response received !!")
+					console.log(result)
+					console.log(result.data)
+					$('#result').val(JSON.stringify(result.data))
+				}
+			})
+		}
+	</script>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+RedisDataViewer::Engine.routes.draw do
+	get '/', to: 'viewer#show_data'
+	get '/get_data', to: 'viewer#get_data'
+end

data/lib/generators/redis_data_viewer/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Run this generator to setup initial configuration
+
+Example:
+    rails generate redis_data_viewer install

data/lib/generators/redis_data_viewer/redis_data_viewer_generator.rb

@@ -0,0 +1,25 @@
+class RedisDataViewerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_route
+    if name == 'install'
+      route "mount RedisDataViewer::Engine, at: '/redis'"
+    end
+  end
+
+
+  def create_initializer
+    if name == 'install'
+      configs = begin
+        f_loc = File.expand_path('../templates/initializer_template.rb', __FILE__)
+        f = File.open(f_loc)
+        f.read
+      rescue => e
+        print e.message + "#{File.expand_path('../templates', __FILE__)}" + "\n"
+        ""
+      end
+
+      initializer 'redis_data_viewer.rb', configs
+    end
+  end
+end

data/lib/generators/redis_data_viewer/templates/initializer_template.rb

@@ -0,0 +1,6 @@
+RedisDataViewer.setup do |config|
+  config.redis_host = 'localhost'
+  config.redis_port = 6379
+  config.redis_password = ''
+  config.use_password = false
+end

data/lib/redis_data_viewer/configuration.rb

@@ -0,0 +1,5 @@
+module RedisDataViewer
+  class Configuration
+    attr_accessor :redis_host, :redis_port, :redis_password, :use_password
+  end
+end

data/lib/redis_data_viewer/engine.rb

@@ -0,0 +1,5 @@
+module RedisDataViewer
+  class Engine < ::Rails::Engine
+    isolate_namespace RedisDataViewer
+  end
+end

data/lib/redis_data_viewer/version.rb

@@ -0,0 +1,3 @@
+module RedisDataViewer
+  VERSION = '0.1.10'.freeze
+end

data/lib/redis_data_viewer.rb

@@ -0,0 +1,27 @@
+require 'redis_data_viewer/engine'
+require 'redis_data_viewer/configuration'
+require 'redis'
+
+module RedisDataViewer
+  # Your code goes here...
+  # class << self
+  #   attr_accessor :config
+  # end
+
+  def self.setup_data
+    @setup_data ||= Configuration.new
+  end
+
+  def self.setup
+    yield(self.setup_data)
+  end
+
+  def self.redis_client
+    if setup_data.use_password
+      @client ||= Redis.new(host: setup_data.redis_host, port: setup_data.redis_port, password: setup_data.redis_password || '')
+    else
+      @client ||= Redis.new(host: setup_data.redis_host, port: setup_data.redis_port)
+    end
+  end
+
+end

data/lib/tasks/redis_data_viewer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :redis_data_viewer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: redis_data_viewer
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Manjit Borah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- manjitborah2710@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/redis_data_viewer_manifest.js
+- app/assets/javascripts/redis_data_viewer/application.js
+- app/assets/javascripts/redis_data_viewer/viewer.js
+- app/assets/stylesheets/redis_data_viewer/application.css
+- app/assets/stylesheets/redis_data_viewer/viewer.css
+- app/controllers/redis_data_viewer/application_controller.rb
+- app/controllers/redis_data_viewer/viewer_controller.rb
+- app/helpers/redis_data_viewer/application_helper.rb
+- app/helpers/redis_data_viewer/viewer_helper.rb
+- app/jobs/redis_data_viewer/application_job.rb
+- app/mailers/redis_data_viewer/application_mailer.rb
+- app/models/redis_data_viewer/application_record.rb
+- app/views/layouts/redis_data_viewer/application.html.erb
+- app/views/redis_data_viewer/viewer/show_data.html.erb
+- config/routes.rb
+- lib/generators/redis_data_viewer/USAGE
+- lib/generators/redis_data_viewer/redis_data_viewer_generator.rb
+- lib/generators/redis_data_viewer/templates/initializer_template.rb
+- lib/redis_data_viewer.rb
+- lib/redis_data_viewer/configuration.rb
+- lib/redis_data_viewer/engine.rb
+- lib/redis_data_viewer/version.rb
+- lib/tasks/redis_data_viewer_tasks.rake
+homepage: https://manjitborah2710.github.io/redis_data_viewer/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A gem that lets you see redis data in your rails application. It helps you
+  view the data in your redis in a readonly mode. This prevents accidental changes
+  in your datastore.
+test_files: []