verboten_keys 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25f79502f4a51d148ef9fc89c1c6883fd754868bbc27f8c53db220e4a4ad227b
+  data.tar.gz: c688bf6e1dc5ebb4e75dd670cb9b81950ae161f454e7258356ce46c454d3b73d
+SHA512:
+  metadata.gz: 06c3248d1379afb108ee4f98f3805a44162fb986f3b58a483079c1afd205dae9c128a679e4f3aff0aed0220bea6c3cc83988050cdd10be0da3816b3d80f41a45
+  data.tar.gz: 6ced8772a5aa49723113b76f109be121332a06ed6401adc7ed2b7063afc5e768b25e91e2573fe183b6f9f764e40f61c226e2ce357502597d877eb07ef0ece01c

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    name: 'Test Suite'
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+  lint:
+    name: 'Rubocop'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Lint/DuplicateMethods:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+  - 'lib/verboten_keys/errors.rb'
+  - '**/*.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+  - 'Rakefile'
+  - '**/*.rake'
+  - 'spec/**/*.rb'
+  - '**/*.gemspec'
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 - May 11, 2021
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hi@tpritc.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    verboten_keys (1.0.0)
+      rack (>= 1.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    nokogiri (1.11.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.3-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 6.1)
+  railties (>= 4.2)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.5)
+  rubocop-rspec (~> 2.3)
+  verboten_keys!
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tom Pritchard
+
+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,90 @@
+# Verboten Keys
+
+Verboten Keys is a last line of defense to help prevent you and your team from accidentally leaking private information via your APIs. It's Rack middleware that seamlessly integrates into any Rails or Sinatra project (or really anything that's based on Rack) and strips out any data that matches your list of forbidden keys.
+
+It's a quick, easy, set-it-and-forget-it way to have peace of mind that nothing's getting out of your API that should be.
+
+## What it does
+
+Imagine you've got an API endpoint that returns a user's profile, and you've accidentally serialized the user incorrectly, and now it's returning your entire user object serialized as JSON:
+
+```
+GET /api/v1/users/123
+{
+  'id': 123,
+  'name': 'Jane Doe',
+  'email': 'jane.doe@example.com',
+  'password_digest': '$FEUNCqbSZIOu7e1QblI...'
+}
+```
+
+Oh no, this is a disaster!
+
+If only there was a way to automatically filter out accidents like this! This is where Verboten Keys helps out. If you had Verboten Keys in your application, and had `password_digest` set as a forbidden key, the exact same response would look like this:
+
+```
+GET /api/v1/users/123
+{
+  'id': 123,
+  'name': 'Jane Doe',
+  'email': 'jane.doe@example.com'
+}
+```
+
+Verboten Keys is your last line of defense. When all else fails, we prevent you accidentally leaking private data.
+
+## Installation
+
+To install Verboten Keys in your app, simply add this line to your application's `Gemfile` and run `bundle install`:
+
+```ruby
+gem 'verboten-keys'
+```
+
+### Rails
+
+If you're using Rails, you don't need to do anything else to install Verboten Keys. The gem will automatically plug itself into Rails when your application boots.
+
+### Sinatra
+
+If your application is using Sinatra, simply add the Verboten Keys middleware into your app the same way you would any other piece of middleware:
+
+```ruby
+require 'sinatra'
+require 'verboten-keys'
+
+use Rack::Lint
+use VerbotenKeys::Middleware
+
+get '/hello' do
+  'Hello World'
+end
+```
+
+You should include it last, so nothing gets missed when the middleware parses and evaluates your application's response.
+
+## Configuration
+
+Every application has its own security needs, and Verboten Keys is designed to be configurable, so you can get it just so. To configure Verboten Keys, simply call its `configure` method, which takes a block and yields the current configuration:
+
+```ruby
+VerbotenKeys.configure do |config|
+  config.forbidden_keys = [:password, :password_digest, :secret_token]
+  config.strategy = :remove
+end
+```
+
+The `forbidden_keys` option lets you set the keys that will be filtered out of the response. It takes an array of symbols, and will raise an error if it's not in the right format. You should include all of the columns and attributes you absolutely _do not_ want to ever leak from your API. The default value is `[]`.
+
+The `strategy` option lets you pick how Verboten Keys should handle a forbidden key it finds. The default value is `:remove`. Acceptable options are `:remove` and `:nullify`:
+
+* `:remove` removes the key-value pair from the JSON response body, so it looks like the JSON object never had the key-value pair in the first place.
+* `:nullify` leaves the key in the JSON response, but it will nullify the value, so any forbidden values will always appear to be `nil`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/tpritc/verboten-keys). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tpritc/verboten-keys/blob/main/CODE_OF_CONDUCT.md) while interacting in the project's codebases, issue trackers, chat rooms, and mailing lists.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). If you or your organization need a custom, commercial license for any reason, [send me an email](mailto:hi@tpritc.com) and I'll be happy to set something up for you.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'verboten_keys'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/verboten_keys.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+require_relative 'verboten_keys/version'
+require_relative 'verboten_keys/errors'
+require_relative 'verboten_keys/configuration'
+require_relative 'verboten_keys/filterer'
+require_relative 'verboten_keys/middleware'
+require_relative 'verboten_keys/railtie' if defined?(::Rails)
+
+module VerbotenKeys
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/verboten_keys/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module VerbotenKeys
+  class Configuration
+    STRATEGIES = %i[remove nullify].freeze
+
+    attr_accessor :forbidden_keys, :strategy
+
+    def initialize
+      @forbidden_keys = []
+      @strategy = :remove
+    end
+
+    def forbidden_keys=(new_forbidden_keys)
+      unless new_forbidden_keys.is_a? Array
+        raise VerbotenKeys::Errors::ForbiddenKeysMustBeAnArrayError, new_forbidden_keys
+      end
+
+      new_forbidden_keys.each do |new_forbidden_key|
+        next if new_forbidden_key.is_a? Symbol
+
+        raise VerbotenKeys::Errors::ForbiddenKeysMustOnlyContainSymbolsError.new(new_forbidden_keys, new_forbidden_key)
+      end
+
+      @forbidden_keys = new_forbidden_keys
+    end
+
+    def strategy=(new_strategy)
+      raise VerbotenKeys::Errors::StrategyMustBeASymbolError, new_strategy unless new_strategy.is_a? Symbol
+
+      raise VerbotenKeys::Errors::StrategyNotFoundError, new_strategy unless STRATEGIES.include? new_strategy
+
+      @strategy = new_strategy
+    end
+  end
+end

data/lib/verboten_keys/errors.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VerbotenKeys
+  module Errors
+    class ForbiddenKeysMustBeAnArrayError < StandardError
+      def initialize(invalid_forbidden_keys)
+        invalid_forbidden_keys_string = invalid_forbidden_keys&.to_s || 'nil'
+        invalid_forbidden_keys_class = invalid_forbidden_keys.class.to_s
+        super("VerbotenKeys' forbidden_keys must be an array of symbols. You passed in #{invalid_forbidden_keys_string}, which was a #{invalid_forbidden_keys_class}.")
+      end
+    end
+
+    class ForbiddenKeysMustOnlyContainSymbolsError < StandardError
+      def initialize(invalid_forbidden_keys, invalid_forbidden_key)
+        invalid_forbidden_key_string = invalid_forbidden_key&.to_s || 'nil'
+        invalid_forbidden_key_class = invalid_forbidden_key.class.to_s
+        super("VerbotenKeys' forbidden_keys must be an array of symbols. You passed in #{invalid_forbidden_keys}, which included #{invalid_forbidden_key_string}, which was a #{invalid_forbidden_key_class}")
+      end
+    end
+
+    class StrategyMustBeASymbolError < StandardError
+      def initialize(invalid_strategy)
+        invalid_strategy_string = invalid_strategy&.to_s || 'nil'
+        invalid_strategy_class = invalid_strategy.class.to_s
+        super("VerbotenKeys' strategy must be a symbol. You passed in #{invalid_strategy_string}, which was a #{invalid_strategy_class}.")
+      end
+    end
+
+    class StrategyNotFoundError < StandardError
+      def initialize(invalid_strategy)
+        super("VerbotenKeys' strategy must be a valid option. You passed in :#{invalid_strategy}, but the only valid options are: #{VerbotenKeys::Configuration::STRATEGIES}.")
+      end
+    end
+  end
+end

