constantcontact 1.0.0

data/lib/constantcontact/components/result_set.rb

@@ -0,0 +1,27 @@
+#
+# result_set.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class ResultSet
+			attr_accessor :results, :next
+
+
+			# Constructor to create a ResultSet from the results/meta response when performing a get on a collection
+			# @param [Array<Hash>] results - results array from request
+			# @param [Hash] meta - meta hash from request
+			def initialize(results, meta)
+				@results = results
+
+				if meta.has_key?('pagination') and meta['pagination'].has_key?('next_link')
+					next_link = meta['pagination']['next_link']
+					@next = next_link[next_link.index('?'), next_link.length]
+				end
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/bounce_activity.rb

@@ -0,0 +1,29 @@
+#
+# bounce_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class BounceActivity < Component
+			attr_accessor :activity_type, :bounce_code, :bounce_description, :bounce_message, :bounce_date,
+										:contact_id, :email_address, :campaign_id
+
+
+			# Factory method to create a BounceActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [BounceActivity]
+			def self.create(props)
+				bounce_activity = BounceActivity.new
+				if props
+					props.each do |key, value|
+						bounce_activity.send("#{key}=", value)
+					end
+				end
+				bounce_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/click_activity.rb

@@ -0,0 +1,28 @@
+#
+# click_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class ClickActivity < Component
+			attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :link_id, :click_date
+
+
+			# Factory method to create a ClickActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [ClickActivity]
+			def self.create(props)
+				click_activity = ClickActivity.new
+				if props
+					props.each do |key, value|
+						click_activity.send("#{key}=", value)
+					end
+				end
+				click_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/forward_activity.rb

@@ -0,0 +1,28 @@
+#
+# forward_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class ForwardActivity < Component
+			attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :forward_date
+
+
+			# Factory method to create a ForwardActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [ForwardActivity]
+			def self.create(props)
+				forward_activity = ForwardActivity.new
+				if props
+					props.each do |key, value|
+						forward_activity.send("#{key}=", value)
+					end
+				end
+				forward_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/open_activity.rb

@@ -0,0 +1,28 @@
+#
+# open_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class OpenActivity < Component
+			attr_accessor :activity_type, :campaign_id, :email_address, :open_date, :contact_id
+
+
+			# Factory method to create an OpenActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [OpenActivity]
+			def self.create(props)
+				open_activity = OpenActivity.new
+				if props
+					props.each do |key, value|
+						open_activity.send("#{key}=", value)
+					end
+				end
+				open_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/send_activity.rb

@@ -0,0 +1,28 @@
+#
+# send_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class SendActivity < Component
+			attr_accessor :activity_type, :campaign_id, :email_address, :contact_id, :send_date
+
+
+			# Factory method to create a SendActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [SendActivity]
+			def self.create(props)
+				send_activity = SendActivity.new
+				if props
+					props.each do |key, value|
+						send_activity.send("#{key}=", value)
+					end
+				end
+				send_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/tracking_activity.rb

@@ -0,0 +1,27 @@
+#
+# tracking_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class TrackingActivity < Component
+			attr_accessor :results, :next
+
+
+			# Constructor to create a TrackingActivity from the results/pagination response from getting a set of activities
+			# @param [Array] results - results array from a tracking endpoint
+			# @param [Hash] pagination - pagination hash returned from a tracking endpoint
+			# @return [TrackingActivity] 
+			def initialize(results, pagination)
+				@results = results
+
+				if (pagination.has_key?('next'))
+					@next = pagination['next'][pagination['next'].index('&next=') + 6, pagination['next'].length]
+				end
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/tracking_summary.rb

@@ -0,0 +1,28 @@
+#
+# tracking_summary.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class TrackingSummary < Component
+			attr_accessor :sends, :opens, :clicks, :forwards, :unsubscribes, :bounces, :contact_id
+
+
+			# Factory method to create a TrackingSummary object from an array
+			# @param [Hash] props - array of properties to create object from
+			# @return [TrackingSummary]
+			def self.create(props)
+				tracking_summary = TrackingSummary.new
+				if props
+					props.each do |key, value|
+						tracking_summary.send("#{key}=", value)
+					end
+				end
+				tracking_summary
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/tracking/unsubscribe_activity.rb

