constantcontact 1.0.0

data/lib/constantcontact/services/email_marketing_service.rb

@@ -0,0 +1,87 @@
+#
+# email_marketing_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class EmailMarketingService < BaseService
+			class << self
+
+				# Create a new campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Campaign] campaign - Campaign to be created
+				# @return [Campaign]
+				def add_campaign(access_token, campaign)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
+					url = build_url(url)
+					payload = campaign.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::Campaign.create(JSON.parse(response.body))
+				end
+
+
+				# Get a set of campaigns
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Hash] param - query parameters to be appended to the request
+				# @return [ResultSet<Campaign>]
+				def get_campaigns(access_token, param = nil)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
+					url = build_url(url, param)
+
+					response = RestClient.get(url, get_headers(access_token))
+					body = JSON.parse(response.body)
+
+					campaigns = []
+					body['results'].each do |campaign|
+						campaigns << Components::Campaign.create_summary(campaign)
+					end
+
+					Components::ResultSet.new(campaigns, body['meta'])
+				end
+
+
+				# Get campaign details for a specific campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Valid campaign id
+				# @return [Campaign]
+				def get_campaign(access_token, campaign_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign'), campaign_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::Campaign.create(JSON.parse(response.body))
+				end
+
+
+				# Delete an email campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] campaign_id - Valid campaign id
+				# @return [Boolean]
+				def delete_campaign(access_token, campaign_id)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign'), campaign_id)
+					url = build_url(url)
+					response = RestClient.delete(url, get_headers(access_token))
+					response.code == 204
+				end
+
+
+				# Update a specific email campaign
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Campaign] campaign - Campaign to be updated
+				# @return [Campaign]
+				def update_campaign(access_token, campaign)
+					url = Util::Config.get('endpoints.base_url') + 
+								sprintf(Util::Config.get('endpoints.campaign'), campaign.id)
+					url = build_url(url)
+					payload = campaign.to_json
+					response = RestClient.put(url, payload, get_headers(access_token))
+					Components::Campaign.create(JSON.parse(response.body))
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/services/list_service.rb

@@ -0,0 +1,85 @@
+#
+# list_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Services
+		class ListService < BaseService
+			class << self
+
+				# Get lists within an account
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @return [Array<ContactList>]
+				def get_lists(access_token)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.lists')
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					lists = []
+					JSON.parse(response.body).each do |contact|
+						lists << Components::ContactList.create(contact)
+					end
+					lists
+				end
+
+
+				# Add a new list to the Constant Contact account
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [ContactList] list
+				# @return [ContactList]
+				def add_list(access_token, list)
+					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.lists')
+					url = build_url(url)
+					payload = list.to_json
+					response = RestClient.post(url, payload, get_headers(access_token))
+					Components::ContactList.create(JSON.parse(response.body))
+				end
+
+
+				# Update a Contact List
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [ContactList] list - ContactList to be updated
+				# @return [ContactList]
+				def update_list(access_token, list)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list'), list.id)
+					url = build_url(url)
+					payload = list.to_json
+					response = RestClient.put(url, payload, get_headers(access_token))
+					Components::ContactList.create(JSON.parse(response.body))
+				end
+
+
+				# Get an individual contact list
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] list_id - list id
+				# @return [ContactList]
+				def get_list(access_token, list_id)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list'), list_id)
+					url = build_url(url)
+					response = RestClient.get(url, get_headers(access_token))
+					Components::ContactList.create(JSON.parse(response.body))
+				end
+
+
+				# Get all contacts from an individual list
+				# @param [String] access_token - Constant Contact OAuth2 access token
+				# @param [Integer] list_id - list id to retrieve contacts for
+				# @param [Hash] param - query parameters to attach to request
+				# @return [Array<Contact>]
+				def get_contacts_from_list(access_token, list_id, param = nil)
+					url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list_contacts'), list_id)
+					url = build_url(url, param)
+					response = RestClient.get(url, get_headers(access_token))
+					contacts = []
+					body = JSON.parse(response.body)
+					body['results'].each do |contact|
+						contacts << Components::Contact.create(contact)
+					end
+					Components::ResultSet.new(contacts, body['meta'])
+				end
+
+			end
+		end
+	end
+end

