constantcontact 1.0.0 → 1.0.1

data/lib/constantcontact/exceptions/ctct_exception.rb

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

data/lib/constantcontact/exceptions/illegal_argument_exception.rb

@@ -5,7 +5,7 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Exceptions
-		class IllegalArgumentException < Exception; end
-	end
+  module Exceptions
+    class IllegalArgumentException < Exception; end
+  end
 end

data/lib/constantcontact/exceptions/oauth2_exception.rb

@@ -5,7 +5,7 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Exceptions
-		class OAuth2Exception < Exception; end
-	end
+  module Exceptions
+    class OAuth2Exception < Exception; end
+  end
 end

data/lib/constantcontact/services/account_service.rb

@@ -5,25 +5,25 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Services
-		class AccountService < BaseService
-			class << self
+  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
+        # 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
+    end
+  end
 end

data/lib/constantcontact/services/activity_service.rb

@@ -5,103 +5,103 @@
 # 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
+  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

data/lib/constantcontact/services/base_service.rb

@@ -5,33 +5,33 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Services
-		class BaseService
-			class << self
-				attr_accessor :api_key
+  module Services
+    class BaseService
+      class << self
+        attr_accessor :api_key
 
-				protected
+        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
+        # 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
+        # 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
+    end
+  end
 end

data/lib/constantcontact/services/campaign_schedule_service.rb

@@ -5,103 +5,103 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Services
-		class CampaignScheduleService < BaseService
-			class << self
+  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
+        # 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)
+        # 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 = []
+          body.each do |schedule|
+            schedules << Components::Schedule.create(schedule)
+          end
 
-					schedules
-				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
+        # 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
+        # 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
+        # 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
+        # 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
+    end
+  end
 end