constantcontact 1.0.0

data/lib/constantcontact/components/component.rb

@@ -0,0 +1,23 @@
+#
+# component.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Component
+			protected
+
+			# Get the requested value from a hash, or return the default
+			# @param [Hash] hsh - the hash to search for the provided hash key
+			# @param [String] key - hash key to look for
+			# @param [String] default - value to return if the key is not found, default is null
+			# @return [String]
+			def self.get_value(hsh, key, default = nil)
+				hsh.has_key?(key) and hsh[key] ? hsh[key] : default
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/contacts/address.rb

@@ -0,0 +1,28 @@
+#
+# address.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Address < Component
+			attr_accessor :id, :line1, :line2, :line3, :city, :address_type, :state_code,
+										:country_code, :postal_code, :sub_postal_code
+
+			# Factory method to create an Address object from a json string
+			# @param [Hash] props - array of properties to create object from
+			# @return [Address]
+			def self.create(props)
+				address = Address.new
+				if props
+					props.each do |key, value|
+						address.send("#{key}=", value)
+					end
+				end
+				address
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/contacts/contact.rb

@@ -0,0 +1,86 @@
+#
+# contact.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Contact < Component
+
+			attr_accessor :id, :status, :first_name, :middle_name, :last_name, :confirmed, :email_addresses,
+										:prefix_name, :job_title, :addresses, :company_name, :home_phone,
+										:work_phone, :cell_phone, :fax, :custom_fields, :lists,
+										:source_details, :source_is_url, :web_url, :modified_date,
+										:created_date, :notes, :source
+
+
+			# Factory method to create a Contact object from a json string
+			# @param [Hash] props - JSON string representing a contact
+			# @return [Contact]
+			def self.create(props)
+				contact = Contact.new
+				if props
+					props.each do |key, value|
+						if key == 'email_addresses'
+							if value
+								contact.email_addresses = []
+								value.each do |email_address|
+									contact.email_addresses << Components::EmailAddress.create(email_address)
+								end
+							end
+						elsif key == 'addresses'
+							if value
+								contact.addresses = []
+								value.each do |address|
+									contact.addresses << Components::Address.create(address)
+								end
+							end
+						elsif key == 'custom_fields'
+							if value
+								contact.custom_fields = []
+								value.each do |custom_field|
+									contact.custom_fields << Components::CustomField.create(custom_field)
+								end
+							end
+						elsif key == 'lists'
+							if value
+								contact.lists = []
+								value.each do |contact_list|
+									contact.lists << Components::ContactList.create(contact_list)
+								end
+							end
+						else
+							contact.send("#{key}=", value)
+						end
+					end
+				end
+				contact
+			end
+
+			# Setter
+			# @param [ContactList] contact_list
+			def add_list(contact_list)
+				@lists = [] if @lists.nil?
+				@lists << contact_list
+			end
+
+
+			# Setter
+			# @param [EmailAddress] email_address
+			def add_email(email_address)
+				@email_addresses = [] if @email_addresses.nil?
+				@email_addresses << email_address
+			end
+
+
+			# Setter
+			# @param [Address] address
+			def add_address(address)
+				@addresses = [] if @addresses.nil?
+				@addresses << address
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/contacts/contact_list.rb

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

data/lib/constantcontact/components/contacts/custom_field.rb

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

data/lib/constantcontact/components/contacts/email_address.rb

@@ -0,0 +1,34 @@
+#
+# email_address.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class EmailAddress < Component
+			attr_accessor :id, :status, :confirm_status, :opt_in_source, :opt_in_date, :opt_out_date, :email_address
+
+			# Class constructor
+			# @param [String] email_address
+			# @return [EmailAddress]
+			def initialize(email_address = nil)
+				@email_address = email_address if email_address
+			end
+
+			# Factory method to create an EmailAddress object from a json string
+			# @param [Hash] props - array of properties to create object from
+			# @return [EmailAddress]
+			def self.create(props)
+				email_address = EmailAddress.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/contacts/note.rb

@@ -0,0 +1,25 @@
+#
+# note.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Note < Component
+			attr_accessor :id, :note, :created_date
+
+			# Factory method to create a Note object from a json string
+			# @param props - JSON string representing a contact
+			# @return Note
+			def self.create(props)
+				note = Note.new
+				if props
+					props.each do |key, value|
+						note.send("#{key}=", value)
+					end
+				end
+				note
+		end
+	end
+end

data/lib/constantcontact/components/email_marketing/campaign.rb

