createsend 0.0.1

data/lib/subscriber.rb

@@ -0,0 +1,49 @@
+require 'createsend'
+require 'json'
+
+class Subscriber
+  attr_reader :list_id
+  attr_reader :email_address
+
+  def initialize(list_id, email_address)
+    @list_id = list_id
+    @email_address = email_address
+  end
+
+  def self.get(list_id, email_address)
+    options = { :query => { :email => email_address } }
+    response = CreateSend.get "/subscribers/#{list_id}.json", options
+    Hashie::Mash.new(response)
+  end
+
+  def self.add(list_id, email_address, name, custom_fields, resubscribe)
+    options = { :body => {
+      :EmailAddress => email_address,
+      :Name => name,
+      :CustomFields => custom_fields,
+      :Resubscribe => resubscribe }.to_json }
+    response = CreateSend.post "/subscribers/#{list_id}.json", options
+    response.parsed_response
+  end
+
+  def self.import(list_id, subscribers, resubscribe)
+    options = { :body => {
+      :Subscribers => subscribers,
+      :Resubscribe => resubscribe }.to_json }
+    response = CreateSend.post "/subscribers/#{list_id}/import.json", options
+    Hashie::Mash.new(response)
+  end
+
+  def unsubscribe
+    options = { :body => {
+      :EmailAddress => @email_address }.to_json }
+    CreateSend.post "/subscribers/#{@list_id}/unsubscribe.json", options
+  end
+
+  def history
+    options = { :query => { :email => @email_address } }
+    response = CreateSend.get "/subscribers/#{@list_id}/history.json", options
+    response.map{|item| Hashie::Mash.new(item)}
+  end
+
+end

data/lib/template.rb

@@ -0,0 +1,38 @@
+require 'createsend'
+require 'json'
+
+class Template
+  attr_reader :template_id
+
+  def initialize(template_id)
+    @template_id = template_id
+  end
+
+  def self.create(client_id, name, html_url, zip_url, screenshot_url)
+    options = { :body => { 
+      :Name => name,
+      :HtmlPageURL => html_url,
+      :ZipFileURL => zip_url,
+      :ScreenshotURL => screenshot_url }.to_json }
+    response = CreateSend.post "/templates/#{client_id}.json", options
+    response.parsed_response
+  end
+
+  def details
+    response = CreateSend.get "/templates/#{template_id}.json", {}
+    Hashie::Mash.new(response)
+  end
+
+  def update(name, html_url, zip_url, screenshot_url)
+    options = { :body => { 
+      :Name => name,
+      :HtmlPageURL => html_url,
+      :ZipFileURL => zip_url,
+      :ScreenshotURL => screenshot_url }.to_json }
+    response = CreateSend.put "/templates/#{template_id}.json", options
+  end
+
+  def delete
+    response = CreateSend.delete "/templates/#{template_id}.json", {}
+  end
+end

data/test/campaign_test.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/helper'
+
+class ClientTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @campaign = Campaign.new(:campaign_id => '787y87y87y87y87y87y87')
+    end
+
+    should "create a campaign" do
+      client_id = '87y8d7qyw8d7yq8w7ydwqwd'
+      stub_post(@api_key, "campaigns/#{client_id}.json", "create_campaign.json")
+      campaign_id = Campaign.create 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' ], []
+      campaign_id.should == "787y87y87y87y87y87y87"
+    end
+    
+    should "send a campaign" do
+      stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/send.json", nil)
+      @campaign.send "confirmation@example.com"
+    end
+    
+    should "delete a campaign" do
+      stub_delete(@api_key, "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")
+      summary = @campaign.summary
+      summary.Recipients.should == 5
+      summary.TotalOpened.should == 10
+      summary.Clicks.should == 0
+      summary.Unsubscribed.should == 0
+      summary.Bounced.should == 0
+      summary.UniqueOpened.should == 5
+      summary.WebVersionURL.should == "http://clientone.createsend.com//t/ViewEmail/r/3A433FC72FFE3B8B/C67FD2F38AC4859C/"
+    end
+    
+    should "get the lists for a campaign" do
+      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/lists.json", "campaign_lists.json")
+      lists = @campaign.lists
+      lists.size.should == 2
+      lists.first.Name.should == "List One"
+      lists.first.ListID.should == "a58ee1d3039b8bec838e6d1482a8a965"
+    end
+
+    # TODO: Add this test once segments has been implemented
+    # should "get the segments for a campaign" do
+    # end
+    
+    should "get the opens for a campaign" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/opens.json?date=#{CGI.escape(min_date)}", "campaign_opens.json")
+      opens = @campaign.opens min_date
+      opens.size.should == 5
+      opens.first.EmailAddress.should == "subs+6576576576@example.com"
+      opens.first.ListID.should == "512a3bc577a58fdf689c654329b50fa0"
+      opens.first.Date.should == "2010-10-11 08:29:00"
+      opens.first.IPAddress.should == "192.168.126.87"
+    end
+
+    should "get the subscriber clicks for a campaign" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/clicks.json?date=#{CGI.escape(min_date)}", "campaign_clicks.json")
+      clicks = @campaign.clicks min_date
+      clicks.size.should == 3
+      clicks.first.EmailAddress.should == "subs+6576576576@example.com"
+      clicks.first.URL.should == "http://video.google.com.au/?hl=en&tab=wv"
+      clicks.first.ListID.should == "512a3bc577a58fdf689c654329b50fa0"
+      clicks.first.Date.should == "2010-10-11 08:29:00"
+      clicks.first.IPAddress.should == "192.168.126.87"
+    end
+    
+    should "get the unsubscribes for a campaign" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/unsubscribes.json?date=#{CGI.escape(min_date)}", "campaign_unsubscribes.json")
+      unsubscribes = @campaign.unsubscribes min_date
+      unsubscribes.size.should == 1
+      unsubscribes.first.EmailAddress.should == "subs+6576576576@example.com"
+      unsubscribes.first.ListID.should == "512a3bc577a58fdf689c654329b50fa0"
+      unsubscribes.first.Date.should == "2010-10-11 08:29:00"
+      unsubscribes.first.IPAddress.should == "192.168.126.87"
+    end
+
+    should "get the bounces for a campaign" do
+      stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/bounces.json", "campaign_bounces.json")
+      bounces = @campaign.bounces
+      bounces.size.should == 2
+      bounces.first.EmailAddress.should == "asdf@softbouncemyemail.com"
+      bounces.first.ListID.should == "654523a5855b4a440bae3fb295641546"
+      bounces.first.BounceType.should == "Soft"
+      bounces.first.Date.should == "2010-07-02 16:46:00"
+      bounces.first.Reason.should == "Bounce - But No Email Address Returned "
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/helper'
+
+class ClientTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @client = Client.new(:client_id => '321iuhiuhi1u23hi2u3')
+    end
+
+    should "create a client" do
+      stub_post(@api_key, "clients.json", "create_client.json")
+      client_id = Client.create "Client Company Name", "Client Contact Name", "client@example.com", "(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")
+      cl = @client.details
+      cl.BasicDetails.ClientID.should == "4a397ccaaa55eb4e6aa1221e1e2d7122"
+      cl.BasicDetails.ContactName.should == "Client One (contact)"
+      cl.AccessDetails.Username.should == "clientone"
+      cl.AccessDetails.AccessLevel.should == 23
+    end
+
+    should "get all campaigns" do
+      stub_get(@api_key, "clients/#{@client.client_id}/campaigns.json", "campaigns.json")
+      campaigns = @client.campaigns
+      campaigns.size.should == 2
+      campaigns.first.CampaignID.should == 'fc0ce7105baeaf97f47c99be31d02a91'
+      campaigns.first.WebVersionURL.should == 'http://hello.createsend.com//t/ViewEmail/r/765E86829575EE2C/C67FD2F38AC4859C/'
+      campaigns.first.Subject.should == 'Campaign One'
+      campaigns.first.Name.should == 'Campaign One'
+      campaigns.first.SentDate.should == '2010-10-12 12:58:00'
+      campaigns.first.TotalRecipients.should == 2245
+    end
+
+    should "get all drafts" do
+      stub_get(@api_key, "clients/#{@client.client_id}/drafts.json", "drafts.json")
+      drafts = @client.drafts
+      drafts.size.should == 2
+      drafts.first.CampaignID.should == '7c7424792065d92627139208c8c01db1'
+      drafts.first.Name.should == 'Draft One'
+      drafts.first.Subject.should == 'Draft One'
+      drafts.first.DateCreated.should == '2010-08-19 16:08:00'
+    end
+
+    should "get all lists" do
+      stub_get(@api_key, "clients/#{@client.client_id}/lists.json", "lists.json")
+      lists = @client.lists
+      lists.size.should == 2
+      lists.first.ListID.should == 'a58ee1d3039b8bec838e6d1482a8a965'
+      lists.first.Name.should == 'List One'
+    end
+    
+    should "get all segments" do
+      stub_get(@api_key, "clients/#{@client.client_id}/segments.json", "segments.json")
+      segments = @client.segments
+      segments.size.should == 2
+      segments.first.ListID.should == 'a58ee1d3039b8bec838e6d1482a8a965'
+      segments.first.Name.should == 'Segment One'
+    end
+
+    should "get suppression list" do
+      stub_get(@api_key, "clients/#{@client.client_id}/suppressionlist.json", "suppressionlist.json")
+      sl = @client.suppressionlist
+      sl.size.should == 2
+      sl.first.EmailAddress.should == "subs+098u0qu0qwd@example.com"
+      sl.first.Date.should == "2009-11-25 13:23:20"
+      sl.first.State.should == "Suppressed"
+    end
+
+    should "get all templates" do
+      stub_get(@api_key, "clients/#{@client.client_id}/templates.json", "templates.json")
+      templates = @client.templates
+      templates.size.should == 2
+      templates.first.TemplateID.should == '5cac213cf061dd4e008de5a82b7a3621'
+      templates.first.Name.should == 'Template One'
+    end
+    
+    should "set basics" do
+      stub_put(@api_key, "clients/#{@client.client_id}/setbasics.json", nil)
+      @client.set_basics "Client Company Name", "Client Contact Name", "client@example.com", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
+    end
+    
+    should "set access" do
+      stub_put(@api_key, "clients/#{@client.client_id}/setaccess.json", nil)
+      @client.set_access "username", "password", 321
+    end
+    
+    should "set payg billing" do
+      stub_put(@api_key, "clients/#{@client.client_id}/setpaygbilling.json", nil)
+      @client.set_payg_billing "CAD", true, true, 150
+    end
+    
+    should "set monthly billing" do
+      stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
+      @client.set_monthly_billing "CAD", true, true, 150
+    end
+    
+    should "delete a client" do
+      stub_delete(@api_key, "clients/#{@client.client_id}.json", nil)
+      @client.delete
+    end
+    
+  end
+end

data/test/createsend_test.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/helper'
+
+class CreateSendTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      @base_uri = 'http://api.createsend.com/api/v3'
+      CreateSend.api_key @api_key
+      @cs = CreateSend.new
+    end
+    
+    should "get api key" do
+      uri = URI.parse(@base_uri)
+      site_url = "http://iamadesigner.createsend.com/"
+      username = "myusername"
+      password = "mypassword"
+      stub_get(nil, "http://#{username}:#{password}@#{uri.host}#{uri.path}/apikey.json?SiteUrl=#{CGI.escape(site_url)}", "apikey.json")
+      apikey = @cs.apikey(site_url, username, password).ApiKey
+      apikey.should == "981298u298ue98u219e8u2e98u2"
+    end
+
+    should "get all clients" do
+      stub_get(@api_key, "clients.json", "clients.json")
+      clients = @cs.clients
+      clients.size.should == 2
+      clients.first.ClientID.should == '4a397ccaaa55eb4e6aa1221e1e2d7122'
+      clients.first.Name.should == 'Client One'
+    end
+    
+    should "get all countries" do
+      stub_get(@api_key, "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")
+      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")
+      timezones = @cs.timezones
+      timezones.size.should == 97
+      assert timezones.include? "(GMT+12:00) Fiji"
+    end
+  end
+
+  context "when the CreateSend API responds with an error" do
+    setup do
+      @api_key = '123123123123123123123'
+      @base_uri = 'http://api.createsend.com/api/v3'
+      CreateSend.api_key @api_key
+      @cs = CreateSend.new
+      @template = Template.new(:template_id => '98y2e98y289dh89h938389')
+    end
+    
+    { ["400", "Bad Request"]  => BadRequest,
+      ["401", "Unauthorized"] => Unauthorized,
+      ["404", "Not Found"]    => NotFound,
+      ["500", "Server Error"] => 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' ? 'custom_api_error.json' : nil, status)
+          lambda { c = @cs.countries }.should raise_error(exception)
+        end
+      end
+
+      context "#{status.first}, a post" do
+        should "raise a #{exception.name} error" do
+          stub_post(@api_key, "clients.json", status.first == '400' ? 'custom_api_error.json' : nil, status)
+          lambda { Client.create "Client Company Name", "Client Contact Name", "client@example.com", 
+            "(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(@api_key, "templates/#{@template.template_id}.json", status.first == '400' ? 'custom_api_error.json' : nil, status)
+          lambda { @template.update "Template One Updated", "http://templates.org/index.html", 
+            "http://templates.org/files.zip", "http://templates.org/screenshot.jpg" }.should raise_error(exception)
+        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' ? 'custom_api_error.json' : nil, status)
+          lambda { @template.delete }.should raise_error(exception)
+        end
+      end
+    end
+  end
+end

data/test/fixtures/active_subscribers.json

@@ -0,0 +1,67 @@
+[
+  {
+    "EmailAddress": "subs+7t8787Y@example.com",
+    "Name": "Subscriber One",
+    "Date": "2010-10-25 10:28:00",
+    "State": "Active",
+    "CustomFields": [
+      {
+        "Key": "website",
+        "Value": "http://example.com"
+      },
+      {
+        "Key": "age",
+        "Value": "24"
+      },
+      {
+        "Key": "subscription date",
+        "Value": "2010-03-09"
+      }
+    ]
+  },
+  {
+    "EmailAddress": "subs+7878787y8ggg@example.com",
+    "Name": "Subscriber Two",
+    "Date": "2010-10-25 12:17:00",
+    "State": "Active",
+    "CustomFields": [
+      {
+        "Key": "website",
+        "Value": "http://subdomain.example.com"
+      }
+    ]
+  },
+  {
+    "EmailAddress": "subs+7890909i0ggg@example.com",
+    "Name": "Subscriber Three",
+    "Date": "2010-10-25 12:52:00",
+    "State": "Active",
+    "CustomFields": [
+      {
+        "Key": "website",
+        "Value": "http://subdomain.example.com"
+      }
+    ]
+  },
+  {
+    "EmailAddress": "example+1@example.com",
+    "Name": "Example One",
+    "Date": "2010-10-25 14:33:00",
+    "State": "Active",
+    "CustomFields": []
+  },
+  {
+    "EmailAddress": "example+2@example.com",
+    "Name": "Example Two",
+    "Date": "2010-10-25 14:33:00",
+    "State": "Active",
+    "CustomFields": []
+  },
+  {
+    "EmailAddress": "example+3@example.com",
+    "Name": "Example Three",
+    "Date": "2010-10-25 14:33:00",
+    "State": "Active",
+    "CustomFields": []
+  }
+]