createsend 4.1.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cf72a678bbce9cf631fe045d080307019a8a3a7
-  data.tar.gz: 8b7691c4d61ab08e46c544cd41ce994cd79ae819
+  metadata.gz: e4281f173aaf06254761ef8bde5b7da4233f18c7
+  data.tar.gz: 36e0b3673d514f1619cc2d1bb26f9721afdaa79b
 SHA512:
-  metadata.gz: 570b370adad853e0f9491e00758b7e989c4d3db98207e385d7c08bf765a29342e16e9893369527867593961b637c84f0c7f2944a560c46f8ac9bfe44e95b1b4f
-  data.tar.gz: d46d8888041d1a92ce412440821b46769a0d9cc56cda85f79fd4b2700aa11ebc1a90f4093adc04fe969349f8f521595575819e08ff6374ff8e7be0425b1d2424
+  metadata.gz: e7a4b1cfa6bcea21ebc3d6b0c27063d3053784ff3cc6fd85bc111b632fa27a18b9cbf2a133384accb7e9877ee8ce8d368150f340b8931f89ae56b2e3d6332f64
+  data.tar.gz: '0032093a7da459b0d6f58cbbc478d13b779aacacc839dbc12d4d8296ffc2feae4664541dd1a627e886f29fb6e78f19dc64a3745840acbc0591c6af7c08b7d4e5'

data/HISTORY.md

@@ -1,5 +1,11 @@
 # createsend-ruby history
 
+## v5.0.0 - 19 Jun, 2018
+* Upgrades to Createsend API v3.2 which includes new breaking changes
+* Breaking: 'Consent to track' field is now mandatory for sending smart and classic transactionl emails
+* Breaking: 'Consent to track' field is now mandatory when adding or updating subscribers
+* Optional 'Include tracking preference' field when retrieving lists of subscribers
+
 ## v4.1.2 - 27 Nov, 2017
 * Fix for the GZip compression issue: https://github.com/jnunemaker/httparty/issues/562
 

data/lib/createsend/createsend.rb

@@ -109,7 +109,7 @@ module CreateSend
       end
     end
 
-    @@base_uri = "https://api.createsend.com/api/v3.1"
+    @@base_uri = "https://api.createsend.com/api/v3.2"
     @@oauth_base_uri = "https://api.createsend.com/oauth"
     @@oauth_token_uri = "#{@@oauth_base_uri}/token"
     headers({

data/lib/createsend/list.rb

@@ -116,37 +116,37 @@ module CreateSend
 
     # Gets the active subscribers for this list.
     def active(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       paged_result_by_date("active", date, page, page_size, order_field,
-        order_direction)
+        order_direction, include_tracking_preference)
     end
 
     # Gets the unconfirmed subscribers for this list.
     def unconfirmed(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       paged_result_by_date("unconfirmed", date, page, page_size, order_field,
-        order_direction)
+        order_direction, include_tracking_preference)
     end
 
     # Gets the bounced subscribers for this list.
     def bounced(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       paged_result_by_date("bounced", date, page, page_size, order_field,
-        order_direction)
+        order_direction, include_tracking_preference)
     end
 
     # Gets the unsubscribed subscribers for this list.
     def unsubscribed(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       paged_result_by_date("unsubscribed", date, page, page_size, order_field,
-        order_direction)
+        order_direction, include_tracking_preference)
     end
 
     # Gets the deleted subscribers for this list.
     def deleted(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       paged_result_by_date("deleted", date, page, page_size, order_field,
-        order_direction)
+        order_direction, include_tracking_preference)
     end
 
     # Updates this list.
@@ -225,13 +225,14 @@ module CreateSend
     private
     
     def paged_result_by_date(resource, date, page, page_size, order_field,
-      order_direction)
+      order_direction, include_tracking_preference)
       options = { :query => {
         :date => date,
         :page => page,
         :pagesize => page_size,
         :orderfield => order_field,
-        :orderdirection => order_direction } }
+        :orderdirection => order_direction,
+        :includetrackingpreference => include_tracking_preference } }
       response = get resource, options
       Hashie::Mash.new(response)
     end

data/lib/createsend/segment.rb

@@ -35,13 +35,14 @@ module CreateSend
 
     # Gets the active subscribers in this segment.
     def subscribers(date="", page=1, page_size=1000, order_field="email",
-      order_direction="asc")
+      order_direction="asc", include_tracking_preference=false)
       options = { :query => {
         :date => date,
         :page => page,
         :pagesize => page_size,
         :orderfield => order_field,
-        :orderdirection => order_direction } }
+        :orderdirection => order_direction,
+        :includetrackingpreference => include_tracking_preference } }
       response = get "active", options
       Hashie::Mash.new(response)
     end

data/lib/createsend/subscriber.rb

@@ -11,23 +11,27 @@ module CreateSend
     end
 
     # Gets a subscriber by list ID and email address.
-    def self.get(auth, list_id, email_address)
-      options = { :query => { :email => email_address } }
+    def self.get(auth, list_id, email_address, include_tracking_preference=false)
+      options = { :query => { 
+        :email => email_address, 
+        :includetrackingpreference => include_tracking_preference } 
+      }
       cs = CreateSend.new auth
       response = cs.get "/subscribers/#{list_id}.json", options
       Hashie::Mash.new(response)
     end
 
     # Adds a subscriber to a subscriber list.
-    def self.add(auth, list_id, email_address, name, custom_fields, resubscribe,
-      restart_subscription_based_autoresponders=false)
+    def self.add(auth, list_id, email_address, name, custom_fields, resubscribe, 
+      consent_to_track, restart_subscription_based_autoresponders=false)
       options = { :body => {
         :EmailAddress => email_address,
         :Name => name,
         :CustomFields => custom_fields,
         :Resubscribe => resubscribe,
-        :RestartSubscriptionBasedAutoresponders =>
-          restart_subscription_based_autoresponders }.to_json }
+        :RestartSubscriptionBasedAutoresponders => 
+          restart_subscription_based_autoresponders,
+        :ConsentToTrack => consent_to_track }.to_json }
       cs = CreateSend.new auth
       response = cs.post "/subscribers/#{list_id}.json", options
       response.parsed_response
@@ -65,8 +69,8 @@ module CreateSend
 
     # Updates any aspect of a subscriber, including email address, name, and
     # custom field data if supplied.
-    def update(new_email_address, name, custom_fields, resubscribe,
-      restart_subscription_based_autoresponders=false)
+    def update(new_email_address, name, custom_fields, resubscribe, 
+      consent_to_track, restart_subscription_based_autoresponders=false)
       options = {
         :query => { :email => @email_address },
         :body => {
@@ -74,8 +78,9 @@ module CreateSend
           :Name => name,
           :CustomFields => custom_fields,
           :Resubscribe => resubscribe,
-          :RestartSubscriptionBasedAutoresponders =>
-            restart_subscription_based_autoresponders }.to_json }
+          :RestartSubscriptionBasedAutoresponders => 
+            restart_subscription_based_autoresponders,
+          :ConsentToTrack => consent_to_track }.to_json }
       put "/subscribers/#{@list_id}.json", options
       # Update @email_address, so this object can continue to be used reliably
       @email_address = new_email_address

data/lib/createsend/version.rb

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

data/test/fixtures/subscriber_details_with_track_pref.json

@@ -0,0 +1,22 @@
+{
+  "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"
+    }
+  ],
+  "ReadsEmailWith": "Gmail",
+  "ConsentToTrack": "Yes"
+}

data/test/fixtures/unconfirmed_subscribers.json

@@ -11,7 +11,8 @@
                     "Value": "http://example.com"
                 }
             ],
-            "ReadsEmailWith": ""
+            "ReadsEmailWith": "",
+            "ConsentToTrack": "Yes"
         },
         {
             "EmailAddress": "subs+7878787y8ggg@example.com",
@@ -24,7 +25,8 @@
                     "Value": "http://subdomain.example.com"
                 }
             ],
-            "ReadsEmailWith": ""
+            "ReadsEmailWith": "",
+            "ConsentToTrack": "No"
         }
     ],
     "ResultsOrderedBy": "email",

data/test/helper.rb

@@ -30,7 +30,7 @@ def createsend_url(auth, url)
   if not url =~ /^http/
     auth_section = ''
     auth_section = "#{auth[:api_key]}:x@" if auth and auth.has_key? :api_key
-    result = "https://#{auth_section}api.createsend.com/api/v3.1/#{url}"
+    result = "https://#{auth_section}api.createsend.com/api/v3.2/#{url}"
   else
     result = url
   end

data/test/list_test.rb

@@ -129,7 +129,7 @@ class ListTest < Test::Unit::TestCase
     
     should "get the active subscribers for a list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "lists/#{@list.list_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+      stub_get(@auth, "lists/#{@list.list_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=false",
         "active_subscribers.json")
       res = @list.active min_date
       res.ResultsOrderedBy.should == "email"
@@ -156,9 +156,9 @@ class ListTest < Test::Unit::TestCase
 
     should "get the unconfirmed subscribers for a list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "lists/#{@list.list_id}/unconfirmed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+      stub_get(@auth, "lists/#{@list.list_id}/unconfirmed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=true",
         "unconfirmed_subscribers.json")
-      res = @list.unconfirmed min_date
+      res = @list.unconfirmed(min_date, 1, 1000, "email", "asc", true)
       res.ResultsOrderedBy.should == "email"
       res.OrderDirection.should == "asc"
       res.PageNumber.should == 1
@@ -170,11 +170,12 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.EmailAddress.should == "subs+7t8787Y@example.com"
       res.Results.first.Name.should =="Unconfirmed One"
       res.Results.first.State.should == "Unconfirmed"
+      res.Results.first.ConsentToTrack.should == "Yes"
     end
 
     should "get the unsubscribed subscribers for a list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "lists/#{@list.list_id}/unsubscribed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}", 
+      stub_get(@auth, "lists/#{@list.list_id}/unsubscribed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=false", 
         "unsubscribed_subscribers.json")
       res = @list.unsubscribed min_date
       res.ResultsOrderedBy.should == "email"
@@ -195,7 +196,7 @@ class ListTest < Test::Unit::TestCase
 
     should "get the deleted subscribers for a list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "lists/#{@list.list_id}/deleted.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}", 
+      stub_get(@auth, "lists/#{@list.list_id}/deleted.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=false", 
         "deleted_subscribers.json")
       res = @list.deleted min_date
       res.ResultsOrderedBy.should == "email"
@@ -216,7 +217,7 @@ class ListTest < Test::Unit::TestCase
 
     should "get the bounced subscribers for a list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "lists/#{@list.list_id}/bounced.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+      stub_get(@auth, "lists/#{@list.list_id}/bounced.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=false",
         "bounced_subscribers.json")
       res = @list.bounced min_date
       res.ResultsOrderedBy.should == "email"

data/test/segment_test.rb

@@ -28,7 +28,7 @@ class SegmentTest < Test::Unit::TestCase
 
     should "get the active subscribers for a particular segment in the list" do
       min_date = "2010-01-01"
-      stub_get(@auth, "segments/#{@segment.segment_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}",
+      stub_get(@auth, "segments/#{@segment.segment_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{CGI.escape(min_date)}&includetrackingpreference=false",
         "segment_subscribers.json")
       res = @segment.subscribers min_date
       res.ResultsOrderedBy.should == "email"

data/test/subscriber_test.rb

@@ -9,7 +9,7 @@ class SubscriberTest < Test::Unit::TestCase
     
     should "get a subscriber by list id and email address" do
       email = "subscriber@example.com"
-      stub_get(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", "subscriber_details.json")
+      stub_get(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}&includetrackingpreference=false", "subscriber_details.json")
       subscriber = CreateSend::Subscriber.get @auth, @list_id, email
       subscriber.EmailAddress.should == email
       subscriber.Name.should == "Subscriber One"
@@ -21,16 +21,25 @@ class SubscriberTest < Test::Unit::TestCase
       subscriber.ReadsEmailWith.should == "Gmail"
     end
 
+    should "get a subscriber with track preference information" do
+      email = "subscriber@example.com"
+      stub_get(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}&includetrackingpreference=true", "subscriber_details_with_track_pref.json")
+      subscriber = CreateSend::Subscriber.get @auth, @list_id, email, true
+      subscriber.EmailAddress.should == email
+      subscriber.Name.should == "Subscriber One"
+      subscriber.ConsentToTrack == "Yes"
+    end
+
     should "add a subscriber without custom fields" do
       stub_post(@auth, "subscribers/#{@list_id}.json", "add_subscriber.json")
-      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", [], true
+      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", [], true, "Yes"
       email_address.should == "subscriber@example.com"
     end
 
     should "add a subscriber with custom fields" do
       stub_post(@auth, "subscribers/#{@list_id}.json", "add_subscriber.json")
       custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
-      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
+      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", custom_fields, true, "Yes"
       email_address.should == "subscriber@example.com"
     end
 
@@ -39,7 +48,7 @@ class SubscriberTest < Test::Unit::TestCase
       custom_fields = [ { :Key => 'multioptionselectone', :Value => 'myoption' }, 
         { :Key => 'multioptionselectmany', :Value => 'firstoption' },
         { :Key => 'multioptionselectmany', :Value => 'secondoption' } ]
-      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
+      email_address = CreateSend::Subscriber.add @auth, @list_id, "subscriber@example.com", "Subscriber", custom_fields, true, "Yes"
       email_address.should == "subscriber@example.com"
     end
 
@@ -48,7 +57,7 @@ class SubscriberTest < Test::Unit::TestCase
       new_email = "new_email_address@example.com"
       stub_put(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", nil)
       custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
-      @subscriber.update new_email, "Subscriber", custom_fields, true
+      @subscriber.update new_email, "Subscriber", custom_fields, true, "Yes"
       @subscriber.email_address.should == new_email
     end
 
@@ -57,7 +66,7 @@ class SubscriberTest < Test::Unit::TestCase
       new_email = "new_email_address@example.com"
       stub_put(@auth, "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.update new_email, "Subscriber", custom_fields, true, "No"
       @subscriber.email_address.should == new_email
     end
     
@@ -133,8 +142,8 @@ class SubscriberTest < Test::Unit::TestCase
         { :EmailAddress => "example+2@example.com", :Name => "Example Two" },
         { :EmailAddress => "example+3@example.com", :Name => "Example Three" },
       ]
-      lambda { import_result = CreateSend::Subscriber.import @auth, @list_id, subscribers, true
-        }.should raise_error(CreateSend::BadRequest)
+      lambda { import_result = CreateSend::Subscriber.import @auth, @list_id, subscribers, 
+        true }.should raise_error(CreateSend::BadRequest)
     end
 
     should "unsubscribe a subscriber" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 5.0.0
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -245,6 +245,7 @@ files:
 - test/fixtures/segment_subscribers.json
 - test/fixtures/segments.json
 - test/fixtures/subscriber_details.json
+- test/fixtures/subscriber_details_with_track_pref.json
 - test/fixtures/subscriber_history.json
 - test/fixtures/suppressionlist.json
 - test/fixtures/systemdate.json
@@ -297,9 +298,104 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A library which implements the complete functionality of the Campaign Monitor
   API.
-test_files: []
+test_files:
+- test/administrator_test.rb
+- test/campaign_test.rb
+- test/client_test.rb
+- test/createsend_test.rb
+- test/fixtures/active_subscribers.json
+- test/fixtures/add_admin.json
+- test/fixtures/add_person.json
+- test/fixtures/add_subscriber.json
+- test/fixtures/admin_details.json
+- test/fixtures/admin_get_primary_contact.json
+- test/fixtures/admin_set_primary_contact.json
+- test/fixtures/administrators.json
+- test/fixtures/billingdetails.json
+- test/fixtures/bounced_subscribers.json
+- test/fixtures/campaign_bounces.json
+- test/fixtures/campaign_clicks.json
+- 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
+- test/fixtures/client_details.json
+- test/fixtures/client_get_primary_contact.json
+- test/fixtures/client_set_primary_contact.json
+- test/fixtures/clients.json
+- test/fixtures/countries.json
+- test/fixtures/create_campaign.json
+- test/fixtures/create_client.json
+- test/fixtures/create_custom_field.json
+- test/fixtures/create_list.json
+- test/fixtures/create_list_webhook.json
+- test/fixtures/create_segment.json
+- 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/email_client_usage.json
+- test/fixtures/expired_oauth_token_api_error.json
+- test/fixtures/external_session.json
+- test/fixtures/import_subscribers.json
+- test/fixtures/import_subscribers_partial_success.json
+- test/fixtures/invalid_oauth_token_api_error.json
+- test/fixtures/list_details.json
+- test/fixtures/list_stats.json
+- test/fixtures/list_webhooks.json
+- test/fixtures/lists.json
+- test/fixtures/listsforemail.json
+- test/fixtures/oauth_exchange_token.json
+- test/fixtures/oauth_exchange_token_error.json
+- test/fixtures/oauth_refresh_token_error.json
+- test/fixtures/people.json
+- test/fixtures/person_details.json
+- test/fixtures/refresh_oauth_token.json
+- test/fixtures/revoked_oauth_token_api_error.json
+- test/fixtures/scheduled_campaigns.json
+- test/fixtures/segment_details.json
+- test/fixtures/segment_subscribers.json
+- test/fixtures/segments.json
+- test/fixtures/subscriber_details.json
+- test/fixtures/subscriber_details_with_track_pref.json
+- test/fixtures/subscriber_history.json
+- test/fixtures/suppressionlist.json
+- test/fixtures/systemdate.json
+- test/fixtures/template_details.json
+- test/fixtures/templates.json
+- test/fixtures/timezones.json
+- test/fixtures/transfer_credits.json
+- test/fixtures/tx_classicemail_groups.json
+- test/fixtures/tx_message_details.json
+- test/fixtures/tx_message_details_with_statistics.json
+- test/fixtures/tx_messages.json
+- test/fixtures/tx_messages_classic.json
+- test/fixtures/tx_messages_smart.json
+- test/fixtures/tx_resend_message.json
+- test/fixtures/tx_send_multiple.json
+- test/fixtures/tx_send_single.json
+- test/fixtures/tx_smartemail_details.json
+- test/fixtures/tx_smartemails.json
+- test/fixtures/tx_statistics_classic.json
+- test/fixtures/tx_statistics_smart.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
+- test/segment_test.rb
+- test/subscriber_test.rb
+- test/template_test.rb
+- test/transactional_classic_email_test.rb
+- test/transactional_smart_email_test.rb
+- test/transactional_timeline_test.rb