rails-hush 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6867245caf963cbc37708518d67b491ba280abe0e8bfa4499a9f1b814ee2bd03
+  data.tar.gz: 728cefe68ef32e5ad5554fb1b3b027219ead3102d7fca17a04c96969b01cc03b
+SHA512:
+  metadata.gz: 13f9d62b027e8df242a42ef15f5f5c5e235496749f2132202785acd9a7d43069f410ad9f808b3b091d71ddd1b4180eb97ee7d93e3e8be0ca7c190b4f4dc47355
+  data.tar.gz: 8804b6f1eeba38238fc022732aa63b5bafb67b109f88598f21c96079bb67217750e39a266d9a756db71d8dcb8cc7fbcee6582b0e8511823ac235f3b7711701ae

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 thomas morgan
+
+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,85 @@
+# RailsHush
+
+RailsHush hushes worthless Rails exceptions & logs, such as those caused by bots and crawlers.
+
+Rails generates a number of exceptions that, while useful in development, are quite noisy in production. This is expecially true because of the volume of bots deliberately sending malformed traffic to your Rails app. Unfortunately, by default Rails dutifully logs exceptions and backtraces for all of this, and depending on your exception notification system of choice, may trigger unnecessary notifications.
+
+In addition to bots, if your app has an API and is used by third-parties, they may generate a variety of errors while integrating with your app. These too don't need to be logged, but it is useful if the error messages are more helpful than simply "bad request". RailsHush takes care of this for you.
+
+RailsHush will...
+
+* Silence backtrace logging for a wide array of errors that aren't related to your actual app code
+* Return various 4xx HTTP status codes, instead of 500
+* Provide basic, helpful error messages to 3rd-parties integrating with your app
+* Properly trigger "Completed..." log entries at the end of invalid requests
+  * Using standard active_support notifications, for compatibility with non-default logging solutions
+
+RailsHush honors Rails settings for `show_exceptions` and `consider_all_requests_local`. With Rails' defaults, it will only activate in production and will not interfere with debugging while in development or test. The exceptions that are hushed are very selective; actual app errors should continue to raise exceptions as normal, even in production.
+
+
+## Installation
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'rails-hush'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Usage
+
+By default, works automatically upon installation. Most of the time, configuration is not necessary.
+
+
+#### Configuration
+
+RailsHush does support a couple of configuration options:
+
+To disable automatic loading of middleware:
+
+    # Phase one (early) middleware
+    config.rails_hush.use_one  = true
+    # Phase two (late) middleware
+    config.rails_hush.use_two  = true
+
+Then add the middleware on your own:
+
+    # Phase one
+    app.middleware.insert 0, RailsHush::HushOne
+    # Phase two
+    app.middleware.insert_after ActionDispatch::DebugExceptions, RailsHush::HushTwo
+
+RailsHush also has a replaceable renderer, in case you don't like the default json/xml output:
+
+    config.rails_hush.renderer = lambda do |status, content_type, error|
+      # status       - integer, eg: 400
+      # content_type - a Mime::Type instance, eg: Mime[:json]
+      # error        = RailsHush's default text error message, eg: "some error"
+      #                You may replace it with your own based on status or anything else.
+      ...
+      # the block must return a Rack-compatible response:
+      headers = {}
+      body = {my: 'payload'}.to_json
+      [status, headers, [body]]
+    end
+
+
+#### Testing
+
+Rails' default "test" environment settings are quite different than "production". While the default settings are quite appropriate, with them it is near impossible to test the actual behavior of RailsHush, because it will effectively be disabled in "test". On the whole, it's recommended to just rely on RailsHush's own test suite. However, if you really want to test its behavior inside your app, change the following in `environments/test.rb`:
+
+    config.consider_all_requests_local     = false
+    config.action_dispatch.show_exceptions = true
+
+
+## Contributing
+
+Contributions welcome. Please use standard Github Pull Requests.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'RailsHush'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rails-hush.rb

@@ -0,0 +1 @@
+require 'rails_hush'

data/lib/rails_hush.rb

@@ -0,0 +1,4 @@
+%w(simple_renderer hush_one hush_two).each do |f|
+  require "rails_hush/middleware/#{f}"
+end
+require 'rails_hush/railtie'

data/lib/rails_hush/middleware/hush_one.rb

@@ -0,0 +1,24 @@
+module RailsHush
+  class HushOne
+    include SimpleRenderer
+
+    def initialize(app, renderer=nil)
+      @app = app
+      @renderer ||= Rails.application.config.rails_hush.renderer || method(:default_renderer)
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new env
+      if request.show_exceptions? && !request.get_header("action_dispatch.show_detailed_exceptions")
+        begin
+          @app.call(env)
+        rescue ActionController::UnknownHttpMethod
+          render 405, request, 'Unrecognized HTTP method'
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/rails_hush/middleware/hush_two.rb

