constantcontact 1.0.2 → 1.1.0

data/lib/constantcontact/auth/oauth2.rb

@@ -5,81 +5,101 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Auth
-		class OAuth2
-			attr_accessor :client_id, :client_secret, :redirect_uri, :props
+  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] || 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
+      # 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] || 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
 
 
-			# 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
+      # 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
+      # @param [String] state - an optional value used by the client to maintain state between the request and callback
+      # @return [String] the authorization URL
+      def get_authorization_url(server = true, state = nil)
+        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
+        }
+        if state
+            params[:state] = state
+        end
+        [
+          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
-				}
+      # 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
+        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
+        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
+        if response_body['error_description']
+          error = response_body['error_description']
+          raise Exceptions::OAuth2Exception, error
+        end
 
-				response_body
-			end
+        response_body
+      end
 
-		end
-	end
+
+      # Get an information about an access token
+      # @param [String] access_token - Constant Contact OAuth2 access token
+      # @return array
+      def get_token_info(access_token)
+         params = {
+           :access_token => access_token
+         }
+         url = [
+          Util::Config.get('auth.base_url'),
+          Util::Config.get('auth.token_info')
+        ].join
+        response = RestClient.post(url, params)
+        response_body = JSON.parse(response)
+      end
+
+    end
+  end
 end

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

@@ -9,18 +9,18 @@ module ConstantContact
     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)
-				obj = VerifiedEmailAddress.new
-				if props
-					props.each do |key, value|
-						obj.send("#{key}=", value) if obj.respond_to? key
-					end
-				end
-				obj
-			end
-		end
-	end
+      # Factory method to create a VerifiedEmailAddress object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [VerifiedEmailAddress]
+      def self.create(props)
+        obj = VerifiedEmailAddress.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
 end

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

@@ -10,34 +10,34 @@ module ConstantContact
       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)
-				obj = Activity.new
-				if props
-					props.each do |key, value|
-						if key == 'errors'
-							if value
-								obj.errors = []
-								value.each do |error|
-									obj.errors << Components::ActivityError.create(error)
-								end
-							end
-						elsif key == 'warnings'
-							if value
-								obj.warnings = []
-								value.each do |error|
-									obj.warnings << Components::ActivityError.create(error)
-								end
-							end
-						else
-							obj.send("#{key}=", value) if obj.respond_to? key
-						end
-					end
-				end
-				obj
-			end
-		end
-	end
+      # Factory method to create an Activity object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [Activity]
+      def self.create(props)
+        obj = Activity.new
+        if props
+          props.each do |key, value|
+            if key == 'errors'
+              if value
+                obj.errors = []
+                value.each do |error|
+                  obj.errors << Components::ActivityError.create(error)
+                end
+              end
+            elsif key == 'warnings'
+              if value
+                obj.warnings = []
+                value.each do |error|
+                  obj.warnings << Components::ActivityError.create(error)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+    end
+  end
 end

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

@@ -9,18 +9,18 @@ module ConstantContact
     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)
-				obj = ActivityError.new
-				if props
-					props.each do |key, value|
-						obj.send("#{key}=", value) if obj.respond_to? key
-					end
-				end
-				obj
-			end
-		end
-	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)
+        obj = ActivityError.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
 end

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

@@ -102,7 +102,7 @@ module ConstantContact
           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]
+                custom_field_number = custom_field.name[13, custom_field.name.length]
                 used_columns << Util::Config.get('activities_columns.custom_field_' + custom_field_number)
               end
             end

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

@@ -5,40 +5,41 @@
 # 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)) if obj.respond_to? 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
+  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 - properties to create object from
+      # @return [AddContactsImportData]
+      def initialize(props = {})
+        instance_variables.each do |property, value|
+          send("#{property}=", get_value(props, property)) if obj.respond_to? 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/component.rb

@@ -7,6 +7,31 @@
 module ConstantContact
   module Components
     class Component
+
+      def to_hash
+        hash = Hash.new
+        self.instance_variables.collect do |var|
+          hash[var.to_s[1..-1]] = self.class.to_hash_value(self.instance_variable_get(var))
+        end
+        hash
+      end
+
+      def self.to_hash_value(val)
+        if val.is_a? ConstantContact::Components::Component
+          return val.to_hash
+        elsif val.is_a? Array
+          return val.collect{|subval| Component.to_hash_value(subval) }
+        elsif val.is_a? DateTime
+          return val.to_s
+        else
+          return val
+        end
+      end
+
+      def to_json(val = nil)
+        self.to_hash.to_json
+      end
+
       protected
 
       # Get the requested value from a hash, or return the default

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

@@ -10,18 +10,18 @@ module ConstantContact
       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)
-				obj = Address.new
-				if props
-					props.each do |key, value|
-						obj.send("#{key}=", value) if obj.respond_to? key
-					end
-				end
-				obj
-			end
+      # Factory method to create an Address object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [Address]
+      def self.create(props)
+        obj = Address.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
     end
   end
 end