createsend 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4281f173aaf06254761ef8bde5b7da4233f18c7
-  data.tar.gz: 36e0b3673d514f1619cc2d1bb26f9721afdaa79b
+  metadata.gz: 0cbf47984eff0211b8d39e59f1e081fddffc6394
+  data.tar.gz: eea780fdf7c2ea60a2302937e4e08582a72a6c9c
 SHA512:
-  metadata.gz: e7a4b1cfa6bcea21ebc3d6b0c27063d3053784ff3cc6fd85bc111b632fa27a18b9cbf2a133384accb7e9877ee8ce8d368150f340b8931f89ae56b2e3d6332f64
-  data.tar.gz: '0032093a7da459b0d6f58cbbc478d13b779aacacc839dbc12d4d8296ffc2feae4664541dd1a627e886f29fb6e78f19dc64a3745840acbc0591c6af7c08b7d4e5'
+  metadata.gz: 78336e5550ffec584bb92e2c89796df4ef086be3a977e1d0257c04c5c26642293f03ba0c6f3218e50205f52dc2be3b533b29941841f5f29172bc31ed4471f4bb
+  data.tar.gz: 3337d01b81ad49e92d4d0f3fa0a1f446bbe3dbedb8bba4abb774eceb9d4aca60e2a0ff2eeba3af1070cdabe5eeb304e342f8d24ca63952167962052a0641f98e

data/HISTORY.md

@@ -1,5 +1,8 @@
 # createsend-ruby history
 
+## 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

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/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/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/version.rb

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

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

@@ -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
+}

data/test/fixtures/journey_clicks.json

@@ -0,0 +1,35 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "Date": "2019-07-29 10:33:00",
+      "URL": "http://test.com",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "URL": "http://test.com",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    }
+  ],
+  "ResultsOrderedBy": "Date",
+  "OrderDirection": "ASC",
+  "PageNumber": 1,
+  "PageSize": 2,
+  "RecordsOnThisPage": 2,
+  "TotalNumberOfRecords": 5,
+  "NumberOfPages": 3
+}

data/test/fixtures/journey_opens.json

@@ -0,0 +1,55 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "Date": "2019-07-29 10:33:00",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    },
+    {
+      "EmailAddress": "example+4@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "IPAddress": "192.168.0.3",
+      "Latitude": -33.8683,
+      "Longitude": 151.2086,
+      "City": "Sydney",
+      "Region": "New South Wales",
+      "CountryCode": "AU",
+      "CountryName": "Australia"
+    }
+  ],
+  "ResultsOrderedBy": "Date",
+  "OrderDirection": "ASC",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 4,
+  "TotalNumberOfRecords": 4,
+  "NumberOfPages": 1
+}

data/test/fixtures/journey_recipients.json

@@ -0,0 +1,27 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "SentDate": "2019-07-12 09:45:00"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "SentDate": "2019-07-12 10:45:00"
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "SentDate": "2019-07-13 09:00:00"
+    },
+    {
+      "EmailAddress": "example+4@example.com",
+      "SentDate": "2019-07-16 11:45:00"
+    }
+  ],
+  "ResultsOrderedBy": "SentDate",
+  "OrderDirection": "ASC",
+  "PageNumber": 2,
+  "PageSize": 10,
+  "RecordsOnThisPage": 4,
+  "TotalNumberOfRecords": 14,
+  "NumberOfPages": 2
+}

data/test/fixtures/journey_summary.json

@@ -0,0 +1,18 @@
+{
+  "JourneyID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1",
+  "Name": "New journey",
+  "TriggerType": "On Subscription",
+  "Status": "Active",
+  "Emails": [
+    {
+      "EmailID": "b1b1b1b1b1b1b1b1b1b1",
+      "Name": "New Email",
+      "Bounced": 0,
+      "Clicked": 0,
+      "Opened": 3,
+      "Sent": 1,
+      "UniqueOpened": 1,
+      "Unsubscribed": 0
+    }
+  ]
+}