@@ -0,0 +1,51 @@
+module RailsHush
+  class HushTwo
+    include SimpleRenderer
+
+    def initialize(app, renderer=nil)
+      @app = app
+      @renderer ||= Rails.application.config.rails_hush.renderer || method(:default_renderer)
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new env
+      if request.show_exceptions? && !request.get_header("action_dispatch.show_detailed_exceptions")
+        begin
+          _, headers, body = response = @app.call(env)
+          if headers['X-Cascade'] == 'pass'
+            body.close if body.respond_to?(:close)
+            raise ActionController::RoutingError, "No route matches [#{env['REQUEST_METHOD']}] #{env['PATH_INFO'].inspect}"
+          end
+          response
+
+        rescue ActionController::BadRequest => x
+          if x.message =~ /(Invalid encoding for parameter|invalid %-encoding)/
+            log_request 400, request
+            render 400, request, 'Invalid string or encoding'
+          else
+            raise x
+          end
+        rescue ActionDispatch::Http::Parameters::ParseError
+          log_request 400, request
+          render 400, request, 'Unable to parse request body'
+        rescue ActionController::RoutingError => x
+          log_request 404, request
+          render 404, request
+        rescue ActionController::UnknownHttpMethod
+          log_request 405, request
+          render 405, request, 'Unrecognized HTTP method'
+        rescue ActionController::UnknownFormat
+          render 406, request, 'Invalid format'
+        rescue Mime::Type::InvalidMimeType
+          log_request 406, request
+          render 406, request, 'Invalid media type'
+        rescue ActionController::ParameterMissing => x
+          render 422, request, "Required parameter missing or empty: #{x.param}"
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/rails_hush/middleware/simple_renderer.rb

@@ -0,0 +1,38 @@
+module SimpleRenderer
+
+  def log_request(status, request)
+    payload = {
+      params: (request.filtered_parameters rescue {}),
+      headers: request.headers,
+      format: (request.format.ref rescue :text),
+      method: (request.request_method rescue 'INVALID'),
+      path: request.fullpath,
+      status: status
+    }
+    ActiveSupport::Notifications.instrument "process_action.action_controller", payload
+  end
+
+  def render(status, request, error=nil)
+    begin
+      content_type = request.formats.first
+    rescue Mime::Type::InvalidMimeType
+      content_type = Mime[:text]
+    end
+    error ||= Rack::Utils::HTTP_STATUS_CODES.fetch(status, Rack::Utils::HTTP_STATUS_CODES[500])
+    @renderer.call(status, content_type, error)
+  end
+
+  def default_renderer(status, content_type, error)
+    body = { status: status, error: error }
+    format = "to_#{content_type.to_sym}" if content_type
+    if format && body.respond_to?(format)
+      body = body.public_send(format)
+    else
+      content_type = 'application/json'
+      body = body.to_json
+    end
+    [status, { "Content-Type" => "#{content_type}; charset=#{ActionDispatch::Response.default_charset}",
+              "Content-Length" => body.bytesize.to_s }, [body]]
+  end
+
+end

data/lib/rails_hush/railtie.rb

@@ -0,0 +1,18 @@
+module RailsHush
+  class Railtie < Rails::Railtie
+    config.rails_hush          = ActiveSupport::OrderedOptions.new
+    config.rails_hush.use_one  = true
+    config.rails_hush.use_two  = true
+    config.rails_hush.renderer = nil
+
+    initializer 'railshush.init' do |app|
+      if config.rails_hush.use_one
+        app.middleware.insert 0, RailsHush::HushOne
+      end
+      if config.rails_hush.use_two
+        app.middleware.insert_after ActionDispatch::DebugExceptions, RailsHush::HushTwo
+      end
+    end
+
+  end
+end

data/lib/rails_hush/version.rb

@@ -0,0 +1,3 @@
+module RailsHush
+  VERSION = '1.0.0'
+end

data/lib/tasks/rails_hush_tasks.rake

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rails-hush
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- thomas morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !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: minitest-reporters
+  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'
+description: Hushes worthless Rails exceptions & logs, such as those caused by bots
+  and crawlers.
+email:
+- tm@iprog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails-hush.rb
+- lib/rails_hush.rb
+- lib/rails_hush/middleware/hush_one.rb
+- lib/rails_hush/middleware/hush_two.rb
+- lib/rails_hush/middleware/simple_renderer.rb
+- lib/rails_hush/railtie.rb
+- lib/rails_hush/version.rb
+- lib/tasks/rails_hush_tasks.rake
+homepage: https://github.com/zarqman/rails-hush
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Hushes worthless Rails exceptions & logs
+test_files: []