constantcontact 1.0.2 → 1.1.0

data/lib/constantcontact/components/library/info/library_summary.rb

@@ -0,0 +1,26 @@
+#
+# library_summary.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class LibrarySummary < Component
+      attr_accessor :max_free_file_num, :max_premium_space_limit, :max_upload_size_limit, :image_root, :usage_summary
+
+      # Factory method to create a LibrarySummary object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [LibrarySummary]
+      def self.create(props)
+        obj = LibrarySummary.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/library/info/move_results.rb

@@ -0,0 +1,26 @@
+#
+# move_results.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class MoveResults < Component
+      attr_accessor :id, :uri
+
+      # Factory method to create a MoveResults object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [MoveResults]
+      def self.create(props)
+        obj = MoveResults.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/library/info/upload_status.rb

@@ -0,0 +1,26 @@
+#
+# upload_status.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class UploadStatus < Component
+      attr_accessor :status, :description, :file_id
+
+      # Factory method to create an UploadStatus object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [UploadStatus]
+      def self.create(props)
+        obj = UploadStatus.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/tracking/bounce_activity.rb

@@ -11,18 +11,18 @@ module ConstantContact
                     :contact_id, :email_address, :campaign_id
 
 
-			# Factory method to create a BounceActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [BounceActivity]
-			def self.create(props)
-				obj = BounceActivity.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 BounceActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [BounceActivity]
+      def self.create(props)
+        obj = BounceActivity.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/tracking/click_activity.rb

@@ -9,18 +9,18 @@ module ConstantContact
     class ClickActivity < Component
       attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :link_id, :click_date
 
-\			# Factory method to create a ClickActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [ClickActivity]
-			def self.create(props)
-				obj = ClickActivity.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 ClickActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [ClickActivity]
+      def self.create(props)
+        obj = ClickActivity.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/tracking/forward_activity.rb

@@ -9,18 +9,18 @@ module ConstantContact
     class ForwardActivity < Component
       attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :forward_date
 
-			# Factory method to create a ForwardActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [ForwardActivity]
-			def self.create(props)
-				obj = ForwardActivity.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 ForwardActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [ForwardActivity]
+      def self.create(props)
+        obj = ForwardActivity.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/tracking/open_activity.rb

@@ -9,18 +9,18 @@ module ConstantContact
     class OpenActivity < Component
       attr_accessor :activity_type, :campaign_id, :email_address, :open_date, :contact_id
 
-			# Factory method to create an OpenActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [OpenActivity]
-			def self.create(props)
-				obj = OpenActivity.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 OpenActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [OpenActivity]
+      def self.create(props)
+        obj = OpenActivity.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/tracking/send_activity.rb

@@ -10,18 +10,18 @@ module ConstantContact
       attr_accessor :activity_type, :campaign_id, :email_address, :contact_id, :send_date
 
 
-			# Factory method to create a SendActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [SendActivity]
-			def self.create(props)
-				obj = SendActivity.new
-				if props
-					props.each do |key, value|
-						obj.send("#{key}=", value)
-					end
-				end
-				obj
-			end
-		end
-	end
+      # Factory method to create a SendActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [SendActivity]
+      def self.create(props)
+        obj = SendActivity.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value)
+          end
+        end
+        obj
+      end
+    end
+  end
 end

data/lib/constantcontact/components/tracking/tracking_summary.rb

@@ -5,23 +5,23 @@
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
-	module Components
-		class TrackingSummary < Component
-			attr_accessor :sends, :opens, :clicks, :forwards, :unsubscribes, :bounces, :contact_id, :spam_count
+  module Components
+    class TrackingSummary < Component
+      attr_accessor :sends, :opens, :clicks, :forwards, :unsubscribes, :bounces, :spam_count
 
 
-			# Factory method to create a TrackingSummary object from an array
-			# @param [Hash] props - array of properties to create object from
-			# @return [TrackingSummary]
-			def self.create(props)
-				obj = TrackingSummary.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 TrackingSummary object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [TrackingSummary]
+      def self.create(props)
+        obj = TrackingSummary.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/tracking/unsubscribe_activity.rb

@@ -10,18 +10,18 @@ module ConstantContact
       attr_accessor :activity_type, :campaign_id, :contact_id, :email_address, :unsubscribe_date,
                     :unsubscribe_source, :unsubscribe_reason
 
-			# Factory method to create an UnsubscribeActivity object from an array
-			# @param [Hash] props - hash of properties to create object from
-			# @return [UnsubscribeActivity]
-			def self.create(props)
-				obj = UnsubscribeActivity.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 UnsubscribeActivity object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [UnsubscribeActivity]
+      def self.create(props)
+        obj = UnsubscribeActivity.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/services/account_service.rb

