README.md

Decidim::QuestionCaptcha

Question based captcha for Decidim.

Usage

QuestionCaptcha will be available as a Component for a Participatory Space.

Installation

Add this line to your application's Gemfile:

gem "decidim-question_captcha", git: "https://github.com/OpenSourcePolitics/decidim-module-question_captcha.git"
gem "acts_as_textcaptcha", "~> 4.6.0"

And then execute:

bundle

For local development, a memory store must be set:

rails dev:cache

Usage:

With custom questions:

• create an initializer: touch config/initializers/decidim_questions.rb
• Fill it with the following:

# frozen_string_literal: true

Decidim::QuestionCaptcha.configure do |config|
  config.questions = {
      en: [
          { "question" => "1+5", "answers" => "6,six" },
          { "question" => "The blue hat is what color?", "answers" => "blue" },
          { "question" => "The green hat is what color?", "answers" => "green" },
          { "question" => "The yellow hat is what color?", "answers" => "yellow" },
          { "question" => "The red hat is what color?", "answers" => "red" }

      ],
      es: [
          { "question" => "1+2", "answers" => "3,tres" },
          { "question" => "El sombrero verde es de qué color?", "answers" => "verde" }
      ],
      ca: [
          { "question" => "2+2", "answers" => "4,quatre" },
          { "question" => "El barret verd és de quin color?", "answers" => "verd" }
      ]
  }
end

• Replace the questions for the corresponding locales, if a question is missing in a locale, the default one is used.

With external questions API:

• create an initializer: touch config/initializers/decidim_questions.rb
• Fill it with the following:

# frozen_string_literal: true

Decidim::QuestionCaptcha.configure do |config|
  config.api_endpoint = "API_ENDPOINT"
end

Where API_ENDPOINT is an instance of decidim-captcha-api

further configurations:

# frozen_string_literal: true

Decidim::QuestionCaptcha.configure do |config|
  # Type: Hash
  # List of localized questions 
  config.questions = {
    en: [
      { "question" => "1+1", "answers" => "2,two" },
      { "question" => "The green hat is what color?", "answers" => "green" }
    ],
    es: [
      { "question" => "1+2", "answers" => "3,tres" },
      { "question" => "El sombrero verde es de qué color?", "answers" => "verde" }
    ],
    ca: [
      { "question" => "2+2", "answers" => "4,quatre" },
      { "question" => "El barret verd és de quin color?", "answers" => "verd" }
    ]
  }
  
  # Type: String
  # URL of a question API instance
  config.api_endpoint = "API_ENDPOINT"
  
  # Type: Boolean
  # if the text captcha should be performed or not
  config.perform_textcaptcha = true
  
  # Type: Integer
  # Expiration of the captcha between form submission
  config.expiration_time = 10
  
  # Type: Boolean
  # Raise an error if something wrong happens (Wrong API response, timeout etc...)
  config.raise_error = false
end

Contributing

See Decidim.

License

This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.