trusted_keys 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trusted_keys.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+#
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})   { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/minitest_helper\.rb|) { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anders Törnqvist
+
+MIT License
+
+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,35 @@
+# TrustedKeys
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trusted_keys'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trusted_keys
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Other mass assignment protection gems for in controller
+* https://github.com/topdan/param_accessible
+* https://github.com/ryanb/trusted-params
+* https://github.com/elabs/trusted_attributes
+* https://github.com/rails/strong_parameters
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs.push "lib"
+  t.libs.push "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :test => :spec
+task :default => :test
+
+desc  "open console (require 'trusted_keys')"
+task :c do
+  system "irb -I lib -r trusted_keys"
+end

data/example/controller.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+$LOAD_PATH << File.dirname(__FILE__) + "../../lib"
+require 'trusted_keys'
+
+# An exception is raised if untrusted keys are submitted when Rails.env
+# equals 'development' or 'test'. When Rail.env is something else, it will
+# silently remove the untrusted keys.
+Rails.env = "development"
+Rails.env = "test"
+
+#Rails.env = "other"
+
+module Trusted
+  extend ActiveSupport::Concern
+  include TrustedKeys
+  extend self
+
+  def params
+    { "utf8"=>"✓", "authenticity_token"=>"zIE/nwLd",
+      "event"=> { "title"=>"",
+                  "location"=>"not trusted",
+                  "start(1i)"=>"2012", "start(2i)"=>"3", "start(3i)"=>"5",
+                  "description"=>"",
+                  "attendees"=>"",
+                  "slug_attributes" => {  "slug" => "dddd",
+                                          "dangerous" => "not trusted" },
+                  "comment_attributes" => { "body" => "I am body",
+                                            "evil" => "not trusted",
+                                            "slug3_attributes" => { "slug3" => "is cool",
+                                                                    "cruel" => "not trusted" } } } }
+  end
+
+  def puts
+    p trusted_attributes
+  end
+end
+
+puts "params => "
+p Trusted.params
+
+class ApplicationController
+  include Trusted
+end
+
+#ApplicationController.new.trusted_attributes # raises NoMethodError
+#ApplicationController.new.puts #  raises UsageError
+
+class ApplicationController
+  trust :utf8
+end
+ApplicationController.new.puts # {"utf8"=>"✓" }
+
+class ApplicationControllerX
+  include Trusted
+  trust :event, :utf8
+end
+Rails.env = "fff"
+ApplicationControllerX.new.puts # {"utf8"=>"✓"  "event" => "" }
+
+# raises TrustedKeys::NotTrustedError if test och development environment.
+#Rails.env = "test"
+ApplicationControllerX.new.puts
+
+
+#Rails.env = "test"
+class ApplicationController2
+  include Trusted
+  trust :title, :start, :description, :attendees, :slug_attributes, for: :event
+end
+ApplicationController2.new.puts
+# =>
+# { "title"=>"", "start(1i)"=>"2012", "start(2i)"=>"3", "start(3i)"=>"5",
+# "description"=>"", "attendees"=>"", "slug_attributes"=>""}
+
+#Rails.env = "test"
+class ApplicationController3
+  include Trusted
+  trust :title, :start, :description, :attendees, :slug_attributes,
+        :location, :comment_attributes, for: :event
+  trust :slug, for: "event.slug_attributes"
+end
+ApplicationController3.new.puts
+# =>
+# { "title"=>"", "start(1i)"=>"2012", "start(2i)"=>"3", "start(3i)"=>"5",
+#   "description"=>"", "attendees"=>"",
+#   "slug_attributes"=>{ "slug"=>"dddd"}}
+
+#Rails.env = "development"
+class ApplicationController4
+  include Trusted
+  trust :title, :start, :description, :attendees, :slug_attributes,
+        :comment_attributes, :location, for: :event
+  trust :slug, for: "event.slug_attributes"
+  trust "body", :slug3_attributes, for: "event.comment_attributes"
+end
+ApplicationController4.new.puts
+# =>
+# { "title"=>"", "start(1i)"=>"2012", "start(2i)"=>"3", "start(3i)"=>"5",
+#   "description"=>"", "attendees"=>"", "location" => "not trusted"
+#   "slug_attributes"=>{"slug"=>"dddd"},
+#   "comment_attributes"=>{ "body"=>"I am body",
+#                           "slug3_attributes"=>""}}
+#
+
+#Rails.env = "test"
+class ApplicationController5
+  include Trusted
+  trust :title, :start, :description, :attendees, :slug_attributes,
+        :comment_attributes, for: :event
+  trust :slug, for: "event.slug_attributes"
+  trust "body", :slug3_attributes, for: "event.comment_attributes"
+  trust "slug3", for: "event.comment_attributes.slug3_attributes"
+end
+ApplicationController5.new.puts
+# =>
+# { "title"=>"", "start(1i)"=>"2012", "start(2i)"=>"3", "start(3i)"=>"5",
+#   "description"=>"", "attendees"=>"",
+#   "slug_attributes"=>{"slug"=>"dddd"},
+#   "comment_attributes"=>{ "body"=>"I am body",
+#                           "slug3_attributes"=>{"slug3"=>"is cool"}}}

data/lib/trusted_keys.rb

@@ -0,0 +1,54 @@
+require 'trusted_keys/version'
+require 'rails'
+require 'trusted_keys/trustable'
+require 'trusted_keys/error/usage'
+require 'trusted_keys/error/not_trusted'
+
+module TrustedKeys
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def trust(*args)
+      options = args.extract_options!
+      scope = options.fetch(:for, "").to_s.split '.'
+      env = options[:env] || Rails.env
+      nested = options.fetch(:nested, true)
+
+      klass = Class.new do
+        include Trustable
+      end
+
+      @_trusted_keys ||= []
+      @_trusted_keys << klass.new(:scope => scope,
+                                  :trusted_keys => @_trusted_keys,
+                                  :untrusted => Error::NotTrusted.new(env),
+                                  :nested => nested,
+                                  :keys => args)
+    end
+  end
+
+  private
+
+  def trusted_attributes
+    trusted_keys = self.class.instance_variable_get("@_trusted_keys")
+    raise Error::Usage.new(params) unless trusted_keys
+
+    sorted_keys = trusted_keys.sort
+
+    attributes = sorted_keys.first.attributes(params)
+
+    sorted_keys.drop(1).each do |trusted|
+      current_attributes = trusted.on_scope(attributes)
+
+      if trusted.parent_nested?(current_attributes)
+        current_attributes.each do |key, hash|
+          hash[trusted.key] = trusted.attributes(hash)
+        end
+      else
+        current_attributes[trusted.key] = trusted.attributes(current_attributes)
+      end
+    end
+
+    attributes
+  end
+end

data/lib/trusted_keys/error/not_trusted.rb

@@ -0,0 +1,40 @@
+module TrustedKeys
+  module Error
+    class NotTrusted < StandardError
+      def initialize(env)
+        @keys = {}
+        @production = not(env.development? or env.test?)
+      end
+
+      def message
+        usage = @keys.map do |scope, keys|
+          "`trust #{keys}, for: '#{scope}'`"
+        end.join("\n")
+
+        "\n\nError: There are keys in the params hash that are not trusted. " +
+        "Set them as trusted with:\n#{usage} at the top of the controller."
+      end
+
+      def keys(options)
+        scope = options.fetch(:scope)
+        key = options.fetch(:key)
+        keys = options.fetch(:keys).flatten.map do |key|
+          ":#{key.to_s.sub(/\(\di\)/, '')}"
+        end.uniq.join(', ')
+
+        scope_key = (scope + [key]).compact.join('.')
+        @keys[scope_key] = keys unless scope_key.empty?
+
+        self
+      end
+
+      def present?
+        if @production
+          false
+        else
+          not @keys.empty?
+        end
+      end
+    end
+  end
+end

data/lib/trusted_keys/error/usage.rb

@@ -0,0 +1,16 @@
+module TrustedKeys
+  module Error
+    class Usage < StandardError
+      def initialize(params)
+        @params = params
+      end
+
+      def message
+        "\n\nparams => #{@params.inspect}\n\n" +
+        "Error: Before using `trusted_attributes` you must set the " +
+        "trusted keys in the controller, for examples: `trust :post` " +
+        "or `trust :title, :body, for: 'post'`"
+      end
+    end
+  end
+end

data/lib/trusted_keys/trustable.rb

@@ -0,0 +1,114 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module TrustedKeys
+  module Trustable
+    extend ActiveSupport::Concern
+    include ActiveModel::MassAssignmentSecurity
+
+    def initialize(options)
+      @scope = options.fetch(:scope)
+      @trusted_keys = options.fetch(:trusted_keys)
+      @untrusted = options.fetch(:untrusted)
+      @nested = options.fetch(:nested, true)
+      keys = options.fetch(:keys)
+
+      if nested?({})
+        keys << "_destroy"
+        keys << "id"
+      end
+
+      self.class.send("attr_accessible", *keys)
+    end
+
+    def attributes(params)
+      params = params[key.to_sym] || params[key.to_s] if key
+
+      if nested?(params)
+        {}.tap do |hash|
+          params.each do |key, nested_hash|
+            hash[key] = sanitize(nested_hash)
+          end
+        end
+      elsif params.is_a?(Array)
+        [].tap do |array|
+          params.each do |hash|
+            array << sanitize(hash)
+          end
+        end
+      else
+        sanitize(params)
+      end
+    end
+
+    def on_scope(attributes)
+      @scope.slice(1, @scope.size - 2).reduce(attributes) do |attributes, key|
+        attributes[key]
+      end
+    end
+
+    def key; @key ||= @scope.last; end
+    def <=> (other); level <=> other.level; end
+    def level; @scope.size; end
+
+    def parent_nested?(params)
+      if level > 1
+        parent and parent.nested?(params)
+      else
+        false
+      end
+    end
+
+    protected
+
+    def nested?(params)
+      if params.is_a?(Hash)
+        @nested and key.to_s[/\A.+_attributes\Z/]
+      else
+        false
+      end
+    end
+
+    private
+
+    def parent
+      key = @scope.at(@scope.size - 2)
+
+      @trusted_keys.select do |trusted|
+        trusted.key.to_s == key and trusted.level == (level - 1)
+      end.first
+    end
+
+
+    def sanitize(params)
+      result = sanitize_for_mass_assignment(params)
+
+      keys = params.keys.map(&:to_s) - result.keys.map(&:to_s)
+
+      unless keys.empty?
+        untrusted = @untrusted.keys(:scope => @scope,
+                                    :key => nil,
+                                    :keys => keys)
+        raise untrusted if untrusted.present?
+      end
+
+      remove_untrusted_keys(result)
+    end
+
+    def remove_untrusted_keys(attributes)
+      trusted_keys = @trusted_keys.select do |trusted|
+        trusted.level == (level + 1)
+      end.map { |trusted| trusted.key.to_s }
+
+      attributes.each do |key, value|
+        if value.is_a?(Hash) and !trusted_keys.include?(key.to_s)
+          attributes[key] = ""
+          @untrusted.keys :scope => @scope, :key => key, :keys => value.keys
+        end
+      end
+
+      raise @untrusted if @untrusted.present?
+
+      HashWithIndifferentAccess.new(attributes)
+    end
+  end
+end

data/lib/trusted_keys/version.rb

@@ -0,0 +1,3 @@
+module TrustedKeys
+  VERSION = "0.0.1"
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest-colorize'
+require "trusted_keys"
+require 'ostruct'
+
+Kernel.instance_eval do
+  alias_method :context, :describe
+end

data/spec/trusted_keys/trustable_spec.rb

@@ -0,0 +1,274 @@
+require 'minitest_helper'
+
+NotTrusted = TrustedKeys::Error::NotTrusted
+Usage = TrustedKeys::Error::Usage
+
+describe TrustedKeys::Trustable do
+  let(:test) { OpenStruct.new(:test? => true, :development? => false) }
+
+  let(:klass) do
+    Class.new do
+      include TrustedKeys::Trustable
+    end
+  end
+
+  let(:params) do
+    { "email" => "anders@email.com",
+      :controller => "events",
+      :collection => [ { "one" =>  "ok 1",
+                         "two" => "remove me"},
+                       { "one" => "ok 2",
+                         "two" => "remove me 2"} ],
+      :time => { "start_time(1i)"=>"2012",
+                 "start_time(2i)"=>"3",
+                 "start_time(3i)"=>"14" },
+      :events => {
+        :nested_attributes => { "0" => {  "_destroy"=>"false",
+                                          "dangerous" => "remove me",
+                                          "start"=>"2012" },
+                                "new_1331711737056" => {  "_destroy"=>"false",
+                                                          "start"=>"2012" } } },
+      :password => "secret",
+      :post =>  {  :body => "I am a body",
+                   :title => "This is my title",
+                   :comments =>  { 'body' => 'My body',
+                                   :email => "an email",
+                                   :author => { :name => "anders" } } } }
+  end
+
+  def options(options_hash)
+    { :scope => [],
+      :trusted_keys => [],
+      :untrusted => NotTrusted.new(OpenStruct.new(:test? => false,
+                                                  :development? => false)),
+      :keys => [:email]
+    }.merge(options_hash)
+  end
+
+  describe "attributes inside a collection" do
+    it "returns trusted attributes" do
+      t = klass.new(options(:scope => [:collection],
+                           :keys => ["one"]))
+      expected = [{ "one" => "ok 1" }, { "one" => "ok 2" }]
+
+      t.attributes(params).must_equal(expected)
+    end
+  end
+
+  describe "datetime selects" do
+    it "return all datetime attributes" do
+      t = klass.new(options(:scope => [:time],
+                            :trusted_keys => [],
+                            :keys => [:start_time]))
+
+      expected = {  "start_time(1i)"=>"2012",
+                    "start_time(2i)"=>"3",
+                    "start_time(3i)"=>"14" }
+      t.attributes(params).must_equal(expected)
+    end
+  end
+
+  describe "nested attributes" do
+    it "returns nested hash" do
+      t = klass.new(options(:scope => [:events, :nested_attributes],
+                            :trusted_keys => [],
+                            :keys => [ "start" ]))
+
+      expected = { "0" => {  "_destroy"=>"false",
+                             "start"=>"2012" },
+                   "new_1331711737056" => {  "_destroy"=>"false",
+                                             "start"=>"2012" } }
+      t.attributes(params[:events]).must_equal(expected)
+    end
+  end
+
+  describe "#attributes" do
+    describe "when in test or development environment" do
+      context "level 0" do
+        it "doesn't raise an exception if all params isn't trusted" do
+          t = klass.new(options(:scope => [],
+                                :trusted_keys => [],
+                                :untrusted => NotTrusted.new(test),
+                                :keys => [:email]))
+          t.attributes(params).must_equal("email" => "anders@email.com")
+        end
+      end
+
+      context "level 1" do
+        it "raises an exception if all params isn't trusted" do
+          t = klass.new(options(:scope => [:post],
+                                :trusted_keys => [],
+                                :untrusted => NotTrusted.new(test),
+                                :keys => [:body]))
+          proc { t.attributes(params) }.must_raise NotTrusted
+        end
+      end
+
+      context "level 2" do
+        it "raises an exception if all params isn't trusted" do
+          t = klass.new(options(:scope => [:post, :comments],
+                                :trusted_keys => [],
+                                :untrusted => NotTrusted.new(test),
+                                :keys => [:body]))
+          proc { t.attributes(params[:post]) }.must_raise NotTrusted
+        end
+      end
+
+      context "hash on next level isn't trusted" do
+        it "raises an exception" do
+          t = klass.new(options(:scope => [],
+                                :trusted_keys => [],
+                                :untrusted => NotTrusted.new(test),
+                                :keys => [:email, :password, :post]))
+          proc { t.attributes(params) }.must_raise NotTrusted
+        end
+      end
+    end
+
+    context "level 0" do
+      it "returns trusted params for level 0" do
+        t = klass.new(options(:scope => [],
+                              :trusted_keys => [],
+                              :keys => [:email]))
+        t.attributes(params).must_equal("email" => 'anders@email.com')
+      end
+
+      it %(transform hash on next level to an empty string if its keys
+           aren't trusted) do
+        t = klass.new(options(:scope => [],
+                              :trusted_keys => [],
+                              :keys => [:post]))
+        t.attributes(params).must_equal("post" => '')
+      end
+
+      it "returns the hash on next level if it has trusted keys" do
+        level1 = klass.new(options(:scope => [:post],
+                                   :trusted_keys => [],
+                                   :keys => [:body]))
+        t = klass.new(options(:scope => [],
+                              :trusted_keys => [level1],
+                              :keys => [:post]))
+
+        expected = {"post"=> { "body"=>"I am a body",
+                               "title"=>"This is my title",
+                               "comments"=> { "body"=>"My body",
+                                              "email"=>"an email",
+                                              "author"=>{"name"=>"anders"}} } }
+
+        t.attributes(params).must_equal(expected)
+        level1.attributes(params).must_equal("body" => "I am a body")
+      end
+    end
+
+    context "level 1" do
+      it "returns trusted params for level 1" do
+        t = klass.new(options(:scope => [:post],
+                                 :trusted_keys => [],
+                                 :keys => [:body]))
+        t.attributes(params).must_equal("body" => 'I am a body')
+      end
+    end
+
+    context "level 2" do
+      it "returns trusted params for level 2" do
+        t = klass.new(options(:scope => [:post, :comments],
+                                 :trusted_keys => [],
+                                 :keys => [:body]))
+        t.attributes(params[:post]).must_equal("body" => 'My body')
+      end
+    end
+  end
+
+  describe "#on_scope" do
+    context "level 2" do
+      it "returns the hash for that level" do
+        t = klass.new(options(:scope => [:post, :comments],
+                              :trusted_keys => [],
+                              :keys => [:body]))
+        t.on_scope(params[:post]).must_equal(params[:post])
+      end
+    end
+
+    context "level 3" do
+      it "returns the hash for that level" do
+        t = klass.new(options(:scope => [:post, :comments, :author],
+                              :trusted_keys => [],
+                              :keys => [:name]))
+        t.on_scope(params[:post]).must_equal(params[:post][:comments])
+      end
+    end
+
+    context "level 1" do
+      it "not applicable" do
+        t = klass.new(options(:scope => [:post],
+                              :trusted_keys => [],
+                              :keys => [:body]))
+        proc { t.on_scope(params) }.must_raise NoMethodError
+      end
+    end
+
+    context "level 0" do
+      it "not applicable" do
+        t = klass.new(options(:scope => [],
+                              :trusted_keys => [],
+                              :keys => [:body]))
+        proc { t.on_scope(params) }.must_raise NoMethodError
+      end
+    end
+  end
+
+  describe "#key" do
+    context "scope is empty" do
+      it "returns nil" do
+        klass.new(options(:scope => [])).key.must_equal nil
+      end
+    end
+
+    context "scope has 1 key" do
+      it "returns the key" do
+        klass.new(options(:scope => [:post])).key.must_equal :post
+      end
+    end
+
+    context "scope has 2 keys" do
+      it "returns the last key - deepest key" do
+        klass.new(options(:scope => [:post, :comment])).key.must_equal :comment
+      end
+    end
+  end
+
+  describe "#level" do
+    context "scope is empty" do
+      it "returns 0" do
+        klass.new(options(:scope => [])).level.must_equal 0
+      end
+    end
+
+    context "scope has 1 key" do
+      it "returns 1" do
+        klass.new(options(:scope =>[:post])).level.must_equal 1
+      end
+    end
+
+    context "scope has 2 keys" do
+      it "returns 2" do
+        klass.new(options(:scope => [:post, :comment])).level.must_equal 2
+      end
+    end
+  end
+
+  describe "#<=>" do
+    describe "sort an array" do
+      before do
+        @a1 = klass.new(options(:scope =>[:post, :comment]))
+        @a2 = klass.new(options(:scope => [:post]))
+        @array = [@a1, @a2]
+        @array.first.must_equal @a1
+      end
+
+      it "sort objects with the lowest level first" do
+        @array.sort.first.must_equal @a2
+      end
+    end
+  end
+end

data/spec/trusted_keys_spec.rb

@@ -0,0 +1,186 @@
+require 'minitest_helper'
+
+describe TrustedKeys do
+  let(:controller) do
+    Class.new do
+      include TrustedKeys
+
+      def params
+        { "email" => "anders@email.com",
+          :time => { "start_time(1i)"=>"2012",
+                     "start_time(2i)"=>"3",
+                     "start_time(3i)"=>"14" },
+          :event => {
+            :password => "secret",
+            :collection_attributes => [ { "one" =>  "ok 1",
+                                          "two" => "remove me"},
+                                        { "one" => "ok 2",
+                                          "two" => "remove me 2"} ],
+            :nested_attributes => {
+              "0" => {  "_destroy"=>"false",
+                        "start"=>"2012" },
+              "new_1331711737056" => {  "_destroy"=>"false",
+                                        "start"=>"2012" } } },
+          "survey"=> {
+            "name"=>"survery 1",
+            "questions_attributes"=>
+              { "0"=>{"_destroy"=>"1",
+                      "content"=>"question2",
+                      "dddd" => "xxxx",
+                      "id"  => "1",
+                      "answers_attributes"=>{
+                        "0"=>{"content"=>"answer1","_destroy"=>"","dd" => "x"},
+                        "1"=>{"content"=>"answer 2","_destroy"=>"1","id"=>"2"}
+                       }},
+                "1"=>{"_destroy"=>"1",
+                      "content"=>"",
+                      "answers_attributes"=>{
+                        "1"=>{"content"=>"", "_destroy"=>""}}}}},
+
+          :controller => "events",
+          :password => "secret",
+          :post =>  {  :body => "I am a body",
+                       :title => "This is my title",
+                       :comments =>  { 'body' => 'My body',
+                                       :email => "an email",
+                                       :author => { :name => "anders" } } } }
+      end
+    end
+  end
+
+  let(:env) { OpenStruct.new(:test? => false, :development? => false) }
+
+  describe ".trust" do
+    describe "datetime selects" do
+      it "return all datetime attributes" do
+        controller.trust :start_time, :for => :time, :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = {  "start_time(1i)"=>"2012",
+                      "start_time(2i)"=>"3",
+                      "start_time(3i)"=>"14" }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+
+    describe "hashes inside a collection" do
+      it "returns trusted attributes" do
+        controller.trust :collection_attributes, "password", :for => :event,
+                                                             :env => env
+        controller.trust :one, :for => 'event.collection_attributes',
+                               :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "password" => "secret",
+                     "collection_attributes" => [{ "one" => "ok 1" },
+                                                 { "one" => "ok 2" }] }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+
+    context "nested attributes" do
+      it "returns nested hash" do
+        controller.trust :questions_attributes, :name, :for => :survey,
+                                                       :env => env
+        controller.trust "answers_attributes", "content",
+                         :for => 'survey.questions_attributes', :env => env
+
+        controller.trust "content",
+          :for => 'survey.questions_attributes.answers_attributes', :env => env
+
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = {
+          "name"=>"survery 1",
+          "questions_attributes"=>
+            { "0"=>{"_destroy"=>"1",
+                    "content"=>"question2",
+                    "id"  => "1",
+                    "answers_attributes"=>{
+                    "0"=>{"content"=>"answer1", "_destroy"=>""},
+                    "1"=>{"content"=>"answer 2", "_destroy"=>"1", "id"=>"2"}}},
+            "1"=>{"_destroy"=>"1",
+                  "content"=>"",
+                  "answers_attributes"=>{
+                    "1"=>{"content"=>"", "_destroy"=>""}}}}}
+
+        trusted_attributes.must_equal(expected)
+      end
+
+      it "returns nested hash" do
+        controller.trust :nested_attributes, :for => :event, :env => env
+        controller.trust "start", :for => 'event.nested_attributes', :env => env
+
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "nested_attributes" => {
+                        "0" =>  {  "_destroy"=>"false",
+                                   "start"=>"2012" },
+                        "new_1331711737056" => {  "_destroy"=>"false",
+                                                  "start"=>"2012" } } }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+
+    context "no trusted keys" do
+      it "raises an exception" do
+        proc {
+          controller.new.send(:trusted_attributes)
+        }.must_raise TrustedKeys::Error::Usage
+      end
+    end
+
+    context "0 level" do
+      it "returns trusted keys" do
+        controller.trust :email , :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+        trusted_attributes.must_equal("email" => "anders@email.com")
+      end
+    end
+
+    context "1 level" do
+      it "returns trusted keys" do
+        controller.trust :body, :for => :post, :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "body" => "I am a body" }
+        trusted_attributes.must_equal(expected)
+      end
+
+      it "returns trusted keys" do
+        controller.trust :body, :title, :comments, :for => :post, :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "body" => "I am a body",
+                     "title" => "This is my title",
+                     "comments" => "" }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+
+    context "2 levels" do
+      it "returns trusted keys" do
+        controller.trust :body, :comments, :for => :post, :env => env
+        controller.trust :author, :for => 'post.comments', :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "body" => "I am a body",
+                     "comments" => { "author" => "" } }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+
+    context "3 levels" do
+      it "returns trusted keys" do
+        controller.trust :body, :comments, :for => :post, :env => env
+        controller.trust :author, :for => 'post.comments', :env => env
+        controller.trust :name, :for => 'post.comments.author', :env => env
+        trusted_attributes = controller.new.send(:trusted_attributes)
+
+        expected = { "body" => "I am a body",
+                     "comments" => { "author" => { "name" => "anders" } } }
+        trusted_attributes.must_equal(expected)
+      end
+    end
+  end
+end

data/trusted_keys.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/trusted_keys/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Anders Törnqvist"]
+  gem.email         = ["anders.tornqvist@gmail.com"]
+  gem.description   = %q{Mass assignment security in your controller}
+  gem.summary       = %q{Mass assignment security in your controller}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+                        File.basename(f)
+                      end
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "trusted_keys"
+  gem.require_paths = ["lib"]
+  gem.version       = TrustedKeys::VERSION
+
+  gem.add_runtime_dependency "rails", ["~> 3.0"]
+  gem.add_development_dependency "minitest", ["~> 2.11"]
+  gem.add_development_dependency "guard", ["~> 1.0"]
+  gem.add_development_dependency "guard-minitest", ["~> 0.5"]
+  gem.add_development_dependency "minitest-colorize", ["~> 0.0.4"]
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: trusted_keys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anders Törnqvist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description: Mass assignment security in your controller
+email:
+- anders.tornqvist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- example/controller.rb
+- lib/trusted_keys.rb
+- lib/trusted_keys/error/not_trusted.rb
+- lib/trusted_keys/error/usage.rb
+- lib/trusted_keys/trustable.rb
+- lib/trusted_keys/version.rb
+- spec/minitest_helper.rb
+- spec/trusted_keys/trustable_spec.rb
+- spec/trusted_keys_spec.rb
+- trusted_keys.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Mass assignment security in your controller
+test_files:
+- spec/minitest_helper.rb
+- spec/trusted_keys/trustable_spec.rb
+- spec/trusted_keys_spec.rb