data/lib/constantcontact/util/config.rb

@@ -0,0 +1,140 @@
+#
+# config.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Util
+		class Config
+
+			class << self
+
+				# Return a hash of configuration strings
+				# @return [Hash] - hash of configuration properties
+				def props
+					{
+						# REST endpoints
+						:endpoints => {
+							:base_url                       => 'https://api.constantcontact.com/v2/',
+
+							:activity                       => 'activities/%s',
+							:activities                     => 'activities',
+							:export_contacts_activity       => 'activities/exportcontacts',
+							:clear_lists_activity           => 'activities/clearlists',
+							:remove_from_lists_activity     => 'activities/removefromlists',
+							:add_contacts_activity          => 'activities/addcontacts',
+
+							:account_verified_addresses     => 'account/verifiedemailaddresses',
+
+							:contact                        => 'contacts/%s',
+							:contacts                       => 'contacts',
+							:lists                          => 'lists',
+							:list                           => 'lists/%s',
+							:list_contacts                  => 'lists/%s/contacts',
+							:contact_lists                  => 'contacts/%s/lists',
+							:contact_list                   => 'contacts/%s/lists/%s',
+
+							:campaigns                      => 'emailmarketing/campaigns',
+							:campaign                       => 'emailmarketing/campaigns/%s',
+							:campaign_schedules             => 'emailmarketing/campaigns/%s/schedules',
+							:campaign_schedule              => 'emailmarketing/campaigns/%s/schedules/%s',
+							:campaign_test_sends            => 'emailmarketing/campaigns/%s/tests',
+							:campaign_tracking_summary      => 'emailmarketing/campaigns/%s/tracking/reports/summary',
+							:campaign_tracking_bounces      => 'emailmarketing/campaigns/%s/tracking/bounces',
+							:campaign_tracking_clicks       => 'emailmarketing/campaigns/%s/tracking/clicks',
+							:campaign_tracking_forwards     => 'emailmarketing/campaigns/%s/tracking/forwards',
+							:campaign_tracking_opens        => 'emailmarketing/campaigns/%s/tracking/opens',
+							:campaign_tracking_sends        => 'emailmarketing/campaigns/%s/tracking/sends',
+							:campaign_tracking_unsubscribes => 'emailmarketing/campaigns/%s/tracking/unsubscribes',
+							:campaign_tracking_link         => 'emailmarketing/campaigns/%s/tracking/clicks/%s',
+
+							:contact_tracking_summary       => 'contacts/%s/tracking/reports/summary',
+							:contact_tracking_bounces       => 'contacts/%s/tracking/bounces',
+							:contact_tracking_clicks        => 'contacts/%s/tracking/clicks',
+							:contact_tracking_forwards      => 'contacts/%s/tracking/forwards',
+							:contact_tracking_opens         => 'contacts/%s/tracking/opens',
+							:contact_tracking_sends         => 'contacts/%s/tracking/sends',
+							:contact_tracking_unsubscribes  => 'contacts/%s/tracking/unsubscribes',
+							:contact_tracking_link          => 'contacts/%s/tracking/clicks/%s'
+						},
+
+						# OAuth2 Authorization related configuration options
+						:auth => {
+							:base_url                      => 'https://oauth2.constantcontact.com/oauth2/',
+							:response_type_code            => 'code',
+							:response_type_token           => 'token',
+							:authorization_code_grant_type => 'authorization_code',
+							:authorization_endpoint        => 'oauth/siteowner/authorize',
+							:token_endpoint                => 'oauth/token'
+						},
+
+						# Column names used with bulk activities
+						:activities_columns => {
+							:email            => 'EMAIL',
+							:first_name       => 'FIRST NAME',
+							:middle_name      => 'MIDDLE NAME',
+							:last_name        => 'LAST NAME',
+							:job_title        => 'JOB TITLE',
+							:company_name     => 'COMPANY NAME',
+							:work_phone       => 'WORK PHONE',
+							:home_phone       => 'HOME PHONE',
+							:address1         => 'ADDRESS LINE 1',
+							:address2         => 'ADDRESS LINE 2',
+							:address3         => 'ADDRESS LINE 3',
+							:city             => 'CITY',
+							:state            => 'STATE',
+							:state_province   => 'US STATE/CA PROVINCE',
+							:country          => 'COUNTRY',
+							:postal_code      => 'ZIP/POSTAL CODE',
+							:sub_postal_code  => 'SUB ZIP/POSTAL CODE',
+							:custom_field_1   => 'CUSTOM FIELD 1',
+							:custom_field_2   => 'CUSTOM FIELD 2',
+							:custom_field_3   => 'CUSTOM FIELD 3',
+							:custom_field_4   => 'CUSTOM FIELD 4',
+							:custom_field_5   => 'CUSTOM FIELD 5',
+							:custom_field_6   => 'CUSTOM FIELD 6',
+							:custom_field_7   => 'CUSTOM FIELD 7',
+							:custom_field_8   => 'CUSTOM FIELD 8',
+							:custom_field_9   => 'CUSTOM FIELD 9',
+							:custom_field_10  => 'CUSTOM FIELD 10',
+							:custom_field_11  => 'CUSTOM FIELD 11',
+							:custom_field_12  => 'CUSTOM FIELD 12',
+							:custom_field_13  => 'CUSTOM FIELD 13',
+							:custom_field_14  => 'CUSTOM FIELD 14',
+							:custom_field_15  => 'CUSTOM FIELD 15'
+						},
+
+						# Errors to be returned for various exceptions
+						:errors => {
+							:id_or_object => 'Only an id or %s object are allowed for this method.'
+						}
+					}
+				end
+
+				# Get a configuration property given a specified location, example usage: Config::get('auth.token_endpoint')
+				# @param [String] index - location of the property to obtain
+				# @return [String]
+				def get(index)
+					properties = index.split('.')
+					get_value(properties, props)
+				end
+
+				private
+
+				# Navigate through a config array looking for a particular index
+				# @param [Array] index The index sequence we are navigating down
+				# @param [Hash, String] value The portion of the config array to process
+				# @return [String]
+				def get_value(index, value)
+					index = index.is_a?(Array) ? index : [index]
+					key = index.shift.to_sym
+					value.is_a?(Hash) and value[key] and value[key].is_a?(Hash) ?
+					get_value(index, value[key]) :
+					value[key]
+				end
+			end
+
+		end
+	end
+end