@@ -0,0 +1,29 @@
+#
+# unsubscribe_activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class UnsubscribeActivity < Component
+			attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :unsubscribe_date,
+										:unsubscribe_source, :unsubscribe_reason
+
+
+			# Factory method to create an UnsubscribeActivity object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [UnsubscribeActivity]
+			def self.create(props)
+				unsubscribe_activity = UnsubscribeActivity.new
+				if props
+					props.each do |key, value|
+						unsubscribe_activity.send("#{key}=", value)
+					end
+				end
+				unsubscribe_activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/exceptions/ctct_exception.rb

@@ -0,0 +1,25 @@
+#
+# ctct_exception.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Exceptions
+		class CtctException < Exception
+			attr_accessor :errors
+
+			# Setter
+			# @param [Array<String>] errors
+			def set_errors(errors)
+				@errors = errors
+			end
+
+			# Getter
+			# @return [Array<String>]
+			def get_errors
+				@errors
+			end
+		end
+	end
+end

data/lib/constantcontact/exceptions/illegal_argument_exception.rb

@@ -0,0 +1,11 @@
+#
+# illegal_argument_exception.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Exceptions
+		class IllegalArgumentException < Exception; end
+	end
+end

data/lib/constantcontact/exceptions/oauth2_exception.rb

@@ -0,0 +1,11 @@
+#
+# oauth2_exception.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Exceptions
+		class OAuth2Exception < Exception; end
+	end
+end

data/lib/constantcontact/services/account_service.rb

@@ -0,0 +1,29 @@
+#
+# email_address_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class AccountService < BaseService
+			class << self
+
+				# Get the verified emails from account
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @return [Array<VerifiedEmailAddress>]
+				def get_verified_email_addresses(access_token)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.account_verified_addresses')
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					email_addresses = []
+					JSON.parse(response.body).each do |email_address|
+						email_addresses << Components::VerifiedEmailAddress.create(email_address)
+					end
+					email_addresses
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/activity_service.rb

@@ -0,0 +1,107 @@
+#
+# activity_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class ActivityService < BaseService
+			class << self
+
+				# Get a set of activities
+				# @param [String] access_token
+				# @return [Array<Activity>]
+				def get_activities(access_token)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.activities')
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+
+					activities = []
+					JSON.parse(response.body).each do |activity|
+						activities << Components::Activity.create(activity)
+					end
+
+					activities
+				end
+
+
+				# Get an array of activities
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [String] activity_id - Activity id
+				# @return [Activity]
+				def get_activity(access_token, activity_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.activity'), activity_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::Activity.create(JSON.parse(response.body))
+				end
+
+
+				# Create an Add Contacts Activity
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [AddContacts] add_contacts
+				# @return [Activity]
+				def create_add_contacts_activity(access_token, add_contacts)
+					url = Util::Config.get('endpoints.base_url') + 
+								Util::Config.get('endpoints.add_contacts_activity')
+					url = build_url(url)
+					payload = add_contacts.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Activity.create(JSON.parse(response.body))
+				end
+
+
+				# Create a Clear Lists Activity
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Array<lists>] lists - array of list id's to be cleared
+				# @return [Activity]
+				def add_clear_lists_activity(access_token, lists)
+					url = Util::Config.get('endpoints.base_url') + 
+								Util::Config.get('endpoints.clear_lists_activity')
+					url = build_url(url)
+					payload = {'lists' => lists}.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Activity.create(JSON.parse(response.body))
+				end
+
+
+				# Create an Export Contacts Activity
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [ExportContacts] export_contacts
+				# @return [Activity]
+				def add_export_contacts_activity(access_token, export_contacts)
+					url = Util::Config.get('endpoints.base_url') + 
+								Util::Config.get('endpoints.export_contacts_activity')
+					url = build_url(url)
+					payload = export_contacts.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Activity.create(JSON.parse(response.body))
+				end
+
+
+				# Create a Remove Contacts From Lists Activity
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [<Array>EmailAddress] email_addresses
+				# @param [<Array>RemoveFromLists] lists
+				# @return [Activity]
+				def add_remove_contacts_from_lists_activity(access_token, email_addresses, lists)
+					url = Util::Config.get('endpoints.base_url') + 
+								Util::Config.get('endpoints.remove_from_lists_activity')
+					url = build_url(url)
+
+					payload = { 'import_data' => [], 'lists' => lists }
+					email_addresses.each do |email_address|
+						payload['import_data'] << { 'email_addresses' => [email_address] }
+					end
+					payload = payload.to_json
+
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Activity.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end