constantcontact 1.0.0

data/lib/constantcontact/auth/oauth2.rb

@@ -0,0 +1,82 @@
+#
+# oauth2.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Auth
+		class OAuth2
+			attr_accessor :client_id, :client_secret, :redirect_uri, :props
+
+
+			# Class constructor
+			# @param [Hash] opts - the options to create an OAuth2 object with
+			# @option opts [String] :api_key - the Constant Contact API Key
+			# @option opts [String] :api_secret - the Constant Contact secret key
+			# @option opts [String] :redirect_url - the URL where Constact Contact is returning the authorization code
+			# @return
+			def initialize(opts)
+				@client_id = opts[:api_key]
+				@client_secret = opts[:api_secret]
+				@redirect_uri = opts[:redirect_url]
+			end
+
+
+			# Get the URL at which the user can authenticate and authorize the requesting application
+			# @param [Boolean] server - whether or not to use OAuth2 server flow, alternative is client flow
+			# @return [String] the authorization URL
+			def get_authorization_url(server = true)
+				response_type = server ? Util::Config.get('auth.response_type_code') : Util::Config.get('auth.response_type_token')
+				params = {
+					:response_type => response_type,
+					:client_id     => @client_id,
+					:redirect_uri  => @redirect_uri
+				}
+				[
+					Util::Config.get('auth.base_url'),
+					Util::Config.get('auth.authorization_endpoint'),
+					'?',
+					Util::Helpers.http_build_query(params)
+				].join
+			end
+
+
+			# Obtain an access token
+			# @param [String] code - the code returned from Constant Contact after a user has granted access to his account
+			# @return [String] the access token
+			def get_access_token(code)
+				params = {
+					:grant_type    => Util::Config.get('auth.authorization_code_grant_type'),
+					:client_id     => @client_id,
+					:client_secret => @client_secret,
+					:code          => code,
+					:redirect_uri  => @redirect_uri
+				}
+
+				url = [
+					Util::Config.get('auth.base_url'),
+					Util::Config.get('auth.token_endpoint')
+				].join
+
+				response_body = ''
+				begin
+					response = RestClient.post(url, params)
+					response_body = JSON.parse(response)
+				rescue => e
+					response_body = e.respond_to?(:response) ?
+						JSON.parse(e.response) :
+						{'error' => '', 'error_description' => e.message}
+				end
+
+				if response_body['error_description']
+					error = response_body['error_description']
+					raise Exceptions::OAuth2Exception, error
+				end
+
+				response_body
+			end
+
+		end
+	end
+end

data/lib/constantcontact/auth/session_data_store.rb

@@ -0,0 +1,69 @@
+#
+# session_data_store.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Auth
+		class Session
+			attr_accessor :session
+
+			# Create and initialize the session
+			def initialize
+				cgi = CGI.new('html4')
+
+				# We make sure to delete an old session if one exists,
+				# not just to free resources, but to prevent the session
+				# from being maliciously hijacked later on.
+				begin
+					@session = CGI::Session.new(cgi, 'database_manager' => CGI::Session::PStore, 'new_session' => false)
+					@session.delete
+				rescue ArgumentError # if no old session
+				end
+				@session = CGI::Session.new(cgi, 'database_manager' => CGI::Session::PStore, 'new_session' => true)
+				@session['datastore'] = {}
+			end
+
+			# Add a new user to the data store
+			# @param [String] username - Constant Contact username
+			# @param [Hash] params - additional parameters
+			# @return
+			def add_user(username, params)
+				@session['datastore'][username] = params
+			end
+
+			# Get an existing user from the data store
+			# @param [String] username - Constant Contact username key
+			# @return [String] The username value
+			def get_user(username)
+				@session['datastore'].has_key?(username) ? @session['datastore'][username] : false
+			end
+
+			# Update an existing user in the data store
+			# @param [String] username - Constant Contact username
+			# @param [Hash] params - additional parameters
+			# @return
+			def update_user(username, params)
+				if @session['datastore'].has_key?(username)
+					@session['datastore'][username] = params
+				end
+			end
+
+			# Delete an existing user from the data store
+			# @param [String] username - Constant Contact username
+			# @return
+			def delete_user(username)
+				@session['datastore'][username] = nil
+			end
+
+			# Close current session
+			# @return
+			def close
+				@session.close
+			end
+
+		end
+	end
+end
+

data/lib/constantcontact/components/account/verified_email_address.rb

@@ -0,0 +1,27 @@
+#
+# verified_email_address.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class VerifiedEmailAddress < Component
+			attr_accessor :status, :email_address
+
+			# Factory method to create a VerifiedEmailAddress object from a json string
+			# @param [Hash] props - array of properties to create object from
+			# @return [VerifiedEmailAddress]
+			def self.create(props)
+				email_address = VerifiedEmailAddress.new
+				if props
+					props.each do |key, value|
+						email_address.send("#{key}=", value)
+					end
+				end
+				email_address
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/activities/activity.rb

@@ -0,0 +1,44 @@
+#
+# activity.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Activity < Component
+			attr_accessor :id, :type, :status, :start_date, :finish_date, :file_name, :created_date,
+										:error_count, :errors, :warnings, :contact_count
+
+			# Factory method to create an Activity object from a json string
+			# @param [Hash] props - hash of properties to create object from
+			# @return [Activity]
+			def self.create(props)
+				activity = Activity.new
+				if props
+					props.each do |key, value|
+						if key == 'errors'
+							if value
+								activity.errors = []
+								value.each do |error|
+									activity.errors << Components::ActivityError.create(error)
+								end
+							end
+						elsif key == 'warnings'
+							if value
+								activity.warnings = []
+								value.each do |error|
+									activity.warnings << Components::ActivityError.create(error)
+								end
+							end
+						else
+							activity.send("#{key}=", value)
+						end
+					end
+				end
+				activity
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/activities/activity_error.rb

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

data/lib/constantcontact/components/activities/add_contacts.rb

@@ -0,0 +1,117 @@
+#
+# add_contacts.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class AddContacts < Component
+			attr_accessor :import_data, :lists, :column_names
+
+			# Constructor to create an AddContacts object from the given contacts and contact lists
+			# @param [Array<Contact>] contacts - contacts array
+			# @param [Array<ContactList>] lists - contact lists array]
+			# @param [Array<String>] column_names - array of column names
+			# @return [AddContacts]
+			def initialize(contacts, lists, column_names = [])
+				if !contacts.empty?
+					if contacts[0].instance_of?(Components::AddContactsImportData)
+						@import_data = contacts
+					else
+						raise Exceptions::IllegalArgumentException, sprintf(Util::Config.get('errors.id_or_object'), 'AddContactsImportData')
+					end
+				end
+
+				@lists = lists
+				@column_names = column_names
+
+				# attempt to determine the column names being used if they are not provided
+				if column_names.empty?
+					used_columns = [Util::Config.get('activities_columns.email')]
+
+					contact = contacts[0]
+
+					if !contact.first_name.nil?
+						used_columns << Util::Config.get('activities_columns.first_name')
+					end
+
+					if !contact.middle_name.nil?
+						used_columns << Util::Config.get('activities_columns.middle_name')
+					end
+
+					if !contact.last_name.nil?
+						used_columns << Util::Config.get('activities_columns.last_name')
+					end
+
+					if !contact.job_title.nil?
+						used_columns << Util::Config.get('activities_columns.job_title')
+					end
+
+					if !contact.company_name.nil?
+						used_columns << Util::Config.get('activities_columns.company_name')
+					end
+
+					if !contact.work_phone.nil?
+						used_columns << Util::Config.get('activities_columns.work_phone')
+					end
+
+					if !contact.home_phone.nil?
+						used_columns << Util::Config.get('activities_columns.home_phone')
+					end
+
+					address = contact.addresses[0]
+
+					if !address.line1.nil?
+						used_columns << Util::Config.get('activities_columns.address1')
+					end
+
+					if !address.line2.nil?
+						used_columns << Util::Config.get('activities_columns.address2')
+					end
+
+					if !address.line3.nil?
+						used_columns << Util::Config.get('activities_columns.address3')
+					end
+
+					if !address.city.nil?
+						used_columns << Util::Config.get('activities_columns.city')
+					end
+
+					if !address.state_code.nil?
+						used_columns << Util::Config.get('activities_columns.state')
+					end
+
+					if !address.state_code.nil?
+						used_columns << Util::Config.get('activities_columns.state_province')
+					end
+
+					if !address.country_code.nil?
+						used_columns << Util::Config.get('activities_columns.country')
+					end
+
+					if !address.postal_code.nil?
+						used_columns << Util::Config.get('activities_columns.postal_code')
+					end
+
+					if !address.sub_postal_code.nil?
+						used_columns << Util::Config.get('activities_columns.sub_postal_code')
+					end
+
+					# Custom Fields
+					if !contact.custom_fields.nil?
+						contact.custom_fields.each do |custom_field|
+							if custom_field.name.match('custom_field_')
+								custom_field_number = custom_field.name[13, custom_field.length]
+								used_columns << Util::Config.get('activities_columns.custom_field_' + custom_field_number)
+							end
+						end
+					end
+
+					@column_names = used_columns
+				end
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/activities/add_contacts_import_data.rb

@@ -0,0 +1,45 @@
+#
+# add_contacts_import_data.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class AddContactsImportData < Component
+			attr_accessor :first_name, :middle_name, :last_name, :job_title, :company_name,
+										:work_phone, :home_phone, :email_addresses, :addresses, :custom_fields
+
+
+			# Constructor to create an AddContactsImportData object from the given hash
+			# @param [Hash] props - the hash with properties
+			# @return [AddContactsImportData]
+			def initialize(props = {})
+				instance_variables.each do |property, value|
+					send("#{property}=", get_value(props, property))
+				end
+			end
+
+			# Setter
+			def add_custom_field(custom_field)
+				@custom_fields = [] if @custom_fields.nil?
+				@custom_fields << custom_field
+			end
+
+
+			# Setter
+			def add_address(address)
+				@addresses = [] if @addresses.nil?
+				@addresses << address
+			end
+
+
+			# Setter
+			def add_email(email_address)
+				@email_addresses = [] if @email_addresses.nil?
+				@email_addresses << email_address
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/activities/export_contacts.rb

@@ -0,0 +1,30 @@
+#
+# export_contacts.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class ExportContacts < Component
+			attr_accessor :file_type, :sort_by, :export_date_added,
+										:export_added_by, :lists, :column_names
+
+
+			# Constructor to create an ExportContacts object
+			# @param [Array] lists - array of lists ids
+			# @return [ExportContacts]
+			def initialize(lists = nil)
+				if !lists.nil?
+					@lists = lists
+				end
+				@file_type = 'CSV'
+				@sort_by = 'EMAIL_ADDRESS'
+				@export_date_added = true
+				@export_added_by = true
+				@column_names = ['Email Address', 'First Name', 'Last Name']
+			end
+
+		end
+	end
+end