createsend 0.0.1 → 0.0.2

data/test/fixtures/segments.json

@@ -1,10 +1,12 @@
 [
   {
     "ListID": "a58ee1d3039b8bec838e6d1482a8a965",
-    "Name": "Segment One"
+    "SegmentID": "46aa5e01fd43381863d4e42cf277d3a9",
+    "Title": "Segment One"
   },
   {
     "ListID": "8dffb94c60c5faa3d40f496f2aa58a8a",
-    "Name": "Segment Two"
+    "SegmentID": "dhw9q8jd9q8wd09quw0d909wid9i09iq",
+    "Title": "Segment Two"
   }
 ]

data/test/fixtures/suppressionlist.json

@@ -1,12 +1,36 @@
-[
-  {
-    "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"
-  }
-]
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "Date": "2010-10-26 10:55:31",
+      "State": "Suppressed"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "Date": "2010-10-26 10:55:31",
+      "State": "Suppressed"
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "Date": "2010-10-26 10:55:31",
+      "State": "Suppressed"
+    },
+    {
+      "EmailAddress": "subscriber@example.com",
+      "Date": "2010-10-25 13:11:04",
+      "State": "Suppressed"
+    },
+    {
+      "EmailAddress": "subscriberone@example.com",
+      "Date": "2010-10-25 13:04:15",
+      "State": "Suppressed"
+    }
+  ],
+  "ResultsOrderedBy": "email",
+  "OrderDirection": "asc",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 5,
+  "TotalNumberOfRecords": 5,
+  "NumberOfPages": 1
+}

data/test/fixtures/unsubscribed_subscribers.json

@@ -1,21 +1,51 @@
-[
-  {
-    "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"
-      }
-    ]
-  }
-]
+{
+  "Results": [
+    {
+      "EmailAddress": "subscriber@example.com",
+      "Name": "Unsub One",
+      "Date": "2010-10-25 13:11:00",
+      "State": "Unsubscribed",
+      "CustomFields": []
+    },
+    {
+      "EmailAddress": "subscriberone@example.com",
+      "Name": "Subscriber",
+      "Date": "2010-10-25 13:04:00",
+      "State": "Unsubscribed",
+      "CustomFields": [
+        {
+          "Key": "website",
+          "Value": "http://google.com"
+        }
+      ]
+    },
+    {
+      "EmailAddress": "example+1@example.com",
+      "Name": "Example One",
+      "Date": "2010-10-26 10:56:00",
+      "State": "Unsubscribed",
+      "CustomFields": []
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "Name": "Example Two",
+      "Date": "2010-10-26 10:56:00",
+      "State": "Unsubscribed",
+      "CustomFields": []
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "Name": "Example Three",
+      "Date": "2010-10-26 10:56:00",
+      "State": "Unsubscribed",
+      "CustomFields": []
+    }
+  ],
+  "ResultsOrderedBy": "email",
+  "OrderDirection": "asc",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 5,
+  "TotalNumberOfRecords": 5,
+  "NumberOfPages": 1
+}

data/test/list_test.rb

@@ -37,6 +37,13 @@ class ListTest < Test::Unit::TestCase
       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 "update the options of a multi-optioned custom field" do
+      custom_field_key = "[newdatefield]"
+      new_options = [ "one", "two", "three" ]
+      stub_put(@api_key, "lists/#{@list.list_id}/customfields/#{CGI.escape(custom_field_key)}/options.json", nil)
+      @list.update_custom_field_options custom_field_key, new_options, true
+    end
 
     should "get the details of a list" do
       stub_get(@api_key, "lists/#{@list.list_id}.json", "list_details.json")
@@ -57,6 +64,15 @@ class ListTest < Test::Unit::TestCase
       cfs.first.DataType.should == "Text"
       cfs.first.FieldOptions.should == []
     end
+
+    should "get the segments for a list" do
+      stub_get(@api_key, "lists/#{@list.list_id}/segments.json", "segments.json")
+      segments = @list.segments
+      segments.size.should == 2
+      segments.first.ListID.should == 'a58ee1d3039b8bec838e6d1482a8a965'
+      segments.first.SegmentID.should == '46aa5e01fd43381863d4e42cf277d3a9'
+      segments.first.Title.should == 'Segment One'
+    end
     
     should "get the stats for a list" do
       stub_get(@api_key, "lists/#{@list.list_id}/stats.json", "list_stats.json")
@@ -69,38 +85,62 @@ class ListTest < Test::Unit::TestCase
     
     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
+      stub_get(@api_key, "lists/#{@list.list_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+        "active_subscribers.json")
+      res = @list.active min_date
+      res.ResultsOrderedBy.should == "email"
+      res.OrderDirection.should == "asc"
+      res.PageNumber.should == 1
+      res.PageSize.should == 1000
+      res.RecordsOnThisPage.should == 5
+      res.TotalNumberOfRecords.should == 5
+      res.NumberOfPages.should == 1
+      res.Results.size.should == 5
+      res.Results.first.EmailAddress.should == "subs+7t8787Y@example.com"
+      res.Results.first.Name.should =="Person One"
+      res.Results.first.Date.should == "2010-10-25 10:28:00"
+      res.Results.first.State.should == "Active"
+      res.Results.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
+      stub_get(@api_key, "lists/#{@list.list_id}/unsubscribed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}", 
+        "unsubscribed_subscribers.json")
+      res = @list.unsubscribed min_date
+      res.ResultsOrderedBy.should == "email"
+      res.OrderDirection.should == "asc"
+      res.PageNumber.should == 1
+      res.PageSize.should == 1000
+      res.RecordsOnThisPage.should == 5
+      res.TotalNumberOfRecords.should == 5
+      res.NumberOfPages.should == 1
+      res.Results.size.should == 5
+      res.Results.first.EmailAddress.should == "subscriber@example.com"
+      res.Results.first.Name.should == "Unsub One"
+      res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.State.should == "Unsubscribed"
+      res.Results.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
+      stub_get(@api_key, "lists/#{@list.list_id}/bounced.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+        "bounced_subscribers.json")
+      res = @list.bounced min_date
+      res.ResultsOrderedBy.should == "email"
+      res.OrderDirection.should == "asc"
+      res.PageNumber.should == 1
+      res.PageSize.should == 1000
+      res.RecordsOnThisPage.should == 1
+      res.TotalNumberOfRecords.should == 1
+      res.NumberOfPages.should == 1
+      res.Results.size.should == 1
+      res.Results.first.EmailAddress.should == "bouncedsubscriber@example.com"
+      res.Results.first.Name.should == "Bounced One"
+      res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.State.should == "Bounced"
+      res.Results.first.CustomFields.size.should == 0
     end
 
   end

data/test/segment_test.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/helper'
+
+class SegmentTest < Test::Unit::TestCase
+  context "when an api caller is authenticated" do
+    setup do
+      @api_key = '123123123123123123123'
+      CreateSend.api_key @api_key
+      @segment = Segment.new(:segment_id => '98y2e98y289dh89h938389')
+    end
+
+    should "create a new segment" do
+      list_id = "2983492834987394879837498"
+      rules = [ { :Subject => "EmailAddress", :Clauses => [ "CONTAINS example.com" ] } ]
+      stub_post(@api_key, "segments/#{list_id}.json", "create_segment.json")
+      res = Segment.create list_id, "new segment title", rules
+      res.should == "0246c2aea610a3545d9780bf6ab89006"
+    end
+
+    should "update a segment" do
+      rules = [ { :Subject => "Name", :Clauses => [ "EQUALS subscriber" ] } ]
+      stub_put(@api_key, "segments/#{@segment.segment_id}.json", nil)
+      @segment.update "new title for segment", rules
+    end
+    
+    should "add a rule to a segment" do
+      clauses = [ "CONTAINS example.com" ]
+      stub_post(@api_key, "segments/#{@segment.segment_id}/rules.json", nil)
+      @segment.add_rule "EmailAddress", clauses
+    end
+
+    should "get the active subscribers for a particular segment in the list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "segments/#{@segment.segment_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+        "segment_subscribers.json")
+      res = @segment.subscribers 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 == "personone@example.com"
+      res.Results.first.Name.should == "Person One"
+      res.Results.first.Date.should == "2010-10-27 13:13:00"
+      res.Results.first.State.should == "Active"
+      res.Results.first.CustomFields.should == []
+    end
+    
+    should "delete a segment" do
+      stub_delete(@api_key, "segments/#{@segment.segment_id}.json", nil)
+      @segment.delete
+    end
+
+    should "get the details of a segment" do
+      stub_get(@api_key, "segments/#{@segment.segment_id}.json", "segment_details.json")
+      res = @segment.details
+      res.ActiveSubscribers.should == 0
+      res.Rules.size.should == 2
+      res.Rules.first.Subject.should == "EmailAddress"
+      res.Rules.first.Clauses.size.should == 1
+      res.Rules.first.Clauses.first.should == "CONTAINS @hello.com"
+      res.ListID.should == "2bea949d0bf96148c3e6a209d2e82060"
+      res.SegmentID.should == "dba84a225d5ce3d19105d7257baac46f"
+      res.Title.should == "My Segment"
+    end
+
+    should "clear a segment's rules" do
+      stub_delete(@api_key, "segments/#{@segment.segment_id}/rules.json", nil)
+      @segment.clear_rules
+    end
+
+  end
+end

data/test/subscriber_test.rb

@@ -50,6 +50,25 @@ class SubscriberTest < Test::Unit::TestCase
       import_result.DuplicateEmailsInSubmission.size.should == 0
     end
 
+    should "import many subscribers at once with partial success" do
+      # Stub request with 400 Bad Request as the expected response status
+      stub_post(@api_key, "subscribers/#{@list_id}/import.json", "import_subscribers_partial_success.json", 400)
+      subscribers = [
+        { :EmailAddress => "example+1@example", :Name => "Example One" },
+        { :EmailAddress => "example+2@example.com", :Name => "Example Two" },
+        { :EmailAddress => "example+3@example.com", :Name => "Example Three" },
+      ]
+      import_result = Subscriber.import @list_id, subscribers, true
+      import_result.FailureDetails.size.should == 1
+      import_result.FailureDetails.first.EmailAddress.should == "example+1@example"
+      import_result.FailureDetails.first.Code.should == 1
+      import_result.FailureDetails.first.Message.should == "Invalid Email Address"
+      import_result.TotalUniqueEmailsSubmitted.should == 3
+      import_result.TotalExistingSubscribers.should == 2
+      import_result.TotalNewSubscribers.should == 0
+      import_result.DuplicateEmailsInSubmission.size.should == 0
+    end
+
     should "unsubscribe a subscriber" do
       stub_post(@api_key, "subscribers/#{@subscriber.list_id}/unsubscribe.json", nil)
       @subscriber.unsubscribe

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: createsend
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - James Dennes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +11:00
+date: 2010-11-17 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,7 +111,7 @@ dependencies:
   prerelease: false
   name: httparty
   version_requirements: *id006
-description: A wrapper for the CreateSend API v3
+description: A library which implements the complete functionality of v3 of the createsend API.
 email: 
 - jdennes@gmail.com
 executables: []
@@ -123,6 +123,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - config.example.yaml
@@ -131,6 +132,7 @@ files:
 - lib/client.rb
 - lib/createsend.rb
 - lib/list.rb
+- lib/segment.rb
 - lib/subscriber.rb
 - lib/template.rb
 - test/campaign_test.rb
@@ -142,8 +144,9 @@ files:
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json
 - test/fixtures/campaign_clicks.json
-- test/fixtures/campaign_lists.json
+- test/fixtures/campaign_listsandsegments.json
 - test/fixtures/campaign_opens.json
+- test/fixtures/campaign_recipients.json
 - test/fixtures/campaign_summary.json
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
@@ -154,14 +157,18 @@ files:
 - test/fixtures/create_client.json
 - test/fixtures/create_custom_field.json
 - test/fixtures/create_list.json
+- test/fixtures/create_segment.json
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
 - test/fixtures/custom_fields.json
 - test/fixtures/drafts.json
 - test/fixtures/import_subscribers.json
+- test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
 - test/fixtures/lists.json
+- test/fixtures/segment_details.json
+- test/fixtures/segment_subscribers.json
 - test/fixtures/segments.json
 - test/fixtures/subscriber_details.json
 - test/fixtures/subscriber_history.json
@@ -173,6 +180,7 @@ files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/helper.rb
 - test/list_test.rb
+- test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
 has_rdoc: true
@@ -210,7 +218,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Wrapper for the CreateSend API v3
+summary: A library which implements the complete functionality of v3 of the createsend API.
 test_files: 
 - test/campaign_test.rb
 - test/client_test.rb
@@ -221,8 +229,9 @@ test_files:
 - test/fixtures/bounced_subscribers.json
 - test/fixtures/campaign_bounces.json
 - test/fixtures/campaign_clicks.json
-- test/fixtures/campaign_lists.json
+- test/fixtures/campaign_listsandsegments.json
 - test/fixtures/campaign_opens.json
+- test/fixtures/campaign_recipients.json
 - test/fixtures/campaign_summary.json
 - test/fixtures/campaign_unsubscribes.json
 - test/fixtures/campaigns.json
@@ -233,14 +242,18 @@ test_files:
 - test/fixtures/create_client.json
 - test/fixtures/create_custom_field.json
 - test/fixtures/create_list.json
+- test/fixtures/create_segment.json
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
 - test/fixtures/custom_fields.json
 - test/fixtures/drafts.json
 - test/fixtures/import_subscribers.json
+- test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
 - test/fixtures/lists.json
+- test/fixtures/segment_details.json
+- test/fixtures/segment_subscribers.json
 - test/fixtures/segments.json
 - test/fixtures/subscriber_details.json
 - test/fixtures/subscriber_history.json
@@ -252,5 +265,6 @@ test_files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/helper.rb
 - test/list_test.rb
+- test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb