constantcontact 1.0.0

data/lib/constantcontact/services/base_service.rb

@@ -0,0 +1,37 @@
+#
+# base_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class BaseService
+			class << self
+				attr_accessor :api_key
+
+				protected
+
+				# Helper function to return required headers for making an http request with constant contact
+				# @param [String] access_token - OAuth2 access token to be placed into the Authorization header
+				# @return [Hash] - authorization headers
+				def get_headers(access_token)
+					{
+						:content_type   => 'application/json',
+						:accept         => 'application/json',
+						:authorization  => "Bearer #{access_token}"
+					}
+				end
+
+
+				# Build a url from the base url and query parameters hash
+				def build_url(url, params = nil)
+					params = {} if !params
+					params['api_key'] = BaseService.api_key
+					url += '?' + Util::Helpers.http_build_query(params)
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/campaign_schedule_service.rb

@@ -0,0 +1,107 @@
+#
+# campaign_schedule_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class CampaignScheduleService < BaseService
+			class << self
+
+				# Create a new schedule for a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id to be scheduled
+				# @param [Schedule] schedule - Schedule to be created
+				# @return [Schedule]
+				def add_schedule(access_token, campaign_id, schedule)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_schedules'), campaign_id)
+					url = build_url(url)
+					payload = schedule.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Schedule.create(JSON.parse(response.body))
+				end
+
+
+				# Get a list of schedules for a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id to be scheduled
+				# @return [Array<Schedule>]
+				def get_schedules(access_token, campaign_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_schedules'), campaign_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					schedules = []
+					body.each do |schedule|
+						schedules << Components::Schedule.create(schedule)
+					end
+
+					schedules
+				end
+
+
+				# Get a specific schedule for a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id to get a schedule for
+				# @param [Integer] schedule_id - Schedule id to retrieve
+				# @return [Schedule]
+				def get_schedule(access_token, campaign_id, schedule_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::Schedule.create(JSON.parse(response.body))
+				end
+
+
+				# Delete a specific schedule for a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id to delete a schedule for
+				# @param [Integer] schedule_id - Schedule id to delete
+				# @return [Boolean]
+				def delete_schedule(access_token, campaign_id, schedule_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule_id)
+					url = build_url(url)
+					response = RestClient.delete(url, get_headers(access_token))
+					response.code == 204
+				end
+
+
+				# Update a specific schedule for a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id to be scheduled
+				# @param [Schedule] schedule - Schedule to retrieve 
+				# @return [Schedule]
+				def update_schedule(access_token, campaign_id, schedule)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule.id)
+					url = build_url(url)
+					payload = schedule.to_json
+					response = RestClient.put(url, payload, get_headers(access_token))
+					Components::Schedule.create(JSON.parse(response.body))
+				end
+
+
+				# Send a test send of a campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Id of campaign to send test of
+				# @param [TestSend] test_send - Test send details
+				# @return [TestSend]
+				def send_test(access_token, campaign_id, test_send)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign_test_sends'), campaign_id)
+					url = build_url(url)
+					payload = test_send.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::TestSend.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/campaign_tracking_service.rb

@@ -0,0 +1,159 @@
+#
+# campaign_tracking_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class CampaignTrackingService < BaseService
+			class << self
+
+				# Get a result set of bounces for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity
+				def get_bounces(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_bounces'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					bounces = []
+					body['results'].each do |bounce_activity|
+						bounces << Components::BounceActivity.create(bounce_activity)
+					end
+
+					Components::ResultSet.new(bounces, body['meta'])
+				end
+
+
+				# Get clicks for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
+				def get_clicks(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_clicks'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					clicks = []
+					body['results'].each do |click_activity|
+						clicks << Components::ClickActivity.create(click_activity)
+					end
+
+					Components::ResultSet.new(clicks, body['meta'])
+				end
+
+
+				# Get forwards for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
+				def get_forwards(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_forwards'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					forwards = []
+					body['results'].each do |forward_activity|
+						forwards << Components::ForwardActivity.create(forward_activity)
+					end
+
+					Components::ResultSet.new(forwards, body['meta'])
+				end
+
+
+				# Get opens for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
+				def get_opens(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_opens'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					opens = []
+					body['results'].each do |open_activity|
+						opens << Components::OpenActivity.create(open_activity)
+					end
+
+					Components::ResultSet.new(opens, body['meta'])
+				end
+
+
+				# Get sends for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
+				def get_sends(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_sends'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					sends = []
+					body['results'].each do |send_activity|
+						sends << Components::SendActivity.create(send_activity)
+					end
+
+					Components::ResultSet.new(sends, body['meta'])
+				end
+
+
+				# Get unsubscribes for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] campaign_id - Campaign id
+				# @param [Hash] param - query params to be appended to request
+				# @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
+				def get_unsubscribes(access_token, campaign_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_unsubscribes'), campaign_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					unsubscribes = []
+					body['results'].each do |unsubscribe_activity|
+						unsubscribes[] = Components::UnsubscribeActivity.create(unsubscribe_activity)
+					end
+
+					Components::ResultSet.new(unsubscribes, body['meta'])
+				end
+
+
+				# Get a summary of reporting data for a given campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Campaign id
+				# @return [TrackingSummary]
+				def get_summary(access_token, campaign_id)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.campaign_tracking_summary'), campaign_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::TrackingSummary.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/contact_service.rb

@@ -0,0 +1,114 @@
+#
+# contact_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class ContactService < BaseService
+			class << self
+
+				# Get an array of contacts
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Hash] param - query parameters to be appended to the request
+				# @return [ResultSet<Contact>]
+				def get_contacts(access_token, param = nil)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					contacts = []
+					body['results'].each do |contact|
+						contacts << Components::Contact.create(contact)
+					end
+
+					Components::ResultSet.new(contacts, body['meta'])
+				end
+
+
+				# Get contact details for a specific contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] contact_id - Unique contact id
+				# @return [Contact]
+				def get_contact(access_token, contact_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.contact'), contact_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::Contact.create(JSON.parse(response.body))
+				end
+
+
+				# Add a new contact to the Constant Contact account
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Contact] contact - Contact to add
+				# @param [Boolean] action_by_visitor - is the action being taken by the visitor
+				# @return [Contact]
+				def add_contact(access_token, contact, action_by_visitor = false)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
+					param = action_by_visitor ? {'action_by' => 'ACTION_BY_VISITOR'} : nil
+					url = build_url(url, param)
+					payload = contact.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Contact.create(JSON.parse(response.body))
+				end
+
+
+				# Delete contact details for a specific contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] contact_id - Unique contact id
+				# @return [Boolean]
+				def delete_contact(access_token, contact_id)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact'), contact_id)
+					url = build_url(url)
+					response = RestClient.delete(url, get_headers(access_token))
+					response.code == 204
+				end
+
+
+				# Delete a contact from all contact lists
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] contact_id - Contact id to be removed from lists
+				# @return [Boolean]
+				def delete_contact_from_lists(access_token, contact_id)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact_lists'), contact_id)
+					url = build_url(url)
+					response = RestClient.delete(url, get_headers(access_token))
+					response.code == 204
+				end
+
+
+				# Delete a contact from a specific contact list
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] contact_id - Contact id to be removed
+				# @param [Integer] list_id - ContactList to remove the contact from
+				# @return [Boolean]
+				def delete_contact_from_list(access_token, contact_id, list_id)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact_list'), contact_id, list_id)
+					url = build_url(url)
+					response = RestClient.delete(url, get_headers(access_token))
+					response.code == 204
+				end
+
+
+				# Update contact details for a specific contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Contact] contact - Contact to be updated
+				# @param [Boolean] action_by_visitor - is the action being taken by the visitor
+				# @return [Contact]
+				def update_contact(access_token, contact, action_by_visitor = false)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact'), contact.id)
+					param = action_by_visitor ? {'action_by' => 'ACTION_BY_VISITOR'} : nil
+					url = build_url(url, param)
+					payload = contact.to_json
+					response = RestClient.put(url, payload, get_headers(access_token))
+					Components::Contact.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/contact_tracking_service.rb

@@ -0,0 +1,159 @@
+#
+# contact_tracking_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class ContactTrackingService < BaseService
+			class << self
+
+				# Get a result set of bounces for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity
+				def get_bounces(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_bounces'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					bounces = []
+					body['results'].each do |bounce_activity|
+						bounces << Components::BounceActivity.create(bounce_activity)
+					end
+
+					Components::ResultSet.new(bounces, body['meta'])
+				end
+
+
+				# Get clicks for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
+				def get_clicks(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_clicks'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					clicks = []
+					body['results'].each do |click_activity|
+						clicks << Components::ClickActivity.create(click_activity)
+					end
+
+					Components::ResultSet.new(clicks, body['meta'])
+				end
+
+
+				# Get forwards for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
+				def get_forwards(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_forwards'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					forwards = []
+					body['results'].each do |forward_activity|
+						forwards << Components::ForwardActivity.create(forward_activity)
+					end
+
+					Components::ResultSet.new(forwards, body['meta'])
+				end
+
+
+				# Get opens for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
+				def get_opens(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_opens'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					opens = []
+					body['results'].each do |open_activity|
+						opens << Components::OpenActivity.create(open_activity)
+					end
+
+					Components::ResultSet.new(opens, body['meta'])
+				end
+
+
+				# Get sends for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
+				def get_sends(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_sends'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					sends = []
+					body['results'].each do |send_activity|
+						sends << Components::SendActivity.create(send_activity)
+					end
+
+					Components::ResultSet.new(sends, body['meta'])
+				end
+
+
+				# Get unsubscribes for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @param [Hash] param - query parameters to be appended to request
+				# @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
+				def get_unsubscribes(access_token, contact_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_unsubscribes'), contact_id)
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					unsubscribes = []
+					body['results'].each do |unsubscribe_activity|
+						unsubscribes[] = Components::UnsubscribeActivity.create(unsubscribe_activity)
+					end
+
+					Components::ResultSet.new(unsubscribes, body['meta'])
+				end
+
+
+				# Get a summary of reporting data for a given contact
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] contact_id - Contact id
+				# @return [TrackingSummary]
+				def get_summary(access_token, contact_id)
+					url = Util::Config.get('endpoints.base_url') +
+								sprintf(Util::Config.get('endpoints.contact_tracking_summary'), contact_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::TrackingSummary.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end