leadtune 0.0.1

data/lib/leadtune/rest.rb

@@ -0,0 +1,98 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "json"
+
+module Leadtune
+  class Rest #:nodoc:all
+
+    def initialize(config)
+      @config = config
+      @post_data = nil
+    end
+
+    def get(post_data)
+      @post_data = post_data
+      curl = build_curl_easy_object_get
+      curl.http("GET")
+      curl.body_str ? JSON::parse(curl.body_str) : {}
+    end
+
+    def post(post_data)
+      @post_data = post_data
+      curl = build_curl_easy_object_post
+      curl.http("POST")
+      curl.body_str ? JSON::parse(curl.body_str) : {}
+    end
+
+    def put(post_data)
+      @post_data = post_data
+      curl = build_curl_easy_object_put
+      curl.http("PUT")
+      curl.body_str ? JSON::parse(curl.body_str) : {}
+    end
+
+
+    private
+
+    def build_curl_easy_object(&block) #:nodoc:
+      Curl::Easy.new do |curl|
+        curl.http_auth_types = [:basic,]
+        curl.username = @config.username
+        curl.password = @config.password
+        curl.timeout = @config.timeout
+        curl.headers = default_headers
+        curl.on_failure do |curl, code|
+          raise LeadtuneError.new("#{curl.response_code} #{curl.body_str}")
+        end
+        #curl.verbose = true
+        yield curl
+      end
+    end
+
+    def default_headers #:nodoc:
+      {"Content-Type" => "application/json",
+       "Accept" => "application/json",}
+    end
+
+    def build_curl_easy_object_post #:nodoc:
+      build_curl_easy_object do |curl|
+        curl.url = URI.join(@config.leadtune_host, "/prospects").to_s
+        curl.post_body = @post_data.to_json
+      end
+    end
+
+    def build_curl_easy_object_put #:nodoc:
+      build_curl_easy_object do |curl|
+        curl.url = build_put_url
+        #curl.verbose = true
+        curl.put_data = @post_data.to_json
+      end
+    end
+
+    def build_curl_easy_object_get #:nodoc:
+      build_curl_easy_object do |curl|
+        curl.url = build_get_url
+      end
+    end
+
+    def build_get_url #:nodoc:
+      params = {:organization => @post_data["organization"],}
+      if @post_data["prospect_ref"]
+        params.merge!(:prospect_ref => @post_data["prospect_ref"]) 
+      end
+
+      URI.join(build_put_url, "?" + params.to_params).to_s
+    end
+
+    def build_put_url #:nodoc:
+      path = "/prospects"
+      path += "/#{@post_data["prospect_id"]}" if @post_data["prospect_id"]
+      URI.join(@config.leadtune_host, path).to_s
+    end
+
+  end
+end

data/lib/leadtune/version.rb

@@ -0,0 +1,9 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+module Leadtune
+  VERSION = "0.0.1"
+end

data/lib/leadtune.rb

@@ -0,0 +1,26 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+require "array_extensions"
+require "hash_extensions"
+
+
+# For details about the LeadTune API, see: http://leadtune.com/api
+
+module Leadtune #:nodoc:all
+end
+
+# Raised when non-2XX responses are received.
+class Leadtune::LeadtuneError < RuntimeError ; end 
+
+
+require "leadtune/prospect"
+require "leadtune/rest"
+require "leadtune/appraisals"
+

data/spec/echo_server.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "rubygems"
+require "ruby-debug"
+require "webrick"
+require "json"
+require "pp"
+
+server = WEBrick::HTTPServer.new({:Port => 8080})
+trap("INT"){server.shutdown}
+trap("TERM"){server.shutdown}
+
+def random_buyers(target_buyers)
+  target_buyers.map {|name| {"target_buyer" => name, :value => [0, 1].choice}}
+end
+
+server.mount_proc("/prospects") do |request, response|
+  if request.body
+    json = JSON.parse(request.body) if request.body
+
+    pp(json)
+
+    if json.include?("sleep")
+      $stderr.puts "sleeping..."
+      sleep json["sleep"].to_i 
+    end
+
+    response.status = 201
+    response["Content-Type"] = "application/json"
+    r = {
+      "prospect_id" => "deadbeef",
+      "decision" => {
+        "decision_id" => "deadbeef",
+        "organization" => json["organization"],
+        "created_at" => Time.now,
+        "appraisals" => random_buyers(json["decision"]["target_buyers"]),
+      },
+      "organization" => json["organization"],
+      "event" => json["event"],
+      "email_hash" => "deadbeef",
+      "created_at" => Time.now,
+    }
+    response.body = r.to_json
+  else
+    response.body = {:prospect_ids => []}.to_json
+  end
+end
+
+server.start

