acts_as_textcaptcha 4.2.0 → 4.5.2

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Matthew Hutchinson
-
-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/config/textcaptcha.yml

@@ -1,34 +0,0 @@
-development: &common_settings
-  api_key: PASTE_YOUR_TEXTCAPCHA_API_KEY_HERE  # grab one from http://textcaptcha.com/api
-  http_read_timeout: 60 # Optional seconds to wait for one block to be read from http://textcaptcha.com/api
-  # http_open_timeout: 10 # Optional seconds to wait for the connection to open
-  # cache_expiry_minutes: 10 # Optional minutes for captcha answers to persist in the cache (default 10 minutes)
-
-  questions:
-      - question: 'Is ice hot or cold?'
-        answers: 'cold'
-      - question: 'what color is an orange?'
-        answers: 'orange'
-      - question: 'what is two plus 3?'
-        answers: '5,five'
-      - question: 'what is 5 times two?'
-        answers: '10,ten'
-      - question: 'How many colors in the list, green, brown, foot and blue?'
-        answers: '3,three'
-      - question: 'what is Georges name?'
-        answers: 'george'
-      - question: '11 minus 1?'
-        answers: '10,ten'
-      - question: 'is boiling water hot or cold?'
-        answers: 'hot'
-      - question: 'what color is my blue shirt today?'
-        answers: 'blue'
-      - question: 'what is 16 plus 4?'
-        answers: '20,twenty'
-
-test:
-  <<: *common_settings
-  api_key: 6eh1co0j12mi2ogcoggkkok4o
-
-production:
-  <<: *common_settings

data/lib/tasks/textcaptcha.rake

