propagate 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+rdoc
+pkg
+Gemfile.lock

data/CHANGELOG

@@ -0,0 +1,28 @@
+== 0.3.4 / 2011-12-13
+
+* Rails 3
+* Remove jeweler
+
+== 0.2.2 / 2009-09-14
+
+* Add a timeout to the validator
+* Give the documentation some love
+
+== 0.2.1 / 2009-09-14
+
+* Removed Ambethia namespace, and restructured classes a bit
+* Added an example rails app in the example-rails branch
+
+== 0.2.0 / 2009-09-12
+
+* RecaptchaOptions AJAX API Fix
+* Added 'cucumber' as a test environment to skip
+* Ruby 1.9 compat fixes
+* Added option :message => 'Custom error message' to verify_recaptcha
+* Removed dependency on ActiveRecord constant
+* Add I18n
+
+== 0.1.0 / 2008-2-8
+
+* 1 major enhancement
+	* Initial Gem Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Jason L Perry
+
+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

@@ -0,0 +1,7 @@
+Propagate
+=========
+
+This plugin allows for easy insertion of Propagate into your Ruby site. This is
+an adaptation of Jason L Perry's plugin for Recaptcha, which can be found at
+http://github.com/ambethia/recaptcha/tree/master
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new :test do |test|
+  test.libs << "lib"
+  test.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,5 @@
+# Rails plugin initialization.
+# You can also install it as a gem:
+#   config.gem "propagate", :lib => "propagate/rails", :source => "http://gems.github.com"
+
+require 'propagate/rails'

data/lib/propagate.rb

@@ -0,0 +1,49 @@
+require 'propagate/configuration'
+require 'propagate/client_helper'
+require 'propagate/verify'
+
+module Propagate
+  PROPAGATE_API_SERVER_URL        = 'http://nakeit.propagate.com.br'
+  PROPAGATE_API_SECURE_SERVER_URL = 'https://nakeit.propagate.com.br'
+  PROPAGATE_VERIFY_URL            = 'http://nakeit.propagate.com.br'
+
+  HANDLE_TIMEOUTS_GRACEFULLY      = true
+  SKIP_VERIFY_ENV = ['test', 'cucumber']
+
+  # Gives access to the current Configuration.
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Allows easy setting of multiple configuration options. See Configuration
+  # for all available options.
+  #--
+  # The temp assignment is only used to get a nicer rdoc. Feel free to remove
+  # this hack.
+  #++
+  def self.configure
+    config = configuration
+    yield(config)
+  end
+
+  def self.with_configuration(config)
+    original_config = {}
+
+    config.each do |key, value|
+      original_config[key] = configuration.send(key)
+      configuration.send("#{key}=", value)
+    end
+
+    result = yield if block_given?
+
+    original_config.each { |key, value| configuration.send("#{key}=", value) }
+    result
+  end
+
+  class PropagateError < StandardError
+  end
+end
+
+if defined?(Rails)
+  require 'propagate/rails'
+end

data/lib/propagate/client_helper.rb

@@ -0,0 +1,20 @@
+module Propagate
+  module ClientHelper
+    # Your public API can be specified in the +options+ hash or preferably
+    # using the Configuration.
+    def propagate_tags(options = {})
+      # Default options
+      key   = options[:public_key] ||= Propagate.configuration.public_key
+      raise PropagateError, "No public key specified." unless key
+      error = options[:error] ||= (defined? flash ? flash[:propagate_error] : "")
+      uri   = Propagate.configuration.api_server_url(options[:ssl])
+      html  = ""
+
+
+      html << %{<script type="text/javascript" src="#{uri}/site/#{key}/session/?}
+      html << %{#{error ? "&amp;error=#{CGI::escape(error)}" : ""}"></script>\n}
+
+      return (html.respond_to?(:html_safe) && html.html_safe) || html
+    end # propagate_tags
+  end # ClientHelper
+end # Propagate

data/lib/propagate/configuration.rb

@@ -0,0 +1,55 @@
+module Propagate
+  # This class enables detailed configuration of the propagate services.
+  #
+  # By calling
+  #
+  #   Propagate.configuration # => instance of Propagate::Configuration
+  #
+  # or
+  #   Propagate.configure do |config|
+  #     config # => instance of Propagate::Configuration
+  #   end
+  #
+  # you are able to perform configuration updates.
+  #
+  # Your are able to customize all attributes listed below. All values have
+  # sensitive default and will very likely not need to be changed.
+  #
+  # Please note that the public and private key for the Propagate API Access
+  # have no useful default value. The keys may be set via the Shell enviroment
+  # or using this configuration. Settings within this configuration always take
+  # precedence.
+  #
+  # Setting the keys with this Configuration
+  #
+  #   Propagate.configure do |config|
+  #     config.public_key  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
+  #     config.private_key = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
+  #   end
+  #
+  class Configuration
+    attr_accessor :nonssl_api_server_url,
+                  :ssl_api_server_url,
+                  :verify_url,
+                  :skip_verify_env,
+                  :private_key,
+                  :public_key,
+                  :proxy,
+                  :handle_timeouts_gracefully
+
+    def initialize #:nodoc:
+      @nonssl_api_server_url      = PROPAGATE_API_SERVER_URL
+      @ssl_api_server_url         = PROPAGATE_API_SECURE_SERVER_URL
+      @verify_url                 = PROPAGATE_VERIFY_URL
+      @skip_verify_env            = SKIP_VERIFY_ENV
+      @handle_timeouts_gracefully = HANDLE_TIMEOUTS_GRACEFULLY
+
+      @private_key           = ENV['PROPAGATE_PRIVATE_KEY']
+      @public_key            = ENV['PROPAGATE_PUBLIC_KEY']
+    end
+
+    def api_server_url(ssl = false) #:nodoc:
+      ssl ? ssl_api_server_url : nonssl_api_server_url
+    end
+  end
+end

data/lib/propagate/merb.rb

@@ -0,0 +1,4 @@
+require 'propagate'
+
+Merb::GlobalHelpers.send(:include, Propagate::ClientHelper)
+Merb::Controller.send(:include, Propagate::Verify)

data/lib/propagate/rails.rb

@@ -0,0 +1,5 @@
+require 'net/http'
+require 'propagate'
+
+ActionView::Base.send(:include, Propagate::ClientHelper)
+ActionController::Base.send(:include, Propagate::Verify)

data/lib/propagate/railtie.rb

@@ -0,0 +1,15 @@
+require 'net/http'
+require 'propagate'
+module Rails
+  module Propagate
+    class Railtie < Rails::Railtie
+      initializer "setup config" do
+        begin
+          ActionView::Base.send(:include, ::Propagate::ClientHelper)
+          ActionController::Base.send(:include, ::Propagate::Verify)
+        end
+      end
+    end
+  end
+end
+

data/lib/propagate/verify.rb

@@ -0,0 +1,78 @@
+require "uri"
+module Propagate
+  module Verify
+    # Your private API can be specified in the +options+ hash or preferably
+    # using the Configuration.
+    def verify_propagate(options = {})
+      if !options.is_a? Hash
+        options = {:model => options}
+      end
+
+      env = options[:env] || ENV['RAILS_ENV']
+      return true if Propagate.configuration.skip_verify_env.include? env
+      model = options[:model]
+      attribute = options[:attribute] || :base
+      private_key = options[:private_key] || Propagate.configuration.private_key
+      raise PropagateError, "No private key specified." unless private_key
+
+      begin
+        propagate = nil
+        if(Propagate.configuration.proxy)
+          proxy_server = URI.parse(Propagate.configuration.proxy)
+          http = Net::HTTP::Proxy(proxy_server.host, proxy_server.port, proxy_server.user, proxy_server.password)
+        else
+          http = Net::HTTP
+        end
+
+        Timeout::timeout(options[:timeout] || 3) do
+	  uri = Propagate.configuration.verify_url + '/session/' + params[:propagate_sid] + '/answer/'
+          propagate = http.post_form(URI.parse(uri), {
+            "pk" => private_key,
+            "remote_addr"   => request.remote_ip,
+            "forwarded_for" => request.env['HTTP_X_FORWARDED_FOR'] || '',
+            "user_agent"    => request.env['HTTP_USER_AGENT'],
+            "sid"           => params[:propagate_sid],
+            "answer"        => params[:propagate_challenge]
+          })
+        end
+        answer, error = propagate.body.split.map { |s| s.chomp }
+        unless answer == 'Ok'
+          flash[:propagate_error] = if defined?(I18n)
+            I18n.translate("propagate.errors.#{error}", {:default => error})
+          else
+            error
+          end
+
+          if model
+            message = "Word verification response is incorrect, please try again."
+            message = I18n.translate('propagate.errors.verification_failed', {:default => message}) if defined?(I18n)
+            model.errors.add attribute, options[:message] || message
+          end
+          return false
+        else
+          flash.delete(:propagate_error)
+          return true
+        end
+      rescue Timeout::Error
+        if Propagate.configuration.handle_timeouts_gracefully
+          flash[:propagate_error] = if defined?(I18n)
+            I18n.translate('propagate.errors.propagate_unreachable', {:default => 'Propagate unreachable.'})
+          else
+            'Propagate unreachable.'
+          end
+
+          if model
+            message = "Oops, we failed to validate your word verification response. Please try again."
+            message = I18n.translate('propagate.errors.propagate_unreachable', :default => message) if defined?(I18n)
+            model.errors.add attribute, options[:message] || message
+          end
+          return false
+        else
+          raise PropagateError, "Propagate unreachable."
+        end
+      rescue Exception => e
+        raise PropagateError, e.message, e.backtrace
+      end
+    end # verify_propagate
+  end # Verify
+end # Propagate

data/lib/propagate/version.rb

@@ -0,0 +1,3 @@
+module Propagate
+  VERSION = "0.1.0"
+end

data/propagate.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "propagate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "propagate"
+  s.version     = Propagate::VERSION
+  s.authors     = ["Propagate"]
+  s.email       = ["propagate@arcane.com.br"]
+  s.homepage    = "http://www.propagate.com.br/"
+  s.summary     = %q{Helpers for the Propagate API}
+  s.description = %q{This plugin adds helpers for the Propagate API}
+
+  s.rubyforge_project = "propagate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "i18n"
+end

data/test/propagate_test.rb

@@ -0,0 +1,52 @@
+require 'test/unit'
+require 'cgi'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/recaptcha'
+
+class RecaptchaClientHelperTest < Test::Unit::TestCase
+  include Recaptcha
+  include Recaptcha::ClientHelper
+  include Recaptcha::Verify
+
+  attr_accessor :session
+
+  def setup
+    @session = {}
+    Recaptcha.configure do |config|
+      config.public_key = '0000000000000000000000000000000000000000'
+      config.private_key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    end
+  end
+
+  def test_recaptcha_tags
+    # Might as well match something...
+    assert_match /http:\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags
+  end
+
+  def test_recaptcha_tags_with_ssl
+    assert_match /https:\/\/www.google.com\/recaptcha\/api\/challenge/, recaptcha_tags(:ssl => true)
+  end
+
+  def test_recaptcha_tags_without_noscript
+    assert_no_match /noscript/, recaptcha_tags(:noscript => false)
+  end
+
+  def test_should_raise_exception_without_public_key
+    assert_raise RecaptchaError do
+      Recaptcha.configuration.public_key = nil
+      recaptcha_tags
+    end
+  end
+
+  def test_different_configuration_within_with_configuration_block
+    key = Recaptcha.with_configuration(:public_key => '12345') do
+      Recaptcha.configuration.public_key
+    end
+
+    assert_equal('12345', key)
+  end
+
+  def test_reset_configuration_after_with_configuration_block
+    Recaptcha.with_configuration(:public_key => '12345')
+    assert_equal('0000000000000000000000000000000000000000', Recaptcha.configuration.public_key)
+  end
+end

data/test/verify_propagate_test.rb

@@ -0,0 +1,151 @@
+# coding: utf-8
+
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_support/core_ext/string'
+require 'mocha'
+require 'i18n'
+require 'net/http'
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/recaptcha'
+
+class RecaptchaVerifyTest < Test::Unit::TestCase
+  def setup
+    Recaptcha.configuration.private_key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+    @controller = TestController.new
+    @controller.request = stub(:remote_ip => "1.1.1.1")
+    @controller.params = {:recaptcha_challenge_field => "challenge", :recaptcha_response_field => "response"}
+
+    @expected_post_data = {}
+    @expected_post_data["privatekey"] = Recaptcha.configuration.private_key
+    @expected_post_data["remoteip"]   = @controller.request.remote_ip
+    @expected_post_data["challenge"]  = "challenge"
+    @expected_post_data["response"]   = "response"
+
+    @expected_uri = URI.parse(Recaptcha.configuration.verify_url)
+  end
+
+  def test_should_raise_exception_without_private_key
+    assert_raise Recaptcha::RecaptchaError do
+      Recaptcha.configuration.private_key = nil
+      @controller.verify_recaptcha
+    end
+  end
+
+  def test_should_return_false_when_key_is_invalid
+    expect_http_post(response_with_body("false\ninvalid-site-private-key"))
+
+    assert !@controller.verify_recaptcha
+    assert_equal "invalid-site-private-key", @controller.flash[:recaptcha_error]
+  end
+
+  def test_returns_true_on_success
+    @controller.flash[:recaptcha_error] = "previous error that should be cleared"
+    expect_http_post(response_with_body("true\n"))
+
+    assert @controller.verify_recaptcha
+    assert_nil @controller.flash[:recaptcha_error]
+  end
+
+  def test_errors_should_be_added_to_model
+    expect_http_post(response_with_body("false\nbad-news"))
+
+    errors = mock
+    errors.expects(:add).with(:base, "Word verification response is incorrect, please try again.")
+    model = mock(:errors => errors)
+
+    assert !@controller.verify_recaptcha(:model => model)
+    assert_equal "bad-news", @controller.flash[:recaptcha_error]
+  end
+
+  def test_returns_true_on_success_with_optional_key
+    @controller.flash[:recaptcha_error] = "previous error that should be cleared"
+    # reset private key
+    @expected_post_data["privatekey"] =  'ADIFFERENTPRIVATEKEYXXXXXXXXXXXXXX'
+    expect_http_post(response_with_body("true\n"))
+
+    assert @controller.verify_recaptcha(:private_key => 'ADIFFERENTPRIVATEKEYXXXXXXXXXXXXXX')
+    assert_nil @controller.flash[:recaptcha_error]
+  end
+
+  def test_timeout
+    expect_http_post(Timeout::Error, :exception => true)
+    assert !@controller.verify_recaptcha()
+    assert_equal "Recaptcha unreachable.", @controller.flash[:recaptcha_error]
+  end
+
+  def test_timeout_when_handle_timeouts_gracefully_disabled
+    Recaptcha.with_configuration(:handle_timeouts_gracefully => false) do
+      expect_http_post(Timeout::Error, :exception => true)
+      assert_raise Recaptcha::RecaptchaError, "Recaptcha unreachable." do
+        assert @controller.verify_recaptcha()
+      end
+      assert_nil @controller.flash[:recaptcha_error]
+    end
+  end
+
+  def test_message_should_use_i18n
+    I18n.locale = :de
+    verification_failed_translated   = "Sicherheitscode konnte nicht verifiziert werden."
+    verification_failed_default      = "Word verification response is incorrect, please try again."
+    recaptcha_unreachable_translated = "Netzwerkfehler, bitte versuchen Sie es später erneut."
+    recaptcha_unreachable_default    = "Oops, we failed to validate your word verification response. Please try again."
+
+    I18n.expects(:translate).with('recaptcha.errors.bad-news', {:default => 'bad-news'})
+    I18n.expects(:translate).with('recaptcha.errors.recaptcha_unreachable', {:default => 'Recaptcha unreachable.'})
+
+    I18n.expects(:translate).with('recaptcha.errors.verification_failed', :default => verification_failed_default).returns(verification_failed_translated)
+    I18n.expects(:translate).with('recaptcha.errors.recaptcha_unreachable', :default => recaptcha_unreachable_default).returns(recaptcha_unreachable_translated)
+
+    errors = mock
+    errors.expects(:add).with(:base, verification_failed_translated)
+    errors.expects(:add).with(:base, recaptcha_unreachable_translated)
+    model  = mock; model.stubs(:errors => errors)
+
+    expect_http_post(response_with_body("false\nbad-news"))
+    @controller.verify_recaptcha(:model => model)
+
+    expect_http_post(Timeout::Error, :exception => true)
+    @controller.verify_recaptcha(:model => model)
+
+  end
+
+  def test_it_translates_api_response_with_i18n
+    api_error_translated = "Bad news, body :("
+    expect_http_post(response_with_body("false\nbad-news"))
+    I18n.expects(:translate).with('recaptcha.errors.bad-news', :default => 'bad-news').returns(api_error_translated)
+
+    assert !@controller.verify_recaptcha
+    assert_equal api_error_translated, @controller.flash[:recaptcha_error]
+  end
+
+  def test_it_fallback_to_api_response_if_i18n_translation_is_missing
+    expect_http_post(response_with_body("false\nbad-news"))
+
+    assert !@controller.verify_recaptcha
+    assert_equal 'bad-news', @controller.flash[:recaptcha_error]
+  end
+
+  private
+
+  class TestController
+    include Recaptcha::Verify
+    attr_accessor :request, :params, :flash
+
+    def initialize
+      @flash = {}
+    end
+  end
+
+  def expect_http_post(response, options = {})
+    unless options[:exception]
+      Net::HTTP.expects(:post_form).with(@expected_uri, @expected_post_data).returns(response)
+    else
+      Net::HTTP.expects(:post_form).raises response
+    end
+  end
+
+  def response_with_body(body)
+    stub(:body => body)
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: propagate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Propagate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: This plugin adds helpers for the Propagate API
+email: 
+- propagate@arcane.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/propagate.rb
+- lib/propagate/client_helper.rb
+- lib/propagate/configuration.rb
+- lib/propagate/merb.rb
+- lib/propagate/rails.rb
+- lib/propagate/railtie.rb
+- lib/propagate/verify.rb
+- lib/propagate/version.rb
+- propagate.gemspec
+- test/propagate_test.rb
+- test/verify_propagate_test.rb
+has_rdoc: true
+homepage: http://www.propagate.com.br/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: propagate
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Helpers for the Propagate API
+test_files: []
+