rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/monitoring/lograge/templates/lograge_util.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Utility functions used with Lograge generated by rockstart:security:lograge
+module LogrageUtil
+  class << self
+    # format a throttle.rack_attack message from rack:attack
+    def format_rack_attack_throttle(name, start, finish, request_id, payload)
+      format_rack_attack_event(name, start, finish, request_id, payload, status: 429)
+    end
+
+    # format a blocklist.rack_attack message from rack:attack
+    def format_rack_attack_blocklist(name, start, finish, request_id, payload)
+      format_rack_attack_event(name, start, finish, request_id, payload, status: 403)
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/ParameterLists
+    def format_rack_attack_event(name, start, finish, request_id, payload, status:)
+      req = payload[:request]
+      matched_rule = req.env["rack.attack.matched"]
+
+      filter_parameters = Rails.application.config.filter_parameters
+      params = ActiveSupport::ParameterFilter.new(filter_parameters).filter(req.params)
+      remote_ip = IpAnonymizer.mask_ip(req.ip) if req.ip.present?
+
+      message_payload = {
+        method: req.request_method,
+        path: req.path,
+        format: params[:format] || "html",
+        controller: Rack::Attack.name,
+        action: "#{name}[#{matched_rule}]",
+        status: status,
+        duration: (finish - start).to_f.round(2),
+        params: params.except("controller", "action", "format", "id"),
+        host: req.host,
+        remote_ip: remote_ip,
+        request_id: request_id
+      }
+      Lograge.lograge_config.formatter.call(message_payload)
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/ParameterLists
+  end
+end

data/lib/generators/rockstart/monitoring/monitoring_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+class Rockstart::MonitoringGenerator < Rails::Generators::Base
+  include Rockstart::Generators::ClassOptionHelpers
+
+  auth0_class_option
+  devise_class_option
+  memcached_class_option
+  rollbar_class_option
+  sidekiq_class_option
+
+  def generate_lograge
+    generate "rockstart:monitoring:lograge"
+  end
+
+  def generate_rollbar
+    return unless rollbar?
+
+    generate "rockstart:monitoring:rollbar",
+             auth0_option,
+             sidekiq_option
+  end
+
+  def generate_okcomputer
+    generate "rockstart:monitoring:okcomputer", memcached_option, sidekiq_option
+  end
+
+  def generate_sidekiq_ui
+    return unless sidekiq?
+
+    generate "rockstart:monitoring:sidekiq_ui", devise_option
+  end
+end

data/lib/generators/rockstart/monitoring/okcomputer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds a health check using OkComputer
+
+Example:
+    rails generate rockstart:monitoring:okcomputer
+
+    This will create:
+        A /health route for monitoring health

data/lib/generators/rockstart/monitoring/okcomputer/okcomputer_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Monitoring
+  class OkcomputerGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    memcached_class_option
+    sidekiq_class_option
+
+    def add_initalizer
+      initializer_template "okcomputer"
+    end
+
+    def add_translations
+      copy_file "okcomputer.en.yml", "config/locales/okcomputer.en.yml"
+    end
+
+    def add_request_spec
+      copy_file "okcomputer_spec.rb", "spec/requests/okcomputer_spec.rb"
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/okcomputer/templates/okcomputer.en.yml

@@ -0,0 +1,5 @@
+en:
+  okcomputer:
+    check:
+      passed: "%{registrant_name}: [success] %{message}"
+      failed: "%{registrant_name}: [failure] %{message}"

data/lib/generators/rockstart/monitoring/okcomputer/templates/okcomputer_initializer.rb.tt

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Log output to logger
+OkComputer.logger = Rails.logger
+
+# Require authentication
+username = ENV.fetch("OKCOMPUTER_USERNAME", "okcomputer")
+password = ENV.fetch("OKCOMPUTER_PASSWORD") { SecureRandom.hex }
+OkComputer.require_authentication(username, password, except: %w[default])
+
+# Cache
+OkComputer::Registry.register "cache", OkComputer::GenericCacheCheck.new
+
+<%- if memcached? -%>
+# Cache (Memcached)
+memcached_servers = ENV.fetch("MEMCACHE_SERVERS") { ENV.fetch("MEMCACHIER_SERVERS", "") }
+memcached_servers.split(",").each_with_index do |cache_server, index|
+  memcached_check = index.zero? ? "memcached" : "memcached_#{index}"
+  OkComputer::Registry.register memcached_check, OkComputer::CacheCheck.new(cache_server)
+end
+
+<%- end -%>
+<%- if sidekiq? -%>
+# Redis
+OkComputer::Registry.register "redis", OkComputer::RedisCheck.new(url: ENV["REDIS_URL"])
+
+# Sidekiq
+OkComputer::Registry.register "sidekiq-critical", OkComputer::SidekiqLatencyCheck.new("critical")
+OkComputer::Registry.register "sidekiq-default", OkComputer::SidekiqLatencyCheck.new("default")
+OkComputer::Registry.register "sidekiq-low", OkComputer::SidekiqLatencyCheck.new("low")
+
+<%- end -%>
+# mount at /health
+OkComputer.mount_at = "health"

data/lib/generators/rockstart/monitoring/okcomputer/templates/okcomputer_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "OkComputer", type: :request do
+  let(:http_authorization) do
+    username = OkComputer.username
+    password = OkComputer.password
+    ActionController::HttpAuthentication::Basic.encode_credentials(username, password)
+  end
+
+  describe "GET /health" do
+    it "responds with success", :aggregate_failures do
+      get "/health"
+      expect(response.body).to have_content("success")
+      expect(response.body).not_to have_content("failure")
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe "GET /health/all" do
+    it "responds with success", :aggregate_failures do
+      get "/health/all", headers: { "HTTP_AUTHORIZATION" => http_authorization }
+      expect(response.body).to have_content("success")
+      expect(response.body).not_to have_content("failure")
+      expect(response).to have_http_status(:success)
+    end
+
+    it "requires http authorization" do
+      get "/health/all"
+      expect(response).to have_http_status(:unauthorized)
+    end
+  end
+
+  describe "GET /health/cache" do
+    it "responds with success", :aggregate_failures do
+      get "/health/cache", headers: { "HTTP_AUTHORIZATION" => http_authorization }
+      expect(response.body).to have_content("success")
+      expect(response.body).not_to have_content("failure")
+      expect(response).to have_http_status(:success)
+    end
+
+    it "requires http authorization" do
+      get "/health/cache"
+      expect(response).to have_http_status(:unauthorized)
+    end
+  end
+
+  describe "GET /health/database" do
+    it "responds with success", :aggregate_failures do
+      get "/health/database", headers: { "HTTP_AUTHORIZATION" => http_authorization }
+      expect(response.body).to have_content("success")
+      expect(response.body).not_to have_content("failure")
+      expect(response).to have_http_status(:success)
+    end
+
+    it "requires http authorization" do
+      get "/health/database"
+      expect(response).to have_http_status(:unauthorized)
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/rollbar/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds Rollback for exception reporting
+
+Example:
+    rails generate rockstart:monitoring:rollbar
+
+    This will create:
+        Installs rollbar gem

data/lib/generators/rockstart/monitoring/rollbar/rollbar_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Monitoring
+  class RollbarGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    auth0_class_option
+    sidekiq_class_option
+
+    def add_initializer
+      initializer_template "rollbar"
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/rollbar/templates/rollbar_initializer.rb.tt

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+Rollbar.configure do |config|
+  # Without configuration, Rollbar is enabled in all environments.
+  # To disable in specific environments, set config.enabled=false.
+
+  config.access_token = ENV["ROLLBAR_ACCESS_TOKEN"]
+
+  # Here we'll disable in 'test' and when not configured:
+  config.enabled = false if Rails.env.test? || ENV["ROLLBAR_ACCESS_TOKEN"].blank?
+
+  # By default, Rollbar will try to call the `current_user` controller method
+  # to fetch the logged-in user object, and then call that object's `id`
+  # method to fetch this property. To customize:
+  # config.person_method = "my_current_user"
+  config.person_id_method = "id"
+
+  # Additionally, you may specify the following:
+  config.person_username_method = "nickname"
+  config.person_email_method = nil # do not send email address
+
+  # If you want to attach custom data to all exception and message reports,
+  # provide a lambda like the following. It should return a hash.
+  # config.custom_data_method = lambda { {:some_key => "some_value" } }
+
+<%- if auth0? -%>
+  # Scrub userinfo from the session
+  config.transform << proc do |options|
+    data = options[:payload]['data']
+    scrubbed_userinfo = Rollbar::Scrubbers.scrub_value(data[:request][:session][:userinfo])
+    data[:request][:session][:userinfo] = scrubbed_userinfo
+  end
+
+<%- end -%>
+  # Add exception class names to the exception_level_filters hash to
+  # change the level that exception is reported at. Note that if an exception
+  # has already been reported and logged the level will need to be changed
+  # via the rollbar interface.
+  # Valid levels: 'critical', 'error', 'warning', 'info', 'debug', 'ignore'
+  # 'ignore' will cause the exception to not be reported at all.
+  # config.exception_level_filters.merge!('MyCriticalException' => 'critical')
+  #
+  # You can also specify a callable, which will be called with the exception instance.
+  # config.exception_level_filters.merge!('MyCriticalException' => lambda { |e| 'critical' })
+
+<%- if sidekiq? -%>
+  # Enable delayed reporting (using Sidekiq)
+  config.use_sidekiq "queue" => "low"
+  config.failover_handlers = [Rollbar::Delay::Thread]
+<%- else -%>
+  # Enable asynchronous reporting
+  config.use_thread
+<%- end -%>
+
+  # If your application runs behind a proxy server, you can set proxy parameters here.
+  # If https_proxy is set in your environment, that will be used. Settings here have precedence.
+  # The :host key is mandatory and must include the URL scheme (e.g. 'http://'), all other fields
+  # are optional.
+  #
+  # config.proxy = {
+  #   host: 'http://some.proxy.server',
+  #   port: 80,
+  #   user: 'username_if_auth_required',
+  #   password: 'password_if_auth_required'
+  # }
+
+  # Anonymize IP Addresses
+  config.anonymize_user_ip = true
+
+  # Send logger messages straight to Rollbar
+  # require "rollbar/logger"
+  # Rails.logger.extend(ActiveSupport::Logger.broadcast(Rollbar::Logger.new))
+
+  # If you run your staging application instance in production environment then
+  # you'll want to override the environment reported by `Rails.env` with an
+  # environment variable like this: `ROLLBAR_ENV=staging`. This is a recommended
+  # setup for Heroku. See:
+  # https://devcenter.heroku.com/articles/deploying-to-a-custom-rails-environment
+  config.environment = ENV["ROLLBAR_ENV"].presence || Rails.env
+end

