createsend 0.0.1

data/test/fixtures/create_template.json

@@ -0,0 +1 @@
+"98y2e98y289dh89h938389"

data/test/fixtures/custom_api_error.json

@@ -0,0 +1,4 @@
+{
+  "Code": 98798,
+  "Message": "A crazy API error"
+}

data/test/fixtures/custom_fields.json

@@ -0,0 +1,20 @@
+[
+  {
+    "FieldName": "website",
+    "Key": "[website]",
+    "DataType": "Text",
+    "FieldOptions": []
+  },
+  {
+    "FieldName": "age",
+    "Key": "[age]",
+    "DataType": "Number",
+    "FieldOptions": []
+  },
+  {
+    "FieldName": "subscription date",
+    "Key": "[subscriptiondate]",
+    "DataType": "Date",
+    "FieldOptions": []
+  }
+]

data/test/fixtures/drafts.json

@@ -0,0 +1,14 @@
+[
+  {
+    "CampaignID": "7c7424792065d92627139208c8c01db1",
+    "Name": "Draft One",
+    "Subject": "Draft One",
+    "DateCreated": "2010-08-19 16:08:00"
+  },
+  {
+    "CampaignID": "2e928e982065d92627139208c8c01db1",
+    "Name": "Draft Two",
+    "Subject": "Draft Two",
+    "DateCreated": "2010-08-19 16:08:00"
+  }
+]

data/test/fixtures/import_subscribers.json

@@ -0,0 +1,7 @@
+{
+  "FailureDetails": [],
+  "TotalUniqueEmailsSubmitted": 3,
+  "TotalExistingSubscribers": 0,
+  "TotalNewSubscribers": 3,
+  "DuplicateEmailsInSubmission": []
+}

data/test/fixtures/list_details.json

@@ -0,0 +1,7 @@
+{
+  "ConfirmedOptIn": false,
+  "Title": "a non-basic list :)",
+  "UnsubscribePage": "",
+  "ListID": "2fe4c8f0373ce320e2200596d7ef168f",
+  "ConfirmationSuccessPage": ""
+}

data/test/fixtures/list_stats.json

@@ -0,0 +1,26 @@
+{
+  "TotalActiveSubscribers": 6,
+  "NewActiveSubscribersToday": 0,
+  "NewActiveSubscribersYesterday": 8,
+  "NewActiveSubscribersThisWeek": 8,
+  "NewActiveSubscribersThisMonth": 8,
+  "NewActiveSubscribersThisYear": 8,
+  "TotalUnsubscribes": 2,
+  "UnsubscribesToday": 0,
+  "UnsubscribesYesterday": 2,
+  "UnsubscribesThisWeek": 2,
+  "UnsubscribesThisMonth": 2,
+  "UnsubscribesThisYear": 2,
+  "TotalDeleted": 0,
+  "DeletedToday": 0,
+  "DeletedYesterday": 0,
+  "DeletedThisWeek": 0,
+  "DeletedThisMonth": 0,
+  "DeletedThisYear": 0,
+  "TotalBounces": 0,
+  "BouncesToday": 0,
+  "BouncesYesterday": 0,
+  "BouncesThisWeek": 0,
+  "BouncesThisMonth": 0,
+  "BouncesThisYear": 0
+}

data/test/fixtures/lists.json

@@ -0,0 +1,10 @@
+[
+  {
+    "ListID": "a58ee1d3039b8bec838e6d1482a8a965",
+    "Name": "List One"
+  },
+  {
+    "ListID": "99bc35084a5739127a8ab81eae5bd305",
+    "Name": "List Two"
+  }
+]

data/test/fixtures/segments.json

@@ -0,0 +1,10 @@
+[
+  {
+    "ListID": "a58ee1d3039b8bec838e6d1482a8a965",
+    "Name": "Segment One"
+  },
+  {
+    "ListID": "8dffb94c60c5faa3d40f496f2aa58a8a",
+    "Name": "Segment Two"
+  }
+]

data/test/fixtures/subscriber_details.json

@@ -0,0 +1,20 @@
+{
+  "EmailAddress": "subscriber@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"
+    }
+  ]
+}

data/test/fixtures/subscriber_history.json

