rack-filter-param 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bc10c6c7321ddd7522aba2a97ea89fbdef76418
-  data.tar.gz: bd8da917b51e818687433dac3e52f628806fd4cd
+  metadata.gz: 1dff13e084ee634e79836638befe1cb562254b75
+  data.tar.gz: cd5962bb0fb1adb14a47c5810cf3a69ab8e82309
 SHA512:
-  metadata.gz: da3de8e23c850ab80e1287017823e48e1f4897a0a7da475f9ccd84019bb282f1f5054d40dd04ce5a0ad3edac5d55d64457ae7ba8f4d13f904b36e282db6cf988
-  data.tar.gz: 5d65041d63fdb6e62aedc9429e10f9a9c98a23832ef07d584851e05f62fc8f16011dba3bb014bef657f7d330ecf0fff5df332db80e75edc76689961e557623a4
+  metadata.gz: c78c5b5c06bab366d0664a87515448b532e42ead19bdb8352cd7d45451136751613ef29e57e7e510fb173821a4e581412266b6ef0191055b44e11322f410a299
+  data.tar.gz: a3b9a06802b3f7de047f9cabe01801f939fa94adb339132ea9b72c1818f7b4c6ead9e68148dd40c59d99adb54de6264d7c6b24f46fa7cd140bb49c9030a9c536

data/README.md

@@ -2,6 +2,8 @@
 
 Refactoring something behind an API? Plagued by extraneous HTTP params? `rack-filter-param` might be for you.
 
+[![Build Status](https://travis-ci.org/rfwatson/rack-filter-param.svg?branch=master)](https://travis-ci.org/rfwatson/rack-filter-param)
+
 ## What is it?
 
 [Rack](https://github.com/rack/rack) middleware to remove specific params from HTTP requests.

data/lib/rack/filter_param.rb

@@ -1,86 +1,14 @@
-require "rack/filter_param/version"
+require 'rack/filter_param/version'
+require 'rack/filter_param/middleware'
+require 'rack/filter_param/filter'
+require 'rack/filter_param/apply_filter'
 
 module Rack
-  class FilterParam
+  module 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)
-      return unless param_exists?(param)
-      return unless affirmative_conditional?(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 param_exists?(param)
-      param = param.is_a?(Hash) ? param[:param] : param
-      params.has_key?(param.to_s)
-    end
-
-    def params
-      action_dispatch_parsed? ? action_dispatch_params : request.params
-    end
-
-    def affirmative_conditional?(param)
-      return true unless param.is_a?(Hash)
-
-      callable, param = param[:if], param[:param]
-      return true if callable.nil?
-
-      callable.call(params[param.to_s])
-    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
+    extend SingleForwardable
+    def_delegators :'Rack::FilterParam::Middleware', :new
   end
 end

data/lib/rack/filter_param/apply_filter.rb

@@ -0,0 +1,73 @@
+module Rack
+  class ApplyFilter
+    extend Forwardable
+
+    def initialize(filter, request)
+      @filter  = filter
+      @request = request
+    end
+
+    def call
+      return unless param_exists?
+      return unless path_matches?
+      return unless if_proc_affirmative?
+
+      if delete_from_action_dispatch || delete_from_request
+        filtered_params << [ param, nil ]
+      end
+    end
+
+    private
+    attr_reader :filter, :request
+
+    def_delegators :@filter, :param, :path, :if_proc
+    def_delegators :@request, :env
+
+    def params
+      action_dispatch_parsed? ? action_dispatch_params : request.params
+    end
+
+    def param_exists?
+      params.has_key?(param)
+    end
+
+    def param_value
+      params[param]
+    end
+
+    def action_dispatch_params
+      env[FilterParam::ACTION_DISPATCH_KEY]
+    end
+
+    def action_dispatch_parsed?
+      !action_dispatch_params.nil?
+    end
+
+    def path_matches?
+      return true if path.nil?
+
+      return env['PATH_INFO'] == path if path.is_a?(String)
+      return env['PATH_INFO'] =~ path if path.is_a?(Regexp)
+
+      false
+    end
+
+    def if_proc_affirmative?
+      return true if if_proc.nil?
+
+      if_proc.call(param_value)
+    end
+
+    def delete_from_action_dispatch
+      action_dispatch_parsed? && !!action_dispatch_params.delete(param)
+    end
+
+    def delete_from_request
+      !!request.delete_param(param)
+    end
+
+    def filtered_params
+      env[FilterParam::FILTERED_PARAMS_KEY] ||= []
+    end
+  end
+end

data/lib/rack/filter_param/filter.rb

@@ -0,0 +1,21 @@
+module Rack
+  class Filter
+    attr_reader :param, :path, :if_proc
+
+    def initialize(options)
+      if options.is_a?(Hash)
+        @param   = parse_param(options[:param])
+        @path    = options[:path]
+        @if_proc = options[:if]
+      else
+        @param   = parse_param(options)
+      end
+    end
+
+    private
+
+    def parse_param(param)
+      param.is_a?(Symbol) ? param.to_s : param
+    end
+  end
+end

data/lib/rack/filter_param/middleware.rb

@@ -0,0 +1,17 @@
+module Rack
+  module FilterParam
+    class Middleware
+      def initialize(app, *filters)
+        @app = app
+        @filters = filters.flatten.map(&Filter.public_method(:new))
+      end
+
+      def call(env)
+        request = Request.new(env)
+
+        @filters.each { |filter| ApplyFilter.new(filter, request).call }
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/filter_param/version.rb

@@ -1,5 +1,5 @@
 module Rack
-  class FilterParam
-    VERSION = "0.2.1"
+  module FilterParam
+    VERSION = '0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-filter-param
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Rob Watson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,6 +111,9 @@ files:
 - bin/console
 - bin/setup
 - lib/rack/filter_param.rb
+- lib/rack/filter_param/apply_filter.rb
+- lib/rack/filter_param/filter.rb
+- lib/rack/filter_param/middleware.rb
 - lib/rack/filter_param/version.rb
 - rack-filter-param.gemspec
 homepage: https://github.com/rfwatson