gregfitz23-RegPath 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-12-17
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/reg_path
+lib/reg_path.rb
+lib/reg_path/_progress_bar.html.erb
+lib/reg_path/helpers/reg_path_helper.rb
+lib/reg_path/mailer/reg_path_mailer.rb
+lib/reg_path/mailer/reg_path_mailer/house_form.html.erb
+lib/reg_path/offer_engine/models/offer.rb
+lib/reg_path/offer_engine/models/reg_path.rb
+lib/reg_path/offer_engine/models/submission.rb
+lib/reg_path/offer_engine/models/user.rb
+lib/reg_path/offer_engine/client.rb
+lib/reg_path/properties.rb
+lib/reg_path/reg_path.rb
+test/test_reg_path.rb
+test/confirmation_page.html.erb
+test/empty_offers.xml
+test/long_form.html.erb
+test/test_offer_engine_client.rb
+test/offers.xml
+test/reg_path.xml
+test/test_reg_path.rb
+test/short_form.html.erb
+test/submission.xml
+test/submission_no_conf.xml

data/README.txt

@@ -0,0 +1,48 @@
+= RegPath
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/RegPath.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{RegPath}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Greg Fitzgerald"]
+  s.date = %q{2009-04-26}
+  s.default_executable = %q{reg_path}
+  s.description = %q{TODO}
+  s.email = %q{greg_fitz@yahoo.com}
+  s.executables = ["reg_path"]
+  s.extra_rdoc_files = ["README", "README.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "RegPath.gemspec", "VERSION.yml", "bin/reg_path", "lib/reg_path", "lib/reg_path/_progress_bar.html.erb", "lib/reg_path/helpers", "lib/reg_path/helpers/reg_path_helper.rb", "lib/reg_path/mailer", "lib/reg_path/mailer/reg_path_mailer", "lib/reg_path/mailer/reg_path_mailer/house_form.html.erb", "lib/reg_path/mailer/reg_path_mailer.rb", "lib/reg_path/models", "lib/reg_path/offer_engine", "lib/reg_path/offer_engine/client.rb", "lib/reg_path/offer_engine/models", "lib/reg_path/offer_engine/models/offer.rb", "lib/reg_path/offer_engine/models/reg_path.rb", "lib/reg_path/offer_engine/models/submission.rb", "lib/reg_path/offer_engine/models/user.rb", "lib/reg_path/properties.rb", "lib/reg_path/reg_path.rb", "lib/reg_path.rb", "test/confirmation_page.html.erb", "test/empty_offers.xml", "test/house_form.html.erb", "test/long_form.html.erb", "test/offers.xml", "test/reg_path.xml", "test/routes.rb", "test/short_form.html.erb", "test/submission.xml", "test/submission_no_conf.xml", "test/test_helper.rb", "test/test_offer_engine_client.rb", "test/test_reg_path.rb", "README"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/lib/reg_path.rb

@@ -0,0 +1,16 @@
+class RegPath
+  VERSION='1.0.3'  
+end
+
+require "action_mailer"
+require "active_resource"
+require "action_controller"
+require "active_support"
+require_dependency File.join(File.dirname(__FILE__), "reg_path/properties")
+# 
+require_dependency File.join(File.dirname(__FILE__), "reg_path/offer_engine/client")
+require_dependency File.join(File.dirname(__FILE__), "reg_path/offer_engine/models/submission")
+require_dependency File.join(File.dirname(__FILE__), "reg_path/offer_engine/models/reg_path")
+require_dependency File.join(File.dirname(__FILE__), "reg_path/offer_engine/models/offer")
+require_dependency File.join(File.dirname(__FILE__), "reg_path/offer_engine/models/user")
+require_dependency File.join(File.dirname(__FILE__), "reg_path/reg_path")

data/lib/reg_path/_progress_bar.html.erb

@@ -0,0 +1,17 @@
+<div  class="progress-bar">
+	<div class="finish">Finish</div>
+	<div class="start">Start</div>
+	<div style="clear:both"></div>
+	<table cellspacing='1' cellpadding='0'>
+		<tr class="bar">
+			<% (0..num_steps).each do |i| %>
+				<% 
+					klass = []
+					klass << 'green' if i <= step
+					klass << 'last'  if i == num_steps - 1
+				 %>
+				<td class="<%= klass.join(" ") %>">&nbsp;</td>
+			<% end %>
+		</tr>
+	</table>
+</div>

data/lib/reg_path/helpers/reg_path_helper.rb

@@ -0,0 +1,21 @@
+module RegPathHelper
+  
+  def progress_bar(step, num_steps)
+    render(:partial => 'common/progress_bar', :locals=>{:num_steps=>num_steps, :step=>step}) if num_steps && step
+  end
+  
+  def participation_header(options={})
+    name = ""
+    name << ", #{options[:name]}" if options[:name]
+    
+    thank_you_text = options[:thank_you_text] || "Thank you"
+    participation_text = options[:participation_text] || "Thank you for participating"
+
+    terminator = options[:terminator] || "!"
+    (request.post? ? participation_text : thank_you_text) << name << terminator
+  end
+  
+  def skip_this_link
+    link_to 'Skip this', :action=>:offers
+  end
+end

data/lib/reg_path/mailer/reg_path_mailer.rb

@@ -0,0 +1,30 @@
+require "open-uri"
+class RegPathMailer < ActionMailer::Base
+  
+  def house_form(params)
+    standard_mail(params)
+  end
+  
+  def foodfit(params)
+    standard_mail(params)
+  end
+    
+  private
+  def standard_mail(params)
+    template_root = overridden_template_or_default
+    recipients params[:to]
+    from       params.delete(:from)    
+    subject    params.delete(:subject) || "Thank you for your interest in our offers."
+    content_type "text/html"
+    
+    body params    
+  end
+  
+  def overridden_template_or_default
+    if File.exists?(File.join(template_root || "", "reg_path_mailer/#{@template}.html.erb"))
+      template_root
+    else
+      File.dirname(__FILE__)
+    end
+  end
+end

data/lib/reg_path/offer_engine/client.rb

@@ -0,0 +1,48 @@
+require "open-uri"
+# require File.join(File.dirname(__FILE__), "offer_engine/models/submission")
+=begin
+  The *OfferEngineClient* class provides an interface for connecting to the OfferEngine.
+  It exposes two main methods, get_next_offers and submit_to_offer_engine which are resposible for requesting and sending data to/from the server.
+=end
+module OfferEngine
+  class Client
+  
+    #Submit the passed in params to the OfferEngine.  
+    #If this class, or any extending classes, provide a handler method for the particular offer type being sent back to the OfferEngine, call that.
+    #Otherwise, use the standard submit method.
+    def submit_to_offer_engine(params)
+      offer_type = params.delete(:reg_path_offer_type)
+      if offer_type && self.respond_to?("_#{offer_type}_submit_to_offer_engine")
+        submission_xml = self.__send__("_#{offer_type}_submit_to_offer_engine", params) #handle non-standard forms (e.g. multiple offers on short form)
+      else
+        submission_xml = _submit_to_offer_engine(params)
+      end
+      OfferEngine::Models::Submission.new.load(Hash.from_xml(submission_xml)["submission"]) unless submission_xml.blank?
+    end
+
+    def add_data(email, keys, values, options={})
+      uri = URI.parse("#{OfferEngine::Properties.offer_engine_host}/data_store/add_data?email=#{email}&#{keys.to_query('keys')}&#{values.to_query('values')}&#{options.to_query}&#{OfferEngine::Properties.source.to_query(:source)}")
+      resp = Net::HTTP.get(uri)
+      return resp.is_a?(Net::HTTPSuccess)
+    end
+    
+    protected
+    #short form offers will all be in the params at once, so we need to parse before submitting
+    def _short_form_submit_to_offer_engine(params)
+      submission_xml = ""
+      params.keys.each do |p|
+        submission_xml = _submit_to_offer_engine({:offer_id => /[0-9]+/.match(p)[0], params[p] => "true", :email => params[:email]}) if /^offer_[0-9]+$/.match(p)
+      end
+      submission_xml
+    end
+    
+    private
+    def _submit_to_offer_engine(params)
+      url = URI.parse(OfferEngine::Properties.offer_engine_submit_offer_path)
+      params[:source] = OfferEngine::Properties.source
+      response = Net::HTTP.new(url.host, url.port).start {|http| http.post(url.path, params.to_query) }
+
+      response.body
+    end  
+  end
+end

data/lib/reg_path/offer_engine/models/offer.rb

@@ -0,0 +1,7 @@
+module OfferEngine
+  module Models
+    class Offer < ActiveResource::Base
+      self.site = OfferEngine::Properties.offer_engine_host
+    end
+  end
+end

data/lib/reg_path/offer_engine/models/reg_path.rb

@@ -0,0 +1,12 @@
+module OfferEngine
+  module Models
+    class RegPath < ActiveResource::Base
+      self.site = OfferEngine::Properties.offer_engine_host
+    
+      def get_offers(step, options={})
+        offers_hashes = self.get(:get_offers, options.merge({:reg_path_step=>step, :require_match=>false}))
+        offers_hashes.map {|offer_hash| OfferEngine::Models::Offer.new.load(offer_hash)}
+      end
+    end
+  end
+end

data/lib/reg_path/offer_engine/models/submission.rb

@@ -0,0 +1,7 @@
+module OfferEngine
+  module Models
+    class Submission < ActiveResource::Base
+      self.site = OfferEngine::Properties.offer_engine_host
+    end
+  end
+end

data/lib/reg_path/offer_engine/models/user.rb

@@ -0,0 +1,20 @@
+module OfferEngine
+  module Models
+    class User < ActiveResource::Base
+      self.site = OfferEngine::Properties.offer_engine_host
+
+      class << self
+        def search(email)
+          user = self.get(:search, :email=>email)
+          User.new.load(user)
+        end
+      end
+
+      def get_offers(options={})
+        offers_hashes = self.get(:get_offers, options.merge({:require_match=>true}))
+        offers_hashes.map {|offer_hash| OfferEngine::Models::Offer.new.load(offer_hash)}
+      end
+  
+    end
+  end
+end

data/lib/reg_path/properties.rb

@@ -0,0 +1,43 @@
+module OfferEngine
+  module Properties
+    def self.offer_engine_host
+      @offer_engine_host || ""
+    end
+
+    def self.offer_engine_get_offers_path
+      @offer_engine_get_offers_path || ""
+    end
+
+    def self.offer_engine_submit_offer_path
+      @offer_engine_submit_offer_path || ""
+    end
+
+    def self.offer_engine_long_form_path
+      @offer_engine_long_form_path || ""
+    end
+
+    def self.offer_engine_host=(host)
+      @offer_engine_host = host
+    end
+
+    def self.offer_engine_get_offers_path=(path)
+      @offer_engine_get_offers_path = path
+    end
+
+    def self.offer_engine_submit_offer_path=(path)
+      @offer_engine_submit_offer_path = path
+    end
+
+    def self.offer_engine_long_form_path=(path)
+      @offer_engine_long_form_path = path
+    end    
+    
+    def self.source
+      @source || ""
+    end
+    
+    def self.source=(in_source)
+      @source = in_source
+    end
+  end
+end

data/lib/reg_path/reg_path.rb

@@ -0,0 +1,161 @@
+require File.dirname(__FILE__) + "/offer_engine/client"
+# require File.dirname(__FILE__) + "/models/reg_path"
+require File.dirname(__FILE__) + "/mailer/reg_path_mailer"
+require File.dirname(__FILE__) + "/helpers/reg_path_helper"
+
+
+module ActionController
+  module Acts
+    module RegPath
+      
+      class RegPathException < Exception; end;
+      
+      def self.append_features(base) #:nodoc:
+        super
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        #Creates the actions and methods necessary for this controller to be a RegPath.
+        #Specifically this generates the *offers* action which handles moving a user through the reg path.
+        #Entry into the RegPath can be initiated by calling the begin_reg_path method.
+        #Controllers using this act must override the after_reg_path callback or supply the :after option to define what action (render, redirect, etc.) should be taken when the reg path is completed.
+        #A :setup_offers before_filter is provided for extension by including Controller.  Any setup of params to be sent to the offer engine should be done here, in the @reg_path_options member variable.
+        def acts_as_reg_path(reg_path_name_or_sym, options={})
+          @reg_path_name_or_sym = reg_path_name_or_sym
+          @reg_path_setup_options = options
+          @reg_path_setup_options[:after] ||= :after_reg_path
+          
+          include ActionController::Acts::RegPath::InstanceMethods
+          before_filter :setup_offers, :only=>:offers          
+          helper RegPathHelper
+        end
+        
+        def reg_path_setup_options
+          @reg_path_setup_options
+        end
+        
+        def reg_path_name_or_sym
+          @reg_path_name_or_sym
+        end
+      end #ClassMethods
+      
+      module InstanceMethods
+        #Action responsible for navigating user through reg path.  Will continually retrieve and display the next offer in the reg path.
+        #Posts to this action are submitted to the OfferEngine and any confirmation page returned by the OfferEngine is displayed inline.
+        #When no offers are returned, the after_reg_path callback or the method specified by the :after option to acts_as_reg_path is fired.
+        def offers
+          setup_omniture
+          return if request.post? && handle_post
+
+          more_offers = get_and_show_next_offer
+          self.class.reg_path_setup_options[:after].to_proc.call(self) unless more_offers
+        end
+        
+        protected        
+        #Either this method should be overwritten by the including class, or :after should be used when calling acts_as_reg_path
+        def after_reg_path
+          raise RegPathException.new("The after_reg_path lifecycle hook has not been implemented in #{self.class} or the :after option was not passed to acts_as_reg_path.")
+        end
+        
+        def setup_offers;end
+        
+        def go_to_offers; return false; end
+
+        def reg_path_mail_setup
+          @reg_path_mail_params = {}
+        end
+        
+        private
+        #Initiate the reg path.  This will clear the reg_path session and redirect into the offers action.
+        def begin_reg_path
+          clear_reg_path_session
+          go_to_offers || redirect_to(:action=>:offers)
+        end
+        
+        #Retrieve the next offer from the OfferEngine and display it using the template that matches the offer's type.
+        #Returns false if there are no offers returned from the OfferEngine
+        def get_and_show_next_offer
+          @step = session[:reg_path_step] || 0    
+          session[:reg_path_step] = @step + 1
+          
+          return false unless next_offers
+
+          session[:reg_path_processed_offers] ||= []
+          session[:reg_path_processed_offers] += @offers.map(&:id)
+          
+          offer_type_name = @offers.first.offer_type_name
+          session[:reg_path_offer_type] = offer_type_name
+          render :action=>offer_type_name and return true
+        end
+        
+        def next_offers
+          reg_path   = OfferEngine::Models::RegPath.find(reg_path_name)
+          @offers    = reg_path.get_offers(@step, reg_path_options)
+          @num_steps = session[:reg_path_num_steps] ||= reg_path.num_steps
+          @offers.empty? ? false : @offers
+        end
+        
+        def clear_reg_path_session
+          session[:reg_path_step] = nil
+          session[:reg_path_num_steps] = nil
+          session[:reg_path_offer_type] = nil
+          session[:reg_path_processed_offers] = nil
+        end  
+
+        def handle_post          
+          @submission = offer_engine.submit_to_offer_engine(params.merge({:reg_path_offer_type=>session[:reg_path_offer_type]}))
+          return false unless @submission
+          
+          @last_offer = @submission.offer
+          begin 
+            reg_path_mail_setup and RegPathMailer.__send__("deliver_#{@last_offer.email_template}", @reg_path_mail_params) if @last_offer.email_template?
+          rescue
+            if logger
+              logger.error "Error while sending RegPath email: #{$!}"
+            else
+              raise $!
+            end
+          end
+          
+          @confirmation_page = @last_offer.confirmation_page
+          render :action=>:confirmation_page and return true unless @confirmation_page.blank?          
+        end
+
+        def offer_engine
+          @offer_engine ||= OfferEngine::Client.new
+        end
+                
+        def reg_path_name
+          reg_path_name_or_sym = self.class.reg_path_name_or_sym
+          if reg_path_name_or_sym.is_a?(Symbol)
+            reg_path_name_or_sym.to_proc.call(self)
+          elsif reg_path_name_or_sym.is_a?(String)
+            reg_path_name_or_sym
+          else
+            raise RegPathException.new("No reg path name or method specified")
+          end            
+        end
+        
+        def reg_path_options
+          @reg_path_options ||= {}
+          if (excludes = session[:reg_path_processed_offers])
+            @reg_path_options.merge!({:exclude=>excludes}) 
+          end
+          @reg_path_options          
+        end
+        
+        #Omniture event tracking starts at event11 and currently the last view event is event14.  
+        #If in the future we expand the omniture events tracking, this will need to be updated.
+        def setup_omniture          
+          step = session[:reg_path_step] || 0
+          @omniture_products = "Reg Path; #{@omniture_product_name}"
+        end
+      end #InstanceMethods
+    end
+  end
+end
+
+ActionController::Base.class_eval do
+  include ActionController::Acts::RegPath
+end

data/test/empty_offers.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<offers type="array">
+</offers>

data/test/offers.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<offers type="array">
+  <offer>
+    <created-at type="datetime">2008-11-24T22:46:00Z</created-at>
+    <description>Default house form</description>
+    <id type="integer">10</id>
+    <name>House Form</name>
+    <offer-type-id type="integer">2</offer-type-id>
+
+    <show-only-on-match type="boolean">false</show-only-on-match>
+    <submitter-id type="integer" nil="true"></submitter-id>
+    <updated-at type="datetime">2008-11-24T22:46:00Z</updated-at>
+    <url>house.html</url>
+    <weight type="integer">1</weight>
+    <offer-type-name>long_form</offer-type-name>
+	<email-template>house_form</email-template>
+  </offer>
+  <offer>
+    <created-at type="datetime">2008-11-24T22:46:00Z</created-at>
+    <description>iPort long form</description>
+    <id type="integer">11</id>
+    <name>iPort Test Long Form</name>
+    <offer-type-id type="integer">2</offer-type-id>
+
+    <show-only-on-match type="boolean">false</show-only-on-match>
+    <submitter-id type="integer">1</submitter-id>
+    <updated-at type="datetime">2008-11-25T05:34:06Z</updated-at>
+    <url>iport.html</url>
+    <weight type="integer">1</weight>
+    <offer-type-name>long_form</offer-type-name>
+	<email-template>house_form</email-template>
+  </offer>
+</offers>

data/test/reg_path.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<reg-path>
+  <created-at type="datetime">2008-12-08T19:27:37Z</created-at>
+  <description nil="true"></description>
+  <id type="integer">4</id>
+  <name>default</name>
+  <updated-at type="datetime">2008-12-08T19:27:37Z</updated-at>
+  <num-steps>3</num-steps>
+
+</reg-path>

data/test/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+
+  map.connect ':controller/:action/:id'
+end

data/test/submission.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<submission>
+  <created_at type="datetime">2008-12-08T14:57:30Z</created_at>
+  <id type="integer">28</id>
+  <offer_id type="integer">11</offer_id>
+  <sent_at type="datetime" nil="true"></sent_at>
+  <updated_at type="datetime">2008-12-08T14:57:30Z</updated_at>
+  <user_id type="integer">1</user_id>
+  <offer>
+    <confirmation_page>conf_page.html</confirmation_page>
+    <created_at type="datetime">2008-12-08T14:57:30Z</created_at>
+    <description nil="true"></description>
+    <id type="integer">11</id>
+    <name>Long form with confirmation page</name>
+    <offer_type_id type="integer">3</offer_type_id>
+    <show_only_on_match type="boolean">false</show_only_on_match>
+    <submitter_id type="integer" nil="true"></submitter_id>
+    <updated_at type="datetime">2008-12-08T14:57:30Z</updated_at>
+    <url nil="true"></url>
+    <weight type="integer">1</weight>
+    <offer_type_name>long_form</offer_type_name>
+	<email_template>house_form</email_template>
+  </offer>
+</submission>

data/test/submission_no_conf.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<submission>
+  <created_at type="datetime">2008-12-08T14:57:30Z</created_at>
+  <id type="integer">28</id>
+  <offer_id type="integer">11</offer_id>
+  <sent_at type="datetime" nil="true"></sent_at>
+  <updated_at type="datetime">2008-12-08T14:57:30Z</updated_at>
+  <user_id type="integer">1</user_id>
+  <offer>
+    <confirmation_page></confirmation_page>
+    <created_at type="datetime">2008-12-08T14:57:30Z</created_at>
+    <description nil="true"></description>
+    <id type="integer">11</id>
+    <name>Long form with confirmation page</name>
+    <offer_type_id type="integer">3</offer_type_id>
+    <show_only_on_match type="boolean">false</show_only_on_match>
+    <submitter_id type="integer" nil="true"></submitter_id>
+    <updated_at type="datetime">2008-12-08T14:57:30Z</updated_at>
+    <url nil="true"></url>
+    <weight type="integer">1</weight>
+    <offer_type_name>long_form</offer_type_name>
+	<email_confirmation_fragment></email_confirmation_fragment>
+  </offer>
+</submission>

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/reg_path'
+require "action_controller/test_case"
+require 'action_controller/test_process'
+require "routes"
+require "mocha"

data/test/test_offer_engine_client.rb

@@ -0,0 +1,95 @@
+require 'test_helper'
+require "mocha"
+require "shoulda"
+
+class OfferEngineClientTest < ActiveSupport::TestCase
+  
+  context "An OfferEngineClient, @offer_engine," do
+    setup do
+      @offer_engine = OfferEngine::Client.new
+    end
+    
+    context "submitting a long offer form to the OfferEngine" do
+      setup do
+        @mock = mock_submit    
+        @params = {:reg_path_offer_type=>"long_form", :test=>"test", :x=>"x"}
+      end
+      
+      should "submit to OfferEngine once" do
+        @mock.once    
+        @offer_engine.submit_to_offer_engine(@params)
+      end
+      
+      context "that has a confirmation form" do
+        setup do
+          # @mock.returns(mock('response', :body=>File.new(File.dirname(__FILE__) + "/submission.xml", 'r')))
+        end
+        
+        should "return a Submission representing the succesful submission" do
+          assert_equal OfferEngine::Models::Submission, @offer_engine.submit_to_offer_engine(@params).class
+        end
+        
+        should "return a Submission with confirmation_page equal to 'iport_confirmation.html'" do
+          submission = @offer_engine.submit_to_offer_engine(@params)
+          assert_equal "conf_page.html", submission.offer.confirmation_page
+          
+        end
+      end
+    end #submitting a long offer form to the OfferEngine    
+    
+    context "submitting 3 short offer forms to the OfferEngine" do
+      setup do
+        @mock = mock_submit    
+        @params = {:reg_path_offer_type=>"short_form", "offer_1"=>"test", "offer_2"=>"x", "offer_3"=>"y"}
+      end
+      
+      should "submit to OfferEngine once" do
+        @mock.times(3)
+        @offer_engine.submit_to_offer_engine(@params)
+      end
+    end #submitting a long offer form to the OfferEngine
+    
+    context "adding data for a user" do
+      setup do
+        @email = "test@test.com"
+        @keys = ["condition", "medication"]
+        @values = ["diabetes", "adhd"]
+      end
+      
+      should "call to the offer engine with query string ?email=test@test.com&keys[]=condition&keys[]=medication&values[]=diabetes&values[]=adhd" do
+        uri = URI.parse("#{OfferEngine::Properties.offer_engine_host}/data_store/add_data?email=test@test.com&keys%5B%5D=condition&keys%5B%5D=medication&values%5B%5D=diabetes&values%5B%5D=adhd")
+        Net::HTTP.expects(:get).with(responds_with(:path, uri.path)).returns(Net::HTTPSuccess.new("","",""))
+        assert @offer_engine.add_data(@email, @keys, @values)
+      end
+      
+      context "in hash form" do
+        setup do
+          @hash = {@keys[0] => @values[0], @keys[1] => @values[1]}
+        end
+        
+        should "call to the offer engine with query string ?email=test@test.com&keys[]=condition&keys[]=medication&values[]=diabetes&values[]=adhd" do
+          uri = URI.parse("#{OfferEngine::Properties.offer_engine_host}/data_store/add_data?email=test@test.com&keys%5B%5D=condition&keys%5B%5D=medication&values%5B%5D=diabetes&values%5B%5D=adhd")
+          Net::HTTP.expects(:get).with(responds_with(:path, uri.path)).returns(Net::HTTPSuccess.new("","",""))
+          assert @offer_engine.add_data(@email, @keys, @values)
+        end
+      end #in hash form
+    end #adding data for a user
+  end # An OfferEngineClient, @offer_engine,
+
+
+  private  
+  def stub_open(successful=true, with_offers=true, xml_filename=nil)
+    stub = OfferEngine::Client.any_instance.stubs(:open)
+    if successful
+      filename = xml_filename || (with_offers ? "offers" : "empty_offers")    
+      stub.returns(File.new(File.dirname(__FILE__) + "/#{filename}.xml", 'r'))
+    else
+      stub.raises(OpenURI::HTTPError.new("Error", ""))
+    end
+  end
+  
+  def mock_submit
+    OfferEngine::Properties.offer_engine_submit_offer_path = "http://test.com/test"
+    Net::HTTP.any_instance.expects(:start).returns(stub('response', :body=>File.read(File.dirname(__FILE__) + "/submission.xml")))
+  end
+end

data/test/test_reg_path.rb

@@ -0,0 +1,204 @@
+require 'test_helper'
+require "lib/reg_path"
+require "mocha"
+require "shoulda"
+
+class TestController < ActionController::Base
+  acts_as_reg_path :determine_reg_path_name, :after=>:reg_path_complete
+  
+  def start
+    begin_reg_path
+  end
+  
+  def finish
+  end
+  
+  def offers_with_view_path
+    append_view_path File.dirname(__FILE__) + "/.."   
+    offers_without_view_path
+  end
+  alias_method_chain :offers, :view_path
+  
+  protected
+  def setup_offers
+    @omniture_product_name = "Test"
+  end
+  
+  def reg_path_complete
+    redirect_to :action=>:finish
+  end
+  
+  def determine_reg_path_name
+    "test"
+  end
+
+  def reg_path_mail_setup
+    @reg_path_mail_params = {:to=>"test@test.com", :from=>"from@from.com", :subject=>"subject"}
+  end
+end
+
+class RegPathTest < ActionController::TestCase
+  tests TestController
+  
+  context "A RegPath controller" do
+    setup do
+      OfferEngine::Models::RegPath.stubs(:find).returns(OfferEngine::Models::RegPath.new.load(Hash.from_xml(File.read(File.dirname(__FILE__) + "/reg_path.xml"))["reg_path"]))
+      @emails = ActionMailer::Base.deliveries
+      @emails.clear
+    end
+    
+    context "in the action that triggers the reg path" do
+      setup do
+        get :start
+      end
+    
+      should "redirect to offers" do
+        assert_redirected_to :action => "offers"
+      end      
+    end #in the action that triggers the reg path
+    
+    context "calling the offers action in a case that returns offers" do
+      setup do
+        mock_reg_path
+        get :offers
+        @offer_type = @offers.first.offer_type_name
+      end
+      
+      should "render the template for the offer_type of the offer" do
+        assert_response :success
+        assert_template "test/#{@offer_type}"
+      end
+      
+      should "set @offers to the offers returned from OfferEngine" do
+        assert_equal @offers, assigns(:offers)        
+      end
+      
+      should "increment session[:reg_path_step] to 1" do
+        assert_equal 1, session[:reg_path_step]
+      end
+      
+      should "set session[:reg_path_offer_type] to the offer type" do
+        assert_equal @offer_type, session[:reg_path_offer_type]
+      end
+      
+      should "add the offer id returned by the OfferEngine to the list of offers to exclude" do
+        @offers.each do |offer|        
+          assert session[:reg_path_processed_offers].include?(offer.id)
+        end
+      end      
+      
+      should "set up omniture products correctly" do
+        assert_equal "Reg Path; Test", assigns(:omniture_products)
+      end
+      
+      should "set up omniture events correctly" do
+        assert_equal "event11", assigns(:omniture_events)
+      end
+      
+      context "calling offers action again" do
+        setup do
+          get :offers
+        end
+        
+        should "increment session[:reg_path_step] to 2" do
+          assert_equal 2, session[:reg_path_step]
+        end
+        
+        should "set up omniture events properly" do
+          assert_equal "event14,event13", assigns(:omniture_events)
+        end
+        
+        context "calling offers action a third time" do
+          setup do
+            get :offers
+          end
+
+          should "increment session[:reg_path_step] to 3" do
+            assert_equal 3, session[:reg_path_step]
+          end
+
+          should "set up omniture events properly.  View events should not exceed the maximum view event in omniture (currently event14)" do
+            assert_equal "event14,event13", assigns(:omniture_events)
+          end
+        end #calling offers action again
+      end #calling offers action again
+      
+      
+      
+      context "calling the action that starts the reg path again" do
+        setup do
+          get :start
+        end
+        
+        should "clear all session variables" do
+          [:reg_path_step, :reg_path_processed_offers, :reg_path_offer_type].each do |sym|
+            assert_nil session[sym]
+          end
+        end
+      end #calling the action the starts the reg path again
+          
+    end #calling the offers action in a case that returns offers
+    
+    context "calling the offers action in a case that returns no offers" do
+      setup do
+        mock_reg_path(false)
+        get :offers
+      end
+      
+      should "redirect to the finish action" do
+        assert_redirected_to :action => "finish"
+      end      
+    end #calling the offers action in a case that returns offers
+    
+    context "posting to the offers action" do
+      setup do
+        mock_reg_path_submit
+      end
+      
+      should "still call RegPath.get_offers" do
+        mock_reg_path
+        post :offers
+      end
+      
+      should "not send an email" do
+        mock_reg_path
+        assert_no_difference("@emails.size") do
+          post :offers
+        end
+      end
+    end #posting to the offers action
+    
+    context "posting to the offers action with an offer that has a confirmation page and email" do
+      setup do
+        mock_reg_path_submit("confirmation_page.html")
+        File.expects(:exists?).returns(false) #ignore the overridden mail templates
+      end
+      
+      should "render the confirmation page action" do
+        post :offers
+        assert_response :success
+        assert_template "test/confirmation_page"
+      end
+      
+      should "send an email" do 
+        assert_difference("@emails.size") do
+          post :offers
+        end
+      end
+    end #posting to the offers action with an offer that has a confirmation page
+    
+  end #A RegPath controller
+  
+  private
+  def mock_reg_path(with_offers = true)
+    @offers = with_offers ? Hash.from_xml(File.read(File.dirname(__FILE__) + "/offers.xml"))["offers"] : []
+    @offers.map! {|offer| OfferEngine::Models::Offer.new.load(offer)}
+    OfferEngine::Models::RegPath.any_instance.expects(:get_offers).at_least_once.returns(@offers)
+  end
+  
+  def mock_reg_path_submit(confirmation_page = false)
+    filename = confirmation_page ? "submission.xml" : "submission_no_conf.xml"
+    OfferEngine::Properties.offer_engine_submit_offer_path = "http://test.com/test"    
+    Net::HTTP.any_instance.expects(:start).returns(stub('response', :body=>File.read(File.dirname(__FILE__) + "/#{filename}")))
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: gregfitz23-RegPath
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Greg Fitzgerald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-26 00:00:00 -07:00
+default_executable: reg_path
+dependencies: []
+
+description: TODO
+email: greg_fitz@yahoo.com
+executables: 
+- reg_path
+extensions: []
+
+extra_rdoc_files: 
+- README
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- RegPath.gemspec
+- VERSION.yml
+- bin/reg_path
+- lib/reg_path
+- lib/reg_path/_progress_bar.html.erb
+- lib/reg_path/helpers
+- lib/reg_path/helpers/reg_path_helper.rb
+- lib/reg_path/mailer
+- lib/reg_path/mailer/reg_path_mailer
+- lib/reg_path/mailer/reg_path_mailer/house_form.html.erb
+- lib/reg_path/mailer/reg_path_mailer.rb
+- lib/reg_path/models
+- lib/reg_path/offer_engine
+- lib/reg_path/offer_engine/client.rb
+- lib/reg_path/offer_engine/models
+- lib/reg_path/offer_engine/models/offer.rb
+- lib/reg_path/offer_engine/models/reg_path.rb
+- lib/reg_path/offer_engine/models/submission.rb
+- lib/reg_path/offer_engine/models/user.rb
+- lib/reg_path/properties.rb
+- lib/reg_path/reg_path.rb
+- lib/reg_path.rb
+- test/confirmation_page.html.erb
+- test/empty_offers.xml
+- test/house_form.html.erb
+- test/long_form.html.erb
+- test/offers.xml
+- test/reg_path.xml
+- test/routes.rb
+- test/short_form.html.erb
+- test/submission.xml
+- test/submission_no_conf.xml
+- test/test_helper.rb
+- test/test_offer_engine_client.rb
+- test/test_reg_path.rb
+- README
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+