@@ -9,12 +9,13 @@ module ConstantContact
     class AccountService < BaseService
       class << self
 
-        # Get the verified emails from account
+        # Get all verified email addresses associated with an account
         # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Hash] params - hash of query parameters/values to append to the request
         # @return [Array<VerifiedEmailAddress>]
-        def get_verified_email_addresses(access_token)
+        def get_verified_email_addresses(access_token, params)
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.account_verified_addresses')
-          url = build_url(url)
+          url = build_url(url, params)
           response = RestClient.get(url, get_headers(access_token))
           email_addresses = []
           JSON.parse(response.body).each do |email_address|

data/lib/constantcontact/services/activity_service.rb

@@ -10,11 +10,12 @@ module ConstantContact
       class << self
 
         # Get a set of activities
-        # @param [String] access_token
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Hash] params - query parameters to be appended to the url
         # @return [Array<Activity>]
-        def get_activities(access_token)
+        def get_activities(access_token, params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.activities')
-          url = build_url(url)
+          url = build_url(url, params)
           response = RestClient.get(url, get_headers(access_token))
 
           activities = []
@@ -53,6 +54,24 @@ module ConstantContact
         end
 
 
+        # Create an Add Contacts Activity from a file. Valid file types are txt, csv, xls, xlsx
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [String] file_name - The name of the file (ie: contacts.csv)
+        # @param [String] contents - The content of the file
+        # @param [String] lists - Comma separated list of ContactList id's to add the contacts to
+        # @return [Activity]
+        def create_add_contacts_activity_from_file(access_token, file_name, contents, lists)
+          url = Util::Config.get('endpoints.base_url') +
+                Util::Config.get('endpoints.add_contacts_activity')
+          url = build_url(url)
+
+          payload = { :file_name => file_name, :lists => lists, :data => contents, :multipart => true }
+
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::Activity.create(JSON.parse(response.body))
+        end
+
+
         # Create a Clear Lists Activity
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Array<lists>] lists - array of list id's to be cleared
@@ -101,6 +120,24 @@ module ConstantContact
           Components::Activity.create(JSON.parse(response.body))
         end
 
+
+        # Create an Remove Contacts Activity from a file. Valid file types are txt, csv, xls, xlsx
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [String] file_name - The name of the file (ie: contacts.csv)
+        # @param [String] contents - The content of the file
+        # @param [String] lists - Comma separated list of ContactList id' to add the contacts too
+        # @return [Activity]
+        def add_remove_contacts_from_lists_activity_from_file(access_token, file_name, contents, lists)
+          url = Util::Config.get('endpoints.base_url') +
+                Util::Config.get('endpoints.remove_from_lists_activity')
+          url = build_url(url)
+
+          payload = { :file_name => file_name, :lists => lists, :data => contents, :multipart => true }
+
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::Activity.create(JSON.parse(response.body))
+        end
+
       end
     end
   end

data/lib/constantcontact/services/base_service.rb

@@ -12,21 +12,49 @@ module ConstantContact
 
         protected
 
-        # Helper function to return required headers for making an http request with constant contact
+        # Return required headers for making an http request with constant contact
         # @param [String] access_token - OAuth2 access token to be placed into the Authorization header
+        # @param [String] content_type - The MIME type of the body of the request, default is 'application/json'
         # @return [Hash] - authorization headers
-        def get_headers(access_token)
+        def get_headers(access_token, content_type = 'application/json')
           {
-            :content_type   => 'application/json',
+            :content_type   => content_type,
             :accept         => 'application/json',
-            :authorization  => "Bearer #{access_token}"
+            :authorization  => "Bearer #{access_token}",
+            :user_agent     => "AppConnect Ruby SDK v#{ConstantContact::SDK::VERSION} (#{RUBY_DESCRIPTION})"
           }
         end
 
 
-        # Build a url from the base url and query parameters hash
+        # returns the id of a ConstantContact component
+        def get_id_for(obj)
+          if obj.kind_of? ConstantContact::Components::Component
+            obj.id
+          elsif obj.kind_of? Hash
+            obj["id"]
+          else
+            obj
+          end
+        end
+
+
+        # Build a url from the base url and query parameters hash. Query parameters
+        # should not be URL encoded because this method will handle that
+        # @param [String] url - The base url
+        # @param [Hash] params - A hash with query parameters
+        # @return [String] - the url with query parameters hash 
         def build_url(url, params = nil)
-          params = {} if !params
+          if params.respond_to? :each
+            params.each do |key, value|
+              # Convert dates to CC date format
+              if value.respond_to? :iso8601
+                params[key] = value.iso8601
+              end
+            end
+          else
+            params ||= {}
+          end
+
           params['api_key'] = BaseService.api_key
           url += '?' + Util::Helpers.http_build_query(params)
         end