acts_as_textcaptcha 4.2.0 → 4.5.2

data/lib/acts_as_textcaptcha/textcaptcha_api.rb

@@ -1,61 +1,55 @@
-# simple wrapper for the textcaptcha.com API service
-# loads and parses captcha question and answers
+# frozen_string_literal: true
 
-require 'rexml/document'
+require "json"
 
 module ActsAsTextcaptcha
-
-  # raised if an empty response is returned
-  class EmptyResponseError < StandardError; end;
-
   class TextcaptchaApi
+    BASE_URL = "http://textcaptcha.com"
+
+    def initialize(api_key: nil, api_endpoint: nil, raise_errors: false)
+      self.uri = if api_endpoint
+                   URI(api_endpoint)
+                 else
+                   URI("#{BASE_URL}/#{api_key}.json")
+                 end
+      self.raise_errors = raise_errors || false
+    rescue URI::InvalidURIError => e
+      raise ApiKeyError.new(api_key, e)
+    end
 
-    ENDPOINT = 'http://textcaptcha.com/api/'
-
-    def self.fetch(api_key, options = {})
-      begin
-        url = uri_parser.parse("#{ENDPOINT}#{api_key}")
-        http = Net::HTTP.new(url.host, url.port)
-        if options[:http_open_timeout]
-          http.open_timeout = options[:http_open_timeout]
-        end
-        if options[:http_read_timeout]
-          http.read_timeout = options[:http_read_timeout]
-        end
-
-        response = http.get(url.path)
-        if response.body.to_s.empty?
-          raise ActsAsTextcaptcha::EmptyResponseError
-        else
-          return parse(response.body)
-        end
-      rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
-        Errno::EHOSTUNREACH, EOFError, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
-        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
-        URI::InvalidURIError, ActsAsTextcaptcha::EmptyResponseError,
-        REXML::ParseException
-        # rescue from these errors and continue
-      end
+    def fetch
+      parse(get.to_s)
     end
 
-    def self.parse(xml)
-      parsed_xml = ActiveSupport::XmlMini.parse(xml)['captcha']
-      question = parsed_xml['question']['__content__']
-      if parsed_xml['answer'].is_a?(Array)
-        answers = parsed_xml['answer'].collect { |a| a['__content__'] }
+    private
+
+    attr_accessor :uri, :raise_errors
+
+    def get
+      response = Net::HTTP.new(uri.host, uri.port).get(uri.path)
+      if response.code == "200"
+        response.body
       else
-        answers = [parsed_xml['answer']['__content__']]
+        handle_error ResponseError.new(uri, "status: #{response.code}")
       end
-
-      [question, answers]
+    rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+           Errno::EHOSTUNREACH, EOFError, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
+           Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+           Net::ProtocolError => e
+      handle_error ResponseError.new(uri, e)
     end
 
+    def parse(response)
+      JSON.parse(response) unless response.empty?
+    rescue JSON::ParserError
+      handle_error ParseError.new(uri)
+    end
 
-    private
+    def handle_error(error)
+      raise error if raise_errors
 
-    def self.uri_parser
-      # URI.parse is deprecated in 1.9.2
-      URI.const_defined?(:Parser) ? URI::Parser.new : URI
+      Rails.logger.error("#{error.class} #{error.message}")
+      nil
     end
   end
 end

data/lib/acts_as_textcaptcha/textcaptcha_cache.rb

@@ -1,34 +1,30 @@
-# A simple cache for storing Textcaptcha answers
-# by default the underlying cache implementation is
-# the standard Rails.cache (ActiveSupport::Cache)
+# frozen_string_literal: true
+
+# A simple cache for storing Textcaptcha answers, Rails.cache is used as the
+# backend (ActiveSupport::Cache). This must not be set as a `:null_store`.
 
 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
-      end
+      options[:expires_in] = DEFAULT_EXPIRY_MINUTES.minutes unless options.has_key?(:expires_in)
       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}"
+      "#{KEY_PREFIX}#{key}"
     end
   end
 end

data/lib/acts_as_textcaptcha/textcaptcha_config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActsAsTextcaptcha
+  class TextcaptchaConfig
+    YAML = <<~CONFIG
+      development: &common_settings
+        api_key: 'TEXTCAPTCHA_API_IDENT' # see https://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:
+            - 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: '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,21 +1,20 @@
+# frozen_string_literal: true
+
 module ActsAsTextcaptcha
   module TextcaptchaHelper
+    def textcaptcha_fields(form, &block)
+      build_textcaptcha_form_elements(form, &block) if form.object.perform_textcaptcha? && form.object.textcaptcha_key
+    end
 
-    # 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
-      end
+    private
 
+    def build_textcaptcha_form_elements(form, &block)
+      captcha_html = form.hidden_field(:textcaptcha_key)
+      if form.object.textcaptcha_question
+        captcha_html += capture(&block)
+      elsif form.object.textcaptcha_answer
+        captcha_html += form.hidden_field(:textcaptcha_answer)
+      end
       captcha_html.html_safe
     end
   end

data/lib/acts_as_textcaptcha/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTextcaptcha
-  VERSION = "4.2.0"
+  VERSION = "4.5.2"
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_textcaptcha
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.5.2
 platform: ruby
 authors:
 - Matthew Hutchinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2021-01-28 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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,21 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.3.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.3.4
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,73 +164,81 @@ 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 text-based
+    logic question captchas. Questions are fetched from Rob Tuley's
+    textcaptcha.com They can be solved easily by humans but are tough for robots
+    to crack.
 email:
 - matt@hiddenloop.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
-- ".coveralls.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
+- PULL_REQUEST_TEMPLATE.md
 - 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
+- gemfiles/rails_6.gemfile
 - lib/acts_as_textcaptcha.rb
+- lib/acts_as_textcaptcha/errors.rb
 - lib/acts_as_textcaptcha/framework/rails.rb
+- lib/acts_as_textcaptcha/railtie.rb
+- lib/acts_as_textcaptcha/tasks/textcaptcha.rake
 - 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: []
+post_install_message:
+rdoc_options:
+- "--title"
+- ActAsTextcaptcha
+- "--main"
+- README.md
+- "-ri"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.3
+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: []