createsend 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748f11bd6ee056946dca025a17681b5143a0944c
-  data.tar.gz: 62ea0f5505683df105955fb54205350c9121a6f5
+  metadata.gz: 83c11f38273068f99455b389075f882b24d9a17b
+  data.tar.gz: cfcd57555d0656ceddd52d6fc64f5762bbd00820
 SHA512:
-  metadata.gz: 22b2f5d3cf74a197a1d176f22116450464b84d4743f852ef4d9094c12d48cc91761670bbe1bbc27794eb244d8ea1641d8553c52a24cb2dac32937f2462fd7d2c
-  data.tar.gz: 47989c8a9f9b3e309e7069354067e38f5e72074d70a39bf9f4ad5aff3380612eae7b685106d1a978f99d314a7834f63e3107039bd0108095dd0b7685ef5af78d
+  metadata.gz: 790ac1bd3644138ca49adda8c2ad284cb7d222fb84cb831a82704cf5a36a89142902b73f3f824908a82e848d17af34bbd03ea0887f5895330a5b12110b196c03
+  data.tar.gz: 57df8eeda52d4aba84e938b3165ef14592027fc7deafd1881ca255baf59223309148853fcdc5554dd1bb35d560e9eb56d92c7add1d5bfe4541eb3d73e89a4b15

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.2
   - 2.1
   - 2.0.0
   - 1.9.3

data/HISTORY.md

@@ -1,5 +1,9 @@
 # createsend-ruby history
 
+## v4.1.0 - 4 Aug, 2015
+
+* Added support for Transactional Email
+
 ## v4.0.2 - 15 Oct, 2014
 
 * Bumped and simplified `hashie` dependency to `~> 3.0`

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2014 James Dennes
+Copyright (c) 2010-2015 James Dennes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/createsend.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda-context', '~> 1.2'
   s.add_development_dependency 'simplecov', '~> 0'
   s.add_development_dependency 'coveralls', '~> 0'
+  s.add_development_dependency 'test-unit', '~>3.0'
   s.name = "createsend"
   s.author = "James Dennes"
   s.description = %q{Implements the complete functionality of the Campaign Monitor API.}

data/lib/createsend.rb

@@ -11,3 +11,6 @@ require 'createsend/subscriber'
 require 'createsend/template'
 require 'createsend/person'
 require 'createsend/administrator'
+require 'createsend/transactional_classic_email'
+require 'createsend/transactional_smart_email'
+require 'createsend/transactional_timeline'

data/lib/createsend/transactional_classic_email.rb

@@ -0,0 +1,32 @@
+module CreateSend
+  module Transactional
+    class ClassicEmail < CreateSend
+      attr_accessor :options
+
+      def initialize(auth, client_id = nil)
+        @auth = auth
+        @client_id = client_id
+        super
+      end
+
+      def send(options)
+        response = post "/transactional/classicemail/send", { :body => options.to_json , :query => client_id }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def groups
+        response = get "/transactional/classicemail/groups", :query => client_id
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      private
+
+      def client_id
+        {:clientID => @client_id} if @client_id
+      end
+
+    end
+  end
+end
+
+

data/lib/createsend/transactional_smart_email.rb

@@ -0,0 +1,31 @@
+module CreateSend
+  module Transactional
+    class SmartEmail < CreateSend
+      attr_reader :smart_email_id
+
+      def self.list(auth, options = nil)
+        cs = CreateSend.new auth
+        response = cs.get "/transactional/smartemail", :query => options
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def initialize(auth, smart_email_id)
+        @auth = auth
+        @smart_email_id = smart_email_id
+        super
+      end
+
+      def details
+        response = get "/transactional/smartemail/#{@smart_email_id}"
+        Hashie::Mash.new(response)
+      end
+
+      def send(options)
+        response = post "/transactional/smartemail/#{@smart_email_id}/send", { :body => options.to_json }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+    end
+  end
+end
+

data/lib/createsend/transactional_timeline.rb

@@ -0,0 +1,45 @@
+module CreateSend
+  module Transactional
+    class Timeline < CreateSend
+      attr_reader :client_id
+
+      def initialize(auth, client_id = nil)
+        @auth      = auth
+        @client_id = client_id
+        super
+      end
+
+      def messages(options = {})
+        options = add_client_id(options)
+        response = get "/transactional/messages", { :query => options }
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      def statistics(options = {})
+        options = add_client_id(options)
+        response = get "/transactional/statistics", { :query => options }
+        Hashie::Mash.new(response)
+      end
+
+      def details(message_id, options = {})
+        options = add_client_id(options)
+        response = get "/transactional/messages/#{message_id}", { :query => options }
+        Hashie::Mash.new(response)
+      end
+
+      def resend(message_id)
+        response = post "/transactional/messages/#{message_id}/resend"
+        response.map{|item| Hashie::Mash.new(item)}
+      end
+
+      private
+
+      def add_client_id(options)
+        options['clientID'] = @client_id if @client_id
+        options
+      end
+
+    end
+  end
+end
+

data/lib/createsend/version.rb

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

data/test/fixtures/tx_classicemail_groups.json

@@ -0,0 +1,14 @@
+[
+    {
+        "Group": "Password Reset",
+        "CreatedAt": "2015-03-28T09:41:36+11:00"
+    },
+    {
+        "Group": "Credit card expired",
+        "CreatedAt": "2015-05-04T22:24:12+10:00"
+    },
+    {
+        "Group": "Order shipped",
+        "CreatedAt": "2015-03-29T11:11:52+11:00"
+    }
+]

data/test/fixtures/tx_message_details.json

@@ -0,0 +1,36 @@
+{
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "SmartEmailID": "c0da9c4c-e7e4-11e4-a74d-6c4008bc7468",
+    "CanBeResent": true,
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "Message": {
+        "From": "Team Webapp <team@webapp123.com",
+        "Subject": "Thanks for signing up to web app 123",
+        "To": [
+          "Joe Smith <joesmith@example.com>",
+          "jamesmith@example.com"
+        ],
+        "CC": [
+          "Joe Smith <joesmith@example.com>"
+        ],
+        "BCC": "joesmith@example.com",
+        "Attachments": [
+            {
+                "Name": "Invoice.pdf",
+                "Type": "application/pdf"
+            }
+        ],
+        "Body": {
+            "Html": "...",
+            "Text": "..."
+        },
+        "Data": {
+            "new_password_url": "https://www.mywebapp.com/newpassword?uid=jguf45hf74hbf74gf"
+        }
+    },
+    "TotalOpens": 1,
+    "TotalClicks": 1
+}
+

data/test/fixtures/tx_message_details_with_statistics.json

@@ -0,0 +1,72 @@
+{
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "SmartEmailID": "c0da9c4c-e7e4-11e4-a74d-6c4008bc7468",
+    "CanBeResent": true,
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "Message": {
+        "From": "Team Webapp <team@webapp123.com",
+        "Subject": "Thanks for signing up to web app 123",
+        "To": [
+          "Joe Smith <joesmith@example.com>",
+          "jamesmith@example.com"
+        ],
+        "CC": [
+          "Joe Smith <joesmith@example.com>"
+        ],
+        "BCC": "joesmith@example.com",
+        "Attachments": [
+            {
+                "Name": "Invoice.pdf",
+                "Type": "application/pdf"
+            }
+        ],
+        "Body": {
+            "Html": "...",
+            "Text": "..."
+        },
+        "Data": {
+            "new_password_url": "https://www.mywebapp.com/newpassword?uid=jguf45hf74hbf74gf"
+        }
+    },
+    "TotalOpens": 1,
+    "TotalClicks": 1,
+    "Opens": [
+        {
+            "EmailAddress": "jamesmith@example.com",
+            "Date": "2009-05-18 16:45:00",
+            "IPAddress": "192.168.0.1",
+            "Geolocation": {
+                "Latitude": -33.8683,
+                "Longitude": 151.2086,
+                "City": "Sydney",
+                "Region": "New South Wales",
+                "CountryCode": "AU",
+                "CountryName": "Australia"
+            },
+            "MailClient": {
+                "Name": "Apple Mail",
+                "OS": "OS X",
+                "Device": "Desktop"
+            }
+        }
+    ],
+    "Clicks": [
+        {
+            "EmailAddress": "jamesmith@example.com",
+            "Date": "2009-05-18 16:45:00",
+            "IPAddress": "192.168.0.1",
+            "URL": "http://www.myexammple.com/index.html",
+            "Geolocation": {
+              "Latitude": -33.8683,
+              "Longitude": 151.2086,
+              "City": "Sydney",
+              "Region": "New South Wales",
+              "CountryCode": "AU",
+              "CountryName": "Australia"
+            }
+        }
+    ]
+}
+

