double_trouble 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,10 +1,56 @@
 = Double Trouble
 
-Adds nonces to your Rails' forms.
+Adds nonces to your Rails' forms, avoiding duplicates by sending the
+same form again (when the user has ADHD, as well in the other
+situations).
 
 == Installation
 
-  gem install form_nonce
+  gem install double_trouble
+
+== Usage
+
+  class CommentsController < ApplicationController
+    protect_from_double_trouble :comment, :only => :create
+
+    def create
+      @comment = Comment.new(params[:comment])
+      if @comment.save
+        # ordinary stuff
+      end
+    end
+  end
+
+Double trouble works quite similar to CSRF protection
+(authenticity_token) - it adds form_nonce parameter to your
+forms. After the protected model is successfully saved (when
+new_record? returns false), it stores received form_nonce in the
+Rails.cache by default (you can easily replace the default store by DB
+backend for instance).
+
+== Configuration
+
+You can globally turn the protection off (test environment?):
+
+  ActionController::Base.allow_double_trouble_protection = false
+
+Default nonce store can be changed:
+
+  ActionController::Base.double_trouble_nonce_store = FormNonce
+
+FormNonce class must implement two class methods:
+
+  def self.valid?(nonce)
+    # checks if the nonce has not been used before
+  end
+
+  def self.store!(nonce)
+    # stores the given nonce somewhere
+  end
+
+The name of the form nonce param can be changed as well:
+
+  ActionController::Base.double_trouble_nonce_param = :double_trouble_nonce
 
 == Copyright
 

data/lib/double_trouble/protection.rb

@@ -3,52 +3,47 @@ module DoubleTrouble
     def self.included(base)
       base.class_eval do
         class_inheritable_accessor :allow_double_trouble_protection
-        class_inheritable_accessor :double_trouble_resource_name
         cattr_accessor             :double_trouble_nonce_store
         cattr_accessor             :double_trouble_nonce_param
         helper_method              :protect_against_double_trouble?, :double_trouble_nonce_param, :double_trouble_form_nonce
 
         self.allow_double_trouble_protection = true
+
         extend(ClassMethods)
       end
     end
 
     module ClassMethods
       def protect_from_double_trouble(resource_name, options = {})
-        self.double_trouble_resource_name   = resource_name
         self.double_trouble_nonce_param   ||= :form_nonce
         self.double_trouble_nonce_store   ||= CachedNonce
 
-        around_filter :double_trouble_protection, options.slice(:only, :except)
-      end
-    end
+        around_filter(options.slice(:only, :except)) do |controller, action_block|
+          if controller.send(:protect_against_double_trouble?)
+            nonce = controller.params[double_trouble_nonce_param]
 
-    protected
+            double_trouble_nonce_store.valid?(nonce) || raise(InvalidNonce)
 
-    def double_trouble_protection
-      if protect_against_double_trouble?
-        nonce    = params[double_trouble_nonce_param]
-        store    = double_trouble_nonce_store
+            action_block.call
 
-        store.valid?(nonce) || raise(InvalidNonce)
-        yield
-        instance_variable_get("@#{double_trouble_resource_name}").tap do |resource|
-          resource.present? && !resource.new_record? && store.store!(nonce)
+            controller.instance_variable_get("@#{resource_name}").tap do |resource|
+              resource.present? && !resource.new_record? && double_trouble_nonce_store.store!(nonce)
+            end
+          else
+            action_block.call
+          end
         end
-      else
-        yield
       end
     end
 
+    protected
+
     def double_trouble_form_nonce
       ActiveSupport::SecureRandom.base64(32)
     end
 
     def protect_against_double_trouble?
-      allow_double_trouble_protection &&
-        double_trouble_resource_name &&
-        double_trouble_nonce_store &&
-        double_trouble_nonce_param
+      allow_double_trouble_protection && double_trouble_nonce_store && double_trouble_nonce_param
     end
   end
 end

data/lib/double_trouble/version.rb

@@ -1,3 +1,3 @@
 module DoubleTrouble
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: double_trouble
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -72,11 +72,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/double_trouble/errors.rb
-- lib/double_trouble/cached_nonce.rb
 - lib/double_trouble/form_tag_helper_hack.rb
-- lib/double_trouble/version.rb
 - lib/double_trouble/protection.rb
+- lib/double_trouble/cached_nonce.rb
+- lib/double_trouble/version.rb
+- lib/double_trouble/errors.rb
 - lib/double_trouble.rb
 - LICENSE
 - README.rdoc