leadtune 0.0.2 → 0.0.3

data/README.rdoc

@@ -19,26 +19,6 @@ detailed below.  Available configuration values include:
 * password
 * organization
 
-=== Configuration File
-
-The configuration file can be specified when calling Prospect#new.  If no
-file is specified, the gem will also look for +leadtune.yml+ in the
-current directory.
-
-==== Format
-
-The configuration file is a YAML file, an example of which is:
- username: me@mycorp.com
- password: my_secret
- organization: MYC
-
-=== Environment Variables
-
-Your LeadTune username, password, and organization can be specified in the
-+LEADTUNE_USERNAME+, +LEADTUNE_PASSWORD+, and +LEADTUNE_ORGANIZATION+
-environment variables. <em>These values take precedence over values read
-from the configuration file.</em>
-
 === Rack Initializer
 
  # config/initializers/leadtune.rb
@@ -46,23 +26,19 @@ from the configuration file.</em>
  Leadtune::Config.password = "my_secret"
  Leadtune::Config.organization = "MYC"
 
-<em>These values take precedence over values read from environment variables
-or configuration file.</em>
-
 === Factors Hash
 
 When initializing your Leadtune::Prospect, you can include your username,
 password, and organization along with any factors you wish to
-submit. <em>These values take precedence over values read from rack
-initializers, environment variables, or the configuration file.</em>
+submit. <em>These values take precedence over values read from the rack
+initializer.</em>
 
 === Instance Methods
 
 You can also set your username, password, and organization by calling the
 Leadtune::Prospect object's #username=, #password=, and #organization=
 methods. <em>These values take precedence over values read from the factors
-hash, rack initializers, environment variables, or the configuration
-file.</em>
+hash and the rack initializer.</em>
 
 == Example Usage
 
@@ -97,9 +73,9 @@ An attempt was made to allow for an ActiveModel-like interface.
  ... and so on
  prospect.post
 
-== Automatic Environment Determination
+== Automatic Environment Detection
 
-At initialization, an attempt is made to determine your application's current
+At initialization, an attempt is made to detect your application's current
 environment.  If a rack or rails production environment is detected, prospects
 will be posted to LeadTune's production host.  Otherwise prospects will be
 posted to LeadTune's sandbox host.  The application environment can be

data/Rakefile

@@ -36,7 +36,4 @@ end
 
 task :hudson => [:spec, :rdoc,]
 
-task :default => [:spec, :cucumber,]
-
-
-
+task :default => [:spec,]# :cucumber,]

data/lib/leadtune/config.rb

@@ -16,10 +16,6 @@ module Leadtune
     @@organization = nil
     @@timeout = nil
 
-    def initialize(config_file=nil)
-      load_config_file_values(config_file)
-    end
-
     def self.username=(username)
       @@username = username
     end
@@ -37,32 +33,27 @@ module Leadtune
     end
 
     def self.timeout=(timeout)
-      @@timeout = timeout.to_i
+      @@timeout = timeout
     end
 
     def username
-      @username ||= @@username || ENV["LEADTUNE_USERNAME"] || @config_file_values["username"]
+      @username ||= @@username
     end
 
     def password
-      @password ||= @@password || ENV["LEADTUNE_PASSWORD"] || @config_file_values["password"]
+      @password ||= @@password
     end
 
     def timeout
-      @timeout ||= (@@timeout ||
-                    ENV["LEADTUNE_TIMEOUT"] || 
-                    @config_file_values["timeout"] || 
-                    DEFAULT_TIMEOUT).to_i
+      @timeout ||= @@timeout || DEFAULT_TIMEOUT
     end
 
     def organization
-      @@organization || ENV["LEADTUNE_ORGANIZATION"] || @config_file_values["organization"]
+      @@organization
     end
 
     def leadtune_host
-      @leadtune_host ||= (ENV["LEADTUNE_HOST"] || 
-                          @config_file_values["host"] ||
-                          LEADTUNE_HOSTS[environment])
+      @leadtune_host ||= @@leadtune_host || LEADTUNE_HOSTS[environment]
     end
 
     def environment
@@ -83,28 +74,6 @@ module Leadtune
 
     private
 
-    def load_config_file_values(config_file)
-      @config_file_values = {}
-
-      find_config_file(config_file) do |config_file|
-        @config_file_values = YAML::load(config_file)
-      end
-    end
-
-    def find_config_file(config_file)
-      case config_file
-      when String
-        yield File.open(config_file)
-      when File, StringIO
-        yield config_file
-      when nil
-        if File.exist?("leadtune.yml")
-          yield File.open("leadtune.yml") 
-        end
-      end
-    end
-
-
     DEFAULT_TIMEOUT = 5
     LEADTUNE_HOST_SANDBOX = "https://sandbox-appraiser.leadtune.com".freeze 
     LEADTUNE_HOST_PRODUCTION = "https://appraiser.leadtune.com".freeze

data/lib/leadtune/prospect.rb

@@ -29,18 +29,13 @@ module Leadtune
   class Prospect
     attr_accessor :decision  #:nodoc:
 
-    # Initialize a new Leadtune::Prospect object.  
-    #
-    # [+config_file+] An optional filename or a file-like object
-    # [+factors+]     A hash of factors with which to initialize the Prospect
-
-    def initialize(*args, &block)
+    def initialize(options_and_factors={}, &block)
       @factors = {}
       @decision = nil
-      @config = Config.new(args.first)
+      @config = Config.new
       @rest = Rest.new(@config)
 
-      load_options_and_factors(args.extract_options!)
+      load_options_and_factors(options_and_factors)
       block.call(self) if block_given?
     end
 
@@ -48,24 +43,24 @@ module Leadtune
     #
     # Raises a Leadtune::LeadtuneError if a non-2XX response is received.
 
-    def self.get(options={}, &block)
-      new(options, &block).get
+    def self.get(options_and_factors={}, &block)
+      new(options_and_factors, &block).get
     end
 
     # Post a prospect to the LeadTune Appraiser service.
     #
     # Raises a Leadtune::LeadtuneError if a non-2XX response is received.
 
-    def self.post(options={}, &block)
-      new(options, &block).post
+    def self.post(options_and_factors={}, &block)
+      new(options_and_factors, &block).post
     end
 
     # Update a prospect from the LeadTune Appraiser service.
     #
     # Raises a Leadtune::LeadtuneError if a non-2XX response is received.
 
-    def self.put(options={}, &block)
-      new(options, &block).put
+    def self.put(options_and_factors={}, &block)
+      new(options_and_factors, &block).put
     end
 
     # Get a prospect from the LeadTune Appraiser service.
@@ -159,6 +154,14 @@ module Leadtune
       @config.leadtune_host
     end
 
+    def timeout=(timeout) #:nodoc:
+      @config.timeout = timeout
+    end
+
+    def timeout #:nodoc:
+      @config.timeout
+    end
+
     def username=(username)
       @config.username = username
     end
@@ -167,18 +170,18 @@ module Leadtune
       @config.password = password
     end
 
-    def response
+    def response #:nodoc:
       @rest.response
     end
 
-    def payload
+    def payload #:nodoc:
       post_data.reject {|k,v| CURL_OPTIONS.include?(k)}
     end
 
 
     private 
 
