leadtune 0.0.7 → 0.0.8

data/README.rdoc

@@ -15,30 +15,27 @@ For details about the LeadTune API, see: http://leadtune.com/api
 Authentication credentials can be specified by any of several methods, as
 detailed below.  Available configuration values include:
 
-* username
-* password
+* api_key
 * organization
 
 === Rack Initializer
 
  # config/initializers/leadtune.rb
- Leadtune::Config.username = "me@mycorp.com"
- Leadtune::Config.password = "my_secret"
+ Leadtune::Config.api_key = "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f"
  Leadtune::Config.organization = "MYC"
 
 === 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 the rack
-initializer.</em>
+When initializing your Leadtune::Prospect, you can include your API key and
+organization along with any factors you wish to 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 and the rack initializer.</em>
+You can also set your API key and organization by calling the
+Leadtune::Prospect object's #api_key= and #organization= methods. <em>These
+values take precedence over values read from the factors hash and the rack
+initializer.</em>
 
 == Example Usage
 
@@ -48,8 +45,7 @@ An attempt was made to allow for an ActiveModel-like interface.
  require "leadtune"
 
  prospect = Leadtune::Prospect.post({
-   :username => "admin@loleads.com"        # required (See Leadtune::Config)
-   :password => "secret"                   # required (See Leadtune::Config)
+   :api_key => "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f", # required (See Leadtune::Config)
    :organization => "LOL",                 # required (See Leadtune::Config)
    :event => "offers_prepared",            # required
    :email => "test@example.com"            # required

data/lib/leadtune/config.rb

@@ -8,20 +8,15 @@ module Leadtune
 
   class Config #:nodoc:all
 
-    attr_accessor :environment, :leadtune_host, :username, :password, :timeout
+    attr_accessor :environment, :leadtune_host, :api_key, :timeout
 
     @@leadtune_host = nil
-    @@username = nil
-    @@password = nil
+    @@api_key = nil
     @@organization = nil
     @@timeout = nil
 
-    def self.username=(username)
-      @@username = username
-    end
-
-    def self.password=(password)
-      @@password = password
+    def self.api_key=(api_key)
+      @@api_key = api_key
     end
 
     def self.organization=(organization)
@@ -36,12 +31,8 @@ module Leadtune
       @@timeout = timeout
     end
 
-    def username
-      @username ||= @@username
-    end
-
-    def password
-      @password ||= @@password
+    def api_key
+      @api_key ||= @@api_key
     end
 
     def timeout
@@ -75,7 +66,7 @@ module Leadtune
     private
 
     DEFAULT_TIMEOUT = 5
-    LEADTUNE_HOST_SANDBOX = "https://sandbox-appraiser.leadtune.com".freeze 
+    LEADTUNE_HOST_SANDBOX = "https://sandbox-appraiser.leadtune.com".freeze
     LEADTUNE_HOST_PRODUCTION = "https://appraiser.leadtune.com".freeze
     LEADTUNE_HOSTS = {
       :production => LEADTUNE_HOST_PRODUCTION,

data/lib/leadtune/prospect.rb

@@ -180,12 +180,8 @@ module Leadtune
       @config.timeout
     end
 
-    def username=(username)
-      @config.username = username
-    end
-
-    def password=(password)
-      @config.password = password
+    def api_key=(api_key)
+      @config.api_key = api_key
     end
 
     def response #:nodoc:
@@ -199,7 +195,7 @@ module Leadtune
 
     private
 
-    CURL_OPTIONS = ["username", "password", "timeout", "leadtune_host",] #:nodoc:
+    CURL_OPTIONS = ["api_key", "timeout", "leadtune_host",] #:nodoc:
 
     def post_data #:nodoc:
       f = @factors.merge("organization" => organization)

data/lib/leadtune/rest.rb

@@ -52,8 +52,6 @@ module Leadtune
     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|
@@ -66,7 +64,8 @@ module Leadtune
 
     def default_headers #:nodoc:
       {"Content-Type" => "application/json",
-       "Accept" => "application/json",}
+       "Accept" => "application/json",
+       "X-API-Key" => @config.api_key,}
     end
 
     def build_curl_easy_object_post #:nodoc:

data/lib/leadtune/version.rb

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

data/spec/delete.rb

@@ -13,8 +13,7 @@ require File.join(File.dirname(__FILE__), "../lib/leadtune")
 begin
   p = Leadtune::Prospect.delete do |p|
     p.organization = "LOL"
-    p.username = "admin@loleads.com"
-    p.password = "admin"
+    p.api_key = "h5fvNoTFa9AqzxUgixNcGey7HfZNKiBE9pC39fIH"
     p.leadtune_host = "http://localhost:8080"
     p.prospect_id = ARGV[0]
   end

data/spec/get.rb

@@ -13,8 +13,7 @@ require File.join(File.dirname(__FILE__), "../lib/leadtune")
 begin
   p = Leadtune::Prospect.get({
     :organization => "LOL",
-    :username => "admin@loleads.com",
-    :password => "admin",
+    :api_key => "h5fvNoTFa9AqzxUgixNcGey7HfZNKiBE9pC39fIH",
     # :leadtune_host => "https://staging-appraiser.leadtune.com",
     # :leadtune_host => "https://sandbox-appraiser.leadtune.com",
     :leadtune_host => "http://localhost:8080",

data/spec/leadtune/config_spec.rb

@@ -19,16 +19,10 @@ describe Leadtune::Config do
   end
 
   context("can set") do
-    it "password" do
-      Leadtune::Config.password = "secret"
+    it "api_key" do
+      Leadtune::Config.api_key = "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f"
 
-      Leadtune::Config.new.password.should == "secret"
-    end
-
-    it "username" do
-      Leadtune::Config.username = "bob"
-
-      Leadtune::Config.new.username.should == "bob"
+      Leadtune::Config.new.api_key.should == "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f"
     end
 
     it "timeout" do

data/spec/leadtune/rest_spec.rb

@@ -14,7 +14,7 @@ describe Leadtune::Rest do
 
   subject {Leadtune::Rest.new(Leadtune::Config.new)}
 
-  context("w/ username and password from initializer") do
+  context("w/ api_key from initializer") do
 
     before(:each) do
       @curl_easy = null_curl_easy
@@ -25,21 +25,14 @@ describe Leadtune::Rest do
       teardown_initializer
     end
 
-    describe "#username" do
-      it "uses the initializer value" do
-        @curl_easy.should_receive(:username=).with("init_user")
-
+    describe "#get" do
+      it "uses the initialized API key value" do
         subject.get(mock_post_data)
-      end
-    end
-
-    describe "#password" do
-      it "uses the initializer value" do
-        @curl_easy.should_receive(:password=).with("init_secret")
 
-        subject.get(mock_post_data)
+        @curl_easy.headers.should include("X-API-Key" => "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f")
       end
     end
+
   end
 
 
@@ -134,7 +127,7 @@ describe Leadtune::Rest do
 
       thread = Thread.new(server) {|s| s.start}
 
-      TCPSocket.wait_for_service_with_timeout({:host => "localhost", 
+      TCPSocket.wait_for_service_with_timeout({:host => "localhost",
                                                :port => THREADED_MOCK_SERVER_PORT,
                                                :timeout => 10})
       block.call
@@ -151,7 +144,7 @@ describe Leadtune::Rest do
       old_stderr, $stderr = $stderr, tf
       block.call(tf)
     end
-    
+
     $stdout, $stderr = old_stdout, old_stderr
   end
 

data/spec/post.rb

@@ -13,8 +13,7 @@ require File.join(File.dirname(__FILE__), "../lib/leadtune")
 begin
   p = Leadtune::Prospect.post do |p|
     p.organization = "LOL"
-    p.username = "admin@loleads.com"
-    p.password = "admin"
+    p.api_key = "h5fvNoTFa9AqzxUgixNcGey7HfZNKiBE9pC39fIH"
     # p.leadtune_host = "https://staging-appraiser.leadtune.com"
     # p.leadtune_host = "https://sandbox-appraiser.leadtune.com"
     p.leadtune_host = "http://localhost:8080"

data/spec/put.rb

@@ -12,8 +12,7 @@ require File.join(File.dirname(__FILE__), "../lib/leadtune")
 
 begin
   p = Leadtune::Prospect.new({:prospect_id => ARGV[0],
-                              :username => "admin@loleads.com",
-                              :password => "admin",
+                              :api_key => "h5fvNoTFa9AqzxUgixNcGey7HfZNKiBE9pC39fIH",
                               :target_buyers => ["AcmeU", "Bravo", "ConvU",],
                               :organization => "LOL",
                               :age => rand(30)+18})

data/spec/spec_helper.rb

@@ -15,16 +15,14 @@ RSpec.configure do |config|
 end
 
 def setup_initializer
-  Leadtune::Config.username = "init_user"
-  Leadtune::Config.password = "init_secret"
+  Leadtune::Config.api_key = "DeadB33fDeadB33fDeadB33fDeadB33fDeadB33f"
   Leadtune::Config.timeout = 7
   Leadtune::Config.organization = "init_org"
   Leadtune::Config.leadtune_host = "http://localhost.init"
 end
 
 def teardown_initializer
-  Leadtune::Config.username = nil
-  Leadtune::Config.password = nil
+  Leadtune::Config.api_key = nil
   Leadtune::Config.timeout = nil
   Leadtune::Config.organization = nil
   Leadtune::Config.leadtune_host = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: leadtune
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Eric Wollesen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-22 00:00:00 -06:00
+date: 2010-11-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency