constantcontact 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  metadata.gz: ce4ab04068029132c0a484c8de77cdffa0a4eda24eeb8e42806266f0935151255a3d270b5c133aba9e337c87788597386cec2b5de64c1e81fe33c9a473d02076
-  data.tar.gz: 19c32b1028d217e47bc65a3e145d666b5b57b67a9b58692e75ca6f25fb8f16daecb6e43f8392038a51eb2324f4907db5398884c9746270b3eeb422048904b214
-SHA1: 
-  metadata.gz: e6944720fbf8a0b247595feb9676859612b53376
-  data.tar.gz: d2294f919b1f9d7292618c7a817ff29e0bc09987
+---
+SHA1:
+  metadata.gz: 3f4035ebff0d2fa600a1671cf3aec57955f32e57
+  data.tar.gz: c395ffc1e0e64498f04f49f1850b63ee7c798ecf
+SHA512:
+  metadata.gz: 2a6c7fb69db0876b55e1d26215d940520d0fd612dcd219bdebfb75bde753b9c32798127db1ac74012719c37068ca26fe03bdac9e8873ed8bfe44d232f0d2bd4c
+  data.tar.gz: 8edaaebe146ff2b94f22604a97704fdbcad79041e0460ba79cc6995aa6f34eda229b41a8233ba080c1824dcf9c4ac722f35e50b614e11d5935debb9bc12a5bc6

data/README.md

@@ -70,6 +70,13 @@ Follow the link, go through all the Constant Contact steps required
 and then you will be redirected back to your action and you should see the list of contacts.
 
 
+6. Add config initializer (optional)
+````ruby
+    ConstantContact::Util::Config.configure do |config|
+      config[:auth][:api_key] = 'foobar'
+      config[:auth][:api_secret] = 'foobar'
+    end
+
 B. Sinatra example :
 
 

data/constantcontact.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Constant Contact SDK for Ruby}
   s.email = "apisupport@constantcontact.com"
   s.description = "Ruby library for interactions with Constant Contact v2 API"