@@ -0,0 +1,45 @@
+[
+  {
+    "ID": "fc0ce7105baeaf97f47c99be31d02a91",
+    "Type": "Campaign",
+    "Name": "Campaign One",
+    "Actions": [
+      {
+        "Event": "Open",
+        "Date": "2010-10-12 13:18:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": ""
+      },
+      {
+        "Event": "Click",
+        "Date": "2010-10-12 13:16:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": "http://example.com/post/12323/"
+      },
+      {
+        "Event": "Click",
+        "Date": "2010-10-12 13:15:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": "http://example.com/post/29889/"
+      },
+      {
+        "Event": "Open",
+        "Date": "2010-10-12 13:15:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": ""
+      },
+      {
+        "Event": "Click",
+        "Date": "2010-10-12 13:01:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": "http://example.com/post/82211/"
+      },
+      {
+        "Event": "Open",
+        "Date": "2010-10-12 13:01:00",
+        "IPAddress": "192.168.126.87",
+        "Detail": ""
+      }
+    ]
+  }
+]

data/test/fixtures/suppressionlist.json

@@ -0,0 +1,12 @@
+[
+  {
+    "EmailAddress": "subs+098u0qu0qwd@example.com",
+    "Date": "2009-11-25 13:23:20",
+    "State": "Suppressed"
+  },
+  {
+    "EmailAddress": "subs+3018006@example.com",
+    "Date": "2009-11-10 11:50:04",
+    "State": "Suppressed"
+  }
+]

data/test/fixtures/systemdate.json

@@ -0,0 +1,3 @@
+{
+  "SystemDate": "2010-10-15 09:27:00"
+}

data/test/fixtures/template_details.json

@@ -0,0 +1,6 @@
+{
+  "TemplateID": "98y2e98y289dh89h938389",
+  "Name": "Template One",
+  "PreviewURL": "http://preview.createsend.com/createsend/templates/previewTemplate.aspx?ID=01AF532CD8889B33&d=r&c=E816F55BFAD1A753",
+  "ScreenshotURL": "http://preview.createsend.com/ts/r/14/833/263/14833263.jpg?0318092600"
+}

data/test/fixtures/templates.json

@@ -0,0 +1,14 @@
+[
+  {
+    "TemplateID": "5cac213cf061dd4e008de5a82b7a3621",
+    "Name": "Template One",
+    "PreviewURL": "http://preview.createsend.com/createsend/templates/previewTemplate.aspx?ID=01AF532CD8889B33&d=r&c=E816F55BFAD1A753",
+    "ScreenshotURL": "http://preview.createsend.com/ts/r/14/833/263/14833263.jpg?0318092541"
+  },
+  {
+    "TemplateID": "da645c271bc85fb6550acff937c2ab2e",
+    "Name": "Template Two",
+    "PreviewURL": "http://preview.createsend.com/createsend/templates/previewTemplate.aspx?ID=C8A180629495E798&d=r&c=E816F55BFAD1A753",
+    "ScreenshotURL": "http://preview.createsend.com/ts/r/18/7B3/552/187B3552.jpg?0705043527"
+  }
+]

data/test/fixtures/timezones.json