data/test/fixtures/tx_messages.json

@@ -0,0 +1,38 @@
+[
+  {
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "From": "Team <team@company.com>",
+    "Subject": "Ungrouped message",
+    "TotalOpens": 2,
+    "TotalClicks": 4,
+    "CanBeResent": true
+  },
+  {
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "From": "Team <team@company.com>",
+    "Subject": "Your password has been reset",
+    "TotalOpens": 2,
+    "TotalClicks": 4,
+    "CanBeResent": true,
+    "Group": "Password Reset"
+  },
+  {
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "From": "Team <team@company.com>",
+    "Subject": "Your credit card has expired",
+    "TotalOpens": 2,
+    "TotalClicks": 4,
+    "CanBeResent": true,
+    "SmartEmailID": "21dab350-f484-11e4-ad38-6c4008bc7468"
+  }
+]
+

data/test/fixtures/tx_messages_classic.json

@@ -0,0 +1,15 @@
+[
+  {
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "From": "Team <team@company.com>",
+    "Subject": "Your password has been reset",
+    "TotalOpens": 2,
+    "TotalClicks": 4,
+    "CanBeResent": true,
+    "Group": "Password Reset"
+  }
+]
+

data/test/fixtures/tx_messages_smart.json

@@ -0,0 +1,15 @@
+[
+  {
+    "MessageID": "ddc697c7-0788-4df3-a71a-a7cb935f00bd",
+    "Status": "Delivered",
+    "SentAt": "2014-01-15T16:09:19-05:00",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "From": "Team <team@company.com>",
+    "Subject": "Your credit card has expired",
+    "TotalOpens": 2,
+    "TotalClicks": 4,
+    "CanBeResent": true,
+    "SmartEmailID": "21dab350-f484-11e4-ad38-6c4008bc7468"
+  }
+]
+

data/test/fixtures/tx_resend_message.json

@@ -0,0 +1,6 @@
+{
+    "Status": "Accepted",
+    "Recipient": "Joe Smith <joesmith@example.com>",
+    "MessageID": "cfb5e081-ef66-4bc4-a1c0-48493b34e694"
+}
+

data/test/fixtures/tx_send_multiple.json

@@ -0,0 +1,12 @@
+[
+    {
+        "MessageID": "0cfe150d-d507-11e4-84a7-c31e5b59881d",
+        "Recipient": "\"Bob Sacamano\" <bob@example.com>",
+        "Status": "Received"
+    },
+    {
+        "MessageID": "0cfe150d-d507-11e4-b579-a64eb0d9c74d",
+        "Recipient": "\"Newman\" <newman@example.com>",
+        "Status": "Received"
+    }
+]

data/test/fixtures/tx_send_single.json

@@ -0,0 +1,7 @@
+[
+    {
+        "MessageID": "0cfe150d-d507-11e4-84a7-c31e5b59881d",
+        "Recipient": "\"Bob Sacamano\" <bob@example.com>",
+        "Status": "Received"
+    }
+]

data/test/fixtures/tx_smartemail_details.json

@@ -0,0 +1,23 @@
+{
+    "SmartEmailID": "bb4a6ebb-663d-42a0-bdbe-60512cf30a01",
+    "Name": "Reset Password",
+    "CreatedAt": "2015-03-31T16:06:35+11:00",
+    "Status": "active",
+    "Properties": {
+        "From": "\"Team\" <team@example.com>",
+        "ReplyTo": "joe@example.com",
+        "Subject": "[username], your password has been reset!",
+        "Content": {
+            "HTML": "Content managed in Email Builder",
+            "Text": "Content managed in Email Builder",
+            "EmailVariables": [
+                "username",
+                "reset_token"
+            ],
+            "InlineCss": true
+        },
+        "TextPreviewUrl": "https://philoye.devcreatesend.com/t/r-9A7A28EE76054977/T",
+        "HtmlPreviewUrl": "https://philoye.devcreatesend.com/t/r-9A7A28EE76054977/"
+    },
+    "AddRecipientsToList": true
+}

data/test/fixtures/tx_smartemails.json

@@ -0,0 +1,15 @@
+[
+    {
+        "ID": "1e654df2-f484-11e4-970c-6c4008bc7468",
+        "Name": "Welcome email",
+        "CreatedAt": "2015-05-15T16:09:19-05:00",
+        "Status": "Active"
+    },
+    {
+        "ID": "21dab350-f484-11e4-ad38-6c4008bc7468",
+        "Name": "Order shipped",
+        "CreatedAt": "2015-05-15T13:29:49-05:00",
+        "Status": "Active"
+    }
+]
+

data/test/fixtures/tx_statistics_classic.json

@@ -0,0 +1,14 @@
+{
+    "Query": {
+      "Group": "Password Reset",
+      "From": "2014-02-03",
+      "To": "2015-02-02",
+      "TimeZone": "(GMT+10:00) Canberra, Melbourne, Sydney"
+    },
+    "Sent": 1000,
+    "Bounces": 8,
+    "Delivered": 992,
+    "Opened": 300,
+    "Clicked": 50
+}
+

data/test/fixtures/tx_statistics_smart.json

@@ -0,0 +1,14 @@
+{
+    "Query": {
+      "SmartEmailID": "bb4a6ebb-663d-42a0-bdbe-60512cf30a01",
+      "From": "2014-02-03",
+      "To": "2015-02-02",
+      "TimeZone": "UTC"
+    },
+    "Sent": 1000,
+    "Bounces": 8,
+    "Delivered": 992,
+    "Opened": 300,
+    "Clicked": 50
+}
+

data/test/transactional_classic_email_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TransactionalClassicEmailTest < Test::Unit::TestCase
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+    setup do
+      @client_id = "87y8d7qyw8d7yq8w7ydwqwd"
+      @email = CreateSend::Transactional::ClassicEmail.new @auth, @client_id
+    end
+
+    should "send classic email to one recipient" do
+      stub_post(@auth, "transactional/classicemail/send", "tx_send_single.json")
+      email = {
+        "From"       => "George <george@example.com>",
+        "Subject"    => "Thanks for signing up to Vandelay Industries",
+        "To"         => "Bob Sacamano <bob@example.com>",
+        "HTML"       => "<h1>Welcome</h1><a href='http://example.com/'>Click here</a>",
+        "Group" => 'Ruby test group'
+      }
+      response = CreateSend::Transactional::ClassicEmail.new(@auth).send(email)
+      response.length.should == 1
+      response[0].Recipient.should == "\"Bob Sacamano\" <bob@example.com>"
+    end
+
+    should "send classic email to with all the options" do
+      stub_post(@auth, "transactional/classicemail/send", "tx_send_multiple.json")
+      email = {
+        "From" => "T-Bone <tbone@example.com>",
+        "ReplyTo" => "george@example.com",
+        "Subject" => "Thanks for signing up to Vandelay Industries",
+        "To" => [
+          "Bob Sacamano <bob@example.com>",
+          "Newman <newman@example.com>",
+        ],
+        "CC" => [],
+        "BCC" => [],
+        "HTML" => "<h1>Welcome</h1><a href='http://example.com/'>Click here</a>",
+        "Text" => "Instead of using the auto-generated text from the HTML, you can supply your own.",
+        "Attachments" => [
+          "Name" => "filename.gif",
+          "Type" => "image/gif",
+          "Content" => "R0lGODlhIAAgAKIAAP8AAJmZADNmAMzMAP//AAAAAP///wAAACH/C1hNUCBEYXRhWE1QPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMwMTQgNzkuMTU2Nzk3LCAyMDE0LzA4LzIwLTA5OjUzOjAyICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNCAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDowNzZGOUNGOUVDRDIxMUU0ODM2RjhGMjNCMTcxN0I2RiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDowNzZGOUNGQUVDRDIxMUU0ODM2RjhGMjNCMTcxN0I2RiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjA3NkY5Q0Y3RUNEMjExRTQ4MzZGOEYyM0IxNzE3QjZGIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjA3NkY5Q0Y4RUNEMjExRTQ4MzZGOEYyM0IxNzE3QjZGIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+Af/+/fz7+vn49/b19PPy8fDv7u3s6+rp6Ofm5eTj4uHg397d3Nva2djX1tXU09LR0M/OzczLysnIx8bFxMPCwcC/vr28u7q5uLe2tbSzsrGwr66trKuqqainpqWko6KhoJ+enZybmpmYl5aVlJOSkZCPjo2Mi4qJiIeGhYSDgoGAf359fHt6eXh3dnV0c3JxcG9ubWxramloZ2ZlZGNiYWBfXl1cW1pZWFdWVVRTUlFQT05NTEtKSUhHRkVEQ0JBQD8+PTw7Ojk4NzY1NDMyMTAvLi0sKyopKCcmJSQjIiEgHx4dHBsaGRgXFhUUExIREA8ODQwLCgkIBwYFBAMCAQAAIfkEAAAAAAAsAAAAACAAIAAAA5loutz+MKpSpIWU3r1KCBW3eYQmWgWhmiemEgPbNqk6xDOd1XGYV77UzTfbTWC4nAHYQRKLu1VSuXxlpsodAFDAZrfcIbXDFXqhNacoQ3vZpuxHSJZ2zufyTqcunugdd00vQ0F4chQCAgYCaTcxiYuMMhGJFG89kYpFl5MzkoRPnpJskFSaDqctRoBxHEQsdGs0f7Qjq3utDwkAOw=="
+        ],
+        "Group" => "Ruby test group",
+        "AddRecipientsToListID" => "6d0366fcee146ab9bdaf3247446bbfdd"
+      }
+      response = CreateSend::Transactional::ClassicEmail.new(@auth).send(email)
+      response.length.should == 2
+      response[1].Recipient.should == "\"Newman\" <newman@example.com>"
+    end
+
+    should "get the list of classic groups" do
+      stub_get(@auth, "transactional/classicemail/groups", "tx_classicemail_groups.json")
+      response = CreateSend::Transactional::ClassicEmail.new(@auth).groups
+      response.length.should == 3
+      response[0].Group.should == "Password Reset"
+    end
+
+  end
+end
+

data/test/transactional_smart_email_test.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TransactionalSmartEmailTest < Test::Unit::TestCase
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+    setup do
+      @client_id = "87y8d7qyw8d7yq8w7ydwqwd"
+      @smart_email_id = "bcf40510-f968-11e4-ab73-bf67677cc1f4"
+      @email = CreateSend::Transactional::SmartEmail.new @auth, @smart_email_id
+    end
+
+    should "get the list of smart emails" do
+      stub_get(@auth, "transactional/smartemail", "tx_smartemails.json")
+      response = CreateSend::Transactional::SmartEmail.list(@auth)
+      response.length.should == 2
+      response[0].ID.should == "1e654df2-f484-11e4-970c-6c4008bc7468"
+      response[0].Name.should == "Welcome email"
+      response[0].Status.should == "Active"
+    end
+
+    should "get the list of active smart emails using a client ID" do
+      stub_get(@auth, "transactional/smartemail?status=active&client=#{@client_id}", "tx_smartemails.json")
+      response = CreateSend::Transactional::SmartEmail.list(@auth, { :client => @client_id, :status => 'active'} )
+      response.length.should == 2
+      response[0].ID.should == "1e654df2-f484-11e4-970c-6c4008bc7468"
+      response[0].Name.should == "Welcome email"
+      response[0].Status.should == "Active"
+    end
+
+    should "get the details of smart email" do
+      stub_get(@auth, "transactional/smartemail/#{@smart_email_id}", "tx_smartemail_details.json")
+      response = CreateSend::Transactional::SmartEmail.new(@auth, @smart_email_id).details
+      response.Name.should == "Reset Password"
+      response.Status.should == "active"
+      response.Properties.ReplyTo.should == "joe@example.com"
+    end
+
+    should "send smart email to one recipient" do
+      stub_post(@auth, "transactional/smartemail/#{@smart_email_id}/send", "tx_send_single.json")
+      email = {
+        "To" => "Bob Sacamano <bob@example.com>",
+        "Data" => {
+          "anEmailVariable" => 'foo',
+          "anotherEmailVariable" => 'bar'
+        }
+      }
+      response = CreateSend::Transactional::SmartEmail.new(@auth, @smart_email_id).send(email)
+      response.length.should == 1
+      response[0].MessageID.should == "0cfe150d-d507-11e4-84a7-c31e5b59881d"
+      response[0].Recipient.should == "\"Bob Sacamano\" <bob@example.com>"
+      response[0].Status.should == "Received"
+    end
+
+    should "send smart email to multiple recipients with all the options" do
+      stub_post(@auth, "transactional/smartemail/#{@smart_email_id}/send", "tx_send_multiple.json")
+      email = {
+        "To" => [
+          "Bob Sacamano <bob@example.com>",
+          "Newman <newman@example.com>",
+        ],
+        "CC" => [],
+        "BCC" => [],
+        "Data" => {
+          "anEmailVariable" => 'foo',
+          "anotherEmailVariable" => 'bar'
+        },
+        "Attachments" => [
+          "Name" => "filename.gif",
+          "Type" => "image/gif",
+          "Content" => "R0lGODlhIAAgAKIAAP8AAJmZADNmAMzMAP//AAAAAP///wAAACH/C1hNUCBEYXRhWE1QPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMwMTQgNzkuMTU2Nzk3LCAyMDE0LzA4LzIwLTA5OjUzOjAyICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNCAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDowNzZGOUNGOUVDRDIxMUU0ODM2RjhGMjNCMTcxN0I2RiIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDowNzZGOUNGQUVDRDIxMUU0ODM2RjhGMjNCMTcxN0I2RiI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjA3NkY5Q0Y3RUNEMjExRTQ4MzZGOEYyM0IxNzE3QjZGIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjA3NkY5Q0Y4RUNEMjExRTQ4MzZGOEYyM0IxNzE3QjZGIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+Af/+/fz7+vn49/b19PPy8fDv7u3s6+rp6Ofm5eTj4uHg397d3Nva2djX1tXU09LR0M/OzczLysnIx8bFxMPCwcC/vr28u7q5uLe2tbSzsrGwr66trKuqqainpqWko6KhoJ+enZybmpmYl5aVlJOSkZCPjo2Mi4qJiIeGhYSDgoGAf359fHt6eXh3dnV0c3JxcG9ubWxramloZ2ZlZGNiYWBfXl1cW1pZWFdWVVRTUlFQT05NTEtKSUhHRkVEQ0JBQD8+PTw7Ojk4NzY1NDMyMTAvLi0sKyopKCcmJSQjIiEgHx4dHBsaGRgXFhUUExIREA8ODQwLCgkIBwYFBAMCAQAAIfkEAAAAAAAsAAAAACAAIAAAA5loutz+MKpSpIWU3r1KCBW3eYQmWgWhmiemEgPbNqk6xDOd1XGYV77UzTfbTWC4nAHYQRKLu1VSuXxlpsodAFDAZrfcIbXDFXqhNacoQ3vZpuxHSJZ2zufyTqcunugdd00vQ0F4chQCAgYCaTcxiYuMMhGJFG89kYpFl5MzkoRPnpJskFSaDqctRoBxHEQsdGs0f7Qjq3utDwkAOw=="
+        ],
+        "AddRecipientsToListID" => true
+      }
+      response = CreateSend::Transactional::SmartEmail.new(@auth, @smart_email_id).send(email)
+      response.length.should == 2
+      response[1].MessageID.should == "0cfe150d-d507-11e4-b579-a64eb0d9c74d"
+      response[1].Recipient.should == "\"Newman\" <newman@example.com>"
+      response[1].Status.should == "Received"
+    end
+
+  end
+end
+
+

data/test/transactional_timeline_test.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TransactionalTimelineTest < Test::Unit::TestCase
+  multiple_contexts "authenticated_using_oauth_context", "authenticated_using_api_key_context" do
+    setup do
+      @client_id = "87y8d7qyw8d7yq8w7ydwqwd"
+      @message_id = "ddc697c7-0788-4df3-a71a-a7cb935f00bd"
+      @before_id = 'e2e270e6-fbce-11e4-97fc-a7cf717ca157'
+      @after_id = 'e96fc6ca-fbce-11e4-949f-c3ccd6a68863'
+      @smart_email_id = 'bb4a6ebb-663d-42a0-bdbe-60512cf30a01'
+    end
+
+    should "get statistics with the default parameters" do
+      stub_get(@auth, "transactional/statistics", "tx_statistics_classic.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).statistics
+      response.Sent.should == 1000
+      response.Opened.should == 300
+    end
+
+    should "get statistics filtered by date and classic group" do
+      stub_get(@auth, "transactional/statistics?from=2015-01-01&to=2015-06-30&timezone=client&group=Password%20Reset", "tx_statistics_classic.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).statistics(
+        "from" => "2015-01-01",
+        "to" => "2015-06-30",
+        "timezone" => "client",
+        "group" => "Password Reset"
+      )
+      response.Query.TimeZone.should == "(GMT+10:00) Canberra, Melbourne, Sydney"
+      response.Query.Group.should == "Password Reset"
+      response.Sent.should == 1000
+    end
+
+    should "get statistics filtered by date and smart email" do
+      stub_get(@auth, "transactional/statistics?from=2015-01-01&to=2015-06-30&timezone=utc&smartEmailID=#{@smart_email_id}", "tx_statistics_smart.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).statistics(
+        "from" => "2015-01-01",
+        "to" => "2015-06-30",
+        "timezone" => "utc",
+        "smartEmailID" => "bb4a6ebb-663d-42a0-bdbe-60512cf30a01"
+      )
+      response.Query.TimeZone.should == "UTC"
+      response.Query.SmartEmailID.should == "bb4a6ebb-663d-42a0-bdbe-60512cf30a01"
+      response.Sent.should == 1000
+    end
+
+    should "get the message timeline with default parameters" do
+      stub_get(@auth, "transactional/messages", "tx_messages.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).messages
+      response.length.should == 3
+      response[0].MessageID.should == "ddc697c7-0788-4df3-a71a-a7cb935f00bd"
+      response[0].Status.should == "Delivered"
+    end
+
+    should "get the message timeline for a smart email" do
+      stub_get(@auth, "transactional/messages?status=all&count=200&sentBeforeID=#{@before_id}&sentAfterID=#{@after_id}&smartEmailID=#{@smart_email_id}&clientID=#{@client_id}", "tx_messages_smart.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).messages(
+        "status" => 'all',
+        "count" => 200,
+        "sentBeforeID" => @before_id,
+        "sentAfterID" => @after_id,
+        "smartEmailID" => @smart_email_id,
+        "clientID" => @client_id
+      )
+      response.length.should == 1
+      response[0].MessageID.should == "ddc697c7-0788-4df3-a71a-a7cb935f00bd"
+      response[0].Status.should == "Delivered"
+    end
+
+    should "get the message timeline for a classic group" do
+      stub_get(@auth, "transactional/messages?status=all&count=200&sentBeforeID=#{@before_id}&sentAfterID=#{@after_id}&group=Password%20Reset&clientID=#{@client_id}", "tx_messages_classic.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).messages(
+        "status" => 'all',
+        "count" => 200,
+        "sentBeforeID" => @before_id,
+        "sentAfterID" => @after_id,
+        "group" => 'Password Reset',
+        "clientID" => @client_id
+      )
+      response.length.should == 1
+      response[0].Group.should == "Password Reset"
+      response[0].Status.should == "Delivered"
+    end
+
+    should "get the message details" do
+      stub_get(@auth, "transactional/messages/#{@message_id}", "tx_message_details.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).details(@message_id)
+      response.TotalOpens.should == 1
+      response.TotalClicks.should == 1
+    end
+
+    should "get the message details with statistics" do
+      stub_get(@auth, "transactional/messages/#{@message_id}?statistics=true", "tx_message_details_with_statistics.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).details(@message_id, :statistics => true)
+      response.Opens.length == 1
+      response.Clicks.length == 1
+    end
+
+    should "resend a message" do
+      stub_post(@auth, "transactional/messages/#{@message_id}/resend", "tx_send_single.json")
+      response = CreateSend::Transactional::Timeline.new(@auth).resend(@message_id)
+      response.length.should == 1
+      response[0].MessageID.should == "0cfe150d-d507-11e4-84a7-c31e5b59881d"
+      response[0].Recipient.should == "\"Bob Sacamano\" <bob@example.com>"
+      response[0].Status.should == "Received"
+    end
+
+  end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Implements the complete functionality of the Campaign Monitor API.
 email:
 - jdennes@gmail.com
@@ -165,6 +179,9 @@ files:
 - lib/createsend/segment.rb
 - lib/createsend/subscriber.rb
 - lib/createsend/template.rb
+- lib/createsend/transactional_classic_email.rb
+- lib/createsend/transactional_smart_email.rb
+- lib/createsend/transactional_timeline.rb
 - lib/createsend/version.rb
 - test/administrator_test.rb
 - test/campaign_test.rb
@@ -235,6 +252,19 @@ files:
 - test/fixtures/templates.json
 - test/fixtures/timezones.json
 - test/fixtures/transfer_credits.json
+- test/fixtures/tx_classicemail_groups.json
+- test/fixtures/tx_message_details.json
+- test/fixtures/tx_message_details_with_statistics.json
+- test/fixtures/tx_messages.json
+- test/fixtures/tx_messages_classic.json
+- test/fixtures/tx_messages_smart.json
+- test/fixtures/tx_resend_message.json
+- test/fixtures/tx_send_multiple.json
+- test/fixtures/tx_send_single.json
+- test/fixtures/tx_smartemail_details.json
+- test/fixtures/tx_smartemails.json
+- test/fixtures/tx_statistics_classic.json
+- test/fixtures/tx_statistics_smart.json
 - test/fixtures/unconfirmed_subscribers.json
 - test/fixtures/unsubscribed_subscribers.json
 - test/fixtures/update_custom_field.json
@@ -244,6 +274,9 @@ files:
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
+- test/transactional_classic_email_test.rb
+- test/transactional_smart_email_test.rb
+- test/transactional_timeline_test.rb
 homepage: http://campaignmonitor.github.io/createsend-ruby/
 licenses:
 - MIT
@@ -264,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A library which implements the complete functionality of the Campaign Monitor
@@ -339,6 +372,19 @@ test_files:
 - test/fixtures/templates.json
 - test/fixtures/timezones.json
 - test/fixtures/transfer_credits.json
+- test/fixtures/tx_classicemail_groups.json
+- test/fixtures/tx_message_details.json
+- test/fixtures/tx_message_details_with_statistics.json
+- test/fixtures/tx_messages.json
+- test/fixtures/tx_messages_classic.json
+- test/fixtures/tx_messages_smart.json
+- test/fixtures/tx_resend_message.json
+- test/fixtures/tx_send_multiple.json
+- test/fixtures/tx_send_single.json
+- test/fixtures/tx_smartemail_details.json
+- test/fixtures/tx_smartemails.json
+- test/fixtures/tx_statistics_classic.json
+- test/fixtures/tx_statistics_smart.json
 - test/fixtures/unconfirmed_subscribers.json
 - test/fixtures/unsubscribed_subscribers.json
 - test/fixtures/update_custom_field.json
@@ -348,4 +394,6 @@ test_files:
 - test/segment_test.rb
 - test/subscriber_test.rb
 - test/template_test.rb
-has_rdoc: 
+- test/transactional_classic_email_test.rb
+- test/transactional_smart_email_test.rb
+- test/transactional_timeline_test.rb