-    CURL_OPTIONS = ["username", "password", "timeout", "leadtune_host",]
+    CURL_OPTIONS = ["username", "password", "timeout", "leadtune_host",] #:nodoc:
 
     def post_data #:nodoc:
       @factors.merge("decision" => @decision, 

data/lib/leadtune/rest.rb

@@ -89,7 +89,7 @@ module Leadtune
         params.merge!(:prospect_ref => @post_data["prospect_ref"]) 
       end
 
-      URI.join(build_put_url, "?" + params.to_params).to_s
+      URI.join(build_put_url, "?" + Leadtune::Util.to_params(params)).to_s
     end
 
     def build_put_url #:nodoc:

data/lib/leadtune/util.rb

@@ -0,0 +1,38 @@
+# LeadTune API Ruby Gem
+#
+# http://github.com/leadtune/leadtune-ruby
+# Eric Wollesen (mailto:devs@leadtune.com)
+# Copyright 2010 LeadTune LLC
+
+module Leadtune
+  class Util
+
+    # File merb/core_ext/hash.rb, line 87, with slight tweaks
+
+    def self.to_params(hash)
+      params = ''
+      stack = []
+
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << [k,v]
+        else
+          params << "#{k}=#{v}&"
+        end
+      end
+
+      stack.each do |parent, sub_hash|
+        sub_hash.each do |k, v|
+          if v.is_a?(Hash)
+            stack << ["#{parent}[#{k}]", v]
+          else
+            params << "#{parent}[#{k}]=#{v}&"
+          end
+        end
+      end
+
+      params.chop! # trailing &
+      params
+    end
+  end
+end

data/lib/leadtune/version.rb

@@ -5,5 +5,5 @@
 # Copyright 2010 LeadTune LLC
 
 module Leadtune
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/leadtune.rb

@@ -7,10 +7,6 @@
 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
@@ -18,19 +14,24 @@ end
 
 # Raised when non-2XX responses are received.
 class Leadtune::LeadtuneError < RuntimeError 
-  attr_reader :code, :message
+
+  # HTTP status code
+  attr_reader :code
+
+  # Any body text included with the response
+  attr_reader :message 
 
   def initialize(code, message)
     @code, @message = code, message
   end
 
-  def to_s
+  def to_s #:nodoc:
     "#{@code} #{message}"
   end
 end 
 
 
-
+require "leadtune/util"
 require "leadtune/prospect"
 require "leadtune/rest"
 require "leadtune/appraisals"

data/spec/leadtune/config_spec.rb

@@ -6,18 +6,17 @@
 
 require "spec_helper"
 
-class Leadtune::Config
-  def self.reset_class_vars
-    @@timeout = nil
-    @@organization = nil
-    @@username = nil
-    @@password = nil
-  end
-end
-
 describe Leadtune::Config do
-  before(:each) {Leadtune::Config.reset_class_vars}
-  after(:each) {Leadtune::Config.reset_class_vars}
+  before(:each) {teardown_initializer}
+  after(:each) {teardown_initializer}
+
+  it "reads environment from APP_ENV" do
+    ENV["APP_ENV"] = "production"
+
+    subject.environment.should == :production
+
+    ENV.delete("APP_ENV")
+  end
 
   context("can set") do
     it "password" do
@@ -43,5 +42,11 @@ describe Leadtune::Config do
 
       Leadtune::Config.new.organization.should == "ORG"
     end
+
+    it "leadtune_host" do
+      Leadtune::Config.leadtune_host = "http://bad_url_for_test"
+
+      Leadtune::Config.new.leadtune_host.should == "http://bad_url_for_test"
+    end
   end
 end

data/spec/leadtune/prospect_spec.rb

@@ -15,21 +15,11 @@ describe Leadtune::Prospect do
                             "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
+      # use ||= so we won't override if loaded from initializer
       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)
@@ -43,41 +33,6 @@ describe Leadtune::Prospect do
     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)
@@ -114,13 +69,6 @@ describe Leadtune::Prospect do
 
       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
@@ -136,6 +84,17 @@ describe Leadtune::Prospect do
     end
   end
 
+  context("w/ organization from initializer") do
+    before(:each) {setup_initializer}
+    after(:each) {teardown_initializer}
+
+    describe("#organization") do
+      it "uses the initializer value" do
+        subject.organization.should == "init_org"
+      end
+    end        
+  end
+
 
   private
 

data/spec/leadtune/rest_spec.rb

@@ -14,94 +14,35 @@ 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)}
+  context("w/ username and password from initializer") do
 
     before(:each) do
       @curl_easy = null_curl_easy
+      setup_initializer
     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
+    after(:each) do
+      teardown_initializer
     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")
+      it "uses the initializer value" do
+        @curl_easy.should_receive(:username=).with("init_user")
 
         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")
+      it "uses the initializer value" do
+        @curl_easy.should_receive(:password=).with("init_secret")
 
         subject.get(mock_post_data)
       end
     end
   end
 
