createsend 4.1.1 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cf7d3f1ef06c9845b206a5a5440abe87f9982c7f
-  data.tar.gz: 39e71bc8e300c0a240065664d70b9342edaafb0b
+SHA256:
+  metadata.gz: a9e3ed5e50f1be54bdb680b399675fef8e72fc1e09d41264ec35d85de005b0ea
+  data.tar.gz: 1b39dc69dcb31589101712316897771aa15ba48c8ddd5c6bd6255c2352337db3
 SHA512:
-  metadata.gz: 9bade68e29f34aed204378b7e9dae1873ec754d083f71424535113d34fdbf4c70bede35555b576e0916b62c77df53fcb9f1c1884b83e616a537625b0b1a5a355
-  data.tar.gz: 6dd857001b8afd09e28d9659e1c807fb4b17ca2a12471b3563f3204fbd595246898f7f00f8b5b9b5203d0bf58dc1f4846b226cda0300f9010a66d2b1f0eed9a7
+  metadata.gz: c9d44f747b5d4e64692686c47a0ca56f13d55fe97a0674cfc20659e05b8a518df3ac45f33ab8b575945b1ac9dd69fa503c0884cfb74abdbc3c0f306a0642f7a7
+  data.tar.gz: 68987336af46b08f9693bf65a1a6fc29af99ee81a044b1468b7a410084191a2e6973595ba1db86406be7c0c7cdace14a968e46e1f83754950bf3ef3a4c5e76a2

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.4.0
+  - 2.3
   - 2.2
   - 2.1
   - 2.0.0

data/HISTORY.md

@@ -1,5 +1,20 @@
 # createsend-ruby history
 
+## v5.1.1 - 8 Oct, 2021
+* increased default timeout for HTTP requests to 120secs
+
+## v5.1.0 - 3 Sep, 2019
+* Added support for [Journeys API](https://www.campaignmonitor.com/api/journeys/)
+
+## 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
+
 ## v4.1.1 - 14 Jan, 2016
 
 * Drop support for Ruby 1.9.3 ([#49](https://github.com/campaignmonitor/createsend-ruby/pull/49))

data/README.md

@@ -1,4 +1,4 @@
-# createsend
+# createsend [![Build Status](https://app.travis-ci.com/campaignmonitor/createsend-ruby.svg?branch=master)](https://app.travis-ci.com/campaignmonitor/createsend-ruby)
 
 A Ruby library which implements the complete functionality of the [Campaign Monitor API](http://www.campaignmonitor.com/api/). Requires Ruby >= 2.0.0.
 
@@ -193,7 +193,7 @@ For example, if you wanted to find out how to call the `CreateSend::Subscriber.a
 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
 ```
@@ -212,7 +212,7 @@ Please check the [instructions for releasing](https://github.com/campaignmonitor
 
 ## This stuff should be green
 
-[![Build Status](https://secure.travis-ci.org/campaignmonitor/createsend-ruby.png)][travis] [![Coverage Status](https://coveralls.io/repos/campaignmonitor/createsend-ruby/badge.png?branch=master)][coveralls] [![Dependency Status](https://gemnasium.com/campaignmonitor/createsend-ruby.png)][gemnasium] [![Gem Version](https://badge.fury.io/rb/createsend.png)][gembadge]
+[![Build Status](https://app.travis-ci.com/campaignmonitor/createsend-ruby.svg?branch=master)](https://app.travis-ci.com/campaignmonitor/createsend-ruby) [![Coverage Status](https://coveralls.io/repos/campaignmonitor/createsend-ruby/badge.png?branch=master)][coveralls] [![Dependency Status](https://gemnasium.com/campaignmonitor/createsend-ruby.png)][gemnasium] [![Gem Version](https://badge.fury.io/rb/createsend.png)][gembadge]
 
 [travis]: http://travis-ci.org/campaignmonitor/createsend-ruby
 [coveralls]: https://coveralls.io/r/campaignmonitor/createsend-ruby

data/RELEASE.md

@@ -32,7 +32,7 @@
   git push origin master --tags
   ```
 
-- Ensure that all [tests](https://travis-ci.org/campaignmonitor/createsend-ruby) pass, and that [coverage](https://coveralls.io/r/campaignmonitor/createsend-ruby) is maintained or improved.
+- Ensure that all [tests](https://app.travis-ci.com/github/campaignmonitor/createsend-ruby) pass, and that [coverage](https://coveralls.io/r/campaignmonitor/createsend-ruby) is maintained or improved.
 
 - Add a new [GitHub Release](https://github.com/campaignmonitor/createsend-ruby/releases) using the newly created tag.
 

data/Rakefile

@@ -5,7 +5,7 @@ require "./lib/createsend"
 
 desc "Run tests"
 Rake::TestTask.new(:test) do |test|
-  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.ruby_opts = ["-rrubygems"] if defined? Gem
   test.libs << "lib" << "test"
   test.pattern = "test/**/*_test.rb"
   puts "running tests."

data/lib/createsend/campaign.rb

@@ -1,5 +1,5 @@
 module CreateSend
-  # Represents a campaign and provides associated funtionality.
+  # Represents a campaign and provides associated functionality.
   class Campaign < CreateSend
     attr_reader :campaign_id
 

data/lib/createsend/client.rb

@@ -181,6 +181,12 @@ module CreateSend
       super "/clients/#{client_id}.json", {}
     end
 
+    # Gets the journeys belonging to this client.
+    def journeys
+      response = get 'journeys'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
     private
 
     def get(action, options = {})

data/lib/createsend/createsend.rb

@@ -44,6 +44,8 @@ module CreateSend
   # Provides high level CreateSend functionality/data you'll probably need.
   class CreateSend
     include HTTParty
+    default_timeout 120
+
     attr_reader :auth_details
 
     # Specify cert authority file for cert validation
@@ -109,13 +111,13 @@ 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({
       'User-Agent' => USER_AGENT_STRING,
-      'Content-Type' => 'application/json; charset=utf-8',
-      'Accept-Encoding' => 'gzip, deflate' })
+      'Content-Type' => 'application/json; charset=utf-8'
+    })
     base_uri @@base_uri
 
     # Authenticate using either OAuth or an API key.

data/lib/createsend/journey.rb

@@ -0,0 +1,58 @@
+module CreateSend
+  # Represents a journey and provides associated functionality
+  class Journey < CreateSend
+    attr_reader :journey_id
+
+    def initialize(auth, journey_id)
+      @journey_id = journey_id
+      super
+    end
+
+    # Get a full summary of a journey
+    def summary
+      response = get "/journeys/#{@journey_id}.json"
+      Hashie::Mash.new(response)
+    end
+
+    # Gets a list of all recipients of a particular email within a journey
+    def email_recipients(email_id="", date="", page=1, page_size=1000, order_direction='asc')
+      paged_result_by_date("recipients", email_id, date, page, page_size, order_direction)
+    end
+
+    # Gets a paged list of subscribers who opened a given journey email
+    def email_opens(email_id="", date="", page=1, page_size=1000, order_direction='asc')
+      paged_result_by_date("opens", email_id, date, page, page_size, order_direction)
+    end
+
+    # Gets a paged list of subscribers who clicked a given journey email
+    def email_clicks(email_id="", date="", page=1, page_size=1000, order_direction='asc')
+      paged_result_by_date("clicks", email_id, date, page, page_size, order_direction)
+    end
+
+    # Gets a paged result representing all subscribers who unsubscribed from a journey email
+    def email_unsubscribes(email_id="", date="", page=1, page_size=1000, order_direction='asc')
+      paged_result_by_date("unsubscribes", email_id, date, page, page_size, order_direction)
+    end
+
+    # Gets a paged result of all bounces for a journey email
+    def email_bounces(email_id="", date="", page=1, page_size=1000, order_direction='asc')
+      paged_result_by_date("bounces", email_id, date, page, page_size, order_direction)
+    end
+
+    private
+
+    def paged_result_by_date(resource, email_id, date, page, page_size, order_direction)
+      options = { :query => {
+          :date => date,
+          :page => page,
+          :pagesize => page_size,
+          :orderdirection => order_direction } }
+      response = get_journey_email_action email_id, resource, options
+      Hashie::Mash.new(response)
+    end
+
+    def get_journey_email_action(email_id, action, options = {})
+      get "/journeys/email/#{email_id}/#{action}.json", options
+    end
+  end
+end

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.1" unless defined?(CreateSend::VERSION)
+  VERSION = "5.1.1" unless defined?(CreateSend::VERSION)
 end

data/lib/createsend.rb

@@ -14,3 +14,4 @@ require 'createsend/administrator'
 require 'createsend/transactional_classic_email'
 require 'createsend/transactional_smart_email'
 require 'createsend/transactional_timeline'
+require 'createsend/journey'

data/samples/journey_sample.rb

@@ -0,0 +1,86 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class JourneySample
+  @date = "2019-01-01 00:00"
+
+  def initialize
+    raise 'CREATESEND_API_KEY env var missing' if ENV['CREATESEND_API_KEY'].nil?
+    raise 'CREATESEND_CLIENT_ID env var missing' if ENV['CREATESEND_CLIENT_ID'].nil?
+    raise 'CREATESEND_JOURNEY_ID env var missing' if ENV['CREATESEND_JOURNEY_ID'].nil?
+    raise 'CREATESEND_EMAIL_ID env var missing' if ENV['CREATESEND_EMAIL_ID'].nil?
+
+    auth = {:api_key => ENV['CREATESEND_API_KEY']}
+    @client = CreateSend::Client.new auth, ENV['CREATESEND_CLIENT_ID']
+    @journey = CreateSend::Journey.new auth, ENV['CREATESEND_JOURNEY_ID']
+  end
+
+  def get_all_journeys
+    @client.journeys
+  end
+
+  def get_journey_summary
+    @journey.summary
+  end
+
+  def get_recipients_for_email
+    @journey.email_recipients ENV['CREATESEND_EMAIL_ID']
+  end
+
+  def get_email_opens
+    opens = []
+    loop do
+      page = @journey.email_opens email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      opens.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    opens
+  end
+
+  def get_email_clicks
+    clicks = []
+    loop do
+      page = @journey.email_clicks email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      clicks.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    clicks
+  end
+
+  def get_email_unsubscribes
+    unsubscribes = []
+    loop do
+      page = @journey.email_unsubscribes email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'desc'
+      unsubscribes.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    unsubscribes
+  end
+
+  def get_email_bounces
+    bounces = []
+    loop do
+      page = @journey.email_bounces email_id = ENV['CREATESEND_EMAIL_ID'], date = @date, order_direction = 'asc'
+      bounces.concat(page.Results)
+      if page.PageNumber == page.NumberOfPages
+        break
+      end
+    end
+    bounces
+  end
+end
+
+sample = JourneySample.new
+puts "All journeys: #{sample.get_all_journeys.to_json}\n\n"
+puts "Journey Summary: #{sample.get_journey_summary.to_json}\n\n"
+puts "Email recipients : #{sample.get_recipients_for_email.to_json}\n\n"
+puts "Email Opens : #{sample.get_email_opens.to_json}\n\n"
+puts "Email Clicks : #{sample.get_email_clicks.to_json}\n\n"
+puts "Email Unsubscribes : #{sample.get_email_unsubscribes.to_json}\n\n"
+puts "Email Bounces : #{sample.get_email_bounces.to_json}\n\n"

data/test/administrator_test.rb

@@ -8,7 +8,7 @@ class AdministratorTest < Test::Unit::TestCase
 
     should "get a administrator by email address" do
       email = "admin@example.com"
-      stub_get(@auth, "admins.json?email=#{CGI.escape(email)}", "admin_details.json")
+      stub_get(@auth, "admins.json?email=#{ERB::Util.url_encode(email)}", "admin_details.json")
       admin = CreateSend::Administrator.get @auth, email
       admin.EmailAddress.should == email
       admin.Name.should == "Admin One"
@@ -24,13 +24,13 @@ class AdministratorTest < Test::Unit::TestCase
     should "update an administrator" do
       email = "admin@example.com"
       new_email = "new_email_address@example.com"
-      stub_put(@auth, "admins.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "admins.json?email=#{ERB::Util.url_encode(email)}", nil)
       @admin.update new_email, "Admin Name"
       @admin.email_address.should == new_email
     end
 
     should "delete an admin" do
-      stub_delete(@auth, "admins.json?email=#{CGI.escape(@admin.email_address)}", nil)
+      stub_delete(@auth, "admins.json?email=#{ERB::Util.url_encode(@admin.email_address)}", nil)
       @admin.delete
     end
   end

data/test/campaign_test.rb

@@ -191,7 +191,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the opens for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/opens.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_opens.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/opens.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}", "campaign_opens.json")
       opens = @campaign.opens min_date
       opens.Results.size.should == 5
       opens.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -215,7 +215,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the subscriber clicks for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/clicks.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_clicks.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/clicks.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}", "campaign_clicks.json")
       clicks = @campaign.clicks min_date
       clicks.Results.size.should == 3
       clicks.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -240,7 +240,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the unsubscribes for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/unsubscribes.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_unsubscribes.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/unsubscribes.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}", "campaign_unsubscribes.json")
       unsubscribes = @campaign.unsubscribes min_date
       unsubscribes.Results.size.should == 1
       unsubscribes.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -258,7 +258,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the spam complaints for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/spam.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_spam.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/spam.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}", "campaign_spam.json")
       spam = @campaign.spam min_date
       spam.Results.size.should == 1
       spam.Results.first.EmailAddress.should == "subs+6576576576@example.com"
@@ -275,7 +275,7 @@ class CampaignTest < Test::Unit::TestCase
 
     should "get the bounces for a campaign" do
       min_date = "2010-01-01"
-      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/bounces.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{CGI.escape(min_date)}", "campaign_bounces.json")
+      stub_get(@auth, "campaigns/#{@campaign.campaign_id}/bounces.json?page=1&pagesize=1000&orderfield=date&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}", "campaign_bounces.json")
       bounces = @campaign.bounces min_date
       bounces.Results.size.should == 2
       bounces.Results.first.EmailAddress.should == "asdf@softbouncemyemail.com"

data/test/client_test.rb

@@ -10,7 +10,7 @@ class ClientTest < Test::Unit::TestCase
     should "create a client" do
       stub_post(@auth, "clients.json", "create_client.json")
       client_id = CreateSend::Client.create @auth, "Client Company Name", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
-      client_id.should == "32a381c49a2df99f1d0c6f3c112352b9"
+      client_id.parsed_response.should == "32a381c49a2df99f1d0c6f3c112352b9"
     end
 
     should "get details of a client" do
@@ -83,7 +83,7 @@ class ClientTest < Test::Unit::TestCase
 
     should "get all lists to which a subscriber with a particular email address belongs" do
       email = "valid@example.com"
-      stub_get(@auth, "clients/#{@client.client_id}/listsforemail.json?email=#{CGI.escape(email)}", "listsforemail.json")
+      stub_get(@auth, "clients/#{@client.client_id}/listsforemail.json?email=#{ERB::Util.url_encode(email)}", "listsforemail.json")
       lists = @client.lists_for_email(email)
       lists.size.should == 2
       lists.first.ListID.should == 'ab4a2b57c7c8f1ba62f898a1af1a575b'
@@ -131,7 +131,7 @@ class ClientTest < Test::Unit::TestCase
 
     should "unsuppress an email address" do
       email = "example@example.com"
-      stub_put(@auth, "clients/#{@client.client_id}/unsuppress.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "clients/#{@client.client_id}/unsuppress.json?email=#{ERB::Util.url_encode(email)}", nil)
       result = @client.unsuppress email
     end
 
@@ -155,7 +155,7 @@ class ClientTest < Test::Unit::TestCase
 
     should "set primary contact" do
       email = 'person@blackhole.com'
-      stub_put(@auth, "clients/#{@client.client_id}/primarycontact.json?email=#{CGI.escape(email)}", 'client_set_primary_contact.json')
+      stub_put(@auth, "clients/#{@client.client_id}/primarycontact.json?email=#{ERB::Util.url_encode(email)}", 'client_set_primary_contact.json')
       result = @client.set_primary_contact email
       result.EmailAddress.should == email
     end
@@ -217,6 +217,14 @@ class ClientTest < Test::Unit::TestCase
       stub_delete(@auth, "clients/#{@client.client_id}.json", nil)
       @client.delete
     end
-    
+
+    should "get all journeys" do
+      stub_get(@auth, "clients/#{@client.client_id}/journeys.json", "journeys.json")
+      lists = @client.journeys
+      lists.size.should == 3
+      lists.first.ListID.should == 'a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a'
+      lists.first.Name.should == 'Journey One'
+      lists.first.Status.should == 'Not started'
+    end
   end
 end

data/test/createsend_test.rb

@@ -82,7 +82,7 @@ class CreateSendTest < Test::Unit::TestCase
       FakeWeb.register_uri(:post, "https://api.createsend.com/oauth/token", options)
       new_access_token, new_expires_in, new_refresh_token = CreateSend::CreateSend.refresh_access_token refresh_token
 
-      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{CGI.escape(refresh_token)}"
+      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{ERB::Util.url_encode(refresh_token)}"
       new_access_token.should == "SlAV32hkKG2e12e"
       new_expires_in.should == 1209600
       new_refresh_token.should == "tGzv3JOkF0XG5Qx2TlKWIA"
@@ -97,7 +97,7 @@ class CreateSendTest < Test::Unit::TestCase
       lambda { access_token, expires_in, refresh_token = CreateSend::CreateSend.refresh_access_token(
         refresh_token) }.should raise_error(
           Exception, 'Error refreshing access token: invalid_grant - Specified refresh_token was invalid or expired')
-      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{CGI.escape(refresh_token)}"
+      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{ERB::Util.url_encode(refresh_token)}"
     end
 
   end
@@ -120,7 +120,7 @@ class CreateSendTest < Test::Unit::TestCase
       cs = CreateSend::CreateSend.new @auth
       new_access_token, new_expires_in, new_refresh_token = cs.refresh_token
 
-      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{CGI.escape(@auth[:refresh_token])}"
+      FakeWeb.last_request.body.should == "grant_type=refresh_token&refresh_token=#{ERB::Util.url_encode(@auth[:refresh_token])}"
       new_access_token.should == "SlAV32hkKG2e12e"
       new_expires_in.should == 1209600
       new_refresh_token.should == "tGzv3JOkF0XG5Qx2TlKWIA"
@@ -246,7 +246,7 @@ class CreateSendTest < Test::Unit::TestCase
 
     should "set primary contact" do
       email = 'admin@blackhole.com'
-      stub_put(@auth, "primarycontact.json?email=#{CGI.escape(email)}", 'admin_set_primary_contact.json')
+      stub_put(@auth, "primarycontact.json?email=#{ERB::Util.url_encode(email)}", 'admin_set_primary_contact.json')
       result = @cs.set_primary_contact email
       result.EmailAddress.should == email
     end

data/test/fixtures/journey_bounces.json

@@ -0,0 +1,35 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "BounceType": "4",
+      "Date": "2019-07-29 10:33:00",
+      "Reason": "Soft Bounce - Mailbox Full"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "BounceType": "1",
+      "Date": "2019-07-29 10:35:00",
+      "Reason": "Hard Bounce"
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "BounceType": "1",
+      "Date": "2019-07-29 10:35:00",
+      "Reason": "Hard Bounce"
+    },
+    {
+      "EmailAddress": "example+4@example.com",
+      "BounceType": "1",
+      "Date": "2019-07-29 10:35:00",
+      "Reason": "Hard Bounce"
+    }
+  ],
+  "ResultsOrderedBy": "Date",
+  "OrderDirection": "ASC",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 4,
+  "TotalNumberOfRecords": 4,
+  "NumberOfPages": 1
+}