redis_ui_rails 1.0.1

data/spec/redis_ui_rails/config_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+RSpec.describe RedisUiRails::Config do
+  let(:config) { described_class.new }
+  let(:hash_instance) do
+    {
+      id: "test",
+      url: "test/url",
+      name: "test name",
+      enabled: true
+    }
+  end
+  let(:hash_instances) { [hash_instance] }
+
+  before(:each) do
+    config.redis_instances = hash_instances
+  end
+
+  describe "#ingest" do
+    it "slurps hash instances into instance objects" do
+      config.ingest
+
+      expect(config.redis_instances.map(&:class)).to contain_exactly(RedisUiRails::RedisInstance)
+    end
+  end
+
+  describe "validations" do
+    before(:each) { config.ingest }
+
+    context "given a valid instance hash" do
+      it "is valid" do
+        expect { config.validate! }.not_to raise_error
+      end
+    end
+
+    context "given an invalid instance hash" do
+      let(:hash_instance) { super().tap { |obj| obj.delete(:url) } }
+
+      it "is not valid" do
+        expect { config.validate! }.to raise_error(/url/)
+      end
+    end
+
+    context "given 0 instance hashes" do
+      let(:hash_instance) { nil }
+
+      it "is not valid" do
+        expect { config.validate! }.to raise_error(/at least one/i)
+      end
+    end
+
+    context "given duplicate ids" do
+      let(:hash_instances) { [hash_instance, hash_instance] }
+
+      it "is not valid" do
+        expect { config.validate! }.to raise_error(/duplicate/i)
+      end
+    end
+  end
+end

data/spec/redis_ui_rails/redis_instance_spec.rb

@@ -0,0 +1,117 @@
+require "spec_helper"
+
+RSpec.describe RedisUiRails::RedisInstance do
+  let(:options) do
+    {
+      id: "test",
+      url: "//test/url",
+      name: "test name",
+      resource_links: [
+        {
+          label: "label",
+          url: "url"
+        }
+      ]
+    }
+  end
+  let(:instance) { described_class.new(options) }
+
+  it "provides accessors to input hash keys" do
+    expect(instance.id).to eq(options[:id])
+    expect(instance.url).to eq(options[:url])
+    expect(instance.name).to eq(options[:name])
+  end
+
+  describe "#url" do
+    context "given a localhost URL" do
+      let(:url) { "redis://localhost:6379/3" }
+
+      it "returns the full URL" do
+        instance.actual_url = url
+
+        expect(instance.url).to eq(url)
+      end
+    end
+
+    context "given non-localhost URLs" do
+      let(:sensitive_urls) do
+        {
+          "redis://fo-some-service.two01.ng.0001.use1.cache.amazonaws.com:6379" => "redis://fo-some-service.two**.ng.****.use*.cache.amazonaws.com:6379",
+          "redis://user:password@fo-some-service.two01.ng.0001.use1.cache.amazonaws.com:6379" => "redis://user:*@fo-some-service.two**.ng.****.use*.cache.amazonaws.com:6379"
+        }
+      end
+
+      it "obscures the URL" do
+        sensitive_urls.each do |url, redacted_url|
+          instance.actual_url = url
+
+          expect(instance.url).to eq(redacted_url)
+        end
+      end
+
+      it "can bypass URL obscuring" do
+        sensitive_urls.each do |url, _|
+          instance.actual_url = url
+
+          expect(instance.url(unredacted: true)).to eq(url)
+        end
+      end
+    end
+  end
+
+  describe "validations" do
+    context "given a valid set of options" do
+      it "is valid" do
+        expect { instance.validate! }.not_to raise_error
+      end
+    end
+
+    context "given a missing :url" do
+      let(:options) { super().tap { |obj| obj.delete(:url) } }
+
+      it "is not valid" do
+        expect { instance.validate! }.to raise_error(ActiveModel::ValidationError)
+      end
+    end
+
+    context "given a missing :name" do
+      let(:options) { super().tap { |obj| obj.delete(:name) } }
+
+      it "is not valid" do
+        expect { instance.validate! }.to raise_error(ActiveModel::ValidationError)
+      end
+    end
+
+    context "given a missing :id" do
+      let(:options) { super().tap { |obj| obj.delete(:id) } }
+
+      it "is not valid" do
+        expect { instance.validate! }.to raise_error(ActiveModel::ValidationError)
+      end
+    end
+
+    context "given a missing :resource_links" do
+      let(:options) { super().tap { |obj| obj.delete(:resource_links) } }
+
+      it "is valid" do
+        expect { instance.validate! }.not_to raise_error
+      end
+    end
+
+    context "given a missing resource_links: :url" do
+      let(:options) { super().tap { |obj| obj[:resource_links][0].delete(:url) } }
+
+      it "is not valid" do
+        expect { instance.validate! }.to raise_error(ActiveModel::ValidationError)
+      end
+    end
+
+    context "given a missing resource_links: :label" do
+      let(:options) { super().tap { |obj| obj[:resource_links][0].delete(:label) } }
+
+      it "is not valid" do
+        expect { instance.validate! }.to raise_error(ActiveModel::ValidationError)
+      end
+    end
+  end
+end

