createsend 1.0.1 → 1.0.2

data/README.md

@@ -4,7 +4,7 @@ A ruby library which implements the complete functionality of v3 of the CreateSe
 
 ## Installation
 
-    sudo gem install createsend
+    gem install createsend
 
 ## Examples
 

data/lib/createsend/campaign.rb

@@ -43,6 +43,12 @@ module CreateSend
       response = post "send", options
     end
 
+    # Unschedules this campaign if it is currently scheduled.
+    def unschedule
+      options = { :body => "" }
+      response = post "unschedule", options
+    end
+
     # Deletes this campaign.
     def delete
       response = CreateSend.delete "/campaigns/#{campaign_id}.json", {}

data/lib/createsend/list.rb

@@ -111,6 +111,18 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Gets the deleted subscribers for this list.
+    def deleted(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 "deleted", options
+      Hashie::Mash.new(response)
+    end
+
     # Updates this list.
     def update(title, unsubscribe_page, confirmed_opt_in, confirmation_success_page)
       options = { :body => {

data/lib/createsend/subscriber.rb

@@ -31,10 +31,11 @@ module CreateSend
     end
 
     # Imports subscribers into a subscriber list.
-    def self.import(list_id, subscribers, resubscribe)
+    def self.import(list_id, subscribers, resubscribe, queue_subscription_based_autoresponders=false)
       options = { :body => {
         :Subscribers => subscribers,
-        :Resubscribe => resubscribe }.to_json }
+        :Resubscribe => resubscribe,
+        :QueueSubscriptionBasedAutoresponders => queue_subscription_based_autoresponders }.to_json }
       begin
         response = CreateSend.post "/subscribers/#{list_id}/import.json", options
       rescue BadRequest => br
@@ -80,5 +81,10 @@ module CreateSend
       response.map{|item| Hashie::Mash.new(item)}
     end
 
+    # Moves this subscriber to the Deleted state in the associated list.
+    def delete
+      options = { :query => { :email => @email_address } }
+      CreateSend.delete "/subscribers/#{@list_id}.json", options
+    end
   end
 end

data/lib/createsend/version.rb

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

data/test/campaign_test.rb

@@ -26,6 +26,11 @@ class CampaignTest < Test::Unit::TestCase
       stub_post(@api_key, "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)
+      @campaign.unschedule
+    end
     
     should "delete a campaign" do
       stub_delete(@api_key, "campaigns/#{@campaign.campaign_id}.json", nil)
@@ -41,6 +46,9 @@ class CampaignTest < Test::Unit::TestCase
       summary.Unsubscribed.should == 0
       summary.Bounced.should == 0
       summary.UniqueOpened.should == 5
+      summary.Mentions.should == 23
+      summary.Forwards.should == 11
+      summary.Likes.should == 32
       summary.WebVersionURL.should == "http://createsend.com/t/r-3A433FC72FFE3B8B"
     end
     

data/test/fixtures/campaign_summary.json

@@ -5,5 +5,8 @@
   "Unsubscribed": 0,
   "Bounced": 0,
   "UniqueOpened": 5,
+  "Mentions": 23,
+  "Forwards": 11,
+  "Likes": 32,
   "WebVersionURL": "http://createsend.com/t/r-3A433FC72FFE3B8B"
 }

data/test/fixtures/deleted_subscribers.json

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

data/test/list_test.rb

@@ -123,6 +123,26 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.CustomFields.size.should == 0
     end
 
+    should "get the deleted subscribers for a list" do
+      min_date = "2010-01-01"
+      stub_get(@api_key, "lists/#{@list.list_id}/deleted.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}", 
+        "deleted_subscribers.json")
+      res = @list.deleted 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 == "Deleted One"
+      res.Results.first.Date.should == "2010-10-25 13:11:00"
+      res.Results.first.State.should == "Deleted"
+      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?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
@@ -184,6 +204,5 @@ class ListTest < Test::Unit::TestCase
       stub_put(@api_key, "lists/#{@list.list_id}/webhooks/#{webhook_id}/deactivate.json", nil)
       @list.deactivate_webhook webhook_id
     end
-
   end
 end

data/test/subscriber_test.rb

@@ -52,6 +52,15 @@ class SubscriberTest < Test::Unit::TestCase
       @subscriber.update new_email, "Subscriber", custom_fields, true
       @subscriber.email_address.should == new_email
     end
+
+    should "update a subscriber with custom fields including the clear option" do
+      email = "subscriber@example.com"
+      new_email = "new_email_address@example.com"
+      stub_put(@api_key, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", nil)
+      custom_fields = [ { :Key => 'website', :Value => '', :Clear => true } ]
+      @subscriber.update new_email, "Subscriber", custom_fields, true
+      @subscriber.email_address.should == new_email
+    end
     
     should "import many subscribers at once" do
       stub_post(@api_key, "subscribers/#{@list_id}/import.json", "import_subscribers.json")
@@ -68,6 +77,36 @@ class SubscriberTest < Test::Unit::TestCase
       import_result.DuplicateEmailsInSubmission.size.should == 0
     end
 
+    should "import many subscribers at once, and start subscription-based autoresponders" do
+      stub_post(@api_key, "subscribers/#{@list_id}/import.json", "import_subscribers.json")
+      subscribers = [
+        { :EmailAddress => "example+1@example.com", :Name => "Example One" },
+        { :EmailAddress => "example+2@example.com", :Name => "Example Two" },
+        { :EmailAddress => "example+3@example.com", :Name => "Example Three" },
+      ]
+      import_result = CreateSend::Subscriber.import @list_id, subscribers, true, true
+      import_result.FailureDetails.size.should == 0
+      import_result.TotalUniqueEmailsSubmitted.should == 3
+      import_result.TotalExistingSubscribers.should == 0
+      import_result.TotalNewSubscribers.should == 3
+      import_result.DuplicateEmailsInSubmission.size.should == 0
+    end
+
+    should "import many subscribers at once with custom fields, including the clear option" do
+      stub_post(@api_key, "subscribers/#{@list_id}/import.json", "import_subscribers.json")
+      subscribers = [
+        { :EmailAddress => "example+1@example.com", :Name => "Example One", :CustomFields => [ { :Key => 'website', :Value => '', :Clear => true } ] },
+        { :EmailAddress => "example+2@example.com", :Name => "Example Two", :CustomFields => [ { :Key => 'website', :Value => '', :Clear => false } ]  },
+        { :EmailAddress => "example+3@example.com", :Name => "Example Three", :CustomFields => [ { :Key => 'website', :Value => '', :Clear => false } ]  },
+      ]
+      import_result = CreateSend::Subscriber.import @list_id, subscribers, true
+      import_result.FailureDetails.size.should == 0
+      import_result.TotalUniqueEmailsSubmitted.should == 3
+      import_result.TotalExistingSubscribers.should == 0
+      import_result.TotalNewSubscribers.should == 3
+      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)
@@ -106,5 +145,9 @@ class SubscriberTest < Test::Unit::TestCase
       history.first.Actions.first.Detail.should == ""
     end
 
+    should "delete a subscriber" do
+      stub_delete(@api_key, "subscribers/#{@subscriber.list_id}.json?email=#{CGI.escape(@subscriber.email_address)}", nil)
+      @subscriber.delete
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: createsend
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - James Dennes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-25 00:00:00 +11:00
+date: 2011-10-31 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,6 +174,7 @@ files:
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
 - test/fixtures/custom_fields.json
+- test/fixtures/deleted_subscribers.json
 - test/fixtures/drafts.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
@@ -262,6 +263,7 @@ test_files:
 - test/fixtures/create_template.json
 - test/fixtures/custom_api_error.json
 - test/fixtures/custom_fields.json
+- test/fixtures/deleted_subscribers.json
 - test/fixtures/drafts.json
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json