data/spec/get.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "rubygems"
+require "pp"
+require File.join(File.dirname(__FILE__), "../lib/leadtune")
+
+
+begin
+  p = Leadtune::Prospect.new do |p|
+    p.organization = "AcmeU"
+    p.username = "admin@acme.edu"
+    p.password = "admin"
+    # p.leadtune_host = "http://localhost:8080"
+    p.prospect_ref = "CRONIN"
+  end
+
+  p.get
+  pp p.factors
+
+  pp Leadtune::Prospect.new({:prospect_id => "4c92f8d6b34601dd5ecac030",
+                             :username => "admin@acme.edu",
+                             :password => "admin",
+                             :organization => "AcmeU",}).get.factors
+rescue Leadtune::LeadtuneError => e
+  puts e.to_s
+end
+

data/spec/leadtune/appraisals_spec.rb

@@ -0,0 +1,26 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "spec_helper"
+
+describe Leadtune::Appraisals do
+
+  subject do 
+    Leadtune::Appraisals.new([{"target_buyer" => "AcmeU", "value" => 1},
+                              {"target_buyer" => "Bravo", "value" => 0},])
+  end
+
+  describe("#non_duplicates") do
+    it "includes target buyers to whom the prospect is not a duplicate" do
+      subject.non_duplicates.should include({"target_buyer" => "AcmeU", "value" => 1})
+    end
+
+    it "excludes target buyers to whom the prospect is a duplicate" do
+      subject.non_duplicates.should_not include({"target_buyer" => "Bravo", "value" => 0})
+    end
+  end
+
+end

data/spec/leadtune/prospect_spec.rb

@@ -0,0 +1,162 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "digest"
+require "json"
+require "spec_helper"
+
+describe Leadtune::Prospect do
+
+  subject do 
+    Leadtune::Prospect.new({"prospect_id" => "deadfish",
+                            "email" => "bar@baz.com",
+                            "target_buyers" => ["AcmeU", "Bravo", "ConvU",],
+                            "event" => "offers_prepared",}) do |p|
+      # use ||= so we won't override if loaded from ENV or config_file
+      p.organization ||= "Foo"
+    end
+  end
+
+  context("w/ organization from config_file") do
+    subject do
+      Leadtune::Prospect.new(leadtune_config_file)
+    end
+
+    describe "#organization" do
+      specify {subject.organization.should == "config_file_org"}
+    end
+  end
+
+  context("when presented with an unrecognized factor") do
+    it "creates a setter and a getter by that name" do
+      fail "getter already exists" if subject.respond_to?(:my_new_factor)
+      fail "setter already exists" if subject.respond_to?(:my_new_factor=)
+
+      subject.my_new_factor = 5
+
+      subject.should respond_to(:my_new_factor=)
+      subject.should respond_to(:my_new_factor)
+      subject.my_new_factor.should == 5
+    end
+  end
+  
+  context("w/ organization from ENV") do
+    before(:all) do
+      setup_leadtune_env
+    end
+
+    after(:all) do
+      teardown_leadtune_env
+    end
+
+    subject {Leadtune::Prospect.new}
+    
+    describe "#organization" do
+      specify {subject.organization.should == "env_org"}
+    end
+  end
+
+  context("w/ organization from ENV *AND* config_file") do
+
+    before(:all) do
+      setup_leadtune_env
+    end
+
+    after(:all) do
+      teardown_leadtune_env
+    end
+
+    subject {Leadtune::Prospect.new(leadtune_config_file)}
+
+    describe "#organization" do
+      it "uses the ENV value over the config file" do
+        subject.organization.should == "env_org"
+      end
+    end
+  end
+
+  describe "#get" do
+    before(:each) do
+      stub_request(:any, /.*leadtune.*/).to_return(:body => fake_curb_response)
+    end
+
+    it "loads the browser_family factor" do
+      subject.get
+
+      subject.browser_family.should == "Firefox"
+    end
+
+  end
+
+  describe "#post_body" do
+    before(:each) do
+      # requests are stubbed by json_factors_should_include
+    end
+
+    it "includes decision" do
+      rest = double(Leadtune::Rest).as_null_object
+      Leadtune::Rest.stub!(:new).and_return(rest)
+      expected_factors = {"decision" => subject.decision,}
+      subject.stub(:parse_response)
+
+      rest.should_receive(:post).with {|hash| hash.should include(expected_factors)}
+
+      subject.post
+    end
+  end
+
+  describe("#new") do
+    it "receives options in a Hash" do
+      s = Leadtune::Prospect.new({:channel => "banner",})
+
+      s.channel.should == "banner"
+    end
+
+    it "accepts a config_file as its (optional) first argument" do
+      s = Leadtune::Prospect.new(leadtune_config_file, {:channel => "banner",})
+
+      s.channel.should == "banner"
+      s.organization.should == "config_file_org"
+    end
+  end
+
+  describe("#target_buyers=") do
+    it "is represented in the decision field of the JSON post body" do
+      subject.target_buyers = ["foo",]
+      json_factors_should_include({"decision" => {"target_buyers" => ["foo"]}})
+
+      subject.post
+    end
+
+    it "raises ArgumentError when called with a non-Array" do
+      lambda {subject.target_buyers = "foo"}.should raise_error(ArgumentError)
+    end
+  end
+
+
+  private
+
+  def json_factors_should_include(expected_factors)
+    stub_request(:any, /.*leadtune.*/).to_return do |req|
+      json = JSON::parse(req.body)
+      json.should include(expected_factors)
+      {:body => req.body, :status => [201, "Created"]}
+    end
+  end
+
+  def fake_curb_response
+    {:event => "offers_prepared",
+     :organization => "LOL",
+     :created_at => Time.now,
+     :browser_family => "Firefox",
+     :browser_version => "3.6.3",
+     :email_hash => "deadbeef",
+     :decision => {
+       :appraisals => [{:target_buyer => "TB-LOL", :value => 1},],
+     },
+     :prospect_id => "deadbeef",}.to_json
+  end
+end

