robot_catcher 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzZmYzkxZWVhZTdhNWRiMmY3YWYwNDAzMzU5OTY1MDhjNWU1ZGVjOQ==
+  data.tar.gz: !binary |-
+    ZDAyMzlmMmViNWI5ZjZlOGViZjJlZmI5MDc5OWJkZGQ3NjFkYzM4OA==
+SHA512:
+  metadata.gz: !binary |-
+    NTkzNjIzOWIyZjU2M2Y4YjdmYzZiOThmMjkyMTcwZDY2OTAwNGMxYzk5N2I2
+    MDA5MGRjN2E3YzUxOTg1ZDdkZWFhOTQ1YzQ3YjBmNTAxMTJhZjdlNGE5MzQy
+    YzdiM2UxNmM1MmZjNTMzNTJlNDBlNDQxMzQ3NjI1NGE4ZTNkOWY=
+  data.tar.gz: !binary |-
+    ZTg4MTUyOGYwMjM0ZjQ4ODIyMWY0NTI5YmQ0ZjQ3MzNiZGY2ZGJhNTRiYjNi
+    MjI5OTA1YjFjNDZkMTBmMThlZTY0NzBlY2JkMjMwODU4ZDkzMjYxODM0OWIw
+    NGY0ZjhlZDRkNjg1MjY1ZWEzNjkzODQ1MDU3M2ZkNTI4ZmZiNTA=

data/README.md