+
   describe "#post (slow)" do
 
     before(:all) {WebMock.allow_net_connect!}
@@ -123,12 +64,6 @@ describe Leadtune::Rest 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)
@@ -137,25 +72,15 @@ describe Leadtune::Rest do
       end
     end
 
-    context("with timeout of 6 in ENV value") do
-      before(:all) do
-        ENV["LEADTUNE_TIMEOUT"] = "6"
+    context("with timeout of 7 in initializer") do
+      before(:each) do
+        setup_initializer
       end
 
-      after(:all) do
-        ENV.delete("LEADTUNE_TIMEOUT")
+      after(:each) do
+        teardown_initializer
       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)
 
@@ -199,15 +124,6 @@ describe Leadtune::Rest do
     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)

data/spec/spec_helper.rb

@@ -14,22 +14,19 @@ RSpec.configure do |config|
   config.include WebMock
 end
 
-def setup_leadtune_env
-  ENV["LEADTUNE_USERNAME"] = "env@env.com"
-  ENV["LEADTUNE_PASSWORD"] = "env_secret"
-  ENV["LEADTUNE_ORGANIZATION"] = "env_org"
+def setup_initializer
+  Leadtune::Config.username = "init_user"
+  Leadtune::Config.password = "init_secret"
+  Leadtune::Config.timeout = 7
+  Leadtune::Config.organization = "init_org"
+  Leadtune::Config.leadtune_host = "http://localhost.init"
 end
 
-def teardown_leadtune_env
-  ENV.delete("LEADTUNE_USERNAME")
-  ENV.delete("LEADTUNE_PASSWORD")
-  ENV.delete("LEADTUNE_ORGANIZATION")
+def teardown_initializer
+  Leadtune::Config.username = nil
+  Leadtune::Config.password = nil
+  Leadtune::Config.timeout = nil
+  Leadtune::Config.organization = nil
+  Leadtune::Config.leadtune_host = nil
 end
 
-def leadtune_config_file
-  StringIO.new <<EOF
-username: config_file@config_file.com
-password: config_file_secret
-organization: config_file_org
-EOF
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: leadtune
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Eric Wollesen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 -06:00
+date: 2010-09-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -221,13 +221,12 @@ files:
 - README.rdoc
 - Rakefile
 - leadtune.gemspec
-- lib/array_extensions.rb
-- lib/hash_extensions.rb
 - lib/leadtune.rb
 - lib/leadtune/appraisals.rb
 - lib/leadtune/config.rb
 - lib/leadtune/prospect.rb
 - lib/leadtune/rest.rb
+- lib/leadtune/util.rb
 - lib/leadtune/version.rb
 - spec/echo_server.rb
 - spec/get.rb

data/lib/array_extensions.rb

@@ -1,12 +0,0 @@
-# LeadTune API Ruby Gem
-#
-# http://github.com/leadtune/leadtune-ruby
-# Eric Wollesen (mailto:devs@leadtune.com)
-# Copyright 2010 LeadTune LLC
-
-class Array
-  # stolen from ActiveSupport
-  def extract_options!
-    last.is_a?(::Hash) ? pop : {}
-  end
-end

data/lib/hash_extensions.rb

@@ -1,34 +0,0 @@
-# LeadTune API Ruby Gem
-#
-# http://github.com/leadtune/leadtune-ruby
-# Eric Wollesen (mailto:devs@leadtune.com)
-# Copyright 2010 LeadTune LLC
-
-class Hash
-  # File merb/core_ext/hash.rb, line 87
-  def to_params
-    params = ''
-    stack = []
-
-    each do |k, v|
-      if v.is_a?(Hash)
-        stack << [k,v]
-      else
-        params << "#{k}=#{v}&"
-      end
-    end
-
-    stack.each do |parent, hash|
-      hash.each do |k, v|
-        if v.is_a?(Hash)
-          stack << ["#{parent}[#{k}]", v]
-        else
-          params << "#{parent}[#{k}]=#{v}&"
-        end
-      end
-    end
-
-    params.chop! # trailing &
-    params
-  end
-end