@@ -0,0 +1,99 @@
+[
+  "(GMT) Casablanca",
+  "(GMT) Coordinated Universal Time",
+  "(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London",
+  "(GMT) Monrovia, Reykjavik",
+  "(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
+  "(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague",
+  "(GMT+01:00) Brussels, Copenhagen, Madrid, Paris",
+  "(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb",
+  "(GMT+01:00) West Central Africa",
+  "(GMT+02:00) Amman",
+  "(GMT+02:00) Athens, Bucharest, Istanbul",
+  "(GMT+02:00) Beirut",
+  "(GMT+02:00) Cairo",
+  "(GMT+02:00) Damascus",
+  "(GMT+02:00) Harare, Pretoria",
+  "(GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius",
+  "(GMT+02:00) Jerusalem",
+  "(GMT+02:00) Minsk",
+  "(GMT+02:00) Windhoek",
+  "(GMT+03:00) Baghdad",
+  "(GMT+03:00) Kuwait, Riyadh",
+  "(GMT+03:00) Moscow, St. Petersburg, Volgograd",
+  "(GMT+03:00) Nairobi",
+  "(GMT+03:30) Tehran",
+  "(GMT+04:00) Abu Dhabi, Muscat",
+  "(GMT+04:00) Baku",
+  "(GMT+04:00) Port Louis",
+  "(GMT+04:00) Tbilisi",
+  "(GMT+04:00) Yerevan",
+  "(GMT+04:30) Kabul",
+  "(GMT+05:00) Ekaterinburg",
+  "(GMT+05:00) Islamabad, Karachi",
+  "(GMT+05:00) Tashkent",
+  "(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi",
+  "(GMT+05:30) Sri Jayawardenepura",
+  "(GMT+05:45) Kathmandu",
+  "(GMT+06:00) Astana",
+  "(GMT+06:00) Dhaka",
+  "(GMT+06:00) Novosibirsk",
+  "(GMT+06:30) Yangon (Rangoon)",
+  "(GMT+07:00) Bangkok, Hanoi, Jakarta",
+  "(GMT+07:00) Krasnoyarsk",
+  "(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi",
+  "(GMT+08:00) Irkutsk",
+  "(GMT+08:00) Kuala Lumpur, Singapore",
+  "(GMT+08:00) Perth",
+  "(GMT+08:00) Taipei",
+  "(GMT+08:00) Ulaanbaatar",
+  "(GMT+09:00) Osaka, Sapporo, Tokyo",
+  "(GMT+09:00) Seoul",
+  "(GMT+09:00) Yakutsk",
+  "(GMT+09:30) Adelaide",
+  "(GMT+09:30) Darwin",
+  "(GMT+10:00) Brisbane",
+  "(GMT+10:00) Canberra, Melbourne, Sydney",
+  "(GMT+10:00) Guam, Port Moresby",
+  "(GMT+10:00) Hobart",
+  "(GMT+10:00) Vladivostok",
+  "(GMT+11:00) Magadan, Solomon Is., New Caledonia",
+  "(GMT+12:00) Auckland, Wellington",
+  "(GMT+12:00) Coordinated Universal Time+12",
+  "(GMT+12:00) Fiji",
+  "(GMT+12:00) Petropavlovsk-Kamchatsky - Old",
+  "(GMT+13:00) Nuku'alofa",
+  "(GMT-01:00) Azores",
+  "(GMT-01:00) Cape Verde Is.",
+  "(GMT-02:00) Coordinated Universal Time-02",
+  "(GMT-02:00) Mid-Atlantic",
+  "(GMT-03:00) Brasilia",
+  "(GMT-03:00) Buenos Aires",
+  "(GMT-03:00) Cayenne, Fortaleza",
+  "(GMT-03:00) Greenland",
+  "(GMT-03:00) Montevideo",
+  "(GMT-03:30) Newfoundland",
+  "(GMT-04:00) Asuncion",
+  "(GMT-04:00) Atlantic Time (Canada)",
+  "(GMT-04:00) Cuiaba",
+  "(GMT-04:00) Georgetown, La Paz, Manaus, San Juan",
+  "(GMT-04:00) Santiago",
+  "(GMT-04:30) Caracas",
+  "(GMT-05:00) Bogota, Lima, Quito",
+  "(GMT-05:00) Eastern Time (US & Canada)",
+  "(GMT-05:00) Indiana (East)",
+  "(GMT-06:00) Central America",
+  "(GMT-06:00) Central Time (US & Canada)",
+  "(GMT-06:00) Guadalajara, Mexico City, Monterrey",
+  "(GMT-06:00) Saskatchewan",
+  "(GMT-07:00) Arizona",
+  "(GMT-07:00) Chihuahua, La Paz, Mazatlan",
+  "(GMT-07:00) Mountain Time (US & Canada)",
+  "(GMT-08:00) Baja California",
+  "(GMT-08:00) Pacific Time (US & Canada)",
+  "(GMT-09:00) Alaska",
+  "(GMT-10:00) Hawaii",
+  "(GMT-11:00) Coordinated Universal Time-11",
+  "(GMT-11:00) Samoa",
+  "(GMT-12:00) International Date Line West"
+]

data/test/fixtures/unsubscribed_subscribers.json

@@ -0,0 +1,21 @@
+[
+  {
+    "EmailAddress": "subscriber@example.com",
+    "Name": "Unsub One",
+    "Date": "2010-10-25 13:11:00",
+    "State": "Unsubscribed",
+    "CustomFields": []
+  },
+  {
+    "EmailAddress": "subscriberone@example.com",
+    "Name": "Unsub Two",
+    "Date": "2010-10-25 13:04:00",
+    "State": "Unsubscribed",
+    "CustomFields": [
+      {
+        "Key": "website",
+        "Value": "http://google.com"
+      }
+    ]
+  }
+]

data/test/helper.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+require 'pathname'
+
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'createsend'
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def createsend_url(api_key, url)
+  api_key.nil? ? url : url =~ /^http/ ? url : "http://#{api_key}:x@api.createsend.com/api/v3/#{url}"
+end
+
+def stub_request(method, api_key, url, filename, status=nil)
+  options = {:body => ""}
+  options.merge!({:body => fixture_file(filename)}) if filename
+  options.merge!({:status => status}) if status
+  options.merge!(:content_type => "application/json")
+  FakeWeb.register_uri(method, createsend_url(api_key, url), options)
+end
+
+def stub_get(*args); stub_request(:get, *args) end
+def stub_post(*args); stub_request(:post, *args) end
+def stub_put(*args); stub_request(:put, *args) end
+def stub_delete(*args); stub_request(:delete, *args) end