data/test/fixtures/journey_unsubscribes.json

@@ -0,0 +1,26 @@
+{
+  "Results": [
+    {
+      "EmailAddress": "example+1@example.com",
+      "Date": "2019-07-29 10:33:00",
+      "IPAddress": "192.168.0.3"
+    },
+    {
+      "EmailAddress": "example+2@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "IPAddress": "192.168.0.3"
+    },
+    {
+      "EmailAddress": "example+3@example.com",
+      "Date": "2019-07-29 10:35:00",
+      "IPAddress": "192.168.0.3"
+    }
+  ],
+  "ResultsOrderedBy": "Date",
+  "OrderDirection": "ASC",
+  "PageNumber": 1,
+  "PageSize": 1000,
+  "RecordsOnThisPage": 4,
+  "TotalNumberOfRecords": 4,
+  "NumberOfPages": 1
+}

data/test/fixtures/journeys.json

@@ -0,0 +1,20 @@
+[
+  {
+    "ListID": "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a",
+    "JourneyID": "b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b2b",
+    "Name": "Journey One",
+    "Status": "Not started"
+  },
+  {
+    "ListID": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c",
+    "JourneyID": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d",
+    "Name": "Journey Two",
+    "Status": "Active"
+  },
+  {
+    "ListID": "c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c1c",
+    "JourneyID": "e2e2e2e2e2e2e2e2e2e2e2e2e2e2e2e2e2e",
+    "Name": "Journey Three",
+    "Status": "Paused"
+  }
+]

data/test/helper.rb

@@ -42,7 +42,8 @@ def stub_request(method, auth, url, filename, status=nil)
   options.merge!({:body => fixture_file(filename)}) if filename
   options.merge!({:status => status}) if status
   options.merge!(:content_type => "application/json; charset=utf-8")
-  FakeWeb.register_uri(method, createsend_url(auth, url), options)
+  createsend_url = createsend_url(auth, url)
+  FakeWeb.register_uri(method, createsend_url, options)
 end
 
 def stub_get(*args); stub_request(:get, *args) end

data/test/journey_test.rb

@@ -0,0 +1,156 @@
+require File.dirname(__FILE__) + '/helper'
+
+class JourneyTest < Test::Unit::TestCase
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+    setup do
+      @journey = CreateSend::Journey.new @auth, 'a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1'
+    end
+
+    should "get the summary for a journey" do
+      stub_get(@auth, "journeys/#{@journey.journey_id}.json", "journey_summary.json")
+
+      summary = @journey.summary
+      summary.Name.should == 'New journey'
+      summary.TriggerType.should == 'On Subscription'
+      summary.Status.should == 'Active'
+
+      summary.Emails.size.should == 1
+      summary.Emails.first.EmailID.should == 'b1b1b1b1b1b1b1b1b1b1'
+      summary.Emails.first.Name.should == 'New Email'
+      summary.Emails.first.Bounced.should == 0
+      summary.Emails.first.Clicked.should == 0
+      summary.Emails.first.Opened.should == 3
+      summary.Emails.first.Sent.should == 1
+      summary.Emails.first.UniqueOpened.should == 1
+      summary.Emails.first.Unsubscribed.should == 0
+    end
+
+    should "return a paged list of recipients of a particular email" do
+      journey_date = "2019-07-12 09:22"
+      stub_get(@auth, "journeys/email/b1b1b1b1b1b1b1b1b1b1/recipients.json" \
+        "?date=#{ERB::Util.url_encode(journey_date)}" \
+        "&page=2" \
+        "&pagesize=5" \
+        "&orderdirection=asc", "journey_recipients.json")
+
+      recipients = @journey.email_recipients email_id = 'b1b1b1b1b1b1b1b1b1b1', date = journey_date, page = 2, page_size = 5, order_direction = 'asc'
+      recipients.Results.size.should == 4
+      recipients.Results.first.EmailAddress.should == 'example+1@example.com'
+      recipients.Results.first.SentDate.should == '2019-07-12 09:45:00'
+
+      recipients.ResultsOrderedBy.should == 'SentDate'
+      recipients.OrderDirection.should == 'ASC'
+      recipients.PageNumber.should == 2
+      recipients.PageSize.should == 10
+      recipients.RecordsOnThisPage.should == 4
+      recipients.TotalNumberOfRecords.should == 14
+      recipients.NumberOfPages.should == 2
+    end
+
+    should "return a paged list of subscribers who opened given journey email" do
+      journey_date = "2019-02-08 09:22"
+      stub_get(@auth, "journeys/email/b1b1b1b1b1b1b1b1b1b1/opens.json" \
+        "?date=#{ERB::Util.url_encode(journey_date)}" \
+        "&page=2" \
+        "&pagesize=5" \
+        "&orderdirection=asc", "journey_opens.json")
+
+      opens = @journey.email_opens email = 'b1b1b1b1b1b1b1b1b1b1', date = journey_date, page = 2, page_size = 5, order_direction = 'asc'
+      opens.Results.size.should == 4
+      opens.Results.last.EmailAddress.should == "example+4@example.com"
+      opens.Results.last.Date.should == "2019-07-29 10:35:00"
+      opens.Results.last.IPAddress.should == "192.168.0.3"
+      opens.Results.last.Latitude.should == -33.8683
+      opens.Results.last.Longitude.should == 151.2086
+      opens.Results.last.City.should == "Sydney"
+      opens.Results.last.Region.should == "New South Wales"
+      opens.Results.last.CountryCode.should == "AU"
+      opens.Results.last.CountryName.should == "Australia"
+
+      opens.ResultsOrderedBy.should == "Date"
+      opens.OrderDirection.should == "ASC"
+      opens.PageNumber.should == 1
+      opens.PageSize.should == 1000
+      opens.RecordsOnThisPage.should == 4
+      opens.TotalNumberOfRecords.should == 4
+      opens.NumberOfPages.should == 1
+    end
+
+    should "return a paged list of subscribers who clicked on a journey email" do
+      journey_date = "2019-07-29 10:30"
+      stub_get(@auth, "journeys/email/b1b1b1b1b1b1b1b1b1b1/clicks.json" \
+        "?date=#{ERB::Util.url_encode(journey_date)}" \
+        "&page=1" \
+        "&pagesize=2" \
+        "&orderdirection=asc", "journey_clicks.json")
+
+      clicks = @journey.email_clicks email = 'b1b1b1b1b1b1b1b1b1b1', date = journey_date, page = 1, page_size = 2, order_direction = 'asc'
+      clicks.Results.size.should == 2
+      clicks.Results.first.EmailAddress.should == "example+1@example.com"
+      clicks.Results.first.Date.should == "2019-07-29 10:33:00"
+      clicks.Results.first.URL.should == "http://test.com"
+      clicks.Results.first.IPAddress.should == "192.168.0.3"
+      clicks.Results.first.Latitude.should == -33.8683
+      clicks.Results.first.Longitude.should == 151.2086
+      clicks.Results.first.City.should == "Sydney"
+      clicks.Results.first.Region.should == "New South Wales"
+      clicks.Results.first.CountryCode.should == "AU"
+      clicks.Results.first.CountryName.should == "Australia"
+
+      clicks.ResultsOrderedBy.should == "Date"
+      clicks.OrderDirection.should == "ASC"
+      clicks.PageNumber.should == 1
+      clicks.PageSize.should == 2
+      clicks.RecordsOnThisPage.should == 2
+      clicks.TotalNumberOfRecords.should == 5
+      clicks.NumberOfPages.should == 3
+    end
+
+    should "return a paged list of subscribers who unsubscribed from a journey email" do
+      journey_date = "2019-07-29 10:22"
+      stub_get(@auth, "journeys/email/b1b1b1b1b1b1b1b1b1b1/unsubscribes.json" \
+        "?date=#{ERB::Util.url_encode(journey_date)}" \
+        "&page=1" \
+        "&pagesize=10" \
+        "&orderdirection=desc", "journey_unsubscribes.json")
+
+      unsubscribes = @journey.email_unsubscribes email = 'b1b1b1b1b1b1b1b1b1b1', date = journey_date, page = 1, page_size = 10, order_direction = 'desc'
+      unsubscribes.Results.size.should == 3
+      unsubscribes.Results.first.EmailAddress.should == "example+1@example.com"
+      unsubscribes.Results.first.Date.should == "2019-07-29 10:33:00"
+      unsubscribes.Results.first.IPAddress.should == "192.168.0.3"
+
+      unsubscribes.ResultsOrderedBy.should == "Date"
+      unsubscribes.OrderDirection.should == "ASC"
+      unsubscribes.PageNumber.should == 1
+      unsubscribes.PageSize.should == 1000
+      unsubscribes.RecordsOnThisPage.should == 4
+      unsubscribes.TotalNumberOfRecords.should == 4
+      unsubscribes.NumberOfPages.should == 1
+    end
+
+    should "return a paged list of emails that bounced for a journey email" do
+      journey_date = "2019-07-29 10:31"
+      stub_get(@auth, "journeys/email/b1b1b1b1b1b1b1b1b1b1/bounces.json" \
+        "?date=#{ERB::Util.url_encode(journey_date)}" \
+        "&page=20" \
+        "&pagesize=5" \
+        "&orderdirection=desc", "journey_bounces.json")
+
+      bounces = @journey.email_bounces email = 'b1b1b1b1b1b1b1b1b1b1', date = journey_date, page = 20, page_size = 5, order_direction = 'desc'
+      bounces.Results.size.should == 4
+      bounces.Results.first.EmailAddress.should == "example+1@example.com"
+      bounces.Results.first.BounceType.should == "4"
+      bounces.Results.first.Date.should == "2019-07-29 10:33:00"
+      bounces.Results.first.Reason.should == "Soft Bounce - Mailbox Full"
+
+      bounces.ResultsOrderedBy.should == "Date"
+      bounces.OrderDirection.should == "ASC"
+      bounces.PageNumber.should == 1
+      bounces.PageSize.should == 1000
+      bounces.RecordsOnThisPage.should == 4
+      bounces.TotalNumberOfRecords.should == 4
+      bounces.NumberOfPages.should == 1
+    end
+  end
+end