data/lib/verboten_keys/filterer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module VerbotenKeys
+  class Filterer
+    def self.filter_forbidden_keys(hash)
+      hash
+        .map { |k, v| evaluate_key_value_pair(k, v) }
+        .to_h
+        .delete_if { |k, _v| k.nil? }
+    end
+
+    def self.evaluate_key_value_pair(key, value)
+      key = key.to_sym
+
+      if VerbotenKeys.configuration.forbidden_keys.include?(key)
+        case VerbotenKeys.configuration.strategy
+        when :remove
+          return [nil, nil]
+        when :nullify
+          return [key, nil]
+        else
+          raise VerbotenKeys::Errors::StrategyNotFoundError(VerbotenKeys.configuration.strategy)
+        end
+      end
+
+      case value
+      when Hash
+        return [key, VerbotenKeys::Filterer.filter_forbidden_keys(value)]
+      when Array
+        return [key, value.map { |item| item.is_a?(Hash) ? VerbotenKeys::Filterer.filter_forbidden_keys(item) : item }]
+      end
+
+      [key, value]
+    end
+  end
+end

data/lib/verboten_keys/middleware.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module VerbotenKeys
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      # Get the result of the request from the app.
+      @status, @headers, @response = @app.call(env)
+
+      # Perform all of our work here...
+      remove_forbidden_keys
+
+      # Let the app continue as-is.
+      [@status, @headers, @response]
+    end
+
+    private
+
+    def remove_forbidden_keys
+      return unless content_type_is_json?
+
+      new_response = VerbotenKeys::Filterer.filter_forbidden_keys(response_body_as_a_hash).to_json
+
+      @headers['Content-Length'] = new_response.bytesize.to_s
+      @response = [new_response]
+    end
+
+    # Check's the response's headers to see if the response's content-type is a
+    # JSON object.
+    #
+    # @return [Boolean] True if the content type of the response if JSON, and
+    #   false if it is not.
+    def content_type_is_json?
+      return false if @headers['Content-Type'].nil?
+
+      @headers['Content-Type'].split(';').first == 'application/json'
+    end
+
+    def response_body_as_a_hash
+      if @response.is_a? Array
+        JSON.parse(@response.first || '{}')
+      else
+        JSON.parse(@response.body || '{}')
+      end
+    end
+  end
+end

data/lib/verboten_keys/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VerbotenKeys
+  class Railtie < ::Rails::Railtie
+    initializer 'verboten_keys.middleware' do |app|
+      app.middleware.use VerbotenKeys::Middleware
+    end
+  end
+end

data/lib/verboten_keys/version.rb

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

data/verboten_keys.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/verboten_keys/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'verboten_keys'
+  spec.version       = VerbotenKeys::VERSION
+  spec.authors       = ['Tom Pritchard']
+  spec.email         = ['hi@tpritc.com']
+
+  spec.summary       = 'Verboten Keys is a last line of defense to help prevent you and your team from accidentally leaking private information via your APIs.'
+  spec.homepage      = 'https://github.com/tpritc/verboten_keys'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['source_code_uri'] = 'https://github.com/tpritc/verboten_keys'
+  spec.metadata['changelog_uri'] = 'https://github.com/tpritc/verboten_keys/blob/main/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack', '>= 1.0', '< 3'
+  spec.add_development_dependency 'activesupport', '~> 6.1'
+  spec.add_development_dependency 'railties', '>= 4.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.3'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: verboten_keys
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom Pritchard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description:
+email:
+- hi@tpritc.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/verboten_keys.rb
+- lib/verboten_keys/configuration.rb
+- lib/verboten_keys/errors.rb
+- lib/verboten_keys/filterer.rb
+- lib/verboten_keys/middleware.rb
+- lib/verboten_keys/railtie.rb
+- lib/verboten_keys/version.rb
+- verboten_keys.gemspec
+homepage: https://github.com/tpritc/verboten_keys
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tpritc/verboten_keys
+  changelog_uri: https://github.com/tpritc/verboten_keys/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Verboten Keys is a last line of defense to help prevent you and your team
+  from accidentally leaking private information via your APIs.
+test_files: []