adcopy 0.0.0

data/.gitignore

@@ -0,0 +1 @@
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Eddie Siegel
+
+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.rdoc

@@ -0,0 +1,55 @@
+= AdCopy
+
+Author::		Eddie Siegel
+Info::			http://www.adcopy.com
+Documentation::	http://rdoc.info/projects/atomon/adcopy
+
+== Installation
+
+Currently AdCopy can only be installed as a rails plugin (gem coming soon):
+
+  script/plugin install git://github.com/atomon/adcopy.git
+
+== API Keys
+
+Your AdCopy API keys should be stored in <tt>config/adcopy_config.yml</tt>, which can be generated by running
+
+  rake adcopy:setup
+
+== Adding An AdCopy Puzzle To A View
+
+Displaying an AdCopy Puzzle is as simple as calling +adcopy_puzzle+ inside a form within your view. For example:
+
+  <% form_for(@user) do |f| %>
+    # ...
+    <p>
+      <%= adcopy_puzzle %>
+    </p>
+    # ...
+  <% end %>
+
+The appearance of the puzzle can be adjusted by passing options to +adcopy_puzzle+. For a full list of options, see the documentation.
+
+== Verifying The Input To An AdCopy Puzzle In A Controller
+
+The +verify_adcopy_puzzle+ method verifies the user's input and returns +true+ if the user provided the correct input. In the simplest case, verification could be performed as follows:
+
+  respond_to do |format|
+    if verify_adcopy_puzzle && @user.save
+      # ...
+    else
+      # ...
+    end
+  end
+
++verify_adcopy_puzzle+ can also be used to add an error to a model object if the verification fails:
+
+  respond_to do |format|
+    if verify_adcopy_puzzle(:model => @user, :error_message => 'AdCopy puzzle input is invalid') && @user.save
+      # ...
+    else
+      # ...
+    end
+  end
+
+See the documentation for a full list of options accepted by +verify_adcopy_puzzle+.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for the adcopy plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Adcopy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "adcopy"
+    gem.summary = "Simplifies the use of AdCopy puzzles within rails applications"
+    gem.description = "Simplifies the use of AdCopy puzzles within rails applications"
+    gem.email = "atomon@gmail.com"
+    gem.homepage = "http://github.com/atomon/adcopy"
+    gem.authors = ["Eddie Siegel"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/init.rb

@@ -0,0 +1,10 @@
+# Include hook code here
+require 'adcopy'
+
+class ActionView::Base
+  include AdCopy::ViewMethods
+end
+
+class ActionController::Base
+  include AdCopy::ControllerMethods
+end

data/install.rb

@@ -0,0 +1,4 @@
+puts ""
+puts "Run 'rake adcopy:setup' to generate adcopy_config.yml"
+puts "Don't forget to add your API keys to adcopy_config.yml"
+puts ""

data/lib/adcopy.rb

@@ -0,0 +1,20 @@
+# Adcopy
+require 'view_methods'
+require 'controller_methods'
+
+module AdCopy
+  CONFIG_FILE = "#{RAILS_ROOT}/config/adcopy_config.yml"
+  CONFIG = YAML.load_file(CONFIG_FILE) if File.exist?(CONFIG_FILE)
+  VERIFY_SERVER = 'http://verify.adcopy.com'
+  API_SERVER = 'http://api.adcopy.com'
+  SIGNUP_URL = 'http://portal.adcopy.com/portal/public/signup'
+  
+  class AdCopyError < StandardError
+  end
+  
+  def self.check_for_keys!
+    if !File.exist?(CONFIG_FILE) || CONFIG.nil? || CONFIG['C_KEY'].nil? || CONFIG['V_KEY'].nil? || CONFIG['H_KEY'].nil?
+      raise AdCopyError, "AdCopy API keys not found. Keys can be obtained at #{SIGNUP_URL}"
+    end
+  end
+end

data/lib/controller_methods.rb

@@ -0,0 +1,52 @@
+module AdCopy
+  
+  # Methods within this module will be included in ActionController::Base 
+  module ControllerMethods
+    
+    # Sends a POST request to the AdCopy server in order to verify the user's input.
+    # Returns +true+ if the user's input is valid, +false+ otherwise
+    #
+    # Options:
+    # <tt>:validate_response</tt>::  Whether or not the AdCopy authenticator should be used to validate the server's response. If this is set to +true+ and the validation fails, an AdCopyError is raised.
+    # <tt>:timeout</tt>::  The amount of time in seconds before the request should timeout. If the request times out, a Timeout::Error is raised.
+    # <tt>:model</tt>::  An ActiveRecord model. If verification fails, an error will be added to this model.
+    # <tt>:error_message</tt>::  A custom error message (to be used in conjunction with <tt>:model</tt>) to be used if verification fails.
+    def verify_adcopy_puzzle(options = {})
+      AdCopy::check_for_keys!
+      options = { :validate_response  => true,
+                  :timeout            => 5,
+                  :model              => nil,
+                  :error_message      => nil
+                }.merge(options)
+      
+      #Send POST to AdCopy
+      response = nil
+      Timeout::timeout(options[:timeout]) do
+        response = Net::HTTP.post_form URI.parse("#{AdCopy::VERIFY_SERVER}/papi/verify"), {
+          "privatekey"  =>  AdCopy::CONFIG['V_KEY'],
+          "challenge"   =>  params[:adcopy_challenge],
+          "response"    =>  params[:adcopy_response],
+          "remoteip"    =>  request.remote_ip
+        }
+      end
+      answer, error, authenticator = response.body.split("\n")
+      
+      #validate the response
+      if options[:validate_response] && authenticator != Digest::SHA1.hexdigest("#{answer}#{params[:adcopy_challenge]}#{AdCopy::CONFIG['H_KEY']}")
+        raise AdCopyError, "AdCopy Error: Unable to Validate Response" 
+      end
+      
+      if answer.downcase == "true"
+        return true
+      else
+        #Add error to the model
+        if options[:model]
+          options[:model].valid?
+          options[:model].errors.add_to_base options[:error_message] || "AdCopy Puzzle: #{error}"
+        end
+        
+        return false
+      end
+    end
+  end
+end

data/lib/view_methods.rb

@@ -0,0 +1,44 @@
+module AdCopy
+  
+  # Methods within this module will be included in ActionView::Base 
+  module ViewMethods
+    
+    # Returns the HTML for an AdCopy puzzle
+    #
+    # Options:
+    # <tt>tabindex</tt>::  The tab index of the text field within the puzzle (defaults to <tt>nil</tt>)
+    # <tt>theme</tt>::  The theme applied to the puzzle (defaults to <tt>'purple'</tt>)
+    # <tt>lang</tt>::  The language of the puzzle (defaults to <tt>'en'</tt>)
+    def adcopy_puzzle(options = {})
+      AdCopy::check_for_keys!
+      options = { :tabindex => nil,
+                  :theme    => 'purple',
+                  :lang     => 'en'
+                  }.merge(options)
+      
+      output = ""
+      
+      output << %{<script type="text/javascript">\n}
+      output << "	var ACPuzzleOptions = {\n"
+      output << %{			tabindex:   #{options[:tabindex]},\n} unless options[:tabindex].nil?
+      output << %{			theme:	    '#{options[:theme]}',\n}
+      output << %{			lang:	    '#{options[:lang]}'\n}
+      output << "	};\n"
+      output << %{</script>\n}
+      
+      output << %{<script type="text/javascript"}
+      output << %{   src="#{AdCopy::API_SERVER}/papi/challenge.script?k=#{AdCopy::CONFIG['C_KEY']}">}
+      output << %{</script>}
+
+      output << %{<noscript>}
+      output << %{   <iframe src="#{AdCopy::API_SERVER}/papi/challenge.noscript?k=#{AdCopy::CONFIG['C_KEY']}"}
+      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>}
+      return output
+    end
+  end
+end

data/tasks/adcopy_tasks.rake

@@ -0,0 +1,17 @@
+namespace :adcopy do
+  desc "Creates YAML file for API keys"
+  task :setup do
+    file_loc = "#{RAILS_ROOT}/config/adcopy_config.yml"
+    
+    if File.exist?(file_loc)
+      puts "#{file_loc} exists. Nothing to do."
+    else
+      puts "Creating #{file_loc}"
+      file = File.new(file_loc, 'w')
+      file.puts "C_KEY: your_c_key_here"
+      file.puts "V_KEY: your_V_key_here"
+      file.puts "H_KEY: your_H_key_here"
+      puts "Don't forget to put your own API keys in adcopy_config.yml"
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: adcopy
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Eddie Siegel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simplifies the use of AdCopy puzzles within rails applications
+email: atomon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/adcopy.rb
+- lib/controller_methods.rb
+- lib/view_methods.rb
+- tasks/adcopy_tasks.rake
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/atomon/adcopy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Simplifies the use of AdCopy puzzles within rails applications
+test_files: []
+