@@ -0,0 +1,116 @@
+# RobotCatcher
+
+RobotCatcher makes your forms smarter and keeps bots away.
+
+## INSTALLATION
+
+Prerequisites:
++ Ruby (built with for example rbenv and ruby-build)
++ Bundle
++ A Rails application (Rails 3.2.22)
+
+Installation is simple! Add this line to your application's Gemfile:
+
+    gem 'robot_catcher'
+
+Or in your gem specification file:
+
+    Gem::Specification.new do |s|
+        ...
+        s.add_dependency 'robot_catcher'
+
+After running `bundle install`, RobotCatcher's functionality will be available in your 
+project.
+
+## DESCRIPTION
+
+**RobotCatcher** is a small form plugin that uses several kinds of hashing to
+consider whether a form has been filled out by a bot or a human being. 
+
+## HOW TO USE
+
+### Front-end (in your .html.erb document)
+
+In any forms in your Rails application. Instead of `form_for`, use `rc_form_for`, 
+and specify the request ip address as an argument (typically `request.remote_ip`:
+
+    rc_form_for(@article, ip: request.remote_ip) do |f|
+        f.label 'title'
+        f.text_field 'title'
+
+        f.label 'text'
+        f.text_area 'text'
+
+        f.submit
+    end
+
+Idem dito in case you want to use `form_tag` or anyother field `*_tag`:
+
+    rc_form_tag('/articles', ip: request.remote_ip) do
+        label_tag 'title'
+        rc_text_field_tag 'title'
+
+        label_tag 'text'
+        rc_text_area_tag 'text'
+    
+        submit_tag
+    end
+
+NB: In case of tags, only use tags helper methods on fields (i.e. not on 
+labels or submit).
+
+### Back-end
+
+#### In the model
+
+To specify the attributes that should be investigated by the robot catcher,
+use the class method `robot_catch`. See the example below. A prerequisite 
+is that the model class is a child of ActiveRecord::Base.
+
+    class Article < ActiveRecord::Base
+		robot_catch :title, :text
+        ...
+	end
+
+#### In the controller
+
+In the current version, catching robots is done by using the `robot?` method on
+a model object. The arguments are the **original** params hash 
+(technically a ActionController::Parameters instance), and the request ip address. 
+It be the original params hash because that hash contains the information (i.e. 
+spinner, timestamp, etc.) that the robot catcher checks. See the example below. 
+
+	def create
+	    @article = Article.new(params[:article])
+
+	    if @article.robot?(params, request.remote_ip)
+            redirect_to @article, notice: 'Stupid robot.'
+            return
+	    end
+
+	    if @article.save
+            redirect_to @article, notice: 'Article was successfully created.'
+	    else
+            render :new
+	    end
+  	end
+
+NB: This requires some knowledge about the difference between what `rc_form_for`
+and `rc_form_tag` generates. As for in the example given in the front-end section 
+with `rc_form_tag`, the params hash will include no `:article` key, so a new 
+article object is made by passing in the *raw* `params` hash (since this contains 
+the right attribute keys and values). Anyway, if you want to do it the Rails way,
+use `rc_form_for` like in the example above.
+
+## UPCOMING NEXT
++ Store robot catches in database
++ Configuration (e.g. for a secret that is used for hashing)
++ More [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself "Don't Repeat Yourself")
+
+### To be considered
++ Random order on spinner hasher
++ Support for more tags
++ Integration into native validations
++ Rewriting native form helper class
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -1,10 +1,16 @@
+#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-
-require 'rdoc/task'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -17,8 +23,6 @@ end
 
 
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -31,4 +35,4 @@ Rake::TestTask.new(:test) do |t|
 end
 
 
-task default: :test
+task :default => :test

data/lib/robot_catcher/helpers.rb

@@ -3,20 +3,12 @@ module RobotCatcher
     class FormBuilder < ActionView::Helpers::FormBuilder 
       def initialize(object_name, object, template, options)        
         @spinner = options[:spinner]
-        if object_name.nil? and object.nil?
-          @nested_child_index = {}
-          @template, @options = template, options
-          @default_options = @options ? @options.slice(:index, :namespace) : {}
-          @multipart = nil
-          @index = options[:index] || options[:child_index]
-        else
-          super(object_name, object, template, options)
-        end
+        super(object_name, object, template, options, nil)
       end
 
       def self.create_tagged_field(method_name)
         define_method(method_name) do |label, *args|
-          if method_name.eql? :label
+          if method_name.eql? "label"
             super(label, *args)
           else
             hash_tag = Digest::MD5.hexdigest(label.to_s + @spinner + "robotcatcher")
@@ -114,8 +106,6 @@ module RobotCatcher
           raise ArgumentError, "should include ip address"
         end
         ip = options.delete(:ip)
-
-        options[:builder] = RobotCatcher::Helpers::FormBuilder
         
         timestamp = Time.now.to_i.to_s
         # p "To be spinned (front-end): #{timestamp}#{ip}robotcatcher"
@@ -133,8 +123,8 @@ module RobotCatcher
         else
           object      = record.is_a?(Array) ? record.last : record
           raise ArgumentError, "First argument in form cannot contain nil or be empty" unless object
-          object_name = options[:as] || model_name_from_record_or_class(object).param_key
-          apply_form_for_options!(record, object, options)
+          object_name = options[:as] || object.class.name.downcase
+          apply_form_for_options!(record, options)
         end
 
         html_options[:data]   = options.delete(:data)   if options.has_key?(:data)
@@ -143,7 +133,7 @@ module RobotCatcher
         html_options[:enforce_utf8] = options.delete(:enforce_utf8) if options.has_key?(:enforce_utf8)
         html_options[:authenticity_token] = options.delete(:authenticity_token)
 
-        builder = instantiate_builder(object_name, object, options)
+        builder = RobotCatcher::Helpers::FormBuilder.new(object_name, object, self, options)
         content = capture(builder, &block)
         html_options[:multipart] ||= builder.multipart?
 

data/lib/robot_catcher/models.rb

@@ -8,7 +8,7 @@ module RobotCatcher
 
         self.class_eval do
           def robot?(params, ip)
-            timestamp = params["timestamp"]
+            timestamp = params[:timestamp]
 
             if timestamp.nil? or \
               timestamp.to_i < Time.now.to_i - 300 or timestamp.to_i > Time.now.to_i
@@ -16,19 +16,23 @@ module RobotCatcher
               return true
             end
 
-            spinner = params["spinner"]
+            spinner = params[:spinner]
             # p "To be spinned (back-end): #{timestamp}#{ip}robotcatcher"
             hash_spinner = Digest::MD5.hexdigest(timestamp + ip.to_s + "robotcatcher")
 
             if spinner.nil? or spinner != hash_spinner
-              # p "Spinner: #{spinner}" is not equal #{hash_spinner}!"
+              # p "Spinner: #{spinner} is not equal #{hash_spinner}!"
               return true
             end
 
             object_name   = self.class.name.downcase
             object_params = params.include?(object_name) && \
               params[object_name].is_a?(Hash) ? params[object_name] : params
-            
+
+            # p object_name
+            # p object_params
+            # p @@rc_params
+
             to_be_validated = object_params.select {|k,v| @@rc_params.include? k.to_sym}
 
             if to_be_validated.length != @@rc_params.length
@@ -39,7 +43,7 @@ module RobotCatcher
             to_be_validated.each do |k, v|
               hash = Digest::MD5.hexdigest(k.to_s + hash_spinner + "robotcatcher")
               if !params.include? hash or !params[hash].empty?
-                # p "Key hash: #{k}'s hash was wrong!
+                # p "Key hash: #{k}'s hash was wrong!"
                 return true
               end
             end

data/lib/robot_catcher/version.rb

@@ -1,3 +1,3 @@
 module RobotCatcher
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/dummy/README.rdoc

@@ -1,28 +1,261 @@
-== README
+== Welcome to Rails
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
 
-Things you may want to cover:
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
 
-* Ruby version
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
 
-* System dependencies
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
 
-* Configuration
 
-* Database creation
+== Getting Started
 
-* Database initialization
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
 
-* How to run the test suite
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
 
-* Services (job queues, cache servers, search engines, etc.)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
 
-* Deployment instructions
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
 
-* ...
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
 
 
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -1,6 +1,7 @@
+#!/usr/bin/env rake
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
 require File.expand_path('../config/application', __FILE__)
 
-Rails.application.load_tasks
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -2,12 +2,14 @@
 // listed below.
 //
 // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
+// the compiled file.
 //
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
 //
+//= require jquery
+//= require jquery_ujs
 //= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -3,13 +3,11 @@
  * listed below.
  *
  * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
  *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
  *
- *= require_tree .
  *= require_self
+ *= require_tree .
  */

data/test/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,3 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
+  protect_from_forgery
 end