simple_audio_captcha 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b2d01e6335009965998805d8700036e77b0e4d1
+  data.tar.gz: 8c902b8cea8f550f6dccd4f4647def903fe43d5c
+SHA512:
+  metadata.gz: 6fbc38dfc9e15763f7a9db3355c761af3736ed9ea5b65310fa9e59c4f052d84a75faedcbbd00b80bfa7edd3474420bc7c9ddfa9dedea7d10883f10422ad749b2
+  data.tar.gz: 2d83043b3098d12c565ea457e436200edfd22c77ffe7a65dc1791c1a708ff6a096cf75ff2622aa81a29dc55f3da122ef38071a13a853732bc12e559b67b56138

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+*   Add rudimentary specs for the instance methods.
+
+    *Aditya Kapoor*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_audio_captcha.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Aditya Kapoor
+
+MIT License
+
+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,56 @@
+# SimpleAudioCaptcha
+
+Simple audio support for the `simple_captcha`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'simple_audio_captcha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_audio_captcha
+
+## Usage
+
+Use ```rails g simple_audio_captcha [templatetype]``` to generate the default template with audio support and overwrite the existing simple captcha template.
+
+Simple Captcha Audio Utilises Espeak to produce audio. The Espeak configuration for voice, pitch and speed can be added to simple captcha:
+
+```
+SimpleCaptcha.setup do |simple_captcha|
+  simple_captcha.voice = 'en'
+  simple_captcha.speed = 100
+  simple_captcha.pitch = 100
+end
+```
+
+See espeak documentation for further details for these parameters.
+
+## Requirements
+* Ruby >= 1.9.3
+* Rails >= 3.2
+* You need to install `espeak` and `lame` system libraries which would help you in the text to speech conversion and exporting the audio to the `mp3` format.
+
+You can install them on OSX from homebrew:
+
+```
+brew install espeak lame
+```
+
+or on a linux based system from your package manager.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_audio_captcha/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/simple_audio_captcha_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+class SimpleAudioCaptchaGenerator < Rails::Generators::Base
+  argument :template_format, :type => :string, :default => 'erb'
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates/'))
+  end
+
+  def create_partial
+    template "partial.#{template_format}", File.join('app/views', 'simple_captcha', "_simple_captcha.#{template_format}")
+  end
+end

data/lib/generators/templates/partial.erb

@@ -0,0 +1,45 @@
+<style type="text/css">
+  .simple_captcha{border: 1px solid #ccc; padding: 5px !important;}
+  .simple_captcha,
+  .simple_captcha div{display: table;}
+  .simple_captcha .simple_captcha_field,
+  .simple_captcha .simple_captcha_image{
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  .simple_captcha .simple_captcha_image img{
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  .simple_captcha .simple_captcha_label{font-size: 12px;}
+  .simple_captcha .simple_captcha_field input{
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+</style>
+
+<div class='simple_captcha'>
+  <div class='simple_captcha_image'>
+    <%%= simple_captcha_options[:image] %>
+  </div>
+
+  <div class='simple_audio_captcha'>
+    <%%= simple_captcha_options[:audio] %>
+  </div>
+
+  <div class='simple_captcha_field'>
+    <%%= simple_captcha_options[:field] %>
+  </div>
+
+  <div class='simple_captcha_label'>
+    <%%= simple_captcha_options[:label] %>
+  </div>
+
+  <div class='simple_captcha_refresh_button'>
+    <%%= simple_captcha_options[:refresh_button] %>
+  </div>
+</div>

data/lib/generators/templates/partial.haml

@@ -0,0 +1,29 @@
+:css
+  .simple_captcha{border: 1px solid #ccc; padding: 5px !important;}
+  .simple_captcha,
+  .simple_captcha div{display: table;}
+  .simple_captcha .simple_captcha_field,
+  .simple_captcha .simple_captcha_image{
+    border: 1px solid #ccc;
+    margin: 0px 0px 2px 0px !important;
+    padding: 0px !important;
+  }
+  .simple_captcha .simple_captcha_image img{
+    margin: 0px !important;
+    padding: 0px !important;
+    width: 110px !important;
+  }
+  .simple_captcha .simple_captcha_label{font-size: 12px;}
+  .simple_captcha .simple_captcha_field input{
+    width: 150px !important;
+    font-size: 16px;
+    border: none;
+    background-color: #efefef;
+  }
+
+.simple_captcha
+  .simple_captcha_image= simple_captcha_options[:image]
+  .simple_audio_captcha= simple_captcha_options[:audio]
+  .simple_captcha_field= simple_captcha_options[:field]
+  .simple_captcha_label= simple_captcha_options[:label]
+  .simple_captcha_refresh_button= simple_captcha_options[:refresh_button]

data/lib/simple_audio_captcha.rb

@@ -0,0 +1,19 @@
+require 'simple_audio_captcha/version'
+
+module SimpleCaptcha
+  autoload :AudioHelpers, 'simple_audio_captcha/audio_helpers'
+
+  # Espeak Configuration
+  mattr_accessor :voice
+  @@voice = 'en'
+
+  mattr_accessor :pitch
+  @@pitch = 50
+
+  mattr_accessor :speed
+  @@speed = 170
+
+end
+
+require 'simple_audio_captcha/middleware'
+require 'simple_audio_captcha/view'

data/lib/simple_audio_captcha/audio_helpers.rb

@@ -0,0 +1,25 @@
+require 'espeak'
+
+module SimpleCaptcha
+  module AudioHelpers
+    include ESpeak
+
+    def generate_simple_audio_captcha(simple_captcha_key)
+      captcha_value = Utils::simple_captcha_value(simple_captcha_key)
+      make_audio_from_captcha(captcha_value)
+    end
+
+    def make_audio_from_captcha(captcha_str)
+      audio = make_audio_from_char(captcha_str.chars.first)
+      captcha_str.chars.drop(1).inject(audio) { |audio_accumalator, char| audio_accumalator << make_audio_from_char(char) }
+    end
+
+    def make_audio_from_char(char)
+      Speech.new(char,
+                 voice: SimpleCaptcha.voice,
+                 pitch: SimpleCaptcha.pitch,
+                 speed: SimpleCaptcha.speed).bytes.force_encoding('ASCII-8BIT')
+    end
+
+  end
+end

data/lib/simple_audio_captcha/middleware.rb

@@ -0,0 +1,69 @@
+module SimpleCaptcha
+  class Middleware
+    include SimpleCaptcha::AudioHelpers
+
+    def call(env) # :nodoc:
+      if env["REQUEST_METHOD"] == "GET" && captcha_path?(env['PATH_INFO'])
+        request = Rack::Request.new(env)
+        if request.params.present? && request.params['code'].present?
+          if request.params['audio'] && request.params['audio'].eql?('true')
+            make_audio(env)
+          else
+            make_image(env)
+          end
+        else
+          refresh_code(env)
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    protected
+      def make_audio(env, headers = {}, status = 404)
+        request = Rack::Request.new(env)
+        code = request.params["code"]
+        body = []
+
+        if Utils::simple_captcha_value(code)
+          #status, headers, body = @app.call(env)
+          #status = 200
+          #body = generate_simple_audio_captcha(code)
+          #headers['Content-Type'] = 'audio/mpeg3'
+          send_data(generate_simple_audio_captcha(code), type: 'audio/mpeg3', disposition: 'inline', filename: 'simple_audio_captcha.mp3', stream: 'true', buffer_size: '4096')
+        else
+          [status, headers, body]
+        end
+      end
+
+      def refresh_code(env)
+        request = Rack::Request.new(env)
+
+        request.session.delete :captcha
+        key = simple_captcha_key(nil, request)
+        options = {}
+        options[:field_value] = set_simple_captcha_data(key, options)
+        url = simple_captcha_image_url(key, options)
+
+        status = 200
+        id = request.params['id']
+        captcha_hidden_field_id = simple_captch_hidden_field_id(id)
+
+        audio_id = generate_audio_id(id)
+        audio_url = simple_audio_captcha_url(key, options)
+
+        body = %Q{
+                    $("##{id}").attr('src', '#{url}');
+                    $("##{audio_id}").attr('src', '#{audio_url}')
+                    $("##{ captcha_hidden_field_id }").attr('value', '#{key}');
+                  }
+        headers = {'Content-Type' => 'text/javascript; charset=utf-8', "Content-Disposition" => "inline; filename='captcha.js'", "Content-Length" => body.length.to_s}.merge(SimpleCaptcha.extra_response_headers)
+        [status, headers, [body]]
+      end
+
+      def generate_audio_id(id)
+        return '' if id.nil?
+        id.gsub('simple_captcha', simple_captcha_id_prefix)
+      end
+  end
+end

data/lib/simple_audio_captcha/version.rb

@@ -0,0 +1,3 @@
+module SimpleAudioCaptcha
+  VERSION = "1.0.0"
+end

data/lib/simple_audio_captcha/view.rb

@@ -0,0 +1,41 @@
+module SimpleCaptcha
+  module ViewHelper
+    # TODO: Devise some way to use super here..
+    alias_method :__simple_captcha_options__, :simple_captcha_options
+
+    def simple_captcha_options(options = {})
+      super_options = __simple_captcha_options__(options)
+
+      key = super_options[:field_value]
+
+      super_options.merge({
+        audio: simple_audio_captcha(key, options)
+      })
+    end
+
+    private
+      def simple_audio_captcha(simple_captcha_key, options = {})
+        url = simple_audio_captcha_url simple_captcha_key, options
+        id  = simple_audio_captcha_id(options)
+        tag('audio', :src => url, :id => id, controls: true)
+      end
+
+      def simple_audio_captcha_url(simple_captcha_key, options = {})
+        defaults = {}
+        defaults[:time] = options[:time] || Time.now.to_i
+
+        query = defaults.to_query
+        path = "/simple_captcha?code=#{simple_captcha_key}&#{query}&audio=true"
+
+        build_url(options, path)
+      end
+
+      def simple_audio_captcha_id(options={})
+        "#{ simple_captcha_id_prefix }-#{options[:field_value][0..10]}"
+      end
+
+      def simple_captcha_id_prefix
+        "simple_captcha-audio"
+      end
+  end
+end

data/lib/tasks/clean.rake

@@ -0,0 +1,6 @@
+namespace :simple_audio_captcha do
+  desc 'Clears the temporary created .mp3 files.'
+  task clear: :environment do
+    puts "Hello world."
+  end
+end

data/simple_audio_captcha.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_audio_captcha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_audio_captcha"
+  spec.version       = SimpleAudioCaptcha::VERSION
+  spec.authors       = ["Aditya Kapoor, Nimish Mehta"]
+  spec.email         = ["adityakapoor.mait@gmail.com", "nimish@vinsol.com"]
+  spec.summary       = "Simple Audio Extension to Simple Captcha"
+  spec.description   = "adds audio support to simple captcha"
+  spec.homepage      = "https://github.com/vinsol/simple-audio-captcha"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.add_development_dependency "bundler", '~> 1.6'
+  spec.add_development_dependency "rake",    '~> 10.0'
+  spec.add_development_dependency "rspec",   '~> 3.3.0'
+  spec.add_dependency "simple_captcha2",     '~> 0.3.4'
+  spec.add_dependency "espeak-ruby",         '~> 1.0.2'
+end

data/spec/audio_helpers_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'simple_captcha/utils'
+require 'simple_audio_captcha/audio_helpers'
+
+class TestAudioHelper
+  include SimpleCaptcha::AudioHelpers
+end
+
+describe SimpleCaptcha::AudioHelpers do
+  let(:audio_helper_object) { TestAudioHelper.new }
+
+  context 'Constants' do
+    it { expect(SimpleCaptcha::AudioHelpers::TMP_FILES_PATH).to eq 'tmp/simple_captcha' }
+  end
+
+  context 'Instance Methods' do
+    context '#generate_simple_audio_captcha' do
+      pending 'TODO: Write without too much mocks and stubs.'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/view_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'active_support/core_ext/hash'
+require 'action_view'
+require 'simple_captcha/view'
+require 'simple_audio_captcha'
+
+class TestView < ActionView::Base
+  include SimpleCaptcha::ViewHelper
+end
+
+describe SimpleCaptcha::ViewHelper do
+  let(:view_helper_object) { TestView.new }
+  let(:field_value)        { '1234567890' }
+  let(:now)                { 1440753157 }
+
+	context 'Instance Methods' do
+    context 'simple_captcha_options' do
+      before do
+        expect(view_helper_object).to receive(:__simple_captcha_options__).and_return({})
+        allow(Time.now).to receive(:to_i).and_return(1440753157)
+      end
+      it { expect(view_helper_object.simple_captcha_options(field_value: field_value).keys).to include :audio }
+      it 'generates html audio tag' do
+        expect(view_helper_object.simple_captcha_options(field_value: field_value)[:audio].to_str.start_with?('<audio')).to eq(true)
+      end
+    end
+
+    context '#simple_audio_captcha_id' do
+      it { expect(view_helper_object.send(:simple_audio_captcha_id, field_value: field_value)).to eq "simple_captcha-audio-#{ field_value }" }
+    end
+
+    context '#simple_captcha_id_prefix' do
+      it { expect(view_helper_object.send(:simple_captcha_id_prefix)).to eq 'simple_captcha-audio' }
+    end
+
+    context '#simple_audio_captcha_url' do
+      it { expect(view_helper_object.send(:simple_audio_captcha_url, 'some_dummy_id', time: now)).to eq "/simple_captcha?code=some_dummy_id&time=#{ now }&audio=true" }
+    end
+
+    context '#simple_audio_captcha' do
+      it {
+        expect(view_helper_object.send(:simple_audio_captcha, 'some_dummy_id', time: now, field_value: field_value))
+          .to eq "<audio controls=\"controls\" id=\"simple_captcha-audio-1234567890\" src=\"/simple_captcha?code=some_dummy_id&amp;time=#{ now }&amp;audio=true\" />"
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: simple_audio_captcha
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aditya Kapoor, Nimish Mehta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: simple_captcha2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: espeak-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: adds audio support to simple captcha
+email:
+- adityakapoor.mait@gmail.com
+- nimish@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_audio_captcha_generator.rb
+- lib/generators/templates/partial.erb
+- lib/generators/templates/partial.haml
+- lib/simple_audio_captcha.rb
+- lib/simple_audio_captcha/audio_helpers.rb
+- lib/simple_audio_captcha/middleware.rb
+- lib/simple_audio_captcha/version.rb
+- lib/simple_audio_captcha/view.rb
+- lib/tasks/clean.rake
+- simple_audio_captcha.gemspec
+- spec/audio_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/view_spec.rb
+homepage: https://github.com/vinsol/simple-audio-captcha
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Simple Audio Extension to Simple Captcha
+test_files:
+- spec/audio_helpers_spec.rb
+- spec/spec_helper.rb
+- spec/view_spec.rb
+has_rdoc: