express_pigeon 2.0.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fff3380b88a30f5b07051dc8706bd011766c76c
-  data.tar.gz: 7054faf25d532a29f68e927b73572b45b3baa033
+  metadata.gz: dec6639b9221476fba9c7129782bcafcd0f8865d
+  data.tar.gz: 013b35a5e0fd1c7d6649a7bfb8e9419c148cb849
 SHA512:
-  metadata.gz: c0c5c02f47cbd144e218ddbd0c3dfdf429aeba130b3c5c204b14c42cf8a9774945359f0c3b2585c0ee00b9aea952cfff88268feff14625984f2240382631361d
-  data.tar.gz: ac4bd28632697812bb4135f425314bf63931464c7d253aea717e6ce939ab552c639592b7a2354112f69e286d6f152b98ea81200926b635e93a40881fbc57062b
+  metadata.gz: 0179a1e751bb4a2724e2ba5235bf55fb40df81e11c9783c084770748f8014ec3d9f8844ebb2eb0857e4434eee2d38ea19637f577200cca0ea3e45fb01c9740bb
+  data.tar.gz: 2f67667b090857f6a0c793271879262d9a438a5258ea7a7c35f6603a285165b44f96ad5c492773affa5cb701e54067c0e0ee17211aef6ab588e5f2f8b7d9b8e8

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: config/.rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 2.4.0
+
+- Added AutoResponders
+
+# 2.3.0
+
+- Added Campaigns
+
+# 2.2.0
+
+- Added Messages aka Transactional Emails
+
+# 2.1.0
+
+- Added Templates

data/CONTRIBUTING.md

@@ -3,6 +3,15 @@
 **DO _NOT_ RUN THE SPECS AGAINST YOUR PRODUCTION ACCOUNT. THEY ARE INTEGRATION TESTS AND WILL CREATE LISTS, CONTACTS, ETC INSIDE YOUR ACCOUNT.**
 
 - Create a "dummy" account on [https://expresspigeon.com](https://expresspigeon.com).
+
+[![Create the test template](https://www.evernote.com/shard/s13/sh/75e1cdd7-456f-428a-8277-dba816463ac5/f831f96b6fe134bbd365fe979b4e7f10/deep/0/ExpressPigeon---Newsletters.png)](https://expresspigeon.com/newsletters/)
+
+[![Configure the test template](https://www.evernote.com/shard/s13/sh/5748e40d-5620-4452-953d-36f874a69863/8fb550e3544c1ee94309c5ba45bf85a5/deep/0/ExpressPigeon---Create-Edit-Newsletter.png)](https://expresspigeon.com/newsletters/)
+
+[![Extract the template id](https://www.evernote.com/shard/s13/sh/98ab5e45-df3d-4650-bbbb-95017b167453/f68c2c0e7158c358fe58a652aad30300/deep/0/Screenshot-12-26-14,-10-22-AM.png)](https://expresspigeon.com/newsletters/)
+
+- Set the `TEST_TEMPLATE_ID` to the example newsletter template id.
+
 - Create three custom_fields on the account.
     - `my_custom_text_field` as `text` (no default)
     - `my_custom_number_field` as `number` (no default)

data/Gemfile

@@ -8,6 +8,7 @@ group :development do
   gem 'pry-byebug'
 
   gem 'rubocop'
+  gem 'bundler-audit'
 
   gem 'colorize'
 end

data/Guardfile

@@ -1,49 +1,15 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-directories %w(. lib spec)
-
-## Uncomment to clear the screen before every task
+directories %w(. lib lib/express_pigeon spec spec/lib spec/lib/express_pigeon)
 clearing :on
 
-## Make Guard exit when config is changed so it can be restarted
-#
-## Note: if you want Guard to automatically start up again, run guard in a
-## shell loop, e.g.:
-#
-#  $ while bundle exec guard; do echo "Restarting Guard..."; done
-#
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), the you will want to move the Guardfile
-## to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-#
 watch ('Guardfile') do
   UI.info 'Exiting because Guard must be restarted for changes to take effect'
   exit 0
 end
 
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
-guard :rspec, cmd: 'bundle exec rspec' do
+guard :rspec, cmd: 'bundle exec rspec --warnings' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
-  # Feel free to open issues for suggestions and improvements
-
   # RSpec files
   rspec = dsl.rspec
   watch(rspec.spec_helper) { rspec.spec_dir }

data/README.md

@@ -1,5 +1,62 @@
 [![Build Status](https://semaphoreapp.com/api/v1/projects/3d4266af-fb45-45c5-bba9-0c5e825f3e84/316403/badge.png)](https://semaphoreapp.com/just3ws/express_pigeon)
 [![Code Climate](https://codeclimate.com/github/just3ws/express_pigeon/badges/gpa.svg)](https://codeclimate.com/github/just3ws/express_pigeon)
+[![Gem Version](https://badge.fury.io/rb/express_pigeon.svg)](http://badge.fury.io/rb/express_pigeon)
+[![Inline docs](http://inch-ci.org/github/just3ws/express_pigeon.svg?branch=master&style=flat)](http://inch-ci.org/github/just3ws/express_pigeon)
 [![Test Coverage](https://codeclimate.com/github/just3ws/express_pigeon/badges/coverage.svg)](https://codeclimate.com/github/just3ws/express_pigeon)
 
 Another Ruby client for ExpressPigeon.
+
+[![If you ignore the CONTRIBUTING.md then you're going to have a bad time.](https://d8izdk6bl4gbi.cloudfront.net/https://d1015h9unskp4y.cloudfront.net/attachments/ea8fd905-5069-4377-abbb-9013db3f4507/CONTRIBUTING.jpg)](https://github.com/just3ws/express_pigeon/blob/master/CONTRIBUTING.md)
+
+# ExpressPigeon API Endpoints
+
+## Implemented
+
+### ExpressPigeon::Contacts
+
+- `#create` **POST** `https://api.expresspigeon.com/contacts`
+- `#delete` **DELETE** `https://api.expresspigeon.com/contacts`
+- `#find` **GET** `https://api.expresspigeon.com/contacts`
+- `#move` **POST** `https://api.expresspigeon.com/contacts/move`
+
+### ExpressPigeon::Lists
+
+- `#create` **POST** `https://api.expresspigeon.com/lists`
+- `#delete` **DELETE** `https://api.expresspigeon.com/lists/{id}`
+- `#download_csv` **GET** `https://api.expresspigeon.com/lists/{list_id}/csv`
+- `#index` **GET** `https://api.expresspigeon.com/lists`
+- `#update` **PUT** `https://api.expresspigeon.com/lists`
+- `#upload_status` **GET** `https://api.expresspigeon.com/lists/upload_status/{id}`
+- `#upload` **POST** `https://api.expresspigeon.com/lists/{id}/upload`
+
+### ExpressPigeon::Messages
+
+- `#send` **POST** `https://api.expresspigeon.com/messages`
+- `#status` **GET** `https://api.expresspigeon.com/messages/{id}`
+- `#statuses` **GET** `https://api.expresspigeon.com/messages`
+
+### ExpressPigeon::Templates
+
+- `#copy` **POST** `https://api.expresspigeon.com/templates/{template_id}/copy`
+
+### ExpressPigeon::Campaigns
+
+- `#create` **POST** `https://api.expresspigeon.com/campaigns`
+- `#index` **GET** `https://api.expresspigeon.com/campaigns`
+- `#report_bounced` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}/bounced`
+- `#report_clicked` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}/clicked`
+- `#report_opened` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}/opened`
+- `#report_spam` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}/spam`
+- `#report_unsubscribed` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}/unsubscribed`
+- `#report` **GET** `https://api.expresspigeon.com/campaigns/{campaign_id}`
+
+### ExpressPigeon::AutoResponders
+
+- `#index` **GET** `https://api.expresspigeon.com/auto_responders`
+- `#report_bounced` **GET** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}/{auto_responder_part_id}/bounced`
+- `#report_spam` **GET** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}/{auto_responder_part_id}/unsubscribed`
+- `#report_unsubscribed` **GET** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}/{auto_responder_part_id}/spam`
+- `#report` **GET** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}`
+- `#start` **POST** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}/start`
+- `#stop` **POST** `https://api.expresspigeon.com/auto_responders/{auto_responder_id}/stop`
+

data/lib/express_pigeon/auto_responders.rb

@@ -0,0 +1,70 @@
+module ExpressPigeon
+  # AutoResponders
+  class AutoResponders
+    include HTTParty
+    base_uri('https://api.expresspigeon.com/auto_responders')
+
+    # Get all autoresponders
+    #
+    # GET https://api.expresspigeon.com/auto_responders
+    def index
+      self.class.get('')
+    end
+
+    # Start for a contact
+    #
+    # POST https://api.expresspigeon.com/auto_responders/{auto_responder_id}/start
+    def start(auto_responder_id, email_address)
+      options = {}
+      options['email'] = email_address
+
+      self.class.post(
+        "/#{auto_responder_id}/start",
+        body: options.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    # Stop for a contact
+    #
+    # POST https://api.expresspigeon.com/auto_responders/{auto_responder_id}/stop
+    def stop(auto_responder_id, email_address)
+      options = {}
+      options['email'] = email_address
+
+      self.class.post(
+        "/#{auto_responder_id}/stop",
+        body: options.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    # Report for a single autoresponder
+    #
+    # GET https://api.expresspigeon.com/auto_responders/{auto_responder_id}
+    def report(auto_responder_id)
+      self.class.get("/#{auto_responder_id}")
+    end
+
+    # Get bounced contacts for autoresponder part
+    #
+    # GET https://api.expresspigeon.com/auto_responders/{auto_responder_id} /{auto_responder_part_id}/bounced
+    def report_bounced(auto_responder_id, auto_responder_part_id)
+      self.class.get("/#{auto_responder_id}/#{auto_responder_part_id}/bounced")
+    end
+
+    # Get unsubscribed contacts for autoresponder part
+    #
+    # GET https://api.expresspigeon.com/auto_responders/{auto_responder_id} /{auto_responder_part_id}/unsubscribed
+    def report_unsubscribed(auto_responder_id, auto_responder_part_id)
+      self.class.get("/#{auto_responder_id}/#{auto_responder_part_id}/unsubscribed")
+    end
+
+    # Get spam contacts for autoresponder part
+    #
+    # GET https://api.expresspigeon.com/auto_responders/{auto_responder_id} /{auto_responder_part_id}/spam
+    def report_spam(auto_responder_id, auto_responder_part_id)
+      self.class.get("/#{auto_responder_id}/#{auto_responder_part_id}/spam")
+    end
+  end
+end

data/lib/express_pigeon/campaigns.rb

@@ -0,0 +1,120 @@
+module ExpressPigeon
+  # Campaigns
+  #
+  # Campaign API provides the same service as sending email campaigns from the
+  # website. A campaign consists of newsletter template, subject, from name,
+  # reply to, and a lists of contacts a campaign can be sent to.
+  class Campaigns
+    include HTTParty
+    base_uri('https://api.expresspigeon.com/campaigns')
+    debug_output($stderr)
+
+    # Campaigns creation
+    #
+    # POST https://api.expresspigeon.com/campaigns
+    #
+    # list_id:          The id of a list the campaign is sent to. The list must
+    #                   be enabled.
+    # template_id:      The id of a newsletter template used for the campaign.
+    # name:             The name of a campaign. This name is for your reference
+    #                   only and will not be exposed to your audience. If you
+    #                   have Google Analytics turned on, this value will also be
+    #                   used for Google Analytics campaign.
+    # from_name:        This parameter is displayed as "From" field in the email
+    #                   program when your recipients view your message. Use this
+    #                   value to clearly state your name or name of your organization.
+    # reply_to:         This parameter specifies the email address which will
+    #                   be getting replies from your recipients should they
+    #                   choose to reply. The reply_to should be a valid email address.
+    # subject:          The subject of a newsletter
+    # google_analytics: Indicates whether Google Analytics should be enabled
+    #                   for a campaign. Should be true or false.
+    # schedule_for:     Specifies what time a campaign should be sent. If it
+    #                   is provided the campaign will be scheduled to this time,
+    #                   otherwise campaign is sent immediately. The schedule_for
+    #                   must be in ISO date format and should be in the future.
+    def create(list_id, template_id, name:, from_name:, reply_to:, subject:, google_analytics:, schedule_for: nil)
+      options = {}
+      options['list_id'] = list_id
+      options['template_id'] = template_id
+      options['name'] = name
+      options['from_name'] = from_name
+      options['reply_to'] = reply_to
+      options['subject'] = subject
+      options['google_analytics'] = google_analytics
+      options['schedule_for'] = schedule_for unless schedule_for.nil?
+
+      self.class.post(
+        '',
+        body: options.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    # List campaigns
+    #
+    # GET https://api.expresspigeon.com/campaigns
+    #
+    # Returns a list of at most 1000 created campaigns, to get the next batch use from_id parameter.
+    #
+    # from_id: id from where to get the next batch,
+    #          e.g. the last id from the previous call
+    # from:    start of the sending period
+    #          (UTC, example: 2013-03-16T10:00:00.000+0000)
+    # to:      end of the sending period
+    #          (UTC, example: 2013-03-16T20:00:00.000+0000)
+    def index(from_id: nil, from: nil, to: nil)
+      options = {}
+      options['from_id'] = from_id unless from_id.nil?
+      options['from'] = from unless from.nil?
+      options['to'] = to unless to.nil?
+
+      self.class.get(
+        '',
+        query: options
+      )
+    end
+
+    # Report for a single campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}
+    def report(campaign_id)
+      self.class.get("/#{campaign_id}")
+    end
+
+    # Get opened events for campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}/opened
+    def report_opened(campaign_id)
+      self.class.get("/#{campaign_id}/opened")
+    end
+
+    # Get clicked events for campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}/clicked
+    def report_clicked(campaign_id)
+      self.class.get("/#{campaign_id}/clicked")
+    end
+
+    # Get bounced contacts for campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}/bounced
+    def report_bounced(campaign_id)
+      self.class.get("/#{campaign_id}/bounced")
+    end
+
+    # Get unsubscribed contacts for campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}/unsubscribed
+    def report_unsubscribed(campaign_id)
+      self.class.get("/#{campaign_id}/unsubscribed")
+    end
+
+    # Get spam contacts for campaign
+    #
+    # GET https://api.expresspigeon.com/campaigns/{campaign_id}/spam
+    def report_spam(campaign_id)
+      self.class.get("/#{campaign_id}/spam")
+    end
+  end
+end

data/lib/express_pigeon/contacts.rb

@@ -35,9 +35,7 @@ module ExpressPigeon
       self.class.post(
         '/',
         body: options.to_json,
-        headers: {
-          'Content-Type' => 'application/json'
-        }
+        headers: { 'Content-Type' => 'application/json' }
       )
     end
     alias_method :update, :create
@@ -45,7 +43,20 @@ module ExpressPigeon
     # Delete a single contact
     #
     # DELETE https://api.expresspigeon.com/contacts
-    def delete(_email_address)
+    #
+    # email:   contact email to be deleted
+    # list_id: list id to remove contact from, if not provided contact will
+    #          be deleted from system.
+    def delete(email_address, list_id: nil)
+      options = {}
+      options['email'] = email_address
+      options['list_id'] = list_id unless list_id.nil?
+
+      self.class.delete(
+        '',
+        body: options.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
     end
 
     # Move contacts between lists

data/lib/express_pigeon/messages.rb

@@ -0,0 +1,83 @@
+module ExpressPigeon
+  # Messages
+  #
+  # Sending Transactional emails requires that newsletter templates for these
+  # emails are created prior to sending. Such template can have merge fields,
+  # in a format ${field_name}. This feature allows a high degree of flexibility
+  # for message customization.
+  #
+  # The newsletter to be sent can have a number of merge fields, with data for
+  # merging dynamically provided during a call.
+  class Messages
+    include HTTParty
+    base_uri('https://api.expresspigeon.com/messages')
+    debug_output(nil)
+
+    def initialize(auth_key)
+      self.class.headers('X-auth-key' => auth_key)
+    end
+
+    # Sending a single transactional email
+    #
+    # POST https://api.expresspigeon.com/messages
+    #
+    # template_id:      newsletter template id to be sent
+    # to:               email address to send message to
+    # reply_to:         email address tp reply to
+    # from:             from name, such as your name or name of your organization
+    # subject:          email message subject
+    # merge_fields:     values for merge fields
+    # view_online:      generates online version of sent message. We will host
+    #                   this generated message on our servers, default is false
+    # click_tracking:   overwrites all URLs in email to point to
+    #                   http://clicks.expresspigeon.com for click tracking.
+    #                   Setting it to false will preserve all URLs intact, but
+    #                   click tracking will not be available, default is true
+    # suppress_address: if true suppresses insertion of sender's physical
+    #                   address in the email, default is false
+    def send(template_id, to:, reply_to:, from:, subject:, merge_fields: {}, view_online: nil, click_tracking: nil, suppress_address: nil)
+      options = {}
+      options['template_id'] = template_id
+      options['to'] = to
+      options['from'] = from
+      options['reply_to'] = reply_to
+      options['subject'] = subject
+      options['merge_fields'] = merge_fields unless merge_fields.empty?
+      options['view_online'] = view_online unless view_online.nil?
+      options['click_tracking'] = click_tracking unless click_tracking.nil?
+      options['suppress_address'] = suppress_address unless suppress_address.nil?
+
+      self.class.post(
+        '',
+        body: options.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
+
+    # Report for a single message
+    #
+    # GET https://api.expresspigeon.com/messages/{id}
+    def status(message_id)
+      # NOTE: This appears to be sending a valid request but the response
+      #       can contain many status reports. The intent seems to be to
+      #       only return the status report for the id requested. We'll pass
+      #       along the full response for now.
+      self.class.get('', query: { 'id' => message_id })
+    end
+
+    REPORTING_PERIODS = %i(last24hours last_week last_month)
+
+    # Report for multiple messages
+    #
+    # GET https://api.expresspigeon.com/messages
+    def statuses(from_id: nil, start_date: nil, end_date: nil, period: nil)
+      options = {}
+      options['from_id'] = from_id unless from_id.nil?
+      options['start_date'] = start_date unless start_date.nil?
+      options['end_date'] = end_date unless end_date.nil?
+      options['period'] = period unless period.nil?
+
+      self.class.get('', query: options)
+    end
+  end
+end

data/lib/express_pigeon/templates.rb

@@ -1,4 +1,28 @@
 module ExpressPigeon
+  # Templates
   class Templates
+    include HTTParty
+    base_uri('https://api.expresspigeon.com/templates')
+    debug_output(nil)
+
+    def initialize(auth_key)
+      self.class.headers('X-auth-key' => auth_key)
+    end
+
+    # Copy template
+    #
+    # POST https://api.expresspigeon.com/templates/{template_id}/copy
+    #
+    # NOTE: It is important to use only single quotes in injected HTML
+    def copy(template_id, name:, merge_fields: {})
+      self.class.post(
+        "/#{template_id}/copy",
+        body: {
+          name: name,
+          merge_fields: merge_fields
+        }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+    end
   end
 end

data/lib/express_pigeon/version.rb

@@ -1,3 +1,3 @@
 module ExpressPigeon
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/express_pigeon.rb

@@ -1,23 +1,16 @@
-require 'awesome_print'
-
-# require 'net/http'
 require 'json'
-# require 'uri'
 
 require 'httparty'
 require 'httmultiparty'
 
 require 'express_pigeon/version'
 
-require 'express_pigeon/lists'
+require 'express_pigeon/auto_responders'
+require 'express_pigeon/campaigns'
 require 'express_pigeon/contacts'
-require 'express_pigeon/transactional_emails'
+require 'express_pigeon/lists'
+require 'express_pigeon/messages'
 require 'express_pigeon/templates'
-require 'express_pigeon/autoresponders'
-
-AUTH_KEY = ENV['EXPRESS_PIGEON_AUTH_KEY']
-ROOT     = 'https://api.expresspigeon.com/'
-USE_SSL  = true
 
 module ExpressPigeon
 end

data/spec/lib/express_pigeon/auto_responders_spec.rb

@@ -0,0 +1,2 @@
+RSpec.describe ExpressPigeon::AutoResponders do
+end

data/spec/lib/express_pigeon/campaigns_spec.rb

@@ -0,0 +1,2 @@
+RSpec.describe ExpressPigeon::Campaigns do
+end

data/spec/lib/express_pigeon/messages_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe ExpressPigeon::Messages do
+  let(:auth_key) { ENV['EXPRESS_PIGEON_AUTH_KEY'] }
+  let(:client) { ExpressPigeon::Messages.new(auth_key) }
+  let(:test_template_id) { Integer(ENV['TEST_TEMPLATE_ID']) }
+
+  it 'sends a transactional email and gets a status report' do
+    response = client.send(
+      test_template_id,
+      to: 'mike+to@just3ws.com',
+      from: 'mike+from@just3ws',
+      reply_to: 'mike+reply_to@just3ws.com',
+      subject: 'Test sending EP transactional emails',
+      merge_fields: { 'test_merge_field' => 'sending transactional email via EP' })
+
+    expect(response['code']).to eq(200)
+    expect(response['message']).to eq('email queued')
+    message_id = response['id']
+    expect(message_id).to be_a(Fixnum)
+
+    # NOTE: Check the Inbox you configured for you Sandbox account to see the
+    #       actual email as it was sent.
+
+    # cheating in specs and piggy-backing to test the status[es] requests
+
+    response = client.status(message_id)
+    expect(response.code).to eq(200)
+    report = response.select { |report| report['id'] == message_id }
+    expect(report.length).to eq(1)
+    expect(report.first['id']).to eq(message_id)
+
+    response = client.statuses(from_id: message_id - 1)
+    expect(response.code).to eq(200)
+    report = response.select { |report| report['id'] == message_id }
+    expect(report.length).to eq(1)
+    expect(report.first['id']).to eq(message_id)
+  end
+end

data/spec/lib/express_pigeon/templates_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe ExpressPigeon::Templates do
+  # WARN: This test requires setting up a template to use as the baseline for
+  #       copying templates. You can use any existing template or create new
+  #       template from scratch.
+  #
+  #       Once you've selected a template to use check the URL for the template
+  #       and extract the TEMPLATE_ID and update the `.env` file TEST_TEMPLATE_ID.
+  #
+  #       Example:
+  #
+  #         Given the URL `https://expresspigeon.com/newsletters/compose/26013`
+  #         Then the .env file should be set to TEST_TEMPLATE_ID=26013
+  #
+  #       You will need to clean up templates created by this test manually
+  #       as the API doesn't support deleting templates at this time
+  #
+
+  let(:auth_key) { ENV['EXPRESS_PIGEON_AUTH_KEY'] }
+  let(:client) { ExpressPigeon::Templates.new(auth_key) }
+
+  let(:test_template_id) { Integer(ENV['TEST_TEMPLATE_ID']) }
+
+  it 'copies an existing template' do
+    response = client.copy(test_template_id, name: 'TEST copied template', merge_fields: {
+                             test_merge_field: 'Hello, World!'
+                           })
+
+    # NOTE: Since we can't see the actual merge result you'll need to log in
+    #       to your ExpressPigeon account and check the result of the merge.
+
+    expect(response['code']).to eq(200)
+
+    # If this fails then check the response. We're dependant on the behavior
+    # of the env for this expectation. If we run the test multiple times then
+    # the autoincrement for the TEMPLATE_ID is offset further. Right now just
+    # expect it to be an integer greater than the initial template id.
+    expect(response['template_id']).to be_a(Integer)
+    next_template_id = Integer(response['template_id'])
+    expect(next_template_id).to be > test_template_id
+
+    expect(response['message']).to eq('template copied successfully')
+  end
+end