createsend 2.5.1 → 3.0.0

data/lib/createsend/version.rb

@@ -1,3 +1,3 @@
 module CreateSend
-  VERSION = "2.5.1" unless defined?(CreateSend::VERSION)
+  VERSION = "3.0.0" unless defined?(CreateSend::VERSION)
 end

data/test/administrator_test.rb

@@ -1,38 +1,36 @@
 require File.dirname(__FILE__) + '/helper'
 
 class AdministratorTest < Test::Unit::TestCase
-  context "when an api caller is authenticated" do
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
     setup do
-      @api_key = '123123123123123123123'
-      CreateSend.api_key @api_key
-      @admin = CreateSend::Administrator.new "admin@example.com"
+      @admin = CreateSend::Administrator.new @auth, "admin@example.com"
     end
-    
+
     should "get a administrator by email address" do
       email = "admin@example.com"
-      stub_get(@api_key, "admins.json?email=#{CGI.escape(email)}", "admin_details.json")      
-      admin = CreateSend::Administrator.get email
+      stub_get(@auth, "admins.json?email=#{CGI.escape(email)}", "admin_details.json")
+      admin = CreateSend::Administrator.get @auth, email
       admin.EmailAddress.should == email
       admin.Name.should == "Admin One"
       admin.Status.should == "Active"
     end
 
     should "add an administrator" do
-      stub_post(@api_key, "admins.json", "add_admin.json")
-      result = CreateSend::Administrator.add "admin@example.com", "Admin"
+      stub_post(@auth, "admins.json", "add_admin.json")
+      result = CreateSend::Administrator.add @auth, "admin@example.com", "Admin"
       result.EmailAddress.should == "admin@example.com"
     end
 
     should "update an administrator" do
       email = "admin@example.com"
       new_email = "new_email_address@example.com"
-      stub_put(@api_key, "admins.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "admins.json?email=#{CGI.escape(email)}", nil)
       @admin.update new_email, "Admin Name"
       @admin.email_address.should == new_email
     end
-      
+
     should "delete an admin" do
-      stub_delete(@api_key, "admins.json?email=#{CGI.escape(@admin.email_address)}", nil)
+      stub_delete(@auth, "admins.json?email=#{CGI.escape(@admin.email_address)}", nil)
       @admin.delete
     end
   end

data/test/campaign_test.rb

@@ -1,17 +1,15 @@
 require File.dirname(__FILE__) + '/helper'
 
 class CampaignTest < Test::Unit::TestCase
-  context "when an api caller is authenticated" do
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
     setup do
-      @api_key = '123123123123123123123'
-      CreateSend.api_key @api_key
-      @campaign = CreateSend::Campaign.new('787y87y87y87y87y87y87')
+      @campaign = CreateSend::Campaign.new @auth, '787y87y87y87y87y87y87'
     end
 
     should "create a campaign" do
       client_id = '87y8d7qyw8d7yq8w7ydwqwd'
-      stub_post(@api_key, "campaigns/#{client_id}.json", "create_campaign.json")
-      campaign_id = CreateSend::Campaign.create client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
+      stub_post(@auth, "campaigns/#{client_id}.json", "create_campaign.json")
+      campaign_id = CreateSend::Campaign.create @auth, client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
       "http://example.com/campaign.html", "http://example.com/campaign.txt", [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ],
       [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ]
       request = FakeWeb.last_request.body
@@ -21,8 +19,8 @@ class CampaignTest < Test::Unit::TestCase
 
     should "create a campaign with a nil text_url param" do
       client_id = '87y8d7qyw8d7yq8w7ydwqwd'
-      stub_post(@api_key, "campaigns/#{client_id}.json", "create_campaign.json")
-      campaign_id = CreateSend::Campaign.create client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
+      stub_post(@auth, "campaigns/#{client_id}.json", "create_campaign.json")
+      campaign_id = CreateSend::Campaign.create @auth, client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
       "http://example.com/campaign.html", nil, [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ],
       [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ]
       request = FakeWeb.last_request.body
@@ -104,40 +102,40 @@ class CampaignTest < Test::Unit::TestCase
       # </html>     
 
       client_id = '87y8d7qyw8d7yq8w7ydwqwd'
-      stub_post(@api_key, "campaigns/#{client_id}/fromtemplate.json", "create_campaign.json")
-      campaign_id = CreateSend::Campaign.create_from_template client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
+      stub_post(@auth, "campaigns/#{client_id}/fromtemplate.json", "create_campaign.json")
+      campaign_id = CreateSend::Campaign.create_from_template @auth, client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
       [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ], [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ],
       "7j8uw98udowy12989e8298u2e", template_content
       campaign_id.should == "787y87y87y87y87y87y87"
     end
 
     should "send a preview of a draft campaign to a single recipient" do
-      stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/sendpreview.json", nil)
+      stub_post(@auth, "campaigns/#{@campaign.campaign_id}/sendpreview.json", nil)
       @campaign.send_preview "test+89898u9@example.com", "random"
     end
 
     should "send a preview of a draft campaign to multiple recipients" do
-      stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/sendpreview.json", nil)
+      stub_post(@auth, "campaigns/#{@campaign.campaign_id}/sendpreview.json", nil)
       @campaign.send_preview [ "test+89898u9@example.com", "test+787y8y7y8@example.com" ], "random"
     end
 
     should "send a campaign" do
-      stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/send.json", nil)
+      stub_post(@auth, "campaigns/#{@campaign.campaign_id}/send.json", nil)
       @campaign.send "confirmation@example.com"
     end
 
     should "unschedule a campaign" do
-      stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/unschedule.json", nil)
+      stub_post(@auth, "campaigns/#{@campaign.campaign_id}/unschedule.json", nil)
       @campaign.unschedule
     end
     
     should "delete a campaign" do
-      stub_delete(@api_key, "campaigns/#{@campaign.campaign_id}.json", nil)
+      stub_delete(@auth, "campaigns/#{@campaign.campaign_id}.json", nil)
       @campaign.delete
     end
-    
+
     should "get the summary for a campaign" do
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/summary.json", "campaign_summary.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/summary.json", "campaign_summary.json")
       summary = @campaign.summary
       summary.Recipients.should == 5
       summary.TotalOpened.should == 10
@@ -155,7 +153,7 @@ class CampaignTest < Test::Unit::TestCase
     end
 
     should "get the email client usage for a campaign" do
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/emailclientusage.json", "email_client_usage.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/emailclientusage.json", "email_client_usage.json")
       ecu = @campaign.email_client_usage
       ecu.size.should == 6
       ecu.first.Client.should == "iOS Devices"
@@ -165,7 +163,7 @@ class CampaignTest < Test::Unit::TestCase
     end
 
     should "get the lists and segments for a campaign" do
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/listsandsegments.json", "campaign_listsandsegments.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/listsandsegments.json", "campaign_listsandsegments.json")
       ls = @campaign.lists_and_segments
       ls.Lists.size.should == 1
       ls.Segments.size.should == 1
@@ -177,7 +175,7 @@ class CampaignTest < Test::Unit::TestCase
     end
 
     should "get the recipients for a campaign" do
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/recipients.json?pagesize=20&orderfield=email&page=1&orderdirection=asc", "campaign_recipients.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/recipients.json?pagesize=20&orderfield=email&page=1&orderdirection=asc", "campaign_recipients.json")
       res = @campaign.recipients page=1, page_size=20
       res.ResultsOrderedBy.should == "email"
       res.OrderDirection.should == "asc"
@@ -193,7 +191,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the opens for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/opens.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_opens.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/opens.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_opens.json")
       opens = @campaign.opens min_date
       opens.Results.size.should == 5
       opens.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -217,7 +215,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the subscriber clicks for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/clicks.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_clicks.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/clicks.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_clicks.json")
       clicks = @campaign.clicks min_date
       clicks.Results.size.should == 3
       clicks.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -242,7 +240,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the unsubscribes for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/unsubscribes.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_unsubscribes.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/unsubscribes.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_unsubscribes.json")
       unsubscribes = @campaign.unsubscribes min_date
       unsubscribes.Results.size.should == 1
       unsubscribes.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -260,7 +258,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the spam complaints for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/spam.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_spam.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/spam.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_spam.json")
       spam = @campaign.spam min_date
       spam.Results.size.should == 1
       spam.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -277,7 +275,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the bounces for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/bounces.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_bounces.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/bounces.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_bounces.json")
       bounces = @campaign.bounces min_date
       bounces.Results.size.should == 2
       bounces.Results.first.EmailAddress.should == "asdf@softbouncemyemail.com"

data/test/client_test.rb

@@ -1,22 +1,20 @@
 require File.dirname(__FILE__) + '/helper'
 
 class ClientTest < Test::Unit::TestCase
-  context "when an api caller is authenticated" do
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
     setup do
-      @api_key = '123123123123123123123'
-      CreateSend.api_key @api_key
-      @client = CreateSend::Client.new('321iuhiuhi1u23hi2u3')
+      @client = CreateSend::Client.new(@auth, '321iuhiuhi1u23hi2u3')
       @client.client_id.should == '321iuhiuhi1u23hi2u3'
     end
 
     should "create a client" do
-      stub_post(@api_key, "clients.json", "create_client.json")
-      client_id = CreateSend::Client.create "Client Company Name", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
+      stub_post(@auth, "clients.json", "create_client.json")
+      client_id = CreateSend::Client.create @auth, "Client Company Name", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
       client_id.should == "32a381c49a2df99f1d0c6f3c112352b9"
     end
 
     should "get details of a client" do
-      stub_get(@api_key, "clients/#{@client.client_id}.json", "client_details.json")
+      stub_get(@auth, "clients/#{@client.client_id}.json", "client_details.json")
       cl = @client.details
       cl.ApiKey.should == "639d8cc27198202f5fe6037a8b17a29a59984b86d3289bc9"
       cl.BasicDetails.ClientID.should == "4a397ccaaa55eb4e6aa1221e1e2d7122"
@@ -28,7 +26,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all campaigns" do
-      stub_get(@api_key, "clients/#{@client.client_id}/campaigns.json", "campaigns.json")
+      stub_get(@auth, "clients/#{@client.client_id}/campaigns.json", "campaigns.json")
       campaigns = @client.campaigns
       campaigns.size.should == 2
       campaigns.first.CampaignID.should == 'fc0ce7105baeaf97f47c99be31d02a91'
@@ -44,7 +42,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get scheduled campaigns" do
-      stub_get(@api_key, "clients/#{@client.client_id}/scheduled.json", "scheduled_campaigns.json")
+      stub_get(@auth, "clients/#{@client.client_id}/scheduled.json", "scheduled_campaigns.json")
       campaigns = @client.scheduled
       campaigns.size.should == 2
       campaigns.first.DateScheduled.should == "2011-05-25 10:40:00"
@@ -61,7 +59,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all drafts" do
-      stub_get(@api_key, "clients/#{@client.client_id}/drafts.json", "drafts.json")
+      stub_get(@auth, "clients/#{@client.client_id}/drafts.json", "drafts.json")
       drafts = @client.drafts
       drafts.size.should == 2
       drafts.first.CampaignID.should == '7c7424792065d92627139208c8c01db1'
@@ -76,7 +74,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all lists" do
-      stub_get(@api_key, "clients/#{@client.client_id}/lists.json", "lists.json")
+      stub_get(@auth, "clients/#{@client.client_id}/lists.json", "lists.json")
       lists = @client.lists
       lists.size.should == 2
       lists.first.ListID.should == 'a58ee1d3039b8bec838e6d1482a8a965'
@@ -85,7 +83,7 @@ class ClientTest < Test::Unit::TestCase
 
     should "get all lists to which a subscriber with a particular email address belongs" do
       email = "valid@example.com"
-      stub_get(@api_key, "clients/#{@client.client_id}/listsforemail.json?email=#{CGI.escape(email)}", "listsforemail.json")
+      stub_get(@auth, "clients/#{@client.client_id}/listsforemail.json?email=#{CGI.escape(email)}", "listsforemail.json")
       lists = @client.lists_for_email(email)
       lists.size.should == 2
       lists.first.ListID.should == 'ab4a2b57c7c8f1ba62f898a1af1a575b'
@@ -95,7 +93,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all segments for a client" do
-      stub_get(@api_key, "clients/#{@client.client_id}/segments.json", "segments.json")
+      stub_get(@auth, "clients/#{@client.client_id}/segments.json", "segments.json")
       segments = @client.segments
       segments.size.should == 2
       segments.first.ListID.should == 'a58ee1d3039b8bec838e6d1482a8a965'
@@ -104,7 +102,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get suppression list" do
-      stub_get(@api_key, "clients/#{@client.client_id}/suppressionlist.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc", "suppressionlist.json")
+      stub_get(@auth, "clients/#{@client.client_id}/suppressionlist.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc", "suppressionlist.json")
       res = @client.suppressionlist
       res.ResultsOrderedBy.should == "email"
       res.OrderDirection.should == "asc"
@@ -122,23 +120,23 @@ class ClientTest < Test::Unit::TestCase
 
     should "suppress a single email address" do
       email = "example@example.com"
-      stub_post(@api_key, "clients/#{@client.client_id}/suppress.json", nil)
+      stub_post(@auth, "clients/#{@client.client_id}/suppress.json", nil)
       result = @client.suppress email
     end
 
     should "suppress multiple email address" do
-      stub_post(@api_key, "clients/#{@client.client_id}/suppress.json", nil)
+      stub_post(@auth, "clients/#{@client.client_id}/suppress.json", nil)
       result = @client.suppress [ "one@example.com", "two@example.com" ]
     end
 
     should "unsuppress an email address" do
       email = "example@example.com"
-      stub_put(@api_key, "clients/#{@client.client_id}/unsuppress.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/unsuppress.json?email=#{CGI.escape(email)}", nil)
       result = @client.unsuppress email
     end
 
     should "get all people" do
-      stub_get(@api_key, "clients/#{@client.client_id}/people.json", "people.json")
+      stub_get(@auth, "clients/#{@client.client_id}/people.json", "people.json")
       people = @client.people
       people.size.should == 2
       people.first.EmailAddress.should == "person1@blackhole.com"
@@ -148,7 +146,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "get all templates" do
-      stub_get(@api_key, "clients/#{@client.client_id}/templates.json", "templates.json")
+      stub_get(@auth, "clients/#{@client.client_id}/templates.json", "templates.json")
       templates = @client.templates
       templates.size.should == 2
       templates.first.TemplateID.should == '5cac213cf061dd4e008de5a82b7a3621'
@@ -157,29 +155,29 @@ class ClientTest < Test::Unit::TestCase
 
     should "set primary contact" do
       email = 'person@blackhole.com'
-      stub_put(@api_key, "clients/#{@client.client_id}/primarycontact.json?email=#{CGI.escape(email)}", 'client_set_primary_contact.json')
+      stub_put(@auth, "clients/#{@client.client_id}/primarycontact.json?email=#{CGI.escape(email)}", 'client_set_primary_contact.json')
       result = @client.set_primary_contact email
       result.EmailAddress.should == email
     end
 
     should "get primary contact" do
-      stub_get(@api_key, "clients/#{@client.client_id}/primarycontact.json", 'client_get_primary_contact.json')
+      stub_get(@auth, "clients/#{@client.client_id}/primarycontact.json", 'client_get_primary_contact.json')
       result = @client.get_primary_contact
       result.EmailAddress.should == 'person@blackhole.com'
     end
 
     should "set basics" do
-      stub_put(@api_key, "clients/#{@client.client_id}/setbasics.json", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/setbasics.json", nil)
       @client.set_basics "Client Company Name", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
     end
 
     should "set payg billing" do
-      stub_put(@api_key, "clients/#{@client.client_id}/setpaygbilling.json", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/setpaygbilling.json", nil)
       @client.set_payg_billing "CAD", true, true, 150
     end
 
     should "set monthly billing (implicit)" do
-      stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", true, 150 
       request = FakeWeb.last_request.body
       request.include?("\"Currency\":\"CAD\"").should == true
@@ -189,7 +187,7 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "set monthly billing (basic)" do
-      stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", true, 150, "Basic"
       request = FakeWeb.last_request.body
       request.include?("\"Currency\":\"CAD\"").should == true
@@ -199,7 +197,7 @@ class ClientTest < Test::Unit::TestCase
     end
        
     should "set monthly billing (unlimited)" do
-      stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", false, 120, "Unlimited"
       request = FakeWeb.last_request.body
       request.include?("\"Currency\":\"CAD\"").should == true
@@ -209,14 +207,14 @@ class ClientTest < Test::Unit::TestCase
     end
 
     should "transfer credits to a client" do
-      stub_post(@api_key, "clients/#{@client.client_id}/credits.json", "transfer_credits.json")
+      stub_post(@auth, "clients/#{@client.client_id}/credits.json", "transfer_credits.json")
       result = @client.transfer_credits 200, false
       result.AccountCredits.should == 800
       result.ClientCredits.should == 200
     end
 
     should "delete a client" do
-      stub_delete(@api_key, "clients/#{@client.client_id}.json", nil)
+      stub_delete(@auth, "clients/#{@client.client_id}.json", nil)
       @client.delete
     end
     

data/test/createsend_test.rb

@@ -1,34 +1,156 @@
 require File.dirname(__FILE__) + '/helper'
 
 class CreateSendTest < Test::Unit::TestCase
-  context "when an api caller is authenticated" do
+
+  context "when an api caller requires createsend" do
     setup do
-      @api_key = '123123123123123123123'
-      @base_uri = 'https://api.createsend.com/api/v3'
-      CreateSend.api_key @api_key
-      @cs = CreateSend::CreateSend.new
+      @access_token = "h9898wu98u9dqjoijnwld"
+      @refresh_token = "tGzv3JOkF0XG5Qx2TlKWIA"
+      @api_key = "hiuhqiw78hiqhwdwdqwdqw2s2e2"
     end
-    
-    should "include the CreateSend module VERSION constant as part of the user agent when making a call" do
-      # This test is done to ensure that the version from HTTParty isn't included instead
-      assert CreateSend::CreateSend.headers["User-Agent"] == "createsend-ruby-#{CreateSend::VERSION}"
-      stub_get(@api_key, "clients.json", "clients.json")
-      clients = @cs.clients
-      clients.size.should == 2
+
+    should "authenticate using an oauth access token and refresh token" do
+      auth = {
+        :access_token => @access_token,
+        :refresh_token => @refresh_token
+      }
+      cs = CreateSend::CreateSend.new auth
+      cs.auth_details.should == auth
     end
-    
-    should "get api key" do
-      uri = URI.parse(@base_uri)
+
+    should "authenticate using an api key" do
+      auth = {:api_key => @api_key}
+      cs = CreateSend::CreateSend.new auth
+      cs.auth_details.should == auth
+    end
+
+    should "get the authorization url without state included" do
+      client_id = 8998879
+      redirect_uri = 'http://example.com/auth'
+      scope = 'ViewReports,CreateCampaigns,SendCampaigns'
+      url = CreateSend::CreateSend.authorize_url(client_id, redirect_uri, scope)
+      url.should == "https://api.createsend.com/oauth?client_id=8998879&redirect_uri=http%3A%2F%2Fexample.com%2Fauth&scope=ViewReports%2CCreateCampaigns%2CSendCampaigns"
+    end
+
+    should "get the authorization url with state included" do
+      client_id = 8998879
+      redirect_uri = 'http://example.com/auth'
+      scope = 'ViewReports,CreateCampaigns,SendCampaigns'
+      state = 89879287
+      url = CreateSend::CreateSend.authorize_url(client_id, redirect_uri, scope, state)
+      url.should == "https://api.createsend.com/oauth?client_id=8998879&redirect_uri=http%3A%2F%2Fexample.com%2Fauth&scope=ViewReports%2CCreateCampaigns%2CSendCampaigns&state=89879287"
+    end
+
+    should "exchange an OAuth token for an access token, 'expires in' value, and refresh token" do
+      client_id = 8998879
+      client_secret = 'iou0q9wud0q9wd0q9wid0q9iwd0q9wid0q9wdqwd'
+      redirect_uri = 'http://example.com/auth'
+      code = 'jdiwouo8uowi9o9o'
+      options = {
+        :body => fixture_file("oauth_exchange_token.json"),
+        :content_type => "application/json; charset=utf-8" }
+      FakeWeb.register_uri(:post, "https://api.createsend.com/oauth/token", options)
+      access_token, expires_in, refresh_token = CreateSend::CreateSend.exchange_token(
+        client_id, client_secret, redirect_uri, code)
+
+      FakeWeb.last_request.body.should == "grant_type=authorization_code&client_id=8998879&client_secret=iou0q9wud0q9wd0q9wid0q9iwd0q9wid0q9wdqwd&redirect_uri=http%3A%2F%2Fexample.com%2Fauth&code=jdiwouo8uowi9o9o"
+      access_token.should == "SlAV32hkKG"
+      expires_in.should == 1209600
+      refresh_token.should == "tGzv3JOkF0XG5Qx2TlKWIA"
+    end
+
+    should "raise an error when an attempt to exchange an OAuth token for an access token fails" do
+      client_id = 8998879
+      client_secret = 'iou0q9wud0q9wd0q9wid0q9iwd0q9wid0q9wdqwd'
+      redirect_uri = 'http://example.com/auth'
+      code = 'invalidcode'
+      options = {
+        :body => fixture_file("oauth_exchange_token_error.json"),
+        :content_type => "application/json; charset=utf-8" }
+      FakeWeb.register_uri(:post, "https://api.createsend.com/oauth/token", options)
+      lambda { access_token, expires_in, refresh_token = CreateSend::CreateSend.exchange_token(
+        client_id, client_secret, redirect_uri, code) }.should raise_error(
+          Exception, 'Error exchanging code for access token: invalid_grant - Specified code was invalid or expired')
+      FakeWeb.last_request.body.should == "grant_type=authorization_code&client_id=8998879&client_secret=iou0q9wud0q9wd0q9wid0q9iwd0q9wid0q9wdqwd&redirect_uri=http%3A%2F%2Fexample.com%2Fauth&code=invalidcode"
+    end
+
+    should "get a person's api key" do
+      base_uri = "https://api.createsend.com/api/v3"
+      uri = URI.parse(base_uri)
       site_url = "http://iamadesigner.createsend.com/"
       username = "myusername"
       password = "mypassword"
+      cs = CreateSend::CreateSend.new
       stub_get(nil, "https://#{username}:#{password}@#{uri.host}#{uri.path}/apikey.json?SiteUrl=#{CGI.escape(site_url)}", "apikey.json")
-      apikey = @cs.apikey(site_url, username, password).ApiKey
+      apikey = cs.apikey(site_url, username, password).ApiKey
       apikey.should == "981298u298ue98u219e8u2e98u2"
+      cs.auth_details.should == {:api_key => apikey}
+    end
+
+  end
+
+  context "when an api caller is authenticated using oauth" do
+    setup do
+      @access_token = "h9898wu98u9dqjoijnwld"
+      @refresh_token = "tGzv3JOkF0XG5Qx2TlKWIA"
+      @auth = {
+        :access_token => @access_token,
+        :refresh_token => @refresh_token
+      }
+    end
+
+    should "refresh the current access token" do
+      options = {
+        :body => fixture_file("refresh_oauth_token.json"),
+        :content_type => "application/json; charset=utf-8" }
+      FakeWeb.register_uri(:post, "https://api.createsend.com/oauth/token", options)
+      cs = CreateSend::CreateSend.new @auth
+      new_access_token, new_expires_in, new_refresh_token = cs.refresh_token
+
+      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA"
+      new_access_token.should == "SlAV32hkKG2e12e"
+      new_expires_in.should == 1209600
+      new_refresh_token.should == "tGzv3JOkF0XG5Qx2TlKWIA"
+      cs.auth_details.should == {
+        :access_token => new_access_token,
+        :refresh_token => new_refresh_token
+      }
+    end
+
+    should "raise an error when an attempt to refresh the access token is made but refresh token is nil" do
+      cs = CreateSend::CreateSend.new :access_token => 'any token', :refresh_token => nil
+      lambda { new_access_token, new_refresh_token = cs.refresh_token }.should raise_error(
+        Exception, '@auth_details[:refresh_token] does not contain a refresh token.')
+    end
+
+    should "raise an error when an attempt to refresh the access token is made but no there was no refresh token passed in" do
+      cs = CreateSend::CreateSend.new :access_token => 'any token'
+      lambda { new_access_token, new_refresh_token = cs.refresh_token }.should raise_error(
+        Exception, '@auth_details[:refresh_token] does not contain a refresh token.')
+    end
+
+    should "raise an error when an attempt to refresh the access token is made but no there was no auth hash passed in" do
+      cs = CreateSend::CreateSend.new
+      lambda { new_access_token, new_refresh_token = cs.refresh_token }.should raise_error(
+        Exception, '@auth_details[:refresh_token] does not contain a refresh token.')
+    end
+  end
+
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+    setup do
+      @cs = CreateSend::CreateSend.new @auth
+    end
+
+    should "include the CreateSend module VERSION constant as part of the user agent when making a call" do
+      # This test is done to ensure that the version from HTTParty isn't included instead
+      assert CreateSend::CreateSend.headers["User-Agent"] == "createsend-ruby-#{CreateSend::VERSION}"
+      stub_get(@auth, "clients.json", "clients.json")
+      clients = @cs.clients
+      clients.size.should == 2
     end
 
     should "get all clients" do
-      stub_get(@api_key, "clients.json", "clients.json")
+      stub_get(@auth, "clients.json", "clients.json")
       clients = @cs.clients
       clients.size.should == 2
       clients.first.ClientID.should == '4a397ccaaa55eb4e6aa1221e1e2d7122'
@@ -36,98 +158,117 @@ class CreateSendTest < Test::Unit::TestCase
     end
 
     should "get billing details" do
-      stub_get(@api_key, "billingdetails.json", "billingdetails.json")
+      stub_get(@auth, "billingdetails.json", "billingdetails.json")
       bd = @cs.billing_details
       bd.Credits.should == 3021
     end
 
     should "get all countries" do
-      stub_get(@api_key, "countries.json", "countries.json")
+      stub_get(@auth, "countries.json", "countries.json")
       countries = @cs.countries
       countries.size.should == 245
       assert countries.include? "Australia"
     end
     
     should "get system date" do
-      stub_get(@api_key, "systemdate.json", "systemdate.json")
+      stub_get(@auth, "systemdate.json", "systemdate.json")
       systemdate = @cs.systemdate.SystemDate
       systemdate.should == "2010-10-15 09:27:00"
     end
 
     should "get all timezones" do
-      stub_get(@api_key, "timezones.json", "timezones.json")
+      stub_get(@auth, "timezones.json", "timezones.json")
       timezones = @cs.timezones
       timezones.size.should == 97
       assert timezones.include? "(GMT+12:00) Fiji"
     end
     
     should "get all administrators" do
-      stub_get(@api_key, "admins.json", "administrators.json")
+      stub_get(@auth, "admins.json", "administrators.json")
       administrators = @cs.administrators
       administrators.size.should == 2
       administrators.first.EmailAddress.should == "admin1@blackhole.com"
       administrators.first.Name.should == 'Admin One'
       administrators.first.Status.should == 'Active'
     end
-      
+
     should "set primary contact" do
       email = 'admin@blackhole.com'
-      stub_put(@api_key, "primarycontact.json?email=#{CGI.escape(email)}", 'admin_set_primary_contact.json')
+      stub_put(@auth, "primarycontact.json?email=#{CGI.escape(email)}", 'admin_set_primary_contact.json')
       result = @cs.set_primary_contact email
       result.EmailAddress.should == email
     end
-    
+
     should "get primary contact" do
-      stub_get(@api_key, "primarycontact.json", 'admin_get_primary_contact.json')
+      stub_get(@auth, "primarycontact.json", 'admin_get_primary_contact.json')
       result = @cs.get_primary_contact
       result.EmailAddress.should == 'admin@blackhole.com'
     end
-        
+
   end
 
   context "when the CreateSend API responds with an error" do
-    setup do
-      @api_key = '123123123123123123123'
-      @base_uri = 'https://api.createsend.com/api/v3'
-      CreateSend.api_key @api_key
-      @cs = CreateSend::CreateSend.new
-      @template = CreateSend::Template.new('98y2e98y289dh89h938389')
-    end
-    
-    { ["400", "Bad Request"]  => CreateSend::BadRequest,
-      ["401", "Unauthorized"] => CreateSend::Unauthorized,
-      ["404", "Not Found"]    => CreateSend::NotFound,
-      ["500", "Server Error"] => CreateSend::ServerError
-    }.each do |status, exception|
-      context "#{status.first}, a get" do
-        should "raise a #{exception.name} error" do
-          stub_get(@api_key, "countries.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
-          lambda { c = @cs.countries }.should raise_error(exception)
-        end
+
+    multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+      setup do
+        @cs = CreateSend::CreateSend.new @auth
+        @template = CreateSend::Template.new @auth, '98y2e98y289dh89h938389'
       end
 
-      context "#{status.first}, a post" do
-        should "raise a #{exception.name} error" do
-          stub_post(@api_key, "clients.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
-          lambda { CreateSend::Client.create "Client Company Name", 
-            "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia" }.should raise_error(exception)
+      { ["400", "Bad Request"]  => CreateSend::BadRequest,
+        ["401", "Unauthorized"] => CreateSend::Unauthorized,
+        ["404", "Not Found"]    => CreateSend::NotFound,
+        ["500", "Server Error"] => CreateSend::ServerError
+      }.each do |status, exception|
+        context "#{status.first}, a get" do
+          should "raise a #{exception.name} error" do
+            stub_get(@auth, "countries.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
+            lambda { c = @cs.countries }.should raise_error(exception)
+          end
         end
-      end
 
-      context "#{status.first}, a put" do
-        should "raise a #{exception.name} error" do
-          stub_put(@api_key, "templates/#{@template.template_id}.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
-          lambda { @template.update "Template One Updated", "http://templates.org/index.html", 
-            "http://templates.org/files.zip" }.should raise_error(exception)
+        context "#{status.first}, a post" do
+          should "raise a #{exception.name} error" do
+            stub_post(@auth, "clients.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
+            lambda { CreateSend::Client.create @auth, "Client Company Name",
+              "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia" }.should raise_error(exception)
+          end
+        end
+
+        context "#{status.first}, a put" do
+          should "raise a #{exception.name} error" do
+            stub_put(@auth, "templates/#{@template.template_id}.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
+            lambda { @template.update "Template One Updated", "http://templates.org/index.html", 
+              "http://templates.org/files.zip" }.should raise_error(exception)
+          end
         end
-      end
 
-      context "#{status.first}, a delete" do
-        should "raise a #{exception.name} error" do
-          stub_delete(@api_key, "templates/#{@template.template_id}.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
-          lambda { @template.delete }.should raise_error(exception)
+        context "#{status.first}, a delete" do
+          should "raise a #{exception.name} error" do
+            stub_delete(@auth, "templates/#{@template.template_id}.json", (status.first == '400' or status.first == '401') ? 'custom_api_error.json' : nil, status)
+            lambda { @template.delete }.should raise_error(exception)
+          end
         end
       end
     end
+
+    context "when authenticated using oauth and the access token has expired" do
+      setup do
+        @access_token = '98y98u98u98ue212'
+        @refresh_token = 'kj9wud09wi0qi0w'
+        @auth = {
+          :access_token => @access_token,
+          :refresh_token => @refresh_token
+        }
+        @cs = CreateSend::CreateSend.new @auth
+      end
+
+      should "raise a CreateSend::ExpiredOAuthToken error" do
+        stub_get(@auth, "countries.json", "expired_oauth_token_api_error.json", ["401", "Unauthorized"])
+        lambda { c = @cs.countries }.should raise_error(CreateSend::ExpiredOAuthToken)
+      end
+    end
+
   end
+
 end