@@ -0,0 +1,83 @@
+#
+# email_campaign.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Campaign < Component
+			attr_accessor :id, :name, :subject, :status, :from_name, :from_email, :reply_to_email, :template_type,
+										:created_date, :modified_date, :last_run_date, :next_run_date,
+										:is_permission_reminder_enabled, :permission_reminder_text,
+										:is_view_as_webpage_enabled, :view_as_web_page_text, :view_as_web_page_link_text,
+										:greeting_salutations, :greeting_name, :greeting_string, :email_content, :text_content,
+										:message_footer, :tracking_summary, :email_content_format, :style_sheet, :sent_to_contact_lists,
+										:click_through_details, :include_forward_email, :is_visible_in_ui
+
+
+			# Factory method to create an EmailCampaign object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [Campaign]
+			def self.create(props)
+				campaign = Campaign.new
+				if props
+					props.each do |key, value|
+						if key == 'message_footer'
+							campaign.message_footer = Components::MessageFooter.create(value)
+						elsif key == 'tracking_summary'
+							campaign.tracking_summary = Components::TrackingSummary.create(value)
+						elsif key == 'sent_to_contact_lists'
+							if value
+								campaign.sent_to_contact_lists = []
+								value.each do |sent_to_contact_list|
+									campaign.sent_to_contact_lists << Components::ContactList.create(sent_to_contact_list)
+								end
+							end
+						elsif key == 'click_through_details'
+							if value
+								campaign.click_through_details = []
+								value.each do |click_through_details|
+									campaign.click_through_details << Components::ClickThroughDetails.create(click_through_details)
+								end
+							end
+						else
+							campaign.send("#{key}=", value)
+						end
+					end
+				end
+				campaign
+			end
+
+
+			# Factory method to create a Campaign object from an array
+			# @param [Hash] props - hash of initial properties to set
+			# @return [Campaign]
+			def self.create_summary(props)
+				campaign = Campaign.new
+				if props
+					props.each do |key, value|
+						campaign.send("#{key}=", value)
+					end
+				end
+				campaign
+			end
+
+
+			# Add a contact list to set of lists associated with this email
+			# @param [Mixed] contact_list - Contact list id, or ContactList object
+			def add_list(contact_list)
+				if contact_list.instance_of?(ContactList)
+					list = contact_list
+				elsif contact_list.to_i.to_s == contact_list
+					list = ContactList.new(contact_list)
+				else
+					raise Exceptions::IllegalArgumentException, sprintf(Util::Config.get('errors.id_or_object'), 'ContactList')
+				end
+
+				@sent_to_contact_lists << list
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/email_marketing/click_through_details.rb

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

data/lib/constantcontact/components/email_marketing/message_footer.rb

@@ -0,0 +1,30 @@
+#
+# message_footer.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class MessageFooter < Component
+			attr_accessor :city, :state, :country, :organization_name, :address_line_1,
+										:address_line_2, :address_line_3, :international_state,
+										:postal_code, :include_forward_email, :forward_email_link_text,
+										:include_subscribe_link, :subscribe_link_text
+
+			# Factory method to create a MessageFooter object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [MessageFooter]
+			def self.create(props)
+				message_footer = MessageFooter.new
+				if props
+					props.each do |key, value|
+						message_footer.send("#{key}=", value)
+					end
+				end
+				message_footer
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/email_marketing/schedule.rb

@@ -0,0 +1,29 @@
+#
+# schedule.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class Schedule < Component
+			attr_accessor :id, :scheduled_date
+
+
+			# Factory method to create a Schedule object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [Schedule]
+			def self.create(props)
+				schedule = Schedule.new
+				if props
+					props = props.first if props.is_a?(Array)
+					props.each do |key, value|
+						schedule.send("#{key}=", value)
+					end
+				end
+				schedule
+			end
+
+		end
+	end
+end

data/lib/constantcontact/components/email_marketing/test_send.rb

@@ -0,0 +1,45 @@
+#
+# test_send.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Components
+		class TestSend < Component
+			attr_accessor :format, :personal_message, :email_addresses
+
+
+			# Factory method to create a TestSend object from an array
+			# @param [Hash] props - hash of properties to create object from
+			# @return [TestSend]
+			def self.create(props)
+				test_send = TestSend.new
+				if props
+					props.each do |key, value|
+						if key == 'email_addresses'
+							if value
+								test_send.email_addresses = []
+								value.each do |email_address|
+									test_send.email_addresses << email_address
+								end
+							end
+						else
+							test_send.send("#{key}=", value)
+						end
+					end
+				end
+				test_send
+			end
+
+
+			# Add an email address to the set of addresses to send the test send too
+			# @param [String] email_address
+			def add_email(email_address)
+				@email_addresses = [] if @email_addresses.nil?
+				@email_addresses << email_address
+			end
+
+		end
+	end
+end