data/test/list_test.rb

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/helper'
+
+class ListTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @client_id = "87y8d7qyw8d7yq8w7ydwqwd"
+      @list_id = "e3c5f034d68744f7881fdccf13c2daee"
+      @list = List.new @list_id
+    end
+
+    should "create a list" do
+      stub_post(@api_key, "lists/#{@client_id}.json", "create_list.json")
+      list_id = List.create @client_id, "List One", "", false, ""
+      list_id.should == "e3c5f034d68744f7881fdccf13c2daee"
+    end
+    
+    should "update a list" do
+      stub_put(@api_key, "lists/#{@list.list_id}.json", nil)
+      @list.update "List One Renamed", "", false, ""
+    end
+    
+    should "delete a list" do
+      stub_delete(@api_key, "lists/#{@list.list_id}.json", nil)
+      @list.delete
+    end
+
+    should "create a custom field" do
+      stub_post(@api_key, "lists/#{@list.list_id}/customfields.json", "create_custom_field.json")
+      personalisation_tag = @list.create_custom_field "new date field", "Date"
+      personalisation_tag.should == "[newdatefield]"
+    end
+
+    should "delete a custom field" do
+      custom_field_key = "[newdatefield]"
+      stub_delete(@api_key, "lists/#{@list.list_id}/customfields/#{CGI.escape(custom_field_key)}.json", nil)
+      @list.delete_custom_field custom_field_key
+    end
+
+    should "get the details of a list" do
+      stub_get(@api_key, "lists/#{@list.list_id}.json", "list_details.json")
+      details = @list.details
+      details.ConfirmedOptIn.should == false
+      details.Title.should == "a non-basic list :)"
+      details.UnsubscribePage.should == ""
+      details.ListID.should == "2fe4c8f0373ce320e2200596d7ef168f"
+      details.ConfirmationSuccessPage.should == ""
+    end
+
+    should "get the custom fields for a list" do
+      stub_get(@api_key, "lists/#{@list.list_id}/customfields.json", "custom_fields.json")
+      cfs = @list.custom_fields
+      cfs.size.should == 3
+      cfs.first.FieldName.should == "website"
+      cfs.first.Key.should == "[website]"
+      cfs.first.DataType.should == "Text"
+      cfs.first.FieldOptions.should == []
+    end
+    
+    should "get the stats for a list" do
+      stub_get(@api_key, "lists/#{@list.list_id}/stats.json", "list_stats.json")
+      stats = @list.stats
+      stats.TotalActiveSubscribers.should == 6
+      stats.TotalUnsubscribes.should == 2
+      stats.TotalDeleted.should == 0
+      stats.TotalBounces.should == 0
+    end
+    
+    should "get the active subscribers for a list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "lists/#{@list.list_id}/active.json?date=#{CGI.escape(min_date)}", "active_subscribers.json")
+      active = @list.active min_date
+      active.size.should == 6
+      active.first.EmailAddress.should == "subs+7t8787Y@example.com"
+      active.first.Name.should == "Subscriber One"
+      active.first.Date.should == "2010-10-25 10:28:00"
+      active.first.State.should == "Active"
+      active.first.CustomFields.size.should == 3
+    end
+    
+    should "get the unsubscribed subscribers for a list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "lists/#{@list.list_id}/unsubscribed.json?date=#{CGI.escape(min_date)}", "unsubscribed_subscribers.json")
+      unsub = @list.unsubscribed min_date
+      unsub.size.should == 2
+      unsub.first.EmailAddress.should == "subscriber@example.com"
+      unsub.first.Name.should == "Unsub One"
+      unsub.first.Date.should == "2010-10-25 13:11:00"
+      unsub.first.State.should == "Unsubscribed"
+      unsub.first.CustomFields.size.should == 0
+    end
+
+    should "get the bounced subscribers for a list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "lists/#{@list.list_id}/bounced.json?date=#{CGI.escape(min_date)}", "bounced_subscribers.json")
+      bounced = @list.bounced min_date
+      bounced.size.should == 1
+      bounced.first.EmailAddress.should == "bouncedsubscriber@example.com"
+      bounced.first.Name.should == "Bounced One"
+      bounced.first.Date.should == "2010-10-25 13:11:00"
+      bounced.first.State.should == "Bounced"
+      bounced.first.CustomFields.size.should == 0
+    end
+
+  end
+end