data/lib/generators/rockstart/monitoring/sidekiq_ui/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs a UI for monitoring Sidekiq
+
+Example:
+    rails generate rockstart:monitoring:sidekiq_ui
+
+    This will create:
+        Adds Sidekiq UI to the list of known routes

data/lib/generators/rockstart/monitoring/sidekiq_ui/sidekiq_ui_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Monitoring
+  class SidekiqUiGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    devise_class_option
+
+    def add_sidekiq_web_ui_for_devise
+      return unless devise?
+
+      route <<~DEVISE_UI
+        require "sidekiq/web"
+        authenticate :user, lambda { |u| u.admin? } do
+          mount Sidekiq::Web => "/sidekiq"
+        end
+      DEVISE_UI
+    end
+
+    def add_sidekiq_web_ui_for_generic_authentication
+      return if devise?
+
+      route <<~GENERIC_UI
+        require "sidekiq/web"
+        require "admin_constraint"
+        mount Sidekiq::Web => "/sidekiq", constraints: AdminConstraint
+      GENERIC_UI
+    end
+
+    def add_sidekiq_specs
+      copy_file "sidekiq_spec.rb", "spec/requests/sidekiq_spec.rb"
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/sidekiq_ui/templates/sidekiq_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Sidekiq", type: :request do
+  describe "GET /sidekiq" do
+    context "as an authenticated admin" do
+      let(:authenticated_admin) { create(:user, :admin) }
+
+      before do
+        sign_in(authenticated_admin)
+      end
+
+      it "renders the sidekiq interface" do
+        get "/sidekiq"
+        expect(response).to have_http_status(:success)
+      end
+    end
+
+    context "as an authenticated user" do
+      let(:authenticated_user) { create(:user) }
+
+      before do
+        sign_in(authenticated_user)
+      end
+
+      it "responds with not found" do
+        expect { get "/sidekiq" }.to raise_error(ActionController::RoutingError)
+      end
+    end
+  end
+end

data/lib/generators/rockstart/quality/quality_generator.rb

@@ -1,28 +1,17 @@
 # frozen_string_literal: true
 
-class Rockstart::QualityGenerator < Rails::Generators::Base
+require "rockstart/base_generator"
+
+class Rockstart::QualityGenerator < Rockstart::BaseGenerator
   source_root File.expand_path("templates", __dir__)
 
   desc "This generator configures code quality rules"
 
-  class_option :rebuild_todo, type: :boolean,
-                              desc: "Bundle installs rubocop and regenerates .rubocop_todo.yml",
-                              default: true
-
   def add_quality_rake_task
     copy_file "quality.rake", "lib/tasks/quality.rake"
   end
 
-  def install_rubocop
-    copy_file "rubocop.yml", ".rubocop.yml"
-
-    gem "rubocop-rails", require: false
-
-    copy_file "rubocop.rake", "lib/tasks/rubocop.rake"
-
-    return unless options[:rebuild_todo]
-
-    # Rebuild .rubocop_todo.yml, ensuring only existing code is excluded
-    run "bundle install --quiet && bundle exec rubocop --auto-gen-config --exclude-limit 100"
+  def generate_rubocop
+    generate "rockstart:quality:rubocop"
   end
 end