kandr-easy_captcha 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4731d62f91a4a804c690b30a493cf074e34751543049631b5298ef675e1216c
+  data.tar.gz: '055049676e7c65dedd644969e72ecf6500cfbc144e2177c8f4725b16d42eb86b'
+SHA512:
+  metadata.gz: 4d8f84fa675cde65fd4ec50f213be9f869bf53a21b4c4a809f87d232a42cab9fc1b418e138d5a32d62a69fefbe3b52f53a8a0140b8025106bc23cdee76f0a855
+  data.tar.gz: bc33b0c978c9a3ea507c12a6ec1fd86fb96fe9f4f9ee772a41a875075a60740ad81873002956d3beebfabcd96b98b84342af62192f778c2e94ff56d3770d86d4

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Marco Scholl
+
+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/README.md

@@ -0,0 +1,179 @@
+= EasyCAPTCHA
+
+A simple captcha implementation for Rails 5+ based on RMagick.
+
+This (`kandr-easy_captcha`) is a fork of [EasyCaptcha](https://github.com/phatworx/easy_captcha) (`easy_captcha`) with Rails 5+ support. This fork is maintained by Karl Wilbur/K&R Software (karl@kandrsoftware.com).
+
+== Dependencies
+
+RMagick should be included in your `Gemfile`
+
+```
+  gem 'rmagick'
+```
+
+for Java/JRuby you can use
+
+```ruby
+  gem 'rmagick4j'
+```
+
+== Installation
+
+add to Gemfile
+
+```ruby
+  gem 'kandr-easy_captcha', require: 'easy_captcha'
+```
+
+after running `bundle install`, execute
+
+```bash
+  rails g easy_captcha:install
+```
+
+== Configuration
+
+You can configure `easy_captcha` in `config/initializers/easy_captcha.rb`, if you want to customize the default configuration
+
+```ruby
+  EasyCaptcha.setup do |config|
+    # Cache
+    # config.cache          = true
+    # Cache temp dir from Rails.root
+    # config.cache_temp_dir = Rails.root.join('tmp', 'captchas')
+    # Cache size
+    # config.cache_size     = 500
+    # Cache expire
+    # config.cache_expire   = 1.day
+
+    # Chars
+    # config.chars          = %w(2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z)
+
+    # Length
+    # config.length         = 6
+
+    # Image
+    # config.image_height   = 40
+    # config.image_width    = 140
+
+    # eSpeak (default disabled)
+    # config.espeak do |espeak|
+      # Amplitude, 0 to 200
+      # espeak.amplitude = 80..120
+
+      # Word gap. Pause between words
+      # espeak.gap = 80
+
+      # Pitch adjustment, 0 to 99
+      # espeak.pitch = 30..70
+
+      # Use voice file of this name from espeak-data/voices
+      # espeak.voice = nil
+    # end
+
+    # configure generator
+    # config.generator :default do |generator|
+
+      # Font
+      # generator.font_size              = 24
+      # generator.font_fill_color        = '#333333'
+      # generator.font_stroke_color      = '#000000'
+      # generator.font_stroke            = 0
+      # generator.font                   = File.expand_path('../../resources/afont.ttf', __FILE__)
+
+
+      # Background color
+      # generator.image_background_color = "#FFFFFF"
+      # Or background image (e.g. transparent png)
+      # generator.background_image       = File.expand_path('../../resources/captcha_bg.png', __FILE__)
+
+      # Wave
+      # generator.wave                   = true
+      # generator.wave_length            = (60..100)
+      # generator.wave_amplitude         = (3..5)
+
+      # Sketch
+      # generator.sketch                 = true
+      # generator.sketch_radius          = 3
+      # generator.sketch_sigma           = 1
+
+      # Implode
+      # generator.implode                = 0.1
+
+      # Blur
+      # generator.blur                   = true
+      # generator.blur_radius            = 1
+      # generator.blur_sigma             = 2
+    # end
+  end
+```
+
+== Caching
+
+It is strongly recommended to enable caching. You can see the three paramters which you have to fill in your config file below.
+
+```ruby
+  EasyCaptcha.setup do |config|
+    # Cache
+    config.cache          = true
+    # Cache temp dir from Rails.root
+    config.cache_temp_dir = Rails.root.join('tmp', 'captchas')
+    # Cache expire
+    config.cache_expire   = 1.day
+    # Cache size
+    # config.cache_size     = 500
+  end
+```
+
+== Requirements
+
+* RMagick
+* Rails 3 (http://github.com/rails/rails)
+
+== Example
+
+```ruby
+  <% form_tag '/' do %>
+    <% if request.post? %>
+      <p><%= valid_captcha?(params[:captcha]) ? 'valid' : 'invalid' %> captcha</p>
+    <% end %>
+    <p><%= captcha_tag %></p>
+    <p><%= text_field_tag :captcha %></p>
+    <p><%= submit_tag 'Validate' %></p>
+  <% end %>
+```
+
+== Example app
+
+You find an example app under: http://github.com/phatworx/easy_captcha_example
+
+== History
+
+* 0.1 init
+* 0.2 cache support for high frequented sites
+* 0.3 use generators, optimizations, update licence to same of all my plugins
+* 0.4 generator support
+* 0.5 (transparent) background support
+* 0.6 espeak support for barrier-free support
+
+== Maintainers
+
+* Team Phatworx (http://github.com/phatworx)
+* Marco Scholl (http://github.com/traxanos)
+* Alexander Dreher (http://github.com/alexdreher)
+* Christoph Chilian (http://github.com/cc-web)
+
+== Contributing to EasyCaptcha
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Marco Scholl. See LICENSE.txt for further details.

data/spec/easy_captcha/espeak_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+RSpec.describe EasyCaptcha::Espeak do
+  context 'with default values' do
+    subject(:captcha) { described_class.new }
+
+    let(:amplitude_range) { 80..120 }
+    let(:pitch_range) { 30..70 }
+
+    specify(:amplitude) { expect(amplitude_range).to include(captcha.amplitude) }
+    specify(:pitch) { expect(pitch_range).to include(captcha.pitch) }
+    specify(:gap) { expect(captcha.gap).to eq 80 }
+    specify(:voice) { expect(captcha.voice).to be_nil }
+  end
+
+  context 'with config: voices' do
+    subject(:captcha) do
+      described_class.new do |config|
+        config.voice = voices
+      end
+    end
+
+    let(:voices) { ['german', 'german+m1'] }
+
+    specify { expect(voices).to include(captcha.voice) }
+  end
+end

data/spec/easy_captcha/routing_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+module EasyCaptchaTestApp
+  class TestApp < ::Rails::Application
+  end
+
+  TestApp.routes.draw do
+    captcha_route
+  end
+end
+
+RSpec.describe EasyCaptcha::CaptchaController, type: :routing do
+  routes { EasyCaptchaTestApp::TestApp.routes }
+  let(:routeset) { EasyCaptchaTestApp::TestApp.routes }
+  let(:captcha_request) { { get: '/captcha' } }
+
+  it 'has added a route' do
+    expect(routeset.routes.count).to eq 1
+  end
+
+  it 'has added a named route' do
+    expect(routeset.named_routes.count).to eq 1
+  end
+
+  it 'has added a named `:captcha` route' do
+    expect(routeset.named_routes.first.second.name).to eq 'captcha'
+  end
+
+  it 'makes `/captcha` URL routable' do
+    expect(captcha_request).to be_routable
+  end
+
+  it 'has `/captcha` URL handled by `easy_captcha/captcha_controller#captcha`' do
+    expect(captcha_request).to route_to(
+      controller: 'easy_captcha/captcha',
+      action: 'captcha'
+    )
+  end
+end

data/spec/easy_captcha_spec.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
+
+describe EasyCaptcha do
+  describe '#setup' do
+    described_class.setup do |config|
+      # Cache
+      config.cache = false
+
+      # Chars
+      config.captcha_character_pool = %w[2 3 4 5 6 7 9 A C D E F G H J K L M N P Q R S T U X Y Z]
+
+      # Image
+      config.captcha_image_height = 40
+      config.captcha_image_width = 140
+
+      # Length
+      config.captcha_character_count = 6
+
+      # configure generator
+      config.generator :default do |generator|
+        # Blur
+        generator.blur = true
+        generator.blur_radius = 1
+        generator.blur_sigma = 2
+
+        # Font
+        generator.font_size = 24
+        generator.font_fill_color = '#333333'
+        generator.font_stroke_color = '#000000'
+        generator.font_stroke = 0
+        generator.font_family = File.expand_path('../resources/afont.ttf', __dir__)
+
+        # Image background
+        generator.image_background_color = '#FFFFFF'
+
+        # Implode
+        generator.implode = 0.1
+
+        # Sketch
+        generator.sketch = true
+        generator.sketch_radius = 3
+        generator.sketch_sigma = 1
+
+        # Wave
+        generator.wave = true
+        generator.wave_length = (60..100)
+        generator.wave_amplitude = (3..5)
+      end
+    end
+
+    it 'does not cache' do
+      expect(described_class).not_to be_cache
+    end
+
+    it 'has default generator' do
+      expect(described_class.generator).to be_an(EasyCaptcha::Generator::Default)
+    end
+
+    describe '#depracations' do
+      let(:config_methods) do
+        %i[
+          blur
+          blur_radius
+          blur_sigma
+          font_family
+          font_fill_color
+          font_size
+          font_stroke
+          font_stroke_color
+          image_background_color
+          implode
+          sketch
+          sketch_radius
+          sketch_sigma
+          wave
+          wave_amplitude
+          wave_length
+        ]
+      end
+
+      before do
+        described_class.setup do |config|
+          # Image
+          config.captcha_image_height = 40
+          config.captcha_image_width = 140
+
+          # Length
+          config.captcha_character_count = 6
+
+          config.generator :default do |generator|
+            # Blur
+            generator.blur = true
+            generator.blur_radius = 1
+            generator.blur_sigma = 2
+
+            # Font
+            generator.font_size = 24
+            generator.font_fill_color = '#333333'
+            generator.font_stroke_color = '#000000'
+            generator.font_stroke = 0
+            generator.font_family = File.expand_path('../resources/afont.ttf', __dir__)
+
+            # Image background
+            generator.image_background_color = '#FFFFFF'
+
+            # Implode
+            generator.implode = 0.1
+
+            # Sketch
+            generator.sketch = true
+            generator.sketch_radius = 3
+            generator.sketch_sigma = 1
+
+            # Wave
+            generator.wave = true
+            generator.wave_length = (60..100)
+            generator.wave_amplitude = (3..5)
+          end
+        end
+      end
+
+      it 'returns non-nil for config methods' do
+        config_methods.each do |opt|
+          expect(described_class.generator.send(opt)).not_to be_nil
+        end
+      end
+
+      it 'raises NoMethodError on missing non-depracations' do
+        expect { described_class.send(EasyCaptcha::DEPRECATED_METHODS.first) }.not_to raise_error(NoMethodError)
+      end
+
+      it 'does not raise NoMethodError on depracations' do
+        expect { described_class.send(:a_missing_method) }.to raise_error(NoMethodError)
+      end
+
+      it 'does not respond_to? depracations' do
+        expect(described_class).not_to respond_to(EasyCaptcha::DEPRECATED_METHODS.first)
+      end
+
+      it 'does not respond_to? missing non-depracations' do
+        expect(described_class).not_to respond_to(:a_missing_method)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start 'rails'
+# require 'rails/all'
+require 'action_controller'
+require 'action_dispatch'
+require 'action_view'
+require 'rspec/rails'
+require 'easy_captcha'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: kandr-easy_captcha
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Marco Scholl
+- Alexander Dreher
+- Karl Wilbur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+description: A simple CAPTCHA implementation for Rails 5+ based on RMagick.
+email: karl@kandrsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- spec/easy_captcha/espeak_spec.rb
+- spec/easy_captcha/routing_spec.rb
+- spec/easy_captcha_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/K-and-R/easy_captcha
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: CAPTCHA Plugin for Rails
+test_files:
+- spec/easy_captcha/espeak_spec.rb
+- spec/easy_captcha/routing_spec.rb
+- spec/easy_captcha_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb