rack-filter-param 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e90f42cf5877e784de5126dc00f1ee59f6d78ab4
+  data.tar.gz: 50293c18b6b72b49329208bfbbe8e28d8e83855e
+SHA512:
+  metadata.gz: 15b44d865dd742febb1b203ad9a453effc39cd4c51b75afb1ad60cadbadf6b7fb57c09ed12afa8375fd7e4a41d956f78700b28c4544639aab170c7f47ab2ac24
+  data.tar.gz: 44674e64b057061e6b82622d69a453da0bd46cfb2a49ccf82f9b6a86dccc64f6baa88cff82e6a23bdaa08af2ebafe436de0dd24135f158a9d92e87801dd17906

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rob Watson
+
+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,58 @@
+# rack-filter-param
+
+Refactoring something behind an API? Plagued by extraneous HTTP params? `rack-filter-param` might be for you.
+
+## What is it?
+
+[Rack](https://github.com/rack/rack) middleware to remove specific params from HTTP requests.
+
+## What does it do?
+
+Given a set of params and optional constraints, `rack-filter-param` will remove those params, then pass the request downstream.
+
+Removes params from:
+
+* GET querystring
+* POST params (x-www-form-urlencoded)
+* JSON or other params hitherto processed by [`ActionDispatch::ParamsParser`](http://api.rubyonrails.org/classes/ActionDispatch/ParamsParser.html)
+
+## Installation
+
+```ruby
+
+gem 'rack-filter-param', require: 'rack/filter_param'
+```
+
+## Usage
+
+In rackup file or `application.rb`, initialize `rack-filter-param` with a list of HTTP params you want filtered from requests.
+
+Strip a parameter named `client_id`:
+
+```ruby
+use Rack::FilterParam, :client_id
+```
+
+Strip a parameter named `client_id` from a specific path only:
+
+```ruby
+use Rack::FilterParam, { param: :client_id, path: '/oauth/tokens' }
+```
+
+Strip a parameter named `client_id` from a fuzzy path:
+
+```ruby
+use Rack::FilterParam, { param: :client_id, path: /\A\/oauth/ }
+```
+
+To filter multiple parameters, an array of parameters or options hashes can also be passed.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rfwatson/rack-filter-param
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/filter_param"
+
+# 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/rack/filter_param.rb

@@ -0,0 +1,66 @@
+require "rack/filter_param/version"
+
+module Rack
+  class FilterParam
+    ACTION_DISPATCH_KEY = 'action_dispatch.request.request_parameters'.freeze
+    FILTERED_PARAMS_KEY = 'rack.filtered_params'.freeze
+
+    def initialize(app, *params)
+      @app = app
+      @params = params.flatten
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+      @params.each { |param| process_param(param) }
+
+      @app.call(env)
+    end
+
+    private
+
+    attr_reader :request
+
+    def process_param(param)
+      return unless path_matches?(param)
+
+      param = param[:param] if param.is_a?(Hash)
+
+      if delete_from_action_dispatch(param) || delete_from_request(param)
+        filtered_params << [ param.to_s, nil ]
+      end
+    end
+
+    def path_matches?(param)
+      return true unless param.is_a?(Hash)
+
+      path = param[:path]
+      return true unless path = param[:path]
+
+      return request.env['PATH_INFO'] == path if path.is_a?(String)
+      return request.env['PATH_INFO'] =~ path if path.is_a?(Regexp)
+
+      false
+    end
+
+    def delete_from_action_dispatch(param)
+      action_dispatch_parsed? && !!action_dispatch_params.delete(param.to_s)
+    end
+
+    def delete_from_request(param)
+      !!request.delete_param(param.to_s)
+    end
+
+    def action_dispatch_params
+      request.env[ACTION_DISPATCH_KEY]
+    end
+
+    def action_dispatch_parsed?
+      !action_dispatch_params.nil?
+    end
+
+    def filtered_params
+      request.env[FILTERED_PARAMS_KEY] ||= []
+    end
+  end
+end

data/lib/rack/filter_param/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class FilterParam
+    VERSION = "0.1.0"
+  end
+end

data/rack-filter-param.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/filter_param/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-filter-param"
+  spec.version       = Rack::FilterParam::VERSION
+  spec.authors       = ["Rob Watson"]
+  spec.email         = ["rob@mixlr.com"]
+
+  spec.summary       = "Rack middleware to filter params from HTTP requests"
+  spec.homepage      = "https://github.com/rfwatson"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'json', '~> 2'
+  spec.add_development_dependency 'byebug', '~> 9'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rack-filter-param
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Watson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: 
+email:
+- rob@mixlr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/filter_param.rb
+- lib/rack/filter_param/version.rb
+- rack-filter-param.gemspec
+homepage: https://github.com/rfwatson
+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.12
+signing_key: 
+specification_version: 4
+summary: Rack middleware to filter params from HTTP requests
+test_files: []