data/spec/leadtune/rest_spec.rb

@@ -0,0 +1,243 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "tempfile"
+require "webrick"
+require "tcpsocket-wait"
+
+require "spec_helper"
+
+describe Leadtune::Rest do
+
+  subject {Leadtune::Rest.new(Leadtune::Config.new)}
+
+  context("w/ username & password from config_file") do
+
+    subject {Leadtune::Rest.new(rest_config)}
+
+    before(:each) do
+      @curl_easy = null_curl_easy
+    end
+
+    describe "#username" do
+      it "uses the config_file value" do
+        @curl_easy.should_receive(:username=).with("config@config.com")
+
+        subject.get(mock_post_data)
+      end
+    end
+
+    describe "#password" do
+      it "uses the config_file value" do
+        @curl_easy.should_receive(:password=).with("config_secret")
+
+        subject.get(mock_post_data)
+      end
+    end
+  end
+
+  context("w/ username & password from ENV") do
+    before(:all) do
+      setup_leadtune_env
+    end
+
+    after(:all) do
+      teardown_leadtune_env
+    end
+
+    before(:each) do
+      @curl_easy = null_curl_easy
+    end
+
+    describe "#username" do
+      it "uses the ENV value" do
+        @curl_easy.should_receive(:username=).with("env@env.com")
+        
+        subject.get(mock_post_data)
+      end
+    end
+
+    describe "#password" do
+      it "uses the ENV value" do
+        @curl_easy.should_receive(:password=).with("env_secret")
+        
+        subject.get(mock_post_data)
+      end
+    end
+  end
+
+  context("w/ username & password from ENV *AND* config_file") do
+
+    subject {Leadtune::Rest.new(rest_config)}
+
+    before(:all) do
+      setup_leadtune_env
+    end
+
+    after(:all) do
+      teardown_leadtune_env
+    end
+
+    before(:each) do
+      @curl_easy = null_curl_easy
+    end
+
+    describe "#username" do
+      it "uses the ENV value over the config file" do
+        @curl_easy.should_receive(:username=).with("env@env.com")
+
+        subject.get(mock_post_data)
+      end
+    end
+
+    describe "#password" do
+      it "uses the ENV value over the config file" do
+        @curl_easy.should_receive(:password=).with("env_secret")
+
+        subject.get(mock_post_data)
+      end
+    end
+  end
+
+  describe "#post (slow)" do
+
+    before(:all) {WebMock.allow_net_connect!}
+    after(:all) {WebMock.disable_net_connect!}
+
+    ["401", "404", "500"].each do |code|
+      context("when a #{code} is returned") do
+        it "raises a LeadtuneError" do
+          mock_server(code) do
+            lambda {subject.post(mock_post_data)}.should raise_error(Leadtune::LeadtuneError)
+          end
+        end
+      end
+    end
+  end
+
+  describe("#timeout") do
+    before(:each) do
+      @curl_easy = null_curl_easy
+    end
+
+    it "is passed on to Curl::Easy" do
+      @curl_easy.should_receive(:timeout=).with(5)
+
+      subject.get(mock_post_data)
+    end
+
+    context("by default") do
+      it "is 5" do
+        @curl_easy.should_receive(:timeout=).with(5)
+
+        subject.get(mock_post_data)
+      end
+    end
+
+    context("with timeout of 6 in ENV value") do
+      before(:all) do
+        ENV["LEADTUNE_TIMEOUT"] = "6"
+      end
+
+      after(:all) do
+        ENV.delete("LEADTUNE_TIMEOUT")
+      end
+
+      it "is 6" do
+        @curl_easy.should_receive(:timeout=).with(6)
+
+        subject.get(mock_post_data)
+      end
+    end
+
+    context("with timeout of 7 in config_file") do
+      subject {Leadtune::Rest.new(rest_config)}
+
+      it "is 7" do
+        @curl_easy.should_receive(:timeout=).with(7)
+
+        subject.get(mock_post_data)
+      end
+    end
+
+  end
+
+
+  private
+
+  def json_factors_should_include(expected_factors)
+    stub_request(:any, /.*leadtune.*/).to_return do |req|
+      json = JSON::parse(req.body)
+      json.should include(expected_factors)
+      {:body => req.body, :status => [201, "Created"]}
+    end
+  end
+
+  def fake_curb_response
+    {:event => "offers_prepared",
+     :organization => "LOL",
+     :created_at => Time.now,
+     :browser_family => "Firefox",
+     :browser_version => "3.6.3",
+     :email_hash => "deadbeef",
+     :decision => {
+       :appraisals => [{:target_buyer => "TB-LOL", :value => 1},],
+     },
+     :prospect_id => "deadbeef",}.to_json
+  end
+
+  def mock_post_data
+    {"prospect_id" => "deadbeef",}
+  end
+
+  def null_curl_easy
+    curl_easy = double(Curl::Easy, :body_str => "{}").as_null_object
+    Curl::Easy.stub!(:new).and_yield(curl_easy).and_return(curl_easy)
+    curl_easy
+  end
+
+  def rest_config
+    config_file = StringIO.new <<EOF
+username: config@config.com
+password: config_secret
+timeout: 7
+EOF
+    Leadtune::Config.new(config_file)
+  end
+
+  def mock_server(code, &block)
+    quietly do
+      server = WEBrick::HTTPServer.new(:Port => THREADED_MOCK_SERVER_PORT)
+      server.mount_proc("/prospects") do |req, res|
+        res.body = "mock_server"
+        res.status = code
+      end
+
+      thread = Thread.new(server) {|s| s.start}
+
+      TCPSocket.wait_for_service_with_timeout({:host => "localhost", 
+                                               :port => THREADED_MOCK_SERVER_PORT,
+                                               :timeout => 10})
+      block.call
+      server.shutdown
+      thread.join
+    end
+  end
+
+  def quietly(&block)
+    old_stdout = old_stderr = nil
+
+    Tempfile.open("seller_spec") do |tf|
+      old_stdout, $stdout = $stdout, tf
+      old_stderr, $stderr = $stderr, tf
+      block.call(tf)
+    end
+    
+    $stdout, $stderr = old_stdout, old_stderr
+  end
+
+  THREADED_MOCK_SERVER_PORT = 9292
+end

data/spec/post.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+require "rubygems"
+require "ruby-debug"
+require "pp"
+require File.join(File.dirname(__FILE__), "../lib/leadtune")
+
+p = Leadtune::Prospect.post do |p|
+  p.event = "offers_prepared"
+  p.organization = "LOL"
+  p.username = "admin@loleads.com"
+  p.password = "admin"
+  p.email = "test@example.com"
+  p.target_buyers = ["AcmeU", "Bravo", "ConvU",]
+  #p.leadtune_host = "http://localhost:8080"
+end
+
+pp p.factors
+pp p.decision_id