@@ -1,21 +0,0 @@
-namespace :textcaptcha do
-
-  desc "Creates a template config file in config/textcaptcha.yml"
-  task :config do
-    src  = File.join(File.dirname(__FILE__), '../..', 'config', 'textcaptcha.yml')
-    dest = File.join(Rails.root, 'config', 'textcaptcha.yml')
-    if File.exist?(dest)
-      puts "\nOoops, a textcaptcha config file at #{dest} already exists ... aborting.\n\n"
-    else
-      config = ''
-      f = File.open(src, 'r')
-      f.each_line { |line| config += line }
-      config.gsub!(/  api_key:(.*)# for gem test purposes only$/, "  api_key: PASTE_YOUR_TEXTCAPCHA_API_KEY_HERE")
-
-      f = File.new(dest, 'w')
-      f.write(config)
-      f.close
-      puts "\ntextcaptcha.yml generated at #{dest}\nNOTE: edit this file and add your textcaptcha api key, grab one from http://textcaptcha.com/api\n\n"
-    end
-  end
-end

data/test/schema.rb

@@ -1,34 +0,0 @@
-ActiveRecord::Schema.define(:version => 0) do
-
-  create_table :widgets, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :comments, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :fast_comments, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :reviews, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :movie_reviews, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :notes, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :strong_protected_widgets, :force => true do |t|
-    t.string :name
-  end
-
-  create_table :strong_accessible_widgets, :force => true do |t|
-    t.string :name
-  end
-end

data/test/test_helper.rb

@@ -1,44 +0,0 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)+'./../lib/acts_as_textcaptcha'))
-
-ENV['RAILS_ENV'] = 'test'
-
-# ensure tmp dir exists
-FileUtils.mkdir_p './tmp'
-
-# confgure test coverage reporting
-if ENV['COVERAGE']
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter '/test/'
-    add_filter '/vendor/'
-  end
-  SimpleCov.at_exit do
-    SimpleCov.result.format!
-    `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
-  end
-elsif ENV['TRAVIS']
-  require 'coveralls'
-  Coveralls.wear!
-end
-
-require 'minitest/autorun'
-require 'webmock/minitest'
-require 'rails/all'
-require 'acts_as_textcaptcha'
-require './test/test_models'
-
-# load and initialize test db schema
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'tmp/acts_as_textcaptcha_test.sqlite3.db')
-load(File.dirname(__FILE__) + "/schema.rb")
-
-# initialize the Rails cache (use a basic memory store in tests)
-if Rails.version >= '4'
-  Rails.cache = ActiveSupport::Cache::MemoryStore.new
-else
-  RAILS_CACHE = ActiveSupport::Cache::MemoryStore.new
-end
-
-# additional helper methods for use in tests
-def find_in_cache(key)
-  Rails.cache.read("#{ActsAsTextcaptcha::TextcaptchaCache::CACHE_KEY_PREFIX}#{key}")
-end

data/test/test_models.rb

@@ -1,69 +0,0 @@
-# models for use in tests
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end
-
-class Widget < ApplicationRecord
-  # uses textcaptcha.yml file for configuration
-  acts_as_textcaptcha
-end
-
-class Comment < ApplicationRecord
-  # inline options (symbol keys) with api_key only
-  acts_as_textcaptcha :api_key => '8u5ixtdnq9csc84cok0owswgo'
-end
-
-class FastComment < ApplicationRecord
-  # inline options with super fast (0.006 seconds) cache expiry time
-  acts_as_textcaptcha :cache_expiry_minutes => '0.0001',
-                      :questions => [{ :question => '1+1', :answers => '2,two' }]
-end
-
-class Review < ApplicationRecord
-  # inline options with all possible options
-  acts_as_textcaptcha :api_key   => '8u5ixtdnq9csc84cok0owswgo',
-                      :questions => [{ :question => 'The green hat is what color?', :answers => 'green' }]
-end
-
-class MovieReview < ApplicationRecord
-  # inline options with all possible options
-  acts_as_textcaptcha 'api_key'   => '8u5ixtdnq9csc84cok0owswgo',
-                      'questions' => [{ 'Question' => 'The green hat is what color?', 'answers' => nil }]
-end
-
-class Note < ApplicationRecord
-  # inline options (string keys) with user defined questions only (no textcaptcha service)
-  acts_as_textcaptcha 'questions' => [{ 'question' => '1+1', 'answers' => '2,two' }]
-
-  # allows toggling perform_textcaptcha on/off (default on)
-  attr_accessor :turn_off_captcha
-
-  def perform_textcaptcha?
-    super && !turn_off_captcha
-  end
-end
-
-class Contact
-  # non active record object (symbol keys), no API used
-  include ActiveModel::Validations
-  include ActiveModel::Conversion
-  extend  ActsAsTextcaptcha::Textcaptcha
-  acts_as_textcaptcha :questions => [{ :question => 'one+1', :answers => "2,two,апельсин" }]
-end
-
-class StrongAccessibleWidget < ApplicationRecord
-
-  # stub out attr_accessbile interface for testing
-  def self.accessible_attributes(role = :default); end
-  def self.attr_accessible(*args); end
-
-  acts_as_textcaptcha 'questions' => [{ 'question' => '1+1', 'answers' => '2,two' }]
-end
-
-class StrongProtectedWidget < StrongAccessibleWidget
-
-  # stub out attr_protected interface for testing
-  def self.attr_protected(*args); end
-
-  acts_as_textcaptcha 'questions' => [{ 'question' => '1+1', 'answers' => '2,two' }]
-end

data/test/textcaptcha_api_test.rb

@@ -1,46 +0,0 @@
-require File.expand_path(File.dirname(__FILE__)+'/test_helper')
-
-describe 'TextcaptchaApi' do
-
-  describe 'with a valid xml response' do
-
-    before(:each) do
-      body = "<captcha><question>1+1?</question><answer>1</answer><answer>2</answer><answer>3</answer></captcha>"
-      stub_request(:get, "http://textcaptcha.com/api/abc").to_return(:body => body)
-    end
-
-    it 'should fetch and parse an answer from the service' do
-      result = ActsAsTextcaptcha::TextcaptchaApi.fetch('abc')
-      result[0].must_equal '1+1?'
-      result[1].must_equal ['1', '2', '3']
-    end
-
-    it 'should allow http options to be set' do
-      result = ActsAsTextcaptcha::TextcaptchaApi.fetch('abc', { :http_read_timeout => 30,
-                                                                :http_open_timeout => 5 })
-      result.length.must_equal 2
-    end
-  end
-
-  it 'should return nil when Net::HTTP errors occur' do
-    [
-      SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
-      Errno::EHOSTUNREACH, EOFError, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
-      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
-      URI::InvalidURIError
-    ].each do |error|
-       stub_request(:get, "http://textcaptcha.com/api/xyz").to_raise(error)
-       assert_nil ActsAsTextcaptcha::TextcaptchaApi.fetch('xyz')
-     end
-  end
-
-  it 'should return nil when body cannot be parsed as XML' do
-    stub_request(:get, "http://textcaptcha.com/api/jibber").to_return(:body => 'here be gibberish')
-    assert_nil ActsAsTextcaptcha::TextcaptchaApi.fetch('jibber')
-  end
-
-  it 'should return nil when body is empty' do
-    stub_request(:get, "http://textcaptcha.com/api/empty").to_return(:body => '')
-    assert_nil ActsAsTextcaptcha::TextcaptchaApi.fetch('empty')
-  end
-end

data/test/textcaptcha_cache_test.rb

@@ -1,25 +0,0 @@
-require File.expand_path(File.dirname(__FILE__)+'/test_helper')
-
-describe 'TextcaptchaCache' do
-
-  before(:each) do
-    @cache = ActsAsTextcaptcha::TextcaptchaCache.new
-    @cache.write('mykey', [1,2,3])
-  end
-
-  it 'should write to the cache' do
-    @cache.write('my-new-key', 'abc')
-    @cache.read('my-new-key').must_equal 'abc'
-  end
-
-  it 'should read from the cache' do
-    @cache.read('mykey').must_equal [1,2,3]
-  end
-
-  it 'should delete from the cache' do
-    @cache.read('mykey').must_equal [1,2,3]
-    @cache.delete('mykey')
-
-    assert_nil @cache.read('mykey')
-  end
-end

data/test/textcaptcha_helper_test.rb

@@ -1,68 +0,0 @@
-require File.expand_path(File.dirname(__FILE__)+'/test_helper')
-require 'action_controller'
-require 'action_view'
-
-class NotesController < ActionController::Base; end
-
-class Template < ActionView::Base
-  def protect_against_forgery?; false; end
-end
-
-
-describe 'TextcaptchaHelper' do
-
-  before(:each) do
-    @controller = NotesController.new
-    @note       = Note.new
-    @note.textcaptcha
-  end
-
-  def render_template(assigns = { :note => @note })
-    template = <<-ERB
-    <%= form_for(@note, :url => '/') do |f| %>
-      <%= textcaptcha_fields(f) do %>
-      <div class="field textcaptcha">
-        <%= f.label :textcaptcha_answer, @note.textcaptcha_question %><br/>
-        <%= f.text_field :textcaptcha_answer, :value => '' %>
-      </div>
-      <% end %>
-    <% end %>
-    ERB
-
-    Template.new([], assigns, @controller).render(:inline => template)
-  end
-
-  it 'should render question and answer fields, with hidden textcaptcha_key field' do
-    html = render_template
-
-    assert_match(/\<label for\=\"note_textcaptcha_answer\"\>1\+1\<\/label\>/, html)
-    assert_match(/\<input(.*)name\=\"note\[textcaptcha_answer\]\"(.*)\/\>/, html)
-    assert_match(/\<input(.*)name\=\"note\[textcaptcha_key\]\"(.*)\/\>/, html)
-  end
-
-  it 'should render hidden answer and textcaptcha_key when only answer is present' do
-    @note.textcaptcha_question = nil
-    @note.textcaptcha_answer   = 2
-    html = render_template
-
-    refute_match(/\<label for\=\"note_textcaptcha_answer\"\>1\+1\<\/label\>/, html)
-    assert_match(/\<input(.*)name\=\"note\[textcaptcha_answer\]\"(.*)\/\>/, html)
-    assert_match(/\<input(.*)name\=\"note\[textcaptcha_key\]\"(.*)\/\>/, html)
-  end
-
-  it 'should not render any question or answer when perform_textcaptcha? is false' do
-    @note.turn_off_captcha = true
-    html = render_template
-
-    refute_match(/note_textcaptcha_answer/, html)
-    refute_match(/note_textcaptcha_key/, html)
-  end
-
-  it 'should not render any question or answer when textcaptcha_key is missing' do
-    @note.textcaptcha_key = nil
-    html = render_template
-
-    refute_match(/note_textcaptcha_answer/, html)
-    refute_match(/note_textcaptcha_key/, html)
-  end
-end

data/test/textcaptcha_test.rb

@@ -1,198 +0,0 @@
-require File.expand_path(File.dirname(__FILE__)+'/test_helper')
-
-describe 'Textcaptcha' do
-
-  describe 'validations' do
-
-    before(:each) do
-      @note = Note.new
-      @note.textcaptcha
-    end
-
-    it 'should validate an ActiveRecord object (with multiple correct answers)' do
-      @note.textcaptcha_question.must_equal('1+1')
-      @note.valid?.must_equal false
-      @note.errors[:textcaptcha_answer].first.must_equal('is incorrect, try another question instead')
-
-      @note.textcaptcha_answer = 'two'
-      @note.valid?.must_equal true
-      @note.errors[:textcaptcha_answer].must_be_empty
-
-      @note.textcaptcha_answer = '2'
-      @note.valid?.must_equal true
-      @note.errors[:textcaptcha_answer].must_be_empty
-    end
-
-    it 'should strip whitespace and downcase answer' do
-      @note.textcaptcha_answer = ' tWo '
-      @note.valid?.must_equal true
-      @note.errors[:textcaptcha_answer].must_be_empty
-    end
-
-    it 'should always be valid when record has been saved' do
-      @note.textcaptcha_answer = '2'
-      @note.save!
-      @note.textcaptcha
-
-      @note.textcaptcha_answer = 'wrong answer'
-      @note.new_record?.must_equal false
-      @note.valid?.must_equal true
-      @note.errors[:textcaptcha_answer].must_be_empty
-    end
-
-    it 'should always be valid when perform_textcaptcha? is false' do
-      @note.turn_off_captcha = true
-      @note.valid?.must_equal true
-      @note.errors[:textcaptcha_answer].must_be_empty
-
-      @note.save.must_equal true
-    end
-
-    it 'should validate a non ActiveRecord object' do
-      @contact = Contact.new
-      @contact.textcaptcha
-
-      @contact.textcaptcha_question.must_equal('one+1')
-      @contact.textcaptcha_answer = 'wrong'
-      @contact.valid?.must_equal false
-
-      @contact.textcaptcha_answer = 'two'
-      @contact.valid?.must_equal true
-      @contact.errors[:textcaptcha_answer].must_be_empty
-    end
-  end
-
-  describe 'with fast expiry time' do
-
-    before(:each) do
-      @comment = FastComment.new
-    end
-
-    it 'should work' do
-      @comment.textcaptcha
-      @comment.textcaptcha_question.must_equal('1+1')
-      @comment.textcaptcha_answer = 'two'
-      sleep(0.01)
-
-      @comment.valid?.must_equal false
-      @comment.errors[:textcaptcha_answer].first.must_equal('was not submitted quickly enough, try another question instead')
-    end
-  end
-
-  describe 'textcaptcha API' do
-
-    it 'should generate a question from the service' do
-      @review = Review.new
-      body     = "<captcha><question>Something?</question><answer>f6f7fec07f372b7bd5eb196bbca0f3f4</answer></captcha>"
-      stub_request(:get, %r{http://textcaptcha.com/api/}).and_return(:body => body)
-
-      @review.textcaptcha
-      @review.textcaptcha_question.wont_be_nil
-      @review.textcaptcha_question.wont_equal('The green hat is what color?')
-
-      find_in_cache(@review.textcaptcha_key).wont_be_nil
-
-      @review.valid?.must_equal false
-      @review.errors[:textcaptcha_answer].first.must_equal('is incorrect, try another question instead')
-    end
-
-    it 'should parse a single answer from XML response' do
-      @review  = Review.new
-      question = 'If tomorrow is Saturday, what day is today?'
-      body     = "<captcha><question>#{question}</question><answer>f6f7fec07f372b7bd5eb196bbca0f3f4</answer></captcha>"
-      stub_request(:get, %r{http://textcaptcha.com/api/}).and_return(:body => body)
-
-      @review.textcaptcha
-      @review.textcaptcha_question.must_equal(question)
-      find_in_cache(@review.textcaptcha_key).must_equal(['f6f7fec07f372b7bd5eb196bbca0f3f4'])
-    end
-
-    it 'should parse multiple answers from XML response' do
-      @review  = Review.new
-      question = 'If tomorrow is Saturday, what day is today?'
-      body     = "<captcha><question>#{question}</question><answer>1</answer><answer>2</answer><answer>3</answer></captcha>"
-      stub_request(:get, %r{http://textcaptcha.com/api}).and_return(:body => body)
-
-      @review.textcaptcha
-      @review.textcaptcha_question.must_equal(question)
-      find_in_cache(@review.textcaptcha_key).length.must_equal(3)
-    end
-
-    it 'should fallback to a user defined question when api returns nil' do
-      @review = Review.new
-      stub_request(:get, %r{http://textcaptcha.com/api}).and_return(:body => '')
-      @review.textcaptcha
-      @review.textcaptcha_question.must_equal('The green hat is what color?')
-      find_in_cache(@review.textcaptcha_key).wont_be_nil
-    end
-
-    it 'should not generate any question or answer when no user defined questions set' do
-      @comment = Comment.new
-
-      stub_request(:get, %r{http://textcaptcha.com/api/}).to_raise(SocketError)
-      @comment.textcaptcha
-      assert_nil @comment.textcaptcha_question
-      assert_nil @comment.textcaptcha_key
-    end
-
-    it 'should not generate any question or answer when user defined questions set incorrectly' do
-      @comment = MovieReview.new
-
-      stub_request(:get, %r{http://textcaptcha.com/api/}).to_raise(SocketError)
-      @comment.textcaptcha
-      assert_nil @comment.textcaptcha_question
-      assert_nil @comment.textcaptcha_key
-    end
-  end
-
-  describe 'configuration' do
-
-    it 'should be configured with inline hash' do
-      Review.textcaptcha_config.must_equal({ :api_key   => '8u5ixtdnq9csc84cok0owswgo',
-                                             :questions => [{ :question => 'The green hat is what color?', :answers => 'green' }]})
-    end
-
-    it 'should be configured with textcaptcha.yml' do
-      Widget.textcaptcha_config[:api_key].must_equal('6eh1co0j12mi2ogcoggkkok4o')
-      Widget.textcaptcha_config[:questions].length.must_equal(10)
-    end
-  end
-
-  describe 'with strong parameters' do
-
-    it 'should work with accessible_attr widget ' do
-      @widget = StrongAccessibleWidget.new
-
-      @widget.textcaptcha
-      @widget.textcaptcha_question.must_equal('1+1')
-      @widget.valid?.must_equal false
-    end
-
-    it 'should work with protected_attr widget ' do
-      @widget = StrongProtectedWidget.new
-
-      @widget.textcaptcha
-      @widget.textcaptcha_question.must_equal('1+1')
-      @widget.valid?.must_equal false
-    end
-  end
-
-  describe 'when missing config' do
-
-    it 'should raise an error' do
-      YAML.stub :load, -> { raise 'some bad things happened' } do
-
-        error = assert_raises(ArgumentError) do
-          class NoConfig
-            include ActiveModel::Validations
-            include ActiveModel::Conversion
-            extend ActsAsTextcaptcha::Textcaptcha
-            acts_as_textcaptcha
-          end
-        end
-
-        error.message.must_match(/could not find any textcaptcha options/)
-      end
-    end
-  end
-end