ayah_integration 0.6.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "rest-client"
+gem "json"

data/README.md

@@ -0,0 +1,76 @@
+# AYAH::Integration -- AreYouAHuman.com Publisher Integration
+
+* Integrate the AreYouAHuman.com CAPTCHA-alternative human verification 
+into your Ruby application
+
+AreYouAHuman.com provides a novel game-play approach to human verification; 
+instead of deciphering some text, you do a simple task in a fun game.  
+You can sign up for a free publisher key at AreYouAHuman.com to start 
+using it right away.  
+
+* Visit http://areyouahuman.com/ for more information on how to get started
+
+Contact us or check out our website if you are interested in a customization.
+
+# Supported Ruby Versions
+
+The gem has been tested in:
+
+* Ruby 1.8.7 / Rails 3.1.3
+* Ruby 1.9.2 / Rails 3.1.3
+
+If you are running this gem in a different environment, be sure to let us 
+know so we can add it to the list.
+
+# Installation, Setup, and Integration
+
+## Installation
+
+* Simply install from RubyGems:
+    
+    gem install ayah_integration
+
+## Setup
+
+1. In order to use the AYAH Integration gem, you'll first need to sign up at 
+http://portal.areyouahuman.com/registration
+2. Next, get your 'Publisher Key' and 'Scoring Key', these will be used when 
+you first instantiate the AYAH::Integration class
+    
+## Integration (Examples)
+
+Below are the basic steps and examples needed to get the AYAH Integration gem working.
+PUBLISHER_KEY and SCORING_KEY can be found in the AYAH Portal and CLIENT_IP is the IP 
+address of the client playing the AYAH PlayThru.
+
+You can also register a conversion, for example, when a user passes the AYAH PlayThru 
+and completes an order or sign up.
+
+1. Get the HTML needed to be embedded in the form page (in your controller perhaps?):
+    
+    ayah = AYAH::Integration.new(PUBLISHER_KEY, SCORING_KEY)
+    @publisher_html = ayah.get_publisher_html
+        
+2. Handle the form submission and get score (pass/fail):
+
+    session_secret = params['session_secret'] # in this case, using Rails
+    ayah = AYAH::Integration.new(PUBLISHER_KEY, SCORING_KEY)
+    ayah_passed = ayah.score_result(session_secret, CLIENT_IP)
+    
+3. Registering a conversion (optional):
+    
+    session_secret = params['session_secret'] # or anywhere else it's stored
+    ayah = AYAH::Integration.new(PUBLISHER_KEY, SCORING_KEY)
+    @ayah_conversion_html = ayah.record_conversion(session_secret)
+    
+4. THAT'S IT! You're Done!
+    
+# License and Distribution
+
+This software is offered under the MIT License and is copyright (c) 2011 by AreYouAHuman.com LLC
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/ayah_integration.rb

@@ -0,0 +1,88 @@
+require 'rest-client'
+require 'json'
+
+module AYAH
+  
+  # Are You a Human Publisher Integration Rubygem
+  
+  class Integration
+    
+    attr_accessor :publisher_key, :scoring_key, :ayah_server
+    attr_reader :__score_result_status_code, :__last_error, :passed, :converted
+    
+    # @attr_accessor [String] publisher_key this key can be found in the AYAH portal
+    # @attr_accessor [String] scoring_key this key can also be found in the AYAH portal
+    # @attr_accessor [String] ayah_server you shouldn't have to modify this, `ws.areyouahuman.com`
+    
+    # @attr_reader [True,False,nil] passed this will be nil until a score request is made, then either true or false
+    # @attr_reader [True,False,nil] converted this will be nil until convert html is called for, then true
+    def initialize(publisher_key, scoring_key, ayah_server = 'ws.areyouahuman.com')
+      @publisher_key = publisher_key
+      @scoring_key = scoring_key
+      @ayah_server = ayah_server
+      @passed = nil
+      @converted = nil
+    end
+    
+    # returns the HTML string that should be embedded into the form page to be protected
+    #
+    # @return [String] the HTML string
+    def get_publisher_html
+      "<div id='AYAH'></div><script src='https://#{@ayah_server}/ws/script/#{@publisher_key}'></script>"
+    end
+    
+    # returns the score of the current session
+    #
+    # @param [String] session_secret the session_secret for the session to be scored
+    # @param [String] client_ip the ip address being used by the client
+    # @return [True,False] whether the session passed
+    def score_result(session_secret, client_ip='0.0.0.0')
+      
+      # set up the url and form vars for web service submission
+      sr_url = "https://#{@ayah_server}/ayahwebservices/index.php/ayahwebservice/scoreGame"
+      payload = {:session_secret => session_secret, :client_ip => client_ip}
+      
+      result = RestClient.post sr_url, payload, :content_type => 'application/x-www-form-urlencoded'
+      
+      # if there was an HTTP error, fail them automatically
+      unless result.code == 200
+        log_error("ERROR: HTTP Response code: #{result.code}")
+        @passed = false
+        return @passed
+      end
+      
+      json = JSON.parse(result)
+      
+      # set the score result and see if they passed
+      unless json['status_code'].nil?
+        @__score_result_status_code = json['status_code'].to_i
+        @passed = (json['status_code'].to_i ==  1)
+        return @passed
+      end
+    end
+    
+    # returns the HTML to be embedded in the landing page of a completed and converted session
+    #
+    # @param [String] session_secret the session_secret for the session that converted
+    # @return [String] the HTML string
+    def record_conversion(session_secret)
+      @converted = true
+      "<iframe style='border: none;' height='0' width='0' src='https://#{@ayah_server}/ws/recordConversion/#{session_secret}\"></iframe>"
+    end
+    
+    # returns the last error, if any, that occurred
+    #
+    # @return [String] the last error
+    def last_error
+      @__last_error
+    end
+    
+    private
+    def log_error(msg)
+      @__last_error = msg
+      puts msg
+    end
+    
+  end
+  
+end

data/test/test_ayah_integration.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'ayah_integration'
+
+class AYAHIntegrationTest < Test::Unit::TestCase
+  
+  def setup
+    @pub_key = 'get_your_own_pub_key'
+    @score_key = 'get_this_with_the_pub_key'
+    @session_secret = 'shhhhhhhhhh'
+    @ayah = AYAH::Integration.new(@pub_key, @score_key)
+  end
+  
+  def test_get_publisher_html
+    assert_equal((@ayah.get_publisher_html.size > 0), true)
+  end
+
+  def test_score_result_for_neg_ten
+    result = @ayah.score_result(@session_secret, '127.0.0.1')
+    assert_equal(-10, @ayah.__score_result_status_code)
+    assert_equal(false, @ayah.passed)
+  end
+  
+  def test_record_conversion
+    assert_equal((@ayah.record_conversion('invalid_session_secret').size > 0), true)
+    assert_equal(@ayah.converted, true)
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: ayah_integration
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Andrew S Herron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Integrate the AreYouAHuman.com CAPTCHA alternative human verification into your Ruby/Rails application
+email: andrew@areyouahuman.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Rakefile
+- README.md
+- lib/ayah_integration.rb
+- test/test_ayah_integration.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/ayah_integration
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: AreYouAHuman.com CAPTCHA alternative integration library
+test_files: []
+