data/spec/redis_ui_rails_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+RSpec.describe RedisUiRails do
+  after(:each) do
+    described_class.remove_instance_variable(:@config)
+  end
+
+  it "is configurable" do
+    expect {
+      described_class.configure do |config|
+        config.redis_instances = [
+          {
+            id: "test",
+            url: "test/url",
+            name: "test name"
+          }
+        ]
+      end
+    }.not_to raise_error
+  end
+
+  it "raises an error if configured incorrectly" do
+    expect {
+      described_class.configure do |config|
+        config.redis_instances = []
+      end
+    }.to raise_error(ActiveModel::ValidationError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+
+require_relative "../lib/redis_ui_rails"
+require "pry"
+require "mock_redis"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.disable_monkey_patching!
+  config.expose_dsl_globally = true
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+end

data/spec/support/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/support/dummy/app/assets/stylesheets/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/spec/support/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/support/dummy/app/javascript/packs/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 rails-ujs
+//= require_tree .

data/spec/support/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/support/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/support/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/support/dummy/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/spec/support/dummy/config/application.rb

@@ -0,0 +1,16 @@
+require_relative "boot"
+
+require "puma"
+require "sqlite3"
+require "net/smtp"
+require "rails"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "redis_ui_rails"
+
+module RedisUiRailsDummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+  end
+end

data/spec/support/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/spec/support/dummy/config/database.yml

@@ -0,0 +1,11 @@
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+  database: ":memory:"
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/spec/support/dummy/config/environment.rb

@@ -0,0 +1,8 @@
+# Load the Rails application.
+require_relative "application"
+
+# Load the gem/engine under test
+require "redis_ui_rails"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/support/dummy/config/environments/development.rb

@@ -0,0 +1,76 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp", "caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  # config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  # config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  # config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  # config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end

data/spec/support/dummy/config/environments/production.rb

@@ -0,0 +1,120 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
+
+  # Compress CSS using a preprocessor.
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  # config.assets.compile = false
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  # config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain.
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Include generic and useful information about system operation, but avoid logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII).
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_production"
+
+  # config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Log disallowed deprecations.
+  config.active_support.disallowed_deprecation = :log
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require "syslog/logger"
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger = ActiveSupport::Logger.new($stdout)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  # config.active_record.dump_schema_after_migration = false
+
+  # Inserts middleware to perform automatic connection switching.
+  # The `database_selector` hash is used to pass options to the DatabaseSelector
+  # middleware. The `delay` is used to determine how long to wait after a write
+  # to send a subsequent read to the primary.
+  #
+  # The `database_resolver` class is used by the middleware to determine which
+  # database is appropriate to use based on the time delay.
+  #
+  # The `database_resolver_context` class is used by the middleware to set
+  # timestamps for the last write to the primary. The resolver uses the context
+  # class timestamps to determine how long to wait before reading from the
+  # replica.
+  #
+  # By default Rails will store a last write timestamp in the session. The
+  # DatabaseSelector middleware is designed as such you can define your own
+  # strategy for connection switching and pass that into the middleware through
+  # these configuration options.
+  # config.active_record.database_selector = { delay: 2.seconds }
+  # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
+  # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
+end

data/spec/support/dummy/config/environments/test.rb

@@ -0,0 +1,59 @@
+require "active_support/core_ext/integer/time"
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory.
+  # config.active_storage.service = :test
+
+  # config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+end

data/spec/support/dummy/config/initializers/assets.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+# Rails.application.config.assets.version = "1.0"
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/spec/support/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| /my_noisy_library/.match?(line) }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code
+# by setting BACKTRACE=1 before calling your invocation, like "BACKTRACE=1 ./bin/rails runner 'MyClass.perform'".
+Rails.backtrace_cleaner.remove_silencers! if ENV["BACKTRACE"]

data/spec/support/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/support/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]