createsend 4.1.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1cf72a678bbce9cf631fe045d080307019a8a3a7
-  data.tar.gz: 8b7691c4d61ab08e46c544cd41ce994cd79ae819
+SHA256:
+  metadata.gz: 1b2bb4cff071610599c8016946954e43a06069153feacda42c1ed0ec3f358e06
+  data.tar.gz: f3a2e2b67d20cc392b04b469a15b6d97ee1a7af65b9e5245a4d262047863164d
 SHA512:
-  metadata.gz: 570b370adad853e0f9491e00758b7e989c4d3db98207e385d7c08bf765a29342e16e9893369527867593961b637c84f0c7f2944a560c46f8ac9bfe44e95b1b4f
-  data.tar.gz: d46d8888041d1a92ce412440821b46769a0d9cc56cda85f79fd4b2700aa11ebc1a90f4093adc04fe969349f8f521595575819e08ff6374ff8e7be0425b1d2424
+  metadata.gz: 229d9c032d55f82c23fed36742e5186eb7e2e4c590e5b8acf9f9463aba53241b41ba31dd5be1ca342556876f0b5f1b69c52a54bff8b161c4018b1611e2145baa
+  data.tar.gz: 945dc9bc23760e17d1f4a47e155d3cb356e7539e61e0109f3c0324375cc2f05d2bc1224cfcdb382dfa745a2d667a2ead5b8897962de3e0f7504196baf92e065e

data/HISTORY.md

@@ -1,5 +1,34 @@
 # createsend-ruby history
 
+## v6.0.0 - 10 Feb, 2022
+* Upgrades to Createsend API v3.3 which includes new breaking changes
+* Breaking: 'client.campaigns' now returned an object to support pagination (use .Results to ge the array of campaigns)
+* Added 'Tags' as another field that is returned in 'client.scheduled', 'client.drafts' and 'client.campaigns'
+* Added 'Name' as another field that is returned in 'campaign.summary'
+* Add new support for 'client.tags' endpoint (ie: getting list of tags for the client)
+* Add support for pagination, filtering and sorting to 'client.campaigns' endpoint
+* Bump `rake` to `~> 12.3.3`
+* Adding support for returning ListJoinedDate for each subscriber. 
+  * List.Active()
+  * List.Bounced()
+  * List.Unsubscribed()
+  * List.Unconfirmed()
+  * List.Deleted()
+  * Segment.Subscribers()
+  * Subscriber.Get()
+
+## 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
 

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.
 
@@ -133,7 +133,7 @@ clients.each do |cl|
   p "Client: #{cl.Name}"
   client = CreateSend::Client.new auth, cl.ClientID
   p "- Campaigns:"
-  client.campaigns.each do |cm|
+  client.drafts.each do |cm|
     p "  - #{cm.Subject}"
   end
 end
@@ -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/createsend.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '>= 1.0'
   s.add_runtime_dependency 'hashie', '~> 3.0'
   s.add_runtime_dependency 'httparty', '~> 0.14'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rake', '~> 12.3.3'
   s.add_development_dependency 'fakeweb', '~> 1.3'
   s.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
   s.add_development_dependency 'shoulda-context', '~> 1.2'

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

@@ -25,9 +25,19 @@ module CreateSend
     end
 
     # Gets the sent campaigns belonging to this client.
-    def campaigns
-      response = get 'campaigns'
-      response.map{|item| Hashie::Mash.new(item)}
+    def campaigns(page=1, page_size=1000, order_direction="desc",
+      sent_from_date='', sent_to_date='', tags='')
+      options = { :query => {
+        :page => page,
+        :pagesize => page_size,
+        :orderdirection => order_direction,
+        :sentfromdate => sent_from_date,
+        :senttodate => sent_to_date,
+        :tags => tags
+      }}
+
+      response = get 'campaigns', options
+      Hashie::Mash.new(response)
     end
 
     # Gets the currently scheduled campaigns belonging to this client.
@@ -42,6 +52,12 @@ module CreateSend
       response.map{|item| Hashie::Mash.new(item)}
     end
 
+    # Gets all the tags belonging to this client.
+    def tags
+      response = get 'tags'
+      response.map{|item| Hashie::Mash.new(item)}
+    end
+
     # Gets the subscriber lists belonging to this client.
     def lists
       response = get 'lists'
@@ -181,6 +197,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,7 +111,7 @@ module CreateSend
       end
     end
 
-    @@base_uri = "https://api.createsend.com/api/v3.1"
+    @@base_uri = "https://api.createsend.com/api/v3.3"
     @@oauth_base_uri = "https://api.createsend.com/oauth"
     @@oauth_token_uri = "#{@@oauth_base_uri}/token"
     headers({

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.2" unless defined?(CreateSend::VERSION)
+  VERSION = "6.0.0" 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/authentication_sample.rb

@@ -0,0 +1,64 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class AuthorizationSample
+    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_OAUTH_CLIENT_ID env var missing' if ENV['CREATESEND_OAUTH_CLIENT_ID'].nil?
+        raise 'CREATESEND_OAUTH_CLIENT_SECRET env var missing' if ENV['CREATESEND_OAUTH_CLIENT_SECRET'].nil?
+        raise 'CREATESEND_OAUTH_REDIRECT_URL env var missing' if ENV['CREATESEND_OAUTH_REDIRECT_URL'].nil?
+        raise 'CREATESEND_OAUTH_SCOPE env var missing' if ENV['CREATESEND_OAUTH_SCOPE'].nil?
+       
+        @createsendApiKey = ENV['CREATESEND_API_KEY']
+        @oauthClientId = ENV['CREATESEND_OAUTH_CLIENT_ID']
+        @oauthClientSecret = ENV['CREATESEND_OAUTH_CLIENT_SECRET']
+        @oauthRedirectUrl = ENV['CREATESEND_OAUTH_REDIRECT_URL']
+        @oauthScope = ENV['CREATESEND_OAUTH_SCOPE']
+        )
+    end
+
+    def authentication_with_api_key
+        auth = {:api_key => @createsendApiKey}
+        @client = CreateSend::Client.new auth, @createsendClientId
+
+        @client.scheduled
+    end
+
+    def get_authorise_url
+        state = 'some state data'
+
+        @authorize_url = CreateSend::CreateSend.authorize_url(@oauthClientId, @oauthRedirectUrl, @oauthScope, state);
+    end
+
+    def exchange_token(code)
+        CreateSend::CreateSend.exchange_token(
+            client_id=@oauthClientId,
+            client_secret=@oauthClientSecret,
+            redirect_uri=@oauthRedirectUrl,
+            code=code # Get the code from the query string after hitting authorise url
+            )
+    end
+
+    def authentication_with_oauth(access_token, refresh_token)
+        auth = {:access_token => access_token, :refresh_token => refresh_token}
+        @client = CreateSend::Client.new auth, @createsendClientId
+
+        @client.scheduled
+    end
+end
+
+sample = AuthorizationSample.new
+authoriseUrl = sample.get_authorise_url
+# hit the authorise url, where you would be redirected and receive the code parameter in the query string
+access_token, expires_in, refresh_token = sample.exchange_token('code that you get once you hit authorize url')
+
+puts "Getting scheduled campaigns with api authentication: #{sample.authentication_with_api_key.to_json}\n\n"
+puts "Getting authorise url: #{authoriseUrl.to_json}\n\n"
+puts "Getting access_token: #{access_token.to_json}\n\n"
+puts "Getting scheduled campaigns with oauth authentication: #{sample.authentication_with_oauth(access_token, refresh_token).to_json}\n\n"
+
+
+        @client.scheduled
+    end
+end

data/samples/clients_sample.rb

@@ -0,0 +1,79 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class ClientsSample
+    def initialize
+        raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+        raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].nil?
+        raise 'CREATESEND_CLIENT_ID env var missing' if ENV['CREATESEND_CLIENT_ID'].nil?
+
+        auth = auth = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+        @client = CreateSend::Client.new auth, ENV['CREATESEND_CLIENT_ID']
+    end
+
+    def get_all_sent_campaigns
+        campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(page_number)
+            page_number += 1
+            campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        campaigns
+    end
+    
+    def get_sent_campaigns_with_tag_filter
+        filtered_campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(page_number, 1000, 'desc', '', '', 'tag_example, tag_example_2')
+            page_number += 1
+            filtered_campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        filtered_campaigns
+    end
+
+    def get_2021_sent_campaigns
+        2021_campaigns = []
+        page_number = 1
+        loop do
+            page = @client.campaigns(1, 1000, 'desc', '2021-01-01', '2022-01-01', '')
+            page_number += 1
+            2021_campaigns.concat(page.Results)
+            if page.PageNumber == page.NumberOfPages
+                break
+            end
+        end
+
+        2021_campaigns
+    end
+
+    def get_all_scheduled_campaigns
+        @client.scheduled
+    end
+
+    def get_all_draft_campaigns
+        @client.drafts
+    end
+
+    def get_all_client_tags
+        @client.tags
+    end
+end
+
+sample = ClientsSample.new
+
+puts "All sent campaigns: #{sample.get_all_sent_campaigns.to_json}\n\n"
+puts "All sent campaigns with `tag_example` and `tag_example_2` tag: #{sample.get_sent_campaigns_with_tag_filter.to_json}\n\n"
+puts "All 2021 sent campaigns: #{sample.get_2021_sent_campaigns.to_json}\n\n"
+puts "All scheduled campaigns: #{sample.get_all_scheduled_campaigns.to_json}\n\n"
+puts "All draft campaigns: #{sample.get_all_draft_campaigns.to_json}\n\n"
+puts "All client tags: #{sample.get_all_client_tags.to_json}\n\n"

data/samples/journey_sample.rb

@@ -0,0 +1,87 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'createsend'
+
+class JourneySample
+  @date = "2019-01-01 00:00"
+
+  def initialize
+    raise 'CREATESEND_ACCESS_TOKEN env var missing' if ENV['CREATESEND_ACCESS_TOKEN'].nil?
+    raise 'CREATESEND_REFRESH_TOKEN env var missing' if ENV['CREATESEND_REFRESH_TOKEN'].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 = {:access_token => ENV['CREATESEND_ACCESS_TOKEN'], :refresh_token => ENV['CREATESEND_REFRESH_TOKEN']}
+    @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"