restfulness 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c7504fc661a80914cd4f3e3ad81918799de7b0b
-  data.tar.gz: a6b3d22e6fc9c30ba6010043550d37e3c651be0a
+  metadata.gz: fec45922d74ec00c62042cfa323627cb5e23d925
+  data.tar.gz: 87679a0dd96e313a113f24e85e35c4130285cb01
 SHA512:
-  metadata.gz: d21da3dc7f1db2dd8b1259c36e710aa31698f31f5b39b37af0ecca2abc433fa15833941359efabcd9d74681b0570e63a1f4c651d0fb309b1b62c2fc656eb031f
-  data.tar.gz: e7fe0be99de3fcf1947e5fc75bfe2fce76bbd629e9b5cdf3b0370db2ae9e6a1f08a4353130392c3aa83770f37f0c00c0d67e67c4c024046eac142b6897b0ab68
+  metadata.gz: a818c4417a58a9a84fe108b5a0c0a57e02f6342ccd47810e571e6d2f6d49ec0c736a111a1ac9b82ec1a67eeecc644908af1fbb869cf0f67f4a31335112e44fb6
+  data.tar.gz: 568d63dc34ffa86bd6e8f59c5d278ac54426ad7b95648c79252fd1475c93c80cd17611245f8d2e7d926dda22bdc5fc9bad929249cc4cef5aa2e62a9842a35057

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 .bundle
+.idea
 .config
 .yardoc
 Gemfile.lock

data/.travis.yml

@@ -3,4 +3,4 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
+  - rbx

data/README.md

@@ -144,6 +144,8 @@ bundle exec rackup
 
 For a very simple example project, checkout the `/example` directory in the source code.
 
+If you're using Restulfness in a Rails project, you'll want to checkout the Reloading section below.
+
 
 ### Routes
 
@@ -290,11 +292,27 @@ request.body               # "{'key':'value'}" - string payload
 request.params             # {'key' => 'value'} - usually a JSON deserialized object
 ```
 
+### Logging
+
+By default, Restfulness uses `ActiveSupport::Logger.new(STDOUT)` as its logger.
+
+To change the logger:
+
+```ruby
+Restfulness.logger = Rack::NullLogger.new(My::Api)
+```
+
+By default, any parameter with key prefix `password` will be sanitized in the log. To change the sensitive parameters:
+
+```ruby
+Restfulness.sensitive_params = [:password, :secretkey]
+```
+
 ## Error Handling
 
 If you want your application to return anything other than a 200 (or 202) status, you have a couple of options that allow you to send codes back to the client.
 
-The easiest method is probably just to update the `response` code. Take the following example where we set a 403 response and the model's errors object in the payload:
+One of the easiest approaches is to update the `response` code. Take the following example where we set a 403 response and the model's errors object in the payload:
 
 ```ruby
 class ProjectResource < Restfulness::Resource
@@ -315,7 +333,7 @@ The favourite method in Restfulness however is to use the `HTTPException` class
 class ProjectResource < Restfulness::Resource
   def patch
     unless project.update_attributes(request.params)
-      forbidden!(project.errors)
+      forbidden! project.errors
     end
     project
   end
@@ -352,7 +370,7 @@ end
 
 ```
 
-This can be a really nice way to mold your errors into a standard format. All HTTP exceptions generated inside resources will pass through `error!`, even those that a triggered by a callback. It gives a great way to provide your own more complete result, or even just resort to a simple string.
+This can be a really nice way to mold your errors into a standard format. All HTTP exceptions generated inside resources will pass through `error!`, even those that a triggered by a callback. It gives a great way to provide your own JSON error payload, or even just resort to a simple string.
 
 The currently built in error methods are:
 
@@ -367,7 +385,7 @@ The currently built in error methods are:
  * `gone!`
  * `unprocessable_entity!`
 
-If you'd like to see me more, please send us a pull request! Failing that, you can create your own by writing something along the lines of:
+If you'd like to see me more, please send us a pull request. Failing that, you can create your own by writing something along the lines of:
 
 ```ruby
 def im_a_teapot!(payload = "")
@@ -375,38 +393,147 @@ def im_a_teapot!(payload = "")
 end
 ```
 
+## Reloading
 
-## Caveats and TODOs
+We're all used to the way Rails projects magically reload files so you don't have to restart the server after each change. Depending on the way you use Restfulness in your project, this can be supported.
 
-Restfulness is still very much a work in progress. Here is a list of things that we'd like to improve or fix:
+### The Rails Way
 
- * Support for more serializers and content types, not just JSON.
- * Support path methods for automatic URL generation.
- * Support redirect exceptions.
- * Reloading is a PITA (see note below).
- * Needs more functional testing.
- * Support for before and after filters in resources, although I'm slightly aprehensive about this.
+Using Restfulness in Rails is the easiest way to take advantage support reloading.
 
-## Reloading
+The recomended approach is to create two directories in your Rails projects `/app` path:
 
-Reloading is complicated. Unfortunately we're all used to the way Rails projects magically reload changed files so you don't have to restart the server after each change.
+ * `/app/apis` can be used for defining your API route files, and
+ * `/app/resources` for defining a tree of resource definition files.
 
-If you're using Restfulness as a standalone project, we recommend using a rack extension like [Shotgun](https://github.com/rtomayko/shotgun).
+Add the two paths to your rails autoloading configuration in `/config/application.rb`, there will already be a sample in your config provided by Rails:
+
+```ruby
+# Custom directories with classes and modules you want to be autoloadable.
+config.autoload_paths += %W( #{config.root}/app/resources #{config.root}/app/apis )
+```
 
-If you're adding Restfulness to a Rails project, you can take advantage of the `ActionDispatch::Reloader` rack middleware. Simply include it in the application definition:
+Your Resource and API files will now be autoloadable from your Rails project. The next step is to update our Rails router to be able to find our API. Modify the `/config/routes.rb` file so that it looks something like the following:
 
 ```ruby
-class MyAPI < Restfulness::Application
+YourRailsApp::Application.routes.draw do
+
+  # Autoreload the API in development
   if Rails.env.development?
-    middlewares << ActionDispatch::Reloader
+    mount Api.new => '/api'
   end
-  routes do
-    # etc. etc.
+
+  #.... rest of routes
+end
+
+```
+
+You'll see in the code sample that we're only loading the Restfulness API during development. Our recommendation is to use Restfulness as close to Rack as possible and avoid any of the Rails overhead. To support request in production, you'll need to update your `/config.rb` so that it looks something like the following:
+
+```ruby
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+
+map = {
+  "/" => YourRailsApp::Application
+}
+unless Rails.env.development?
+  map["/api"] = Api.new
+end
+
+run Rack::URLMap.new(map)
+```
+
+Thats all there is to it! You'll now have auto-reloading in Rails, and fast request handling in production. Just be sure to be careful in development that none of your other Rack middleware interfere with Restfulness. In a new Rails project this certainly won't be an issue.
+
+### The Rack Way
+
+If you're using Restfulness as a standalone project, we recommend using a rack extension like [Shotgun](https://github.com/rtomayko/shotgun).
+
+
+## Writing Tests
+
+Test your application by creating requests to your resources and making assertions about the responses.
+
+### RSpec
+
+Configure `rack-test` to be included in your resource specs. One way to does this would be to create a new file `/spec/support/example_groups/restfulness_resource_example_group.rb` with something similar to the following:
+
+```ruby
+module RestfulnessResourceExampleGroup
+  extend ActiveSupport::Concern
+  include Rack::Test::Methods
+
+  # Used by Rack::Test. This could be defined per spec if you have multiple Apps
+  def app
+    My::Api.new
+  end
+  protected :app
+
+  # Set the request content type for a JSON payload
+  def set_content_type_json
+    header('content-type', 'application/json; charset=utf-8')
+  end
+
+  # Helper method to POST a json payload
+  # post(uri, params = {}, env = {}, &block)
+  def post_json(uri, json_data = {}, env = {}, &block)
+    set_content_type_json
+    post(uri, json_data.to_json, &block)
+  end
+
+  included do
+    metadata[:type] = :restfulness_resource
+  end
+
+  # Setup RSpec to include RestfulnessResourceExampleGroup for all specs in given folder(s)
+  RSpec.configure do |config|
+    config.include self,
+      :type => :restfulness_resource,
+      :example_group => { :file_path => %r(spec/resources) }
+  end
+
+  # silence logger
+  Restfulness.logger = Rack::NullLogger.new(My::Api)
+end
+```
+
+Make sure in your `spec_helper` all files in the support folder and sub-directories are being loaded. You should have something like the following:
+
+```ruby
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+```
+
+Now you can add a resource spec in the `spec/resources` directory. Here's an example
+
+```ruby
+require 'spec_helper'
+
+describe SessionResource do
+
+  let(:user) { create(:user) }
+
+  context 'GET' do
+    it 'returns 401 if not authorized' do
+      get 'api/session' do |response|
+        expect(response.status).to eq 401
+      end
+    end
+  end
+
+  context 'POST' do
+    it 'returns 200 when request with correct user info' do
+      post_json 'api/session', {:email => user.email, :password => user.password} do |response|
+        expect(response.status).to eq 200
+      end
+    end
   end
 end
 ```
 
-We're still working on ways to improve this. If you have any ideas, please send me a pull request!
+See [Rack::Test](https://github.com/brynary/rack-test) for more information.
+
+A useful gem for making assertions about json objects is [json_spec](https://github.com/collectiveidea/json_spec). This could be included in your `RestfulnessResourceExampleGroup`.
 
 ## Contributing
 
@@ -421,9 +548,34 @@ We're still working on ways to improve this. If you have any ideas, please send
 
 Restfulness was created by Sam Lown <me@samlown.com> as a solution for building simple APIs at [Cabify](http://www.cabify.com).
 
+The project is now awesome, thanks to contributions by:
+
+ * [Adam Williams](https://github.com/awilliams)
+
+
+## Caveats and TODOs
+
+Restfulness is still a work in progress but at Cabify we are using it in production. Here is a list of things that we'd like to improve or fix:
+
+ * Support for more serializers and content types, not just JSON.
+ * Support path methods for automatic URL generation.
+ * Support redirect exceptions.
+ * Needs more functional testing.
+ * Support for before and after filters in resources, although I'm slightly aprehensive about this.
 
 ## History
 
+### 0.2.3 - pending
+
+ * Fixing issue where query parameters are set as Hash instead of HashWithIndifferentAccess.
+ * Rewinding the body, incase rails got there first.
+ * Updating the README to describe auto-reloading in Rails projects.
+ * Improved handling of Content-Type header that includes encoding. (@awilliams)
+ * Return 400 error when malformed JSON is provided in body (@awilliams)
+ * Updated documentation to describe resource testing (@awilliams)
+ * Now supports filtering of sensitive query and parameter request values (@awilliams)
+ * Adding support for X-HTTP-Method-Override header. (@samlown)
+
 ### 0.2.2 - October 31, 2013
 
  * Refactoring logging support to not depend on Rack CommonLogger nor ShowExceptions.

data/lib/restfulness.rb

@@ -20,6 +20,7 @@ require "restfulness/resource"
 require "restfulness/response"
 require "restfulness/route"
 require "restfulness/router"
+require "restfulness/sanitizer"
 require "restfulness/statuses"
 require "restfulness/version"
 
@@ -29,6 +30,15 @@ module Restfulness
   extend self
 
   attr_accessor :logger
+
+  # Determine which parameters keys should be filtered in logs, etc
+  def sensitive_params=(params)
+    @sensitive_params = params
+  end
+
+  def sensitive_params
+    @sensitive_params ||= [:password]
+  end
 end
 
 Restfulness.logger = ActiveSupport::Logger.new(STDOUT)

data/lib/restfulness/dispatchers/rack.rb

@@ -19,14 +19,17 @@ module Restfulness
 
       def prepare_request(env)
         rack_req = ::Rack::Request.new(env)
+
         request = Request.new(app)
 
         request.uri        = rack_req.url
-        request.action     = parse_action(rack_req.request_method)
-        request.query      = rack_req.GET
+        request.action     = parse_action(env, rack_req.request_method)
         request.body       = rack_req.body
         request.headers    = prepare_headers(env)
 
+        # Just in case something else got to body first
+        request.body.rewind if request.body.is_a?(StringIO)
+
         # Useful info
         request.remote_ip  = rack_req.ip
         request.user_agent = rack_req.user_agent
@@ -37,10 +40,13 @@ module Restfulness
         request
       end
 
-      def parse_action(action)
+      # Given that we need to deal with the action early on, we handle the
+      # HTTP method override header here.
+      def parse_action(env, action)
+        action = (env['HTTP_X_HTTP_METHOD_OVERRIDE'] || action).strip.downcase
         case action
-        when 'DELETE', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'OPTIONS'
-          action.downcase.to_sym
+        when 'delete', 'get', 'head', 'post', 'put', 'patch', 'options'
+          action.to_sym
         else
           raise HTTPException.new(501)
         end

data/lib/restfulness/request.rb

@@ -18,15 +18,6 @@ module Restfulness
     # Ruby URI object
     attr_reader :uri
 
-    # Path object of the current URL being accessed
-    attr_accessor :path
-
-    # The route, determined from the path, if available!
-    attr_accessor :route
-
-    # Query parameters included in the URL
-    attr_accessor :query
-
     # Raw HTTP body, for POST and PUT requests.
     attr_accessor :body
 
@@ -56,21 +47,32 @@ module Restfulness
     end
 
     def query
-      @query ||= HashWithIndifferentAccess.new(
-        ::Rack::Utils.parse_nested_query(uri.query)
-      )
+      @query ||= ::Rack::Utils.parse_nested_query(uri.query).with_indifferent_access
+    end
+
+    def sanitized_query_string
+      @sanitized_query ||= uri.query ? Sanitizer.sanitize_query_string(uri.query) : ''
     end
 
     def params
       return @params if @params || body.nil?
       case headers[:content_type]
-      when 'application/json'
-        @params = MultiJson.decode(body)
+        when /application\/json/
+          begin
+            @params = MultiJson.decode(body)
+          rescue MultiJson::LoadError
+            raise HTTPException.new(400)
+          end
       else
         raise HTTPException.new(406)
       end
     end
 
+    def sanitized_params
+      # Note: this returns nil if #params has not been called
+      @sanitized_params ||= @params ? Sanitizer.sanitize_hash(@params) : nil
+    end
+
     [:get, :post, :put, :patch, :delete, :head, :options].each do |m|
       define_method("#{m}?") do
         action == m

data/lib/restfulness/response.rb

@@ -93,13 +93,13 @@ module Restfulness
 
       resource_name = resource ? resource.class.to_s : 'Error'
       # We're only interested in parsed parameters.
-      params = request.instance_variable_get(:@params)
+      params = request.sanitized_params
 
       msg = %{%s "%s %s%s" %s %d %s %s %0.4fs %s} % [
         request.remote_ip,
         request.action.to_s.upcase,
         uri.path,
-        uri.query ? "?#{uri.query}" : '',
+        uri.query ? "?#{request.sanitized_query_string}" : '',
         resource_name,
         status.to_s[0..3],
         STATUSES[status],

data/lib/restfulness/route.rb

@@ -2,7 +2,7 @@ module Restfulness
 
   class Route
 
-    # The path array of eliments, :id always on end!
+    # The path array of elements, :id always on end!
     attr_accessor :path
 
     # Reference to the class that will handle requests for this route

data/lib/restfulness/sanitizer.rb

@@ -0,0 +1,70 @@
+module Restfulness
+  module Sanitizer
+    SANITIZED = 'FILTERED'.freeze
+
+    def self.sanitize_hash(arg)
+      @hash_sanitizer ||= Hash.new(Restfulness.sensitive_params)
+      @hash_sanitizer.sanitize(arg)
+    end
+
+    def self.sanitize_query_string(arg)
+      @query_string_sanitizer ||= QueryString.new(Restfulness.sensitive_params)
+      @query_string_sanitizer.sanitize(arg)
+    end
+
+    class AbstractSanitizer
+      attr_reader :sensitive_params, :sensitive_param_matcher
+
+      def initialize(*sensitive_params)
+        @sensitive_params = [*sensitive_params].flatten.map(&:downcase)
+        @sensitive_param_matcher = Regexp.new("\\A#{@sensitive_params.join('|')}", Regexp::IGNORECASE)
+      end
+
+      def sensitive_param?(param)
+        sensitive_param_matcher === param.to_s
+      end
+
+      def sanitize(arg)
+        raise 'not implemented'
+      end
+    end
+
+    # Clean a hash of sensitive data. Works on nested hashes
+    class Hash < AbstractSanitizer
+      def sanitize(h)
+        return h if sensitive_params.empty? || h.empty?
+        duplicate = h.dup
+        duplicate.each_pair do |k, v|
+          duplicate[k] = if sensitive_param?(k)
+            SANITIZED
+          elsif v.is_a?(::Hash)
+            sanitize(v)
+          else
+            v
+          end
+        end
+        duplicate
+      end
+    end
+
+    # Clean a query string of sensitive data
+    class QueryString < AbstractSanitizer
+      PARSER = /
+        ([^&;=]+?) # param key
+        (\[.*?\])? # optionally a nested param, ie key[9]
+        =          # divider
+        ([^&;=]+)  # param value
+      /x
+      def sanitize(qs)
+        return qs if sensitive_params.empty? || qs.length == 0
+        qs.gsub(PARSER) do |query_param|
+          if sensitive_param?($1)
+            "#{$1}#{$2}=#{SANITIZED}"
+          else
+            query_param
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/unit/dispatchers/rack_spec.rb

@@ -29,7 +29,7 @@ describe Restfulness::Dispatchers::Rack do
     {
       'REQUEST_METHOD'  => 'GET',
       'SCRIPT_NAME'     => '',
-      'PATH_INFO'       => '/projects',
+      'PATH_INFO'       => '/projects?query=test',
       'QUERY_STRING'    => '',
       'SERVER_NAME'     => 'localhost',
       'SERVER_PORT'     => '3000',
@@ -59,17 +59,27 @@ describe Restfulness::Dispatchers::Rack do
     it "should convert main actions to symbols" do
       actions = ['DELETE', 'GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'OPTIONS']
       actions.each do |action|
-        val = obj.send(:parse_action, action)
+        val = obj.send(:parse_action, env, action)
         val.should eql(action.downcase.to_sym)
       end
     end
 
     it "should raise error if action unrecognised" do
       expect {
-        obj.send(:parse_action, 'FOOO')
+        obj.send(:parse_action, env, 'FOOO')
       }.to raise_error(Restfulness::HTTPException)
     end
 
+    it "should override the action if the override header is present" do
+      env['HTTP_X_HTTP_METHOD_OVERRIDE'] = 'PATCH'
+      obj.send(:parse_action, env, 'POST').should eql(:patch)
+    end
+
+    it "should handle junk in action override header" do
+      env['HTTP_X_HTTP_METHOD_OVERRIDE'] = ' PatCH '
+      obj.send(:parse_action, env, 'POST').should eql(:patch)
+    end
+
   end
 
   describe "#prepare_headers (protected)" do
@@ -88,15 +98,33 @@ describe Restfulness::Dispatchers::Rack do
 
       req.uri.should be_a(URI)
       req.action.should eql(:get)
-      req.query.should be_empty
       req.body.should be_nil
       req.headers.keys.should include(:x_auth_token)
       req.remote_ip.should eql('192.168.1.23')
       req.user_agent.should eql('Some Navigator')
 
+      req.query.should_not be_empty
+      req.query[:query].should eql('test')
+
       req.headers[:content_type].should eql('application/json')
     end
 
+    it "should handle the body stringio" do
+      env['rack.input'] = StringIO.new("Some String")
+
+      req = obj.send(:prepare_request, env)
+      req.body.read.should eql('Some String')
+    end
+
+    it "should rewind the body stringio" do
+      env['rack.input'] = StringIO.new("Some String")
+      env['rack.input'].read
+
+      req = obj.send(:prepare_request, env)
+      req.body.read.should eql('Some String')
+    end
+
+
   end
 
 end

data/spec/unit/request_spec.rb

@@ -40,6 +40,13 @@ describe Restfulness::Request do
     end
   end
 
+  describe "#action" do
+    it "should provide basic action" do
+      obj.action = :get
+      obj.action.should eql(:get)
+    end
+  end
+
   describe "#path" do
     it "should be nil if there is no route" do
       obj.stub(:route).and_return(nil)
@@ -94,18 +101,52 @@ describe Restfulness::Request do
     end
   end
 
+  describe "#sanitized_query_string" do
+    it "should be empty if no query" do
+      obj.uri = "https://example.com/project/12345"
+      obj.sanitized_query_string.should be_empty
+    end
+    it "should filter out bad keys" do # See sanitizer tests for more
+      obj.uri = "https://example.com/project/12345?foo=bar&password=safe"
+      obj.sanitized_query_string.should match(/foo=bar/)
+      obj.sanitized_query_string.should_not match(/password=safe/)
+    end
+  end
+
   describe "#params" do
     it "should not return anything for empty body" do
       obj.stub(:body).and_return(nil)
       obj.params.should be_nil
     end
+
+    it "should raise 400 bad request for invalid json body" do
+      obj.headers[:content_type] = "application/json; charset=utf-8"
+      obj.stub(:body).and_return("invalidjson!")
+      expect {
+        obj.params
+      }.to raise_error(Restfulness::HTTPException, "Bad Request"){ |exception|
+        expect(exception.status).to eq 400
+      }
+    end
+
     it "should raise 406 error if no content type" do
       obj.headers[:content_type] = nil
       obj.body = "{\"foo\":\"bar\"}"
       expect {
         obj.params
-      }.to raise_error(Restfulness::HTTPException, "Not Acceptable")
+      }.to raise_error(Restfulness::HTTPException, "Not Acceptable"){ |exception|
+        expect(exception.status).to eq 406
+      }
     end
+
+    it "should decode a JSON body with utf-8 encoding" do
+      obj.headers[:content_type] = "application/json; charset=utf-8"
+      obj.body = "{\"foo\":\"bar\"}"
+      expect {
+        obj.params
+      }.not_to raise_error
+    end
+
     it "should decode a JSON body" do
       obj.headers[:content_type] = "application/json"
       obj.body = "{\"foo\":\"bar\"}"
@@ -113,6 +154,21 @@ describe Restfulness::Request do
     end
   end
 
+  describe "#sanitized_params" do
+    it "should provide nil if the params hash has not been used" do
+      obj.stub(:body).and_return(nil)
+      obj.sanitized_params.should be_nil
+    end
+    it "should provide santized params if params have been used" do
+      obj.headers[:content_type] = "application/json"
+      obj.body = "{\"foo\":\"bar\",\"password\":\"safe\"}"
+      obj.params['password'].should eql('safe')
+      obj.sanitized_params['foo'].should eql('bar')
+      obj.sanitized_params['password'].should_not be_blank
+      obj.sanitized_params['password'].should_not eql('safe')
+    end
+  end
+
   describe "method helpers" do
     it "should respond to method questions" do
       [:get?, :post?, :put?, :delete?, :head?, :options?].each do |q|

data/spec/unit/sanitizer_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Restfulness::Sanitizer do
+  describe 'Hash' do
+    it 'does nothing when not given any sensitive params' do
+      subject = described_class::Hash.new()
+      input = {:password => 'ok', :nested => {:password => 'okay'}}
+      subject.sanitize(input).should eq input
+    end
+
+    it 'filters sensitive param and not others' do
+      subject = described_class::Hash.new(:password)
+      input = {:PASSword => 'supersecret', :user => 'billy'}
+      subject.sanitize(input).should eq({:PASSword => described_class::SANITIZED, :user => 'billy'})
+    end
+
+    it 'filters nested sensitive params and not others' do
+      subject = described_class::Hash.new(:password)
+      input = {:user => {:passWORD => 'supersecret', :user => 'billy'}}
+      subject.sanitize(input).should eq({:user => {:passWORD => described_class::SANITIZED, :user => 'billy'}})
+    end
+
+    it 'filters any parameter beginning with sensitive params (prefix)' do
+      subject = described_class::Hash.new(:password)
+      input = {:user => {:passWORD_confirmation => 'supersecret', :user => 'billy'}}
+      subject.sanitize(input).should eq({:user => {:passWORD_confirmation => described_class::SANITIZED, :user => 'billy'}})
+    end
+  end
+
+  describe 'QueryString' do
+    it 'does nothing when not given any sensitive params' do
+      subject = described_class::QueryString.new()
+      input = 'password=ok&other=false'
+      subject.sanitize(input).should eq input
+    end
+
+    it 'filters sensitive param and not others' do
+      subject = described_class::QueryString.new(:password)
+      input = 'PASSword=ok&other=false'
+      subject.sanitize(input).should eq "PASSword=#{described_class::SANITIZED}&other=false"
+    end
+
+    it 'filters nested (with index) sensitive params and not others' do
+      subject = described_class::QueryString.new(:password)
+      input = 'password[0]=what&PASSword[1]=secret&other=false'
+      subject.sanitize(input).should eq "password[0]=#{described_class::SANITIZED}&PASSword[1]=#{described_class::SANITIZED}&other=false"
+    end
+
+    it 'filters nested (no index) sensitive params and not others' do
+      subject = described_class::QueryString.new(:password)
+      input = 'password[]=what&password[]=secret&other=false'
+      subject.sanitize(input).should eq "password[]=#{described_class::SANITIZED}&password[]=#{described_class::SANITIZED}&other=false"
+    end
+
+    it 'filters any parameter beginning with sensitive params (prefix)' do
+      subject = described_class::QueryString.new(:password)
+      input = 'password_confirmation[]=what&password[]=secret&password=false'
+      subject.sanitize(input).should eq "password_confirmation[]=#{described_class::SANITIZED}&password[]=#{described_class::SANITIZED}&password=#{described_class::SANITIZED}"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -123,6 +123,7 @@ files:
 - lib/restfulness/response.rb
 - lib/restfulness/route.rb
 - lib/restfulness/router.rb
+- lib/restfulness/sanitizer.rb
 - lib/restfulness/statuses.rb
 - lib/restfulness/version.rb
 - restfulness.gemspec
@@ -138,6 +139,7 @@ files:
 - spec/unit/response_spec.rb
 - spec/unit/route_spec.rb
 - spec/unit/router_spec.rb
+- spec/unit/sanitizer_spec.rb
 homepage: https://github.com/samlown/restfulness
 licenses:
 - MIT
@@ -175,3 +177,4 @@ test_files:
 - spec/unit/response_spec.rb
 - spec/unit/route_spec.rb
 - spec/unit/router_spec.rb
+- spec/unit/sanitizer_spec.rb