acts_as_textcaptcha 4.3.0 → 4.4.1

data/lib/acts_as_textcaptcha/textcaptcha_cache.rb

@@ -1,34 +1,31 @@
-# A simple cache for storing Textcaptcha answers
-# by default the underlying cache implementation is
-# the standard Rails.cache (ActiveSupport::Cache)
+# A simple cache for storing Textcaptcha answers, Rails.cache is used as the
+# backend (ActiveSupport::Cache)
 
 module ActsAsTextcaptcha
   class TextcaptchaCache
 
-    CACHE_KEY_PREFIX = 'acts_as_textcaptcha-'
-    DEFAULT_CACHE_EXPIRY_MINUTES = 10
+    KEY_PREFIX = 'acts_as_textcaptcha-'
+    DEFAULT_EXPIRY_MINUTES = 10
 
     def write(key, value, options = {})
       unless options.has_key?(:expires_in)
-        options[:expires_in] = DEFAULT_CACHE_EXPIRY_MINUTES.minutes
+        options[:expires_in] = DEFAULT_EXPIRY_MINUTES.minutes
       end
       Rails.cache.write(cache_key(key), value, options)
     end
 
-    def read(key, options = nil)
-      Rails.cache.read(cache_key(key), options)
+    def read(key)
+      Rails.cache.read(cache_key(key))
     end
 
-    def delete(key, options = nil)
-      Rails.cache.delete(cache_key(key), options)
+    def delete(key)
+      Rails.cache.delete(cache_key(key))
     end
 
     private
 
-    # since this cache may be shared with other objects
-    # a prefix is used in all cache keys
-    def cache_key(key)
-      "#{CACHE_KEY_PREFIX}#{key}"
-    end
+      def cache_key(key)
+        "#{KEY_PREFIX}#{key}"
+      end
   end
 end

data/{config/textcaptcha.yml → lib/acts_as_textcaptcha/textcaptcha_config.rb}

@@ -1,7 +1,11 @@
+module ActsAsTextcaptcha
+  class TextcaptchaConfig
+
+    YAML = <<-CONFIG
 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
+  api_key: 'TEXTCAPTCHA_API_IDENT' # see http://textcaptcha.com for details
+  # api_endpoint: nil        # Optional API URL to fetch questions and answers from
+  # raise_errors: false      # Optional flag, if true errors will be raised if the API endpoint fails
   # cache_expiry_minutes: 10 # Optional minutes for captcha answers to persist in the cache (default 10 minutes)
 
   questions:
@@ -28,7 +32,15 @@ development: &common_settings
 
 test:
   <<: *common_settings
-  api_key: 6eh1co0j12mi2ogcoggkkok4o
+  api_key: 'TEST_TEXTCAPTCHA_API_IDENT'
 
 production:
   <<: *common_settings
+CONFIG
+
+    def self.create(path: './config/textcaptcha.yml')
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') { |f| f.write(YAML) }
+    end
+  end
+end

data/lib/acts_as_textcaptcha/textcaptcha_helper.rb

@@ -1,22 +1,22 @@
 module ActsAsTextcaptcha
   module TextcaptchaHelper
 
-    # builds html form fields for the textcaptcha
     def textcaptcha_fields(f, &block)
-      model        = f.object
-      captcha_html = ''
-      if model.perform_textcaptcha?
-        if model.textcaptcha_key
-          captcha_html += f.hidden_field(:textcaptcha_key)
-          if model.textcaptcha_question
-            captcha_html += capture(&block)
-          elsif model.textcaptcha_answer
-            captcha_html += f.hidden_field(:textcaptcha_answer)
-          end
-        end
+      if f.object.perform_textcaptcha? && f.object.textcaptcha_key
+        build_textcaptcha_form_elements(f, &block)
       end
-
-      captcha_html.html_safe
     end
+
+    private
+
+      def build_textcaptcha_form_elements(f, &block)
+        captcha_html = f.hidden_field(:textcaptcha_key)
+        if f.object.textcaptcha_question
+          captcha_html += capture(&block)
+        elsif f.object.textcaptcha_answer
+          captcha_html += f.hidden_field(:textcaptcha_answer)
+        end
+        captcha_html.html_safe
+      end
   end
 end

data/lib/acts_as_textcaptcha/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTextcaptcha
-  VERSION = "4.3.0"
+  VERSION = '4.4.1'
 end

data/lib/tasks/textcaptcha.rake

@@ -1,21 +1,16 @@
+require 'rails'
+require 'acts_as_textcaptcha/textcaptcha_config'
+
 namespace :textcaptcha do
 
-  desc "Creates a template config file in config/textcaptcha.yml"
+  desc "Creates an example textcaptcha config at 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"
+    path = File.join((Rails.root ? Rails.root : '.'), 'config', 'textcaptcha.yml')
+    if File.exist?(path)
+      puts "Ooops, a textcaptcha config file at #{path} already exists ... aborting."
     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"
+      ActsAsTextcaptcha::TextcaptchaConfig.create(path: path)
+      puts "Done, config generated at #{path}\nEdit this file to add your TextCaptcha API key (see http://textcaptcha.com)."
     end
   end
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_textcaptcha
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-18 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -122,56 +150,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  Simple question/answer based spam protection for your Rails models.
-    You can define your own logic questions and/or fetch questions from the textcaptcha.com API.
-    The questions involve human logic and are tough for spam bots to crack.
-    For more reasons on why logic questions are a good idea visit; http://textcaptcha.com/why
+description: |2
+    ActsAsTextcaptcha provides spam protection for Rails models with a text-based
+    logic question captcha. Questions are fetched from Rob Tuley's textcaptcha.com
+    They can be solved easily by humans but are tough for robots to crack. For
+    reasons on why logic based captchas are a good idea visit textcaptcha.com
 email:
 - matt@hiddenloop.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
-- ".coveralls.yml"
 - ".gitignore"
+- ".simplecov"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - acts_as_textcaptcha.gemspec
 - bin/console
-- config/textcaptcha.yml
+- bin/setup
 - gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
 - lib/acts_as_textcaptcha.rb
+- lib/acts_as_textcaptcha/errors.rb
 - lib/acts_as_textcaptcha/framework/rails.rb
 - lib/acts_as_textcaptcha/textcaptcha.rb
 - lib/acts_as_textcaptcha/textcaptcha_api.rb
 - lib/acts_as_textcaptcha/textcaptcha_cache.rb
+- lib/acts_as_textcaptcha/textcaptcha_config.rb
 - lib/acts_as_textcaptcha/textcaptcha_helper.rb
 - lib/acts_as_textcaptcha/version.rb
 - lib/tasks/textcaptcha.rake
-- test/schema.rb
-- test/test_helper.rb
-- test/test_models.rb
-- test/textcaptcha_api_test.rb
-- test/textcaptcha_cache_test.rb
-- test/textcaptcha_helper_test.rb
-- test/textcaptcha_test.rb
 homepage: http://github.com/matthutchinson/acts_as_textcaptcha
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/matthutchinson/acts_as_textcaptcha
+  changelog_uri: https://github.com/matthutchinson/acts_as_textcaptcha/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/matthutchinson/acts_as_textcaptcha
+  bug_tracker_uri: https://github.com/matthutchinson/acts_as_textcaptcha/issues
   allowed_push_host: https://rubygems.org
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- ActAsTextcaptcha
+- "--main"
+- README.md
+- "-ri"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -186,9 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Spam protection for your models via logic questions and the textcaptcha.com
-  API
+summary: A text-based logic question captcha for Rails
 test_files: []

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/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,28 +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'
-
-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