-  s.version = "1.0.0"
+  #s.version = "1.0.0"
   s.license = "MIT"
 
   s.files = [

data/lib/constantcontact.rb

@@ -13,63 +13,63 @@ require 'cgi/session/pstore'
 
 
 module ConstantContact
-	autoload :Api, "constantcontact/api"
+  autoload :Api, "constantcontact/api"
 
-	module Auth
-		autoload :OAuth2, "constantcontact/auth/oauth2"
-		autoload :Session, "constantcontact/auth/session_data_store"
-	end
+  module Auth
+    autoload :OAuth2, "constantcontact/auth/oauth2"
+    autoload :Session, "constantcontact/auth/session_data_store"
+  end
 
-	module Components
-		autoload :Component, "constantcontact/components/component"
-		autoload :ResultSet, "constantcontact/components/result_set"
-		autoload :Activity, "constantcontact/components/activities/activity"
-		autoload :ActivityError, "constantcontact/components/activities/activity_error"
-		autoload :AddContacts, "constantcontact/components/activities/add_contacts"
-		autoload :AddContactsImportData, "constantcontact/components/activities/add_contacts_import_data"
-		autoload :ExportContacts, "constantcontact/components/activities/export_contacts"
-		autoload :Address, "constantcontact/components/contacts/address"
-		autoload :Contact, "constantcontact/components/contacts/contact"
-		autoload :ContactList, "constantcontact/components/contacts/contact_list"
-		autoload :CustomField, "constantcontact/components/contacts/custom_field"
-		autoload :EmailAddress, "constantcontact/components/contacts/email_address"
-		autoload :Note, "constantcontact/components/contacts/note"
-		autoload :ClickThroughDetails, "constantcontact/components/email_marketing/click_through_details"
-		autoload :Campaign, "constantcontact/components/email_marketing/campaign"
-		autoload :MessageFooter, "constantcontact/components/email_marketing/message_footer"
-		autoload :Schedule, "constantcontact/components/email_marketing/schedule"
-		autoload :TestSend, "constantcontact/components/email_marketing/test_send"
-		autoload :BounceActivity, "constantcontact/components/tracking/bounce_activity"
-		autoload :ClickActivity, "constantcontact/components/tracking/click_activity"
-		autoload :ForwardActivity, "constantcontact/components/tracking/forward_activity"
-		autoload :OpenActivity, "constantcontact/components/tracking/open_activity"
-		autoload :OptOutActivity, "constantcontact/components/tracking/opt_out_activity"
-		autoload :SendActivity, "constantcontact/components/tracking/send_activity"
-		autoload :TrackingActivity, "constantcontact/components/tracking/tracking_activity"
-		autoload :TrackingSummary, "constantcontact/components/tracking/tracking_summary"
-		autoload :VerifiedEmailAddress, "constantcontact/components/account/verified_email_address"
-	end
+  module Components
+    autoload :Component, "constantcontact/components/component"
+    autoload :ResultSet, "constantcontact/components/result_set"
+    autoload :Activity, "constantcontact/components/activities/activity"
+    autoload :ActivityError, "constantcontact/components/activities/activity_error"
+    autoload :AddContacts, "constantcontact/components/activities/add_contacts"
+    autoload :AddContactsImportData, "constantcontact/components/activities/add_contacts_import_data"
+    autoload :ExportContacts, "constantcontact/components/activities/export_contacts"
+    autoload :Address, "constantcontact/components/contacts/address"
+    autoload :Contact, "constantcontact/components/contacts/contact"
+    autoload :ContactList, "constantcontact/components/contacts/contact_list"
+    autoload :CustomField, "constantcontact/components/contacts/custom_field"
+    autoload :EmailAddress, "constantcontact/components/contacts/email_address"
+    autoload :Note, "constantcontact/components/contacts/note"
+    autoload :ClickThroughDetails, "constantcontact/components/email_marketing/click_through_details"
+    autoload :Campaign, "constantcontact/components/email_marketing/campaign"
+    autoload :MessageFooter, "constantcontact/components/email_marketing/message_footer"
+    autoload :Schedule, "constantcontact/components/email_marketing/schedule"
+    autoload :TestSend, "constantcontact/components/email_marketing/test_send"
+    autoload :BounceActivity, "constantcontact/components/tracking/bounce_activity"
+    autoload :ClickActivity, "constantcontact/components/tracking/click_activity"
+    autoload :ForwardActivity, "constantcontact/components/tracking/forward_activity"
+    autoload :OpenActivity, "constantcontact/components/tracking/open_activity"
+    autoload :OptOutActivity, "constantcontact/components/tracking/opt_out_activity"
+    autoload :SendActivity, "constantcontact/components/tracking/send_activity"
+    autoload :TrackingActivity, "constantcontact/components/tracking/tracking_activity"
+    autoload :TrackingSummary, "constantcontact/components/tracking/tracking_summary"
+    autoload :VerifiedEmailAddress, "constantcontact/components/account/verified_email_address"
+  end
 
-	module Exceptions
-		autoload :CtctException, "constantcontact/exceptions/ctct_exception"
-		autoload :IllegalArgumentException, "constantcontact/exceptions/illegal_argument_exception"
-		autoload :OAuth2Exception, "constantcontact/exceptions/oauth2_exception"
-	end
+  module Exceptions
+    autoload :CtctException, "constantcontact/exceptions/ctct_exception"
+    autoload :IllegalArgumentException, "constantcontact/exceptions/illegal_argument_exception"
+    autoload :OAuth2Exception, "constantcontact/exceptions/oauth2_exception"
+  end
 
-	module Services
-		autoload :BaseService, "constantcontact/services/base_service"
-		autoload :ActivityService, "constantcontact/services/activity_service"
-		autoload :CampaignScheduleService, "constantcontact/services/campaign_schedule_service"
-		autoload :CampaignTrackingService, "constantcontact/services/campaign_tracking_service"
-		autoload :ContactService, "constantcontact/services/contact_service"
-		autoload :ContactTrackingService, "constantcontact/services/contact_tracking_service"
-		autoload :EmailMarketingService, "constantcontact/services/email_marketing_service"
-		autoload :ListService, "constantcontact/services/list_service"
-		autoload :AccountService, "constantcontact/services/account_service"
-	end
+  module Services
+    autoload :BaseService, "constantcontact/services/base_service"
+    autoload :ActivityService, "constantcontact/services/activity_service"
+    autoload :CampaignScheduleService, "constantcontact/services/campaign_schedule_service"
+    autoload :CampaignTrackingService, "constantcontact/services/campaign_tracking_service"
+    autoload :ContactService, "constantcontact/services/contact_service"
+    autoload :ContactTrackingService, "constantcontact/services/contact_tracking_service"
+    autoload :EmailMarketingService, "constantcontact/services/email_marketing_service"
+    autoload :ListService, "constantcontact/services/list_service"
+    autoload :AccountService, "constantcontact/services/account_service"
+  end
 
-	module Util
-		autoload :Config, "constantcontact/util/config"
-		autoload :Helpers, "constantcontact/util/helpers"
-	end
+  module Util
+    autoload :Config, "constantcontact/util/config"
+    autoload :Helpers, "constantcontact/util/helpers"
+  end
 end

data/lib/constantcontact/api.rb

@@ -6,12 +6,14 @@
 
 module ConstantContact
 	class Api
-
 		# Class constructor
 		# @param [String] api_key - Constant Contact API Key
 		# @return
-		def initialize(api_key)
-			Services::BaseService.api_key = api_key
+		def initialize(api_key = nil)
+			Services::BaseService.api_key = api_key || Util::Config.get('auth.api_key')
+			if Services::BaseService.api_key.nil? || Services::BaseService.api_key == ''
+				raise ArgumentError.new("api_key required either explicitly or in configuration.")
+			end
 		end
 
 

data/lib/constantcontact/auth/oauth2.rb

@@ -16,10 +16,13 @@ module ConstantContact
 			# @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]
+			def initialize(opts = {})
+				@client_id = opts[:api_key] || Util::Config.get('auth.api_key')
+				@client_secret = opts[:api_secret] || Util::Config.get('auth.api_secret')
+				@redirect_uri = opts[:redirect_url] || Util::Config.get('auth.redirect_uri')
+				if @client_id.nil? || @client_id == '' || @client_secret.nil? || @client_secret.nil? || @redirect_uri.nil? || @redirect_uri == ''
+					raise ArgumentError.new "Either api_key, api_secret or redirect_uri is missing in explicit call or configuration."
+				end
 			end
 
 

data/lib/constantcontact/auth/session_data_store.rb

@@ -5,65 +5,65 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Auth
-		class Session
-			attr_accessor :session
+  module Auth
+    class Session
+      attr_accessor :session
 
-			# Create and initialize the session
-			def initialize
-				cgi = CGI.new('html4')
+      # 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
+        # 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
+      # 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
+      # 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
+      # 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
+      # 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
+      # Close current session
+      # @return
+      def close
+        @session.close
+      end
 
-		end
-	end
+    end
+  end
 end
 

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

@@ -5,23 +5,23 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Components
-		class VerifiedEmailAddress < Component
-			attr_accessor :status, :email_address
+  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
+      # 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
+  end
 end

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

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

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

@@ -5,23 +5,23 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Components
-		class ActivityError < Component
-			attr_accessor :message, :line_number, :email_address
+  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
+      # 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
+  end
 end