data/test/list_test.rb

@@ -66,7 +66,7 @@ class ListTest < Test::Unit::TestCase
 
     should "update a custom field" do
       key = "[mycustomfield]"
-      stub_put(@auth, "lists/#{@list.list_id}/customfields/#{CGI.escape(key)}.json", "update_custom_field.json")
+      stub_put(@auth, "lists/#{@list.list_id}/customfields/#{ERB::Util.url_encode(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
@@ -76,14 +76,14 @@ class ListTest < Test::Unit::TestCase
 
     should "delete a custom field" do
       custom_field_key = "[newdatefield]"
-      stub_delete(@auth, "lists/#{@list.list_id}/customfields/#{CGI.escape(custom_field_key)}.json", nil)
+      stub_delete(@auth, "lists/#{@list.list_id}/customfields/#{ERB::Util.url_encode(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(@auth, "lists/#{@list.list_id}/customfields/#{CGI.escape(custom_field_key)}/options.json", nil)
+      stub_put(@auth, "lists/#{@list.list_id}/customfields/#{ERB::Util.url_encode(custom_field_key)}/options.json", nil)
       @list.update_custom_field_options custom_field_key, new_options, true
     end
 
@@ -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)}&includetrackingpreference=false",
+      stub_get(@auth, "lists/#{@list.list_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}&includetrackingpreference=false",
         "active_subscribers.json")
       res = @list.active min_date
       res.ResultsOrderedBy.should == "email"
@@ -156,7 +156,7 @@ 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)}&includetrackingpreference=true",
+      stub_get(@auth, "lists/#{@list.list_id}/unconfirmed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}&includetrackingpreference=true",
         "unconfirmed_subscribers.json")
       res = @list.unconfirmed(min_date, 1, 1000, "email", "asc", true)
       res.ResultsOrderedBy.should == "email"
@@ -175,7 +175,7 @@ class ListTest < Test::Unit::TestCase
 
     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)}&includetrackingpreference=false", 
+      stub_get(@auth, "lists/#{@list.list_id}/unsubscribed.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}&includetrackingpreference=false",
         "unsubscribed_subscribers.json")
       res = @list.unsubscribed min_date
       res.ResultsOrderedBy.should == "email"
@@ -196,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)}&includetrackingpreference=false", 
+      stub_get(@auth, "lists/#{@list.list_id}/deleted.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}&includetrackingpreference=false",
         "deleted_subscribers.json")
       res = @list.deleted min_date
       res.ResultsOrderedBy.should == "email"
@@ -217,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)}&includetrackingpreference=false",
+      stub_get(@auth, "lists/#{@list.list_id}/bounced.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(min_date)}&includetrackingpreference=false",
         "bounced_subscribers.json")
       res = @list.bounced min_date
       res.ResultsOrderedBy.should == "email"

data/test/person_test.rb

@@ -9,7 +9,7 @@ class PersonTest < Test::Unit::TestCase
 
     should "get a person by client id and email address" do
       email = "person@example.com"
-      stub_get(@auth, "clients/#{@client_id}/people.json?email=#{CGI.escape(email)}", "person_details.json")
+      stub_get(@auth, "clients/#{@client_id}/people.json?email=#{ERB::Util.url_encode(email)}", "person_details.json")
       person = CreateSend::Person.get @auth, @client_id, email
       person.EmailAddress.should == email
       person.Name.should == "Person One"
@@ -26,13 +26,13 @@ class PersonTest < Test::Unit::TestCase
     should "update a person" do
       email = "person@example.com"
       new_email = "new_email_address@example.com"
-      stub_put(@auth, "clients/#{@client_id}/people.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "clients/#{@client_id}/people.json?email=#{ERB::Util.url_encode(email)}", nil)
       @person.update new_email, "Person", 1023, "NewPassword"
       @person.email_address.should == new_email
     end
       
     should "delete a person" do
-      stub_delete(@auth, "clients/#{@person.client_id}/people.json?email=#{CGI.escape(@person.email_address)}", nil)
+      stub_delete(@auth, "clients/#{@person.client_id}/people.json?email=#{ERB::Util.url_encode(@person.email_address)}", nil)
       @person.delete
     end
   end

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)}&includetrackingpreference=false",
+      stub_get(@auth, "segments/#{@segment.segment_id}/active.json?pagesize=1000&orderfield=email&page=1&orderdirection=asc&date=#{ERB::Util.url_encode(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)}&includetrackingpreference=false", "subscriber_details.json")
+      stub_get(@auth, "subscribers/#{@list_id}.json?email=#{ERB::Util.url_encode(email)}&includetrackingpreference=false", "subscriber_details.json")
       subscriber = CreateSend::Subscriber.get @auth, @list_id, email
       subscriber.EmailAddress.should == email
       subscriber.Name.should == "Subscriber One"
@@ -23,7 +23,7 @@ class SubscriberTest < Test::Unit::TestCase
 
     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")
+      stub_get(@auth, "subscribers/#{@list_id}.json?email=#{ERB::Util.url_encode(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"
@@ -55,7 +55,7 @@ class SubscriberTest < Test::Unit::TestCase
     should "update a subscriber with custom fields" do
       email = "subscriber@example.com"
       new_email = "new_email_address@example.com"
-      stub_put(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "subscribers/#{@list_id}.json?email=#{ERB::Util.url_encode(email)}", nil)
       custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
       @subscriber.update new_email, "Subscriber", custom_fields, true, "Yes"
       @subscriber.email_address.should == new_email
@@ -64,7 +64,7 @@ class SubscriberTest < Test::Unit::TestCase
     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(@auth, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", nil)
+      stub_put(@auth, "subscribers/#{@list_id}.json?email=#{ERB::Util.url_encode(email)}", nil)
       custom_fields = [ { :Key => 'website', :Value => '', :Clear => true } ]
       @subscriber.update new_email, "Subscriber", custom_fields, true, "No"
       @subscriber.email_address.should == new_email
@@ -152,7 +152,7 @@ class SubscriberTest < Test::Unit::TestCase
     end
 
     should "get a subscriber's history" do
-      stub_get(@auth, "subscribers/#{@subscriber.list_id}/history.json?email=#{CGI.escape(@subscriber.email_address)}", "subscriber_history.json")
+      stub_get(@auth, "subscribers/#{@subscriber.list_id}/history.json?email=#{ERB::Util.url_encode(@subscriber.email_address)}", "subscriber_history.json")
       history = @subscriber.history
       history.size.should == 1
       history.first.Name.should == "Campaign One"
@@ -166,7 +166,7 @@ class SubscriberTest < Test::Unit::TestCase
     end
 
     should "delete a subscriber" do
-      stub_delete(@auth, "subscribers/#{@subscriber.list_id}.json?email=#{CGI.escape(@subscriber.email_address)}", nil)
+      stub_delete(@auth, "subscribers/#{@subscriber.list_id}.json?email=#{ERB::Util.url_encode(@subscriber.email_address)}", nil)
       @subscriber.delete
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -174,6 +174,7 @@ files:
 - lib/createsend/campaign.rb
 - lib/createsend/client.rb
 - lib/createsend/createsend.rb
+- lib/createsend/journey.rb
 - lib/createsend/list.rb
 - lib/createsend/person.rb
 - lib/createsend/segment.rb
@@ -183,6 +184,7 @@ files:
 - lib/createsend/transactional_smart_email.rb
 - lib/createsend/transactional_timeline.rb
 - lib/createsend/version.rb
+- samples/journey_sample.rb
 - test/administrator_test.rb
 - test/campaign_test.rb
 - test/client_test.rb
@@ -228,6 +230,13 @@ files:
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/invalid_oauth_token_api_error.json
+- test/fixtures/journey_bounces.json
+- test/fixtures/journey_clicks.json
+- test/fixtures/journey_opens.json
+- test/fixtures/journey_recipients.json
+- test/fixtures/journey_summary.json
+- test/fixtures/journey_unsubscribes.json
+- test/fixtures/journeys.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
 - test/fixtures/list_webhooks.json
@@ -270,6 +279,7 @@ files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/fixtures/update_custom_field.json
 - test/helper.rb
+- test/journey_test.rb
 - test/list_test.rb
 - test/person_test.rb
 - test/segment_test.rb
@@ -349,6 +359,13 @@ test_files:
 - test/fixtures/import_subscribers.json
 - test/fixtures/import_subscribers_partial_success.json
 - test/fixtures/invalid_oauth_token_api_error.json
+- test/fixtures/journey_bounces.json
+- test/fixtures/journey_clicks.json
+- test/fixtures/journey_opens.json
+- test/fixtures/journey_recipients.json
+- test/fixtures/journey_summary.json
+- test/fixtures/journey_unsubscribes.json
+- test/fixtures/journeys.json
 - test/fixtures/list_details.json
 - test/fixtures/list_stats.json
 - test/fixtures/list_webhooks.json
@@ -391,6 +408,7 @@ test_files:
 - test/fixtures/unsubscribed_subscribers.json
 - test/fixtures/update_custom_field.json
 - test/helper.rb
+- test/journey_test.rb
 - test/list_test.rb
 - test/person_test.rb
 - test/segment_test.rb