data/lib/constantcontact/util/helpers.rb

@@ -0,0 +1,27 @@
+#
+# helpers.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module Util
+		class Helpers
+			class << self
+			
+				# Build the HTTP query from the given parameters
+				# @param [Hash] params
+				# @return [String] query string
+				def http_build_query(params)
+					params.collect{ |k,v| "#{k.to_s}=#{encode(v.to_s)}" }.reverse.join('&')
+				end
+
+				# Escape special characters
+				# @param [String] str
+				def encode(str)
+					CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+				end
+			end
+		end
+	end
+end

data/lib/constantcontact/version.rb

@@ -0,0 +1,12 @@
+#
+# version.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+	module SDK
+		# Gem version
+		VERSION = "1.0.0"
+	end
+end

data/spec/constantcontact/api_spec.rb

@@ -0,0 +1,183 @@
+#
+# api_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Api do
+	before(:each) do
+		@api = ConstantContact::Api.new('api key')
+	end
+
+	describe "#get_contacts" do
+		it "returns an array of contacts" do
+			json = load_json('contacts.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			contacts = @api.get_contacts('token')
+			contact = contacts.results[0]
+
+			contacts.should be_kind_of(ConstantContact::Components::ResultSet)
+			contact.should be_kind_of(ConstantContact::Components::Contact)
+		end
+	end
+
+	describe "#get_contact" do
+		it "returns a contact" do
+			json = load_json('contact.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			contact = @api.get_contact('token', 1)
+
+			contact.should be_kind_of(ConstantContact::Components::Contact)
+		end
+	end
+
+	describe "#get_contact_by_email" do
+		it "returns a contact" do
+			json = load_json('contacts.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			contacts = @api.get_contact_by_email('token', 'john.smith@gmail.com')
+			contact = contacts.results[0]
+
+			contact.should be_kind_of(ConstantContact::Components::Contact)
+		end
+	end
+
+	describe "#add_contact" do
+		it "adds a contact" do
+			json = load_json('contact.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:post).and_return(response)
+			contact = ConstantContact::Components::Contact.create(JSON.parse(json))
+			added = @api.add_contact('token', contact)
+
+			added.should respond_to(:status)
+			added.status.should eq('REMOVED')
+		end
+	end
+
+	describe "#delete_contact" do
+		it "deletes a contact" do
+			json = load_json('contact.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 204, 'No Content')
+
+			response = RestClient::Response.create('', net_http_resp, {})
+			RestClient.stub(:delete).and_return(response)
+			contact = ConstantContact::Components::Contact.create(JSON.parse(json))
+			@api.delete_contact('token', contact).should be_true
+		end
+	end
+
+	describe "#delete_contact_from_lists" do
+		it "deletes a contact" do
+			json = load_json('contact.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 204, 'No Content')
+
+			response = RestClient::Response.create('', net_http_resp, {})
+			RestClient.stub(:delete).and_return(response)
+			contact = ConstantContact::Components::Contact.create(JSON.parse(json))
+			@api.delete_contact_from_lists('token', contact).should be_true
+		end
+	end
+
+	describe "#delete_contact_from_list" do
+		it "deletes a contact" do
+			contact_json = load_json('contact.json')
+			list_json = load_json('list.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 204, 'No Content')
+
+			response = RestClient::Response.create('', net_http_resp, {})
+			RestClient.stub(:delete).and_return(response)
+			contact = ConstantContact::Components::Contact.create(JSON.parse(contact_json))
+			list = ConstantContact::Components::ContactList.create(JSON.parse(list_json))
+			@api.delete_contact_from_list('token', contact, list).should be_true
+		end
+	end
+
+	describe "#update_contact" do
+		it "updates a contact" do
+			json = load_json('contact.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:put).and_return(response)
+			contact = ConstantContact::Components::Contact.create(JSON.parse(json))
+			added = @api.update_contact('token', contact)
+
+			added.should respond_to(:status)
+			added.status.should eq('REMOVED')
+		end
+	end
+
+	describe "#get_lists" do
+		it "returns an array of lists" do
+			json = load_json('lists.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			lists = @api.get_lists('token')
+			list = lists[0]
+
+			lists.should be_kind_of(Array)
+			list.should be_kind_of(ConstantContact::Components::ContactList)
+		end
+	end
+
+	describe "#get_list" do
+		it "returns a list" do
+			json = load_json('list.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			contact = @api.get_list('token', 1)
+
+			contact.should be_kind_of(ConstantContact::Components::ContactList)
+		end
+	end
+
+	describe "#add_list" do
+		it "adds a list" do
+			json = load_json('list.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json, net_http_resp, {})
+			RestClient.stub(:post).and_return(response)
+			list = ConstantContact::Components::ContactList.create(JSON.parse(json))
+			added = @api.add_list('token', list)
+
+			added.should respond_to(:status)
+			added.status.should eq('ACTIVE')
+		end
+	end
+
+	describe "#get_contacts_from_list" do
+		it "returns an array of contacts" do
+			json_list = load_json('list.json')
+			json_contacts = load_json('contacts.json')
+			net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+			response = RestClient::Response.create(json_contacts, net_http_resp, {})
+			RestClient.stub(:get).and_return(response)
+			list = ConstantContact::Components::ContactList.create(JSON.parse(json_list))
+			contacts = @api.get_contacts_from_list('token', list)
+			contact = contacts.results[0]
+
+			contacts.should be_kind_of(ConstantContact::Components::ResultSet)
+			contact.should be_kind_of(ConstantContact::Components::Contact)
+		end
+	end
+end