createsend 2.3.0 → 2.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    createsend (2.3.0)
+    createsend (2.4.0)
       hashie (~> 1.0)
       httparty (~> 0.8)
       json
@@ -15,17 +15,17 @@ GEM
     cane (2.0.0)
     fakeweb (1.3.0)
     hashie (1.2.0)
-    httparty (0.8.1)
-      multi_json
+    httparty (0.9.0)
+      multi_json (~> 1.0)
       multi_xml
     i18n (0.6.1)
     jnunemaker-matchy (0.4.0)
-    json (1.7.4)
+    json (1.7.5)
     metaclass (0.0.1)
     mocha (0.10.0)
       metaclass (~> 0.0.1)
     multi_json (1.0.3)
-    multi_xml (0.4.1)
+    multi_xml (0.4.4)
     rake (0.9.2.2)
     shoulda (3.3.0)
       shoulda-context (~> 1.0)

data/HISTORY.md

@@ -0,0 +1,83 @@
+# createsend-ruby history
+
+## v2.4.0 - 5 Nov, 2012   (4277d8d9)
+
+* Added CreateSend::Campaign#email_client_usage.
+* Added support for ReadsEmailWith field on subscriber objects.
+* Added support for retrieving unconfirmed subscribers for a list.
+* Added support for suppressing email addresses.
+* Added support for retrieving spam complaints for a campaign, as well as
+adding SpamComplaints field to campaign summary output.
+* Added VisibleInPreferenceCenter field to custom field output.
+* Added support for setting preference center visibility when creating custom
+fields.
+* Added the ability to update a custom field name and preference visibility.
+* Added documentation explaining that text_url may now be nil or an empty
+string when creating a campaign.
+
+## v2.3.0 - 10 Oct, 2012   (6639c1f6)
+
+* Added support for creating campaigns from templates.
+* Added support for unsuppressing an email address.
+* Improved documentation and tests for getting active subscribers. Clearly
+documented the data structure for multi option multi select fields.
+
+## v2.2.0 - 17 Sep, 2012   (17409634)
+
+* Added WorldviewURL field to campaign summary response.
+* Added Latitude, Longitude, City, Region, CountryCode, and CountryName fields
+to campaign opens and clicks response.
+
+## v2.1.0 - 30 Aug, 2012   (ee936259)
+
+* Added support for basic / unlimited pricing.
+
+## v2.0.0 - 22 Aug, 2012   (8a5ab6b4)
+
+* Added support for UnsubscribeSetting field when creating, updating and
+getting list details.
+* Added support for including AddUnsubscribesToSuppList and
+ScrubActiveWithSuppList fields when updating a list.
+* Added support for getting all client lists to which a subscriber with a
+specific email address belongs.
+* Removed deprecated warnings and disallowed calls to be made in a deprecated
+manner.
+
+## v1.1.1 - 24 Jul, 2012   (72934e66)
+
+* Added support for specifying whether subscription-based autoresponders
+should be restarted when adding or updating subscribers.
+
+## v1.1.0 - 11 Jul, 2012   (93e856b6)
+
+* Added support for newly released team management functionality.
+
+## v1.0.4 - 4 May, 2012   (9bce25c1)
+
+* Added Travis CI support.
+* Added Gemnasium support.
+* Fixes to usage of Shoulda and Hashie libraries.
+
+## v1.0.3 - 3 Dec, 2011   (1ed2b56a)
+
+* Fixes to support Ruby 1.9.* (both the library as well as the rake tasks).
+* Fixed the User-Agent header so that it now uses the correct module VERSION.
+
+## v1.0.2 - 31 Oct, 2011   (83020409)
+
+* Added support for deleting a subscriber.
+* Added support for specifying a 'clear' field when updating or importing
+subscribers.
+* Added support for queuing subscription-based autoresponders when importing
+subscribers.
+* Added support for retrieving deleted subscribers.
+* Added support for including more social sharing stats in campaign summary.
+* Added support for unscheduling a campaign.
+
+## v1.0.1 - 25 Oct, 2011   (347b2b95)
+
+* Remove CreateSendOptions and remove usage of yaml config file.
+
+## v1.0.0 - 26 Sep, 2011   (0a078b09)
+
+* Initial release which supports current Campaign Monitor API.

data/createsend.gemspec

@@ -15,13 +15,13 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('httparty', '~> 0.8')
   s.name = "createsend"
   s.author = "James Dennes"
-  s.description = %q{Implements the complete functionality of the createsend API.}
+  s.description = %q{Implements the complete functionality of the Campaign Monitor API.}
   s.email = ["jdennes@gmail.com"]
   s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
   s.files = `git ls-files`.split("\n")
   s.homepage = "http://campaignmonitor.github.com/createsend-ruby/"
   s.require_paths = ["lib"]
-  s.summary = %q{A library which implements the complete functionality of v3 of the createsend API.}
+  s.summary = %q{A library which implements the complete functionality of the Campaign Monitor API.}
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.version = CreateSend::VERSION
   s.platform = Gem::Platform::RUBY

data/lib/createsend/campaign.rb

@@ -11,6 +11,21 @@ module CreateSend
     end
 
     # Creates a new campaign for a client.
+    # client_id - String representing the ID of the client for whom the
+    #   campaign will be created.
+    # subject - String representing the subject of the campaign.
+    # name - String representing the name of the campaign.
+    # from_name - String representing the from name for the campaign.
+    # from_email - String representing the from address for the campaign.
+    # reply_to - String representing the reply-to address for the campaign.
+    # html_url - String representing the URL for the campaign HTML content.
+    # text_url - String representing the URL for the campaign text content.
+    #  Note that text_url is optional and if nil or an empty string, text
+    #  content will be automatically generated from the HTML content.
+    # list_ids - Array of Strings representing the IDs of the lists to
+    #   which the campaign will be sent.
+    # segment_ids - Array of Strings representing the IDs of the segments to
+    #   which the campaign will be sent.
     def self.create(client_id, subject, name, from_name, from_email,
       reply_to, html_url, text_url, list_ids, segment_ids)
       options = { :body => {
@@ -28,6 +43,23 @@ module CreateSend
     end
 
     # Creates a new campaign for a client, from a template.
+    # client_id - String representing the ID of the client for whom the
+    #   campaign will be created.
+    # subject - String representing the subject of the campaign.
+    # name - String representing the name of the campaign.
+    # from_name - String representing the from name for the campaign.
+    # from_email - String representing the from address for the campaign.
+    # reply_to - String representing the reply-to address for the campaign.
+    # list_ids - Array of Strings representing the IDs of the lists to
+    #   which the campaign will be sent.
+    # segment_ids - Array of Strings representing the IDs of the segments to
+    #   which the campaign will be sent.
+    # template_id - String representing the ID of the template on which
+    #   the campaign will be based.
+    # template_content - Hash representing the content to be used for the
+    #   editable areas of the template. See documentation at
+    #   campaignmonitor.com/api/campaigns/#creating_a_campaign_from_template
+    #   for full details of template content format.
     def self.create_from_template(client_id, subject, name, from_name,
       from_email, reply_to, list_ids, segment_ids, template_id,
       template_content)
@@ -80,6 +112,12 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Gets the email clients that subscribers used to open the campaign
+    def email_client_usage
+      response = get "emailclientusage", {}
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
     # Retrieves the lists and segments to which this campaaign will
     # be (or was) sent.
     def lists_and_segments
@@ -138,6 +176,19 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Retrieves the spam complaints for this campaign.
+    def spam(date, page=1, page_size=1000, order_field="date",
+      order_direction="asc")
+      options = { :query => {
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "spam", options
+      Hashie::Mash.new(response)
+    end
+
     # Retrieves the bounces for this campaign.
     def bounces(date="1900-01-01", page=1, page_size=1000, order_field="date",
       order_direction="asc")

data/lib/createsend/client.rb

@@ -93,6 +93,14 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Adds email addresses to a client's suppression list
+    def suppress(emails)
+      options = { :body => {
+        :EmailAddresses => emails.kind_of?(String) ?
+          [ emails ] : emails }.to_json }
+      response = post "suppress", options
+    end
+
     # Unsuppresses an email address by removing it from the the client's
     # suppression list
     def unsuppress(email)

data/lib/createsend/list.rb

@@ -41,15 +41,40 @@ module CreateSend
     end
 
     # Creates a new custom field for this list.
-    def create_custom_field(field_name, data_type, options=[])
+    # field_name - String representing the name to be given to the field
+    # data_type - String representing the data type of the field. Valid data
+    #   types are 'Text', 'Number', 'MultiSelectOne', 'MultiSelectMany',
+    #   'Date', 'Country', and 'USState'.
+    # options - Array of Strings representing the options for the field if it
+    #   is of type 'MultiSelectOne' or 'MultiSelectMany'.
+    # visible_in_preference_center - Boolean indicating whether or not the
+    #    field should be visible in the subscriber preference center
+    def create_custom_field(field_name, data_type, options=[],
+      visible_in_preference_center=true)
       options = { :body => {
         :FieldName => field_name,
         :DataType => data_type,
-        :Options => options }.to_json }
+        :Options => options,
+        :VisibleInPreferenceCenter => visible_in_preference_center }.to_json }
       response = post "customfields", options
       response.parsed_response
     end
 
+    # Updates a custom field belonging to this list.
+    # custom_field_key - String which represents the key for the custom field
+    # field_name - String representing the name to be given to the field
+    # visible_in_preference_center - Boolean indicating whether or not the
+    #    field should be visible in the subscriber preference center
+    def update_custom_field(custom_field_key, field_name,
+      visible_in_preference_center)
+      custom_field_key = CGI.escape(custom_field_key)
+      options = { :body => {
+        :FieldName => field_name,
+        :VisibleInPreferenceCenter => visible_in_preference_center }.to_json }
+      response = put "customfields/#{custom_field_key}", options
+      response.parsed_response
+    end
+
     # Deletes a custom field associated with this list.
     def delete_custom_field(custom_field_key)
       custom_field_key = CGI.escape(custom_field_key)
@@ -104,6 +129,19 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Gets the unconfirmed subscribers for this list.
+    def unconfirmed(date, page=1, page_size=1000, order_field="email",
+      order_direction="asc")
+      options = { :query => {
+        :date => date,
+        :page => page,
+        :pagesize => page_size,
+        :orderfield => order_field,
+        :orderdirection => order_direction } }
+      response = get "unconfirmed", options
+      Hashie::Mash.new(response)
+    end
+
     # Gets the bounced subscribers for this list.
     def bounced(date, page=1, page_size=1000, order_field="email",
       order_direction="asc")

data/lib/createsend/version.rb

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

data/test/campaign_test.rb

@@ -14,6 +14,19 @@ class CampaignTest < Test::Unit::TestCase
       campaign_id = CreateSend::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' ],
       [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ]
+      request = FakeWeb.last_request.body
+      request.include?("\"TextUrl\":\"http://example.com/campaign.txt\"").should == true
+      campaign_id.should == "787y87y87y87y87y87y87"
+    end
+
+    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", 
+      "http://example.com/campaign.html", nil, [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ],
+      [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ]
+      request = FakeWeb.last_request.body
+      request.include?("\"TextUrl\":null").should == true
       campaign_id.should == "787y87y87y87y87y87y87"
     end
 
@@ -22,7 +35,6 @@ class CampaignTest < Test::Unit::TestCase
         :Singlelines => [
           {
             :Content => "This is a heading",
-            :Alt => "This is alt text",
             :Href => "http://example.com/"
           }
         ],
@@ -99,7 +111,12 @@ class CampaignTest < Test::Unit::TestCase
       campaign_id.should == "787y87y87y87y87y87y87"
     end
 
-    should "send a preview of a draft campaign" do
+    should "send a preview of a draft campaign to a single recipient" do
+      stub_post(@api_key, "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)
       @campaign.send_preview [ "test+89898u9@example.com", "test+787y8y7y8@example.com" ], "random"
     end
@@ -133,8 +150,19 @@ class CampaignTest < Test::Unit::TestCase
       summary.Likes.should == 32
       summary.WebVersionURL.should == "http://createsend.com/t/r-3A433FC72FFE3B8B"
       summary.WorldviewURL.should == "http://client.createsend.com/reports/wv/r/3A433FC72FFE3B8B"
+      summary.SpamComplaints.should == 23
     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")
+      ecu = @campaign.email_client_usage
+      ecu.size.should == 6
+      ecu.first.Client.should == "iOS Devices"
+      ecu.first.Version.should == "iPhone"
+      ecu.first.Percentage.should == 19.83
+      ecu.first.Subscribers.should == 7056
+    end
+
     should "get the lists and segments for a campaign" do
       stub_get(@api_key, "campaigns/#{@campaign.campaign_id}/listsandsegments.json", "campaign_listsandsegments.json")
       ls = @campaign.lists_and_segments
@@ -229,6 +257,23 @@ class CampaignTest < Test::Unit::TestCase
       unsubscribes.NumberOfPages.should == 1
     end
 
+    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")
+      spam = @campaign.spam min_date
+      spam.Results.size.should == 1
+      spam.Results.first.EmailAddress.should == "subs+6576576576@example.com"
+      spam.Results.first.ListID.should == "512a3bc577a58fdf689c654329b50fa0"
+      spam.Results.first.Date.should == "2010-10-11 08:29:00"
+      spam.ResultsOrderedBy.should == "date"
+      spam.OrderDirection.should == "asc"
+      spam.PageNumber.should == 1
+      spam.PageSize.should == 1000
+      spam.RecordsOnThisPage.should == 1
+      spam.TotalNumberOfRecords.should == 1
+      spam.NumberOfPages.should == 1
+    end
+
     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")

data/test/client_test.rb

@@ -107,6 +107,17 @@ class ClientTest < Test::Unit::TestCase
       res.Results.first.State.should == "Suppressed"
     end
 
+    should "suppress a single email address" do
+      email = "example@example.com"
+      stub_post(@api_key, "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)
+      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)

data/test/fixtures/active_subscribers.json

@@ -26,7 +26,8 @@
           "Key": "subscription date",
           "Value": "2010-03-09"
         }
-      ]
+      ],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "subs+7878787y8ggg@example.com",
@@ -38,7 +39,8 @@
           "Key": "website",
           "Value": "http://subdomain.example.com"
         }
-      ]
+      ],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "subs+7890909i0ggg@example.com",
@@ -50,21 +52,24 @@
           "Key": "website",
           "Value": "http://subdomain.example.com"
         }
-      ]
+      ],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "subs@example.com",
       "Name": "Person Four",
       "Date": "2010-10-27 13:13:00",
       "State": "Active",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "joey@example.com",
       "Name": "Person Five",
       "Date": "2010-10-27 13:13:00",
       "State": "Active",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": "Gmail"
     }
   ],
   "ResultsOrderedBy": "email",

data/test/fixtures/bounced_subscribers.json

@@ -5,7 +5,8 @@
       "Name": "Bounced One",
       "Date": "2010-10-25 13:11:00",
       "State": "Bounced",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     }
   ],
   "ResultsOrderedBy": "email",

data/test/fixtures/campaign_spam.json

@@ -0,0 +1,16 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "subs+6576576576@example.com",
+      "ListID": "512a3bc577a58fdf689c654329b50fa0",
+      "Date": "2010-10-11 08:29:00"
+    }
+  ],
+  "ResultsOrderedBy": "date",
+  "OrderDirection": "asc",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 1,
+  "TotalNumberOfRecords": 1,
+  "NumberOfPages": 1
+}

data/test/fixtures/campaign_summary.json

@@ -9,5 +9,6 @@
   "Forwards": 11,
   "Likes": 32,
   "WebVersionURL": "http://createsend.com/t/r-3A433FC72FFE3B8B",
-  "WorldviewURL": "http://client.createsend.com/reports/wv/r/3A433FC72FFE3B8B"
+  "WorldviewURL": "http://client.createsend.com/reports/wv/r/3A433FC72FFE3B8B",
+  "SpamComplaints": 23
 }

data/test/fixtures/custom_fields.json

@@ -3,18 +3,21 @@
     "FieldName": "website",
     "Key": "[website]",
     "DataType": "Text",
-    "FieldOptions": []
+    "FieldOptions": [],
+    "VisibleInPreferenceCenter": true
   },
   {
     "FieldName": "age",
     "Key": "[age]",
     "DataType": "Number",
-    "FieldOptions": []
+    "FieldOptions": [],
+    "VisibleInPreferenceCenter": true
   },
   {
     "FieldName": "subscription date",
     "Key": "[subscriptiondate]",
     "DataType": "Date",
-    "FieldOptions": []
+    "FieldOptions": [],
+    "VisibleInPreferenceCenter": false
   }
 ]

data/test/fixtures/deleted_subscribers.json

@@ -5,7 +5,8 @@
       "Name": "Deleted One",
       "Date": "2010-10-25 13:11:00",
       "State": "Deleted",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "subscriberone@example.com",
@@ -17,28 +18,32 @@
           "Key": "website",
           "Value": "http://google.com"
         }
-      ]
+      ],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "example+1@example.com",
       "Name": "Example One",
       "Date": "2010-10-26 10:56:00",
       "State": "Deleted",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "example+2@example.com",
       "Name": "Example Two",
       "Date": "2010-10-26 10:56:00",
       "State": "Deleted",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "example+3@example.com",
       "Name": "Example Three",
       "Date": "2010-10-26 10:56:00",
       "State": "Deleted",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": "Gmail"
     }
   ],
   "ResultsOrderedBy": "email",

data/test/fixtures/email_client_usage.json

@@ -0,0 +1,38 @@
+[
+    {
+        "Client": "iOS Devices",
+        "Version": "iPhone",
+        "Percentage": 19.83,
+        "Subscribers": 7056
+    },
+    {
+        "Client": "Apple Mail",
+        "Version": "Apple Mail 6",
+        "Percentage": 13.02,
+        "Subscribers": 4633
+    },
+    {
+        "Client": "Apple Mail",
+        "Version": "Apple Mail 5",
+        "Percentage": 10.60,
+        "Subscribers": 3773
+    },
+    {
+        "Client": "Microsoft Outlook",
+        "Version": "Outlook 2010",
+        "Percentage": 7.18,
+        "Subscribers": 2556
+    },
+    {
+        "Client": "iOS Devices",
+        "Version": "iPad",
+        "Percentage": 4.43,
+        "Subscribers": 1577
+    },
+    {
+        "Client": "Undetectable",
+        "Version": "Undetectable",
+        "Percentage": 4.94,
+        "Subscribers": 1632
+    }
+]

data/test/fixtures/subscriber_details.json

@@ -16,5 +16,6 @@
       "Key": "subscription date",
       "Value": "2010-03-09"
     }
-  ]
+  ],
+  "ReadsEmailWith": "Gmail"
 }

data/test/fixtures/unconfirmed_subscribers.json

@@ -0,0 +1,37 @@
+{
+    "Results": [
+        {
+            "EmailAddress": "subs+7t8787Y@example.com",
+            "Name": "Unconfirmed One",
+            "Date": "2010-10-25 10:28:00",
+            "State": "Unconfirmed",
+            "CustomFields": [
+                {
+                    "Key": "website",
+                    "Value": "http://example.com"
+                }
+            ],
+            "ReadsEmailWith": ""
+        },
+        {
+            "EmailAddress": "subs+7878787y8ggg@example.com",
+            "Name": "Unconfirmed Two",
+            "Date": "2010-10-25 12:17:00",
+            "State": "Unconfirmed",
+            "CustomFields": [
+                {
+                    "Key": "website",
+                    "Value": "http://subdomain.example.com"
+                }
+            ],
+            "ReadsEmailWith": ""
+        }
+    ],
+    "ResultsOrderedBy": "email",
+    "OrderDirection": "asc",
+    "PageNumber": 1,
+    "PageSize": 1000,
+    "RecordsOnThisPage": 2,
+    "TotalNumberOfRecords": 2,
+    "NumberOfPages": 1
+}

data/test/fixtures/unsubscribed_subscribers.json

@@ -5,7 +5,8 @@
       "Name": "Unsub One",
       "Date": "2010-10-25 13:11:00",
       "State": "Unsubscribed",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "subscriberone@example.com",
@@ -17,28 +18,32 @@
           "Key": "website",
           "Value": "http://google.com"
         }
-      ]
+      ],
+      "ReadsEmailWith": "Gmail"
     },
     {
       "EmailAddress": "example+1@example.com",
       "Name": "Example One",
       "Date": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "example+2@example.com",
       "Name": "Example Two",
       "Date": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": ""
     },
     {
       "EmailAddress": "example+3@example.com",
       "Name": "Example Three",
       "Date": "2010-10-26 10:56:00",
       "State": "Unsubscribed",
-      "CustomFields": []
+      "CustomFields": [],
+      "ReadsEmailWith": "Gmail"
     }
   ],
   "ResultsOrderedBy": "email",

data/test/fixtures/update_custom_field.json

@@ -0,0 +1 @@
+"[myrenamedcustomfield]"

data/test/list_test.rb

@@ -45,9 +45,37 @@ class ListTest < Test::Unit::TestCase
     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"
+      request = FakeWeb.last_request.body
+      request.include?("\"FieldName\":\"new date field\"").should == true
+      request.include?("\"DataType\":\"Date\"").should == true
+      request.include?("\"Options\":[]").should == true
+      request.include?("\"VisibleInPreferenceCenter\":true").should == true
       personalisation_tag.should == "[newdatefield]"
     end
 
+    should "create a custom field with options and visible_in_preference_center" do
+      stub_post(@api_key, "lists/#{@list.list_id}/customfields.json", "create_custom_field.json")
+      options = ["one", "two"]
+      personalisation_tag = @list.create_custom_field("newsletter format",
+        "MultiSelectOne", options, false)
+      request = FakeWeb.last_request.body
+      request.include?("\"FieldName\":\"newsletter format\"").should == true
+      request.include?("\"DataType\":\"MultiSelectOne\"").should == true
+      request.include?("\"Options\":[\"one\",\"two\"]").should == true
+      request.include?("\"VisibleInPreferenceCenter\":false").should == true
+      personalisation_tag.should == "[newdatefield]"
+    end
+
+    should "update a custom field" do
+      key = "[mycustomfield]"
+      stub_put(@api_key, "lists/#{@list.list_id}/customfields/#{CGI.escape(key)}.json", "update_custom_field.json")
+      personalisation_tag = @list.update_custom_field key, "my renamed custom field", true
+      request = FakeWeb.last_request.body
+      request.include?("\"FieldName\":\"my renamed custom field\"").should == true
+      request.include?("\"VisibleInPreferenceCenter\":true").should == true
+      personalisation_tag.should == "[myrenamedcustomfield]"
+    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)
@@ -80,6 +108,7 @@ class ListTest < Test::Unit::TestCase
       cfs.first.Key.should == "[website]"
       cfs.first.DataType.should == "Text"
       cfs.first.FieldOptions.should == []
+      cfs.first.VisibleInPreferenceCenter.should == true
     end
 
     should "get the segments for a list" do
@@ -124,8 +153,27 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.CustomFields[1].Value.should == "option one"
       res.Results.first.CustomFields[2].Key.should == "multi select field"
       res.Results.first.CustomFields[2].Value.should == "option two"
+      res.Results.first.ReadsEmailWith.should == "Gmail"
     end
-    
+
+    should "get the unconfirmed subscribers for a list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "lists/#{@list.list_id}/unconfirmed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+        "unconfirmed_subscribers.json")
+      res = @list.unconfirmed min_date
+      res.ResultsOrderedBy.should == "email"
+      res.OrderDirection.should == "asc"
+      res.PageNumber.should == 1
+      res.PageSize.should == 1000
+      res.RecordsOnThisPage.should == 2
+      res.TotalNumberOfRecords.should == 2
+      res.NumberOfPages.should == 1
+      res.Results.size.should == 2
+      res.Results.first.EmailAddress.should == "subs+7t8787Y@example.com"
+      res.Results.first.Name.should =="Unconfirmed One"
+      res.Results.first.State.should == "Unconfirmed"
+    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?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}", 
@@ -144,6 +192,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.Date.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Unsubscribed"
       res.Results.first.CustomFields.size.should == 0
+      res.Results.first.ReadsEmailWith.should == "Gmail"
     end
 
     should "get the deleted subscribers for a list" do
@@ -164,6 +213,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.Date.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Deleted"
       res.Results.first.CustomFields.size.should == 0
+      res.Results.first.ReadsEmailWith.should == "Gmail"
     end
 
     should "get the bounced subscribers for a list" do
@@ -184,6 +234,7 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.Date.should == "2010-10-25 13:11:00"
       res.Results.first.State.should == "Bounced"
       res.Results.first.CustomFields.size.should == 0
+      res.Results.first.ReadsEmailWith.should == ""
     end
 
     should "get the webhooks for a list" do

data/test/subscriber_test.rb

@@ -20,6 +20,7 @@ class SubscriberTest < Test::Unit::TestCase
       subscriber.CustomFields.size.should == 3
       subscriber.CustomFields.first.Key.should == 'website'
       subscriber.CustomFields.first.Value.should == 'http://example.com'
+      subscriber.ReadsEmailWith.should == "Gmail"
     end
 
     should "add a subscriber without custom fields" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70321789088920 !ruby/object:Gem::Requirement
+  requirement: &70098807897300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70321789088920
+  version_requirements: *70098807897300
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70321789088160 !ruby/object:Gem::Requirement
+  requirement: &70098807896180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70321789088160
+  version_requirements: *70098807896180
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70321789084600 !ruby/object:Gem::Requirement
+  requirement: &70098807915080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70321789084600
+  version_requirements: *70098807915080
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70321789096560 !ruby/object:Gem::Requirement
+  requirement: &70098807914240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70321789096560
+  version_requirements: *70098807914240
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70321789092060 !ruby/object:Gem::Requirement
+  requirement: &70098807913600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 3.3.0
   type: :development
   prerelease: false
-  version_requirements: *70321789092060
+  version_requirements: *70098807913600
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &70321789105720 !ruby/object:Gem::Requirement
+  requirement: &70098807912660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70321789105720
+  version_requirements: *70098807912660
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70321789104280 !ruby/object:Gem::Requirement
+  requirement: &70098807911800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70321789104280
+  version_requirements: *70098807911800
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70321789103040 !ruby/object:Gem::Requirement
+  requirement: &70098807911160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70321789103040
+  version_requirements: *70098807911160
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70321789101200 !ruby/object:Gem::Requirement
+  requirement: &70098807910060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,8 +109,8 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70321789101200
-description: Implements the complete functionality of the createsend API.
+  version_requirements: *70098807910060
+description: Implements the complete functionality of the Campaign Monitor API.
 email:
 - jdennes@gmail.com
 executables: []
@@ -121,6 +121,7 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -154,6 +155,7 @@ files:
 - test/fixtures/campaign_listsandsegments.json
 - test/fixtures/campaign_opens.json
 - test/fixtures/campaign_recipients.json
+- test/fixtures/campaign_spam.json
 - test/fixtures/campaign_summary.json
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
@@ -173,6 +175,7 @@ files:
 - test/fixtures/custom_fields.json
 - test/fixtures/deleted_subscribers.json
 - test/fixtures/drafts.json
+- test/fixtures/email_client_usage.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
@@ -193,7 +196,9 @@ files:
 - test/fixtures/template_details.json
 - test/fixtures/templates.json
 - test/fixtures/timezones.json
+- test/fixtures/unconfirmed_subscribers.json
 - test/fixtures/unsubscribed_subscribers.json
+- test/fixtures/update_custom_field.json
 - test/helper.rb
 - test/list_test.rb
 - test/person_test.rb
@@ -212,9 +217,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3175201096736061315
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -226,7 +228,7 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: A library which implements the complete functionality of v3 of the createsend
+summary: A library which implements the complete functionality of the Campaign Monitor
   API.
 test_files:
 - test/administrator_test.rb
@@ -248,6 +250,7 @@ test_files:
 - test/fixtures/campaign_listsandsegments.json
 - test/fixtures/campaign_opens.json
 - test/fixtures/campaign_recipients.json
+- test/fixtures/campaign_spam.json
 - test/fixtures/campaign_summary.json
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
@@ -267,6 +270,7 @@ test_files:
 - test/fixtures/custom_fields.json
 - test/fixtures/deleted_subscribers.json
 - test/fixtures/drafts.json
+- test/fixtures/email_client_usage.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
@@ -287,7 +291,9 @@ test_files:
 - test/fixtures/template_details.json
 - test/fixtures/templates.json
 - test/fixtures/timezones.json
+- test/fixtures/unconfirmed_subscribers.json
 - test/fixtures/unsubscribed_subscribers.json
+- test/fixtures/update_custom_field.json
 - test/helper.rb
 - test/list_test.rb
 - test/person_test.rb