solvemedia 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6db952947e80394a9fa2cd0fd3cf411aeeab69f
+  data.tar.gz: b72433e90e90419f653925dc707dfab211f5aec0
+SHA512:
+  metadata.gz: 493bd6688ec5736ab23915e074018576cb91a9f2df4054de33a51b9d5bc9f51139d4ea4bbcd1569df2b0f0a2258c4d84d707fbcf3f03c4f00beb0b8155e8ee9f
+  data.tar.gz: 64378fd7d8f7b307d93184a1e3d843e96a4b340232f76a881ea23eb91ccf32a73ece8840b5249b944fe96f732da64929c6ad7de1071da0e5d7113b3e7bd471e2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Solve Media, Inc.
+
+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,91 @@
+# SolveMedia
+
+Solve Media's patent-pending technology turns CAPTCHA into branded 
+TYPE-IN™ Ads. Solve Media's technology improves site security, and every 
+time a user types a brand message into a TYPE-IN™ Ad, we share the 
+revenue with our publisher partners.
+
+The Solve Media gem makes it easy to use the Solve Media unit in your Ruby and
+Rails projects.
+
+## Note
+
+This gem supercedes and replaces the earlier gem from Solve Media. This new gem 
+provides improved compatibility with Rails 3 and is now also usable in pure Ruby 
+as well. If you previously used the old gem with Rails 3, you should uninstall 
+it, install this one, and configure the keys as below. Your view and controller 
+code should continue to work without alteration.
+
+This gem is not directly backward compatible with Rails 2. Rails 2 users should 
+continue to use the old gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'solvemedia'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solvemedia
+
+## Usage
+
+### Setting API Keys
+Before using Solve Media, you need to 
+[sign up for an account](https://portal.solvemedia.com/portal/public/signup) 
+and get a set of API keys. 
+
+To use within a Rails 3 project, you must set these keys within the app config.
+Inside config/application.rb:
+
+    config.solvemedia.ckey = "Your Challenge (Public) Key"
+    config.solvemedia.vkey = "Your Verification (Private) Key"
+    config.solvemedia.hkey = "Your Authentication Hash Key"
+
+In addition, you can set these keys on a per-environment basis by using the
+environment configuration files under config/environment/. For instance, you
+may wish to create a second set of keys with the security mode 
+set to "Security" instead of "Revenue", to avoid receiving ads during 
+development.
+
+### Displaying the Puzzle
+
+To display the Solve Media puzzle within one of your form views, simply call
+{SolveMedia::ViewHelpers#solvemedia_puzzle solvemedia_puzzle}.
+
+    <% form_for(@user) do |f| %>
+        #...
+        <p>
+            <%= solvemedia_puzzle %>
+        </p>
+        #...
+    <% end %>
+
+### Verifying the Response
+
+The {SolveMedia::ControllerMethods#verify_solvemedia_puzzle verify_solvemedia_puzzle} method verifies the user's input, returning
+`true` if the user solved the puzzle correctly.
+
+    respond_to do |format|
+        if verify_solvemedia_puzzle && @user.save
+            #...
+        else
+            #...
+        end
+    end
+
+`verify_solvemedia_puzzle` can also be used to add an error to a model object
+if the verification fails:
+
+    respond_to do |format|
+        if verify_solvemedia_puzzle(:model => @user, :error_message => 'Solve Media puzzle input is invalid') && @user.save
+            #...
+        else
+            #...
+        end
+    end

data/Rakefile

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

data/lib/solvemedia/ad_copy_error.rb

@@ -0,0 +1,6 @@
+module SolveMedia
+  # Error raised in instances of missing keys or unverifiable responses from
+  # the Solve Media server.
+  class AdCopyError < StandardError
+  end
+end

data/lib/solvemedia/constants.rb

@@ -0,0 +1,6 @@
+module SolveMedia
+  VERIFY_SERVER = 'http://verify.solvemedia.com'
+  API_SERVER = 'http://api.solvemedia.com'
+  API_SECURE_SERVER = 'https://api-secure.solvemedia.com'
+  SIGNUP_URL = 'http://portal.solvemedia.com/portal/public/signup'
+end

data/lib/solvemedia/controller_methods.rb

@@ -0,0 +1,39 @@
+module SolveMedia
+  module ControllerMethods
+    # Controller method to verify a Solve Media puzzle. Assumes a form with
+    # the puzzle is being processed by the calling method. 
+    #
+    # Calls {SolveMedia.verify} internally.
+    #
+    # @param [Hash] options
+    # 
+    # @option options [Boolean] :validate_response (true) Validate the 
+    #   response from the Solve Media server
+    # @option options [Integer] :timeout (5) Time in seconds to wait for a 
+    #   response form the Solve Media server
+    # @option options [Object<ActiveRecord::Base>] :model ActiveRecord model
+    #   object to which error is added
+    # @option options [String] :error_message Custom error message to add to
+    #   the model. Does nothing if +:model+ is not present
+    #
+    # @raise [AdCopyError] if +validate_response+ is true and the response
+    #   cannot be verified
+    # @raise [Timeout::Error] if the request to the verification server takes
+    #   longer than expected
+    #
+    # @return [Boolean] Was the user's answer correct?
+    #
+    def verify_solvemedia_puzzle(options={})
+      ver_options = { :validate_response => options[:validate_response] || true,
+                      :timeout           => options[:timeout] || 5
+      }
+      verified = SolveMedia.verify(params[:adcopy_challenge], params[:adcopy_response], VKEY, HKEY, request.remote_ip)
+      if options[:model] && !verified
+        options[:model].valid?
+        options[:model].errors.add(:base, options[:error_message] || "Please fill out the Solve Media puzzle")
+      end
+
+      return verified
+    end
+  end
+end

data/lib/solvemedia/railtie.rb

@@ -0,0 +1,28 @@
+require "solvemedia/view_helpers"
+require "solvemedia/controller_methods"
+module SolveMedia
+  # Integrates the Solve Media library into the Rails project.
+  # Adds {SolveMedia::ViewHelpers} and {SolveMedia::ControllerMethods} to
+  # to the project.
+  class Railtie < Rails::Railtie
+    config.solvemedia = ActiveSupport::OrderedOptions.new
+
+    initializer "solvemedia.configure" do |app|
+      SolveMedia::CKEY = app.config.solvemedia[:ckey] 
+      SolveMedia::VKEY = app.config.solvemedia[:vkey]
+      SolveMedia::HKEY = app.config.solvemedia[:hkey]
+
+      unless (SolveMedia::CKEY && SolveMedia::VKEY && SolveMedia::HKEY)
+        raise AdCopyError, "Solve Media API keys not found. Keys can be obtained at #{SIGNUP_URL}"
+      end
+    end
+    
+    initializer "solvemedia.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+
+    initializer "solvemedia.controller_methods" do
+      ActionController::Base.send :include, ControllerMethods
+    end
+  end
+end

data/lib/solvemedia/version.rb

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

data/lib/solvemedia/view_helpers.rb

@@ -0,0 +1,29 @@
+module SolveMedia
+  module ViewHelpers
+    # View helper to insert the Solve Media puzzle HTML.
+    #
+    # Can be set to use either the standard version or the AJAX version. For 
+    # more complex uses of the AJAX version, such as multi-puzzle, you should 
+    # not use this method and instead use purpose-written Javascript in your 
+    # view.
+    #
+    # Calls {SolveMedia.puzzle} internally.
+    # 
+    # @see https://portal.solvemedia.com/portal/help/pub/themewiz
+    #   Documentation for theme, lang, and size
+    # @see https://portal.solvemedia.com/portal/help/pub/ajax
+    #   AJAX API documentation
+    # @see SolveMedia.puzzle
+    #
+    #
+    # @param [Hash] options
+    # @option (see SolveMedia.puzzle)
+    #
+    # @raise (see SolveMedia.puzzle)
+    #
+    # @return [String] HTML for the puzzle, marked as +html_safe+.
+    def solvemedia_puzzle(options={})
+      return SolveMedia.puzzle(CKEY, options).html_safe
+    end
+  end
+end

data/lib/solvemedia.rb

@@ -0,0 +1,151 @@
+require "solvemedia/version"
+require "solvemedia/constants"
+require "solvemedia/ad_copy_error"
+require "solvemedia/railtie" if defined? ::Rails::Railtie
+require 'net/http'
+require 'timeout'
+
+# Methods for using the Solve Media service. These methods are called internally
+# by the Rails Railtie; those not using Rails may call these methods directly.
+module SolveMedia
+
+  # Returns the HTML for the Solve Media puzzle.
+  # Can be set to use either the standard version or the AJAX version. For more
+  # complex uses of the AJAX version, such as multi-puzzle, you should not use
+  # this method and instead use purpose-written Javascript in your view.
+  #
+  # For theme, lang, and size options, see
+  # (https://portal.solvemedia.com/portal/help/pub/themewiz)
+  #
+  # For more about the AJAX puzzle, see
+  # (https://portal.solvemedia.com/portal/help/pub/ajax)
+  #
+  # @param [String] ckey Your challenge (public) key
+  # @param [Hash] options
+  # @option options [Integer] :tabindex (nil) HTML tabindex
+  # @option options [String] :theme ('purple')
+  # @option options [String] :lang ('en')
+  # @option options [String] :size ('300x150') Widget size. Please note that
+  #   300x150 is the only size which can display ads.
+  # @option options [Boolean] :use_SSL (false) Set to +true+ if using the puzzle
+  #   on an HTTPS site
+  # @option options [Boolean] :ajax (false) Uses the AJAX api (see above)
+  # @option options [String] :ajax_div ID of the div element into which the
+  #   puzzle is inserted, if using AJAX. Required if +ajax+ is set to +true+.
+  #
+  # @raise [AdCopyError] if key is not set
+  # @raise [AdCopyError] if AJAX puzzle is selected but no container div is
+  #   specified
+  #
+  # @return [String] HTML string containing code to display the puzzle
+  #
+  def self.puzzle(ckey, options = {})
+    raise AdCopyError, "Solve Media API keys not found. Keys can be obtained at #{SIGNUP_URL}" unless ckey
+
+    options = { :tabindex => nil,
+                :theme    => 'purple',
+                :lang     => 'en',
+                :size     => '300x150',
+                :use_SSL  => false,
+                :ajax     => false
+              }.merge(options)
+
+    server = options[:use_SSL] ? SolveMedia::API_SECURE_SERVER : SolveMedia::API_SERVER
+      
+    if options[:ajax]
+      puts options.inspect
+      raise AdCopyError, "No div specified for AJAX puzzle" unless options[:ajax_div]
+      aopts = {:theme => options[:theme], :lang => options[:lang], :size => options[:size]}
+      aopts[:tabindex] = options[:tabindex] if options[:tabindex]
+
+      output = <<-EOF
+        <script src="#{server}/papi/challenge.ajax"></script>
+        <script type="text/javascript">
+          function loadSolveMediaCaptcha(){
+            if(window.ACPuzzle) { 
+                ACPuzzle.create('#{ckey}', '#{options[:ajax_div]}', {#{aopts.map{|k,v| "#{k}:'#{v}'" }.join(', ') }});
+            } else {
+                setTimeout(loadSolveMediaCaptcha, 50);
+            }
+          }
+          loadSolveMediaCaptcha();
+        </script>
+      EOF
+    else
+      output = []
+      
+      output << %{<script type="text/javascript">}
+      output << "	var ACPuzzleOptions = {"
+      output << %{			tabindex:   #{options[:tabindex]},} unless options[:tabindex].nil?
+      output << %{			theme:      '#{options[:theme]}',}
+      output << %{			lang:       '#{options[:lang]}',}
+      output << %{			size:       '#{options[:size]}'}
+      output << "	};"
+      output << %{</script>}
+      
+      output << %{<script type="text/javascript"}
+      output << %{   src="#{server}/papi/challenge.script?k=#{ckey}">}
+      output << %{</script>}
+
+      output << %{<noscript>}
+      output << %{   <iframe src="#{server}/papi/challenge.noscript?k=#{ckey}"}
+      output << %{	 height="300" width="500" frameborder="0"></iframe><br/>}
+      output << %{   <textarea name="adcopy_challenge" rows="3" cols="40">}
+      output << %{   </textarea>}
+      output << %{   <input type="hidden" name="adcopy_response"}
+      output << %{	 value="manual_challenge"/>}
+      output << %{</noscript>}
+      output = output.join("\n")
+    end
+    return output
+  end
+
+  # Sends a POST request to the Solve Media server in order to verify the user's input.
+  #
+  # @param [String] challenge The challenge id. Normally found in the form
+  #   field +adcopy_challenge+
+  # @param [String] response The user's response to the puzzle. Normally found
+  #   in the form field +acdopy_response+
+  # @param [String] vkey Your verification (private) key
+  # @param [String] hkey Your hash key
+  # @param [String] remote_ip The IP from which the form was submitted
+  # @param [Hash] options
+  #
+  # @option options [Boolean] :validate_response (true) Validate the response
+  #   from the Solve Media server
+  # @option options [Integer] :timeout (5) Amount of time in seconds before the
+  #   request should time out
+  #
+  # @return [Boolean] Was the user's answer correct?
+  #
+  # @raise [AdCopyError] if +validate_response+ is true and the response
+  #   cannot be verified
+  # @raise [Timeout::Error] if the request to the verification server takes
+  #   longer than expected
+  #
+  def self.verify(challenge, response, vkey, hkey, remote_ip, options = {})
+    options = { :validate_response  => true,
+                :timeout            => 5,
+              }.merge(options)
+    
+    #Send POST to SolveMedia
+    result = nil
+    Timeout::timeout(options[:timeout]) do
+      result = Net::HTTP.post_form URI.parse("#{SolveMedia::VERIFY_SERVER}/papi/verify"), {
+        "privatekey"  =>  vkey,  
+        "challenge"   =>  challenge,
+        "response"    =>  response,
+        "remoteip"    =>  remote_ip
+      }
+    end
+
+    answer, error, authenticator = result.body.split("\n")
+
+    #validate the response
+    if options[:validate_response] && authenticator != Digest::SHA1.hexdigest("#{answer}#{challenge}#{hkey}")
+      raise AdCopyError, "SolveMedia Error: Unable to Validate Response" 
+    end
+    
+    return answer.downcase == "true" ? true : false
+  end
+end

data/solvemedia.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'solvemedia/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "solvemedia"
+  gem.version       = SolveMedia::VERSION
+  gem.authors       = ["Tyler Cunnion"]
+  gem.email         = ["tyler@solvemedia.com"]
+  gem.description   = %q{Solve Media CAPTCHA Replacement}
+  gem.summary       = %q{Library for implementing the Solve Media CAPTCHA solution.
+                        Contains basic Ruby library plus Railtie for Rails 3+.}
+  gem.homepage      = "http://www.solvemedia.com/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: solvemedia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tyler Cunnion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies: []
+description: Solve Media CAPTCHA Replacement
+email:
+- tyler@solvemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solvemedia.rb
+- lib/solvemedia/ad_copy_error.rb
+- lib/solvemedia/constants.rb
+- lib/solvemedia/controller_methods.rb
+- lib/solvemedia/railtie.rb
+- lib/solvemedia/version.rb
+- lib/solvemedia/view_helpers.rb
+- solvemedia.gemspec
+homepage: http://www.solvemedia.com/
+licenses: []
+metadata: {}
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Library for implementing the Solve Media CAPTCHA solution. Contains basic
+  Ruby library plus Railtie for Rails 3+.
+test_files: []