constantcontact 1.0.2 → 1.1.0

data/lib/constantcontact/services/campaign_tracking_service.rb

@@ -9,15 +9,15 @@ module ConstantContact
     class CampaignTrackingService < BaseService
       class << self
 
-        # Get a result set of bounces for a given campaign
+        # Get bounces for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity
-        def get_bounces(access_token, campaign_id, param = nil)
+        def get_bounces(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_bounces'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -34,12 +34,12 @@ module ConstantContact
         # Get clicks for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
-        def get_clicks(access_token, campaign_id, param = nil)
+        def get_clicks(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_clicks'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -56,12 +56,12 @@ module ConstantContact
         # Get forwards for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
-        def get_forwards(access_token, campaign_id, param = nil)
+        def get_forwards(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_forwards'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -78,12 +78,12 @@ module ConstantContact
         # Get opens for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
-        def get_opens(access_token, campaign_id, param = nil)
+        def get_opens(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_opens'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -100,12 +100,12 @@ module ConstantContact
         # Get sends for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
-        def get_sends(access_token, campaign_id, param = nil)
+        def get_sends(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_sends'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -122,19 +122,19 @@ module ConstantContact
         # Get unsubscribes for a given campaign
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
-        # @param [Hash] param - query params to be appended to request
+        # @param [Hash] params - query params to be appended to request
         # @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
-        def get_unsubscribes(access_token, campaign_id, param = nil)
+        def get_unsubscribes(access_token, campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_unsubscribes'), campaign_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
 
           unsubscribes = []
           body['results'].each do |unsubscribe_activity|
-            unsubscribes[] = Components::UnsubscribeActivity.create(unsubscribe_activity)
+            unsubscribes << Components::UnsubscribeActivity.create(unsubscribe_activity)
           end
 
           Components::ResultSet.new(unsubscribes, body['meta'])

data/lib/constantcontact/services/contact_service.rb

@@ -11,11 +11,11 @@ module ConstantContact
 
         # Get an array of contacts
         # @param [String] access_token - Constant Contact OAuth2 access token
-        # @param [Hash] param - query parameters to be appended to the request
+        # @param [Hash] params - query parameters to be appended to the request
         # @return [ResultSet<Contact>]
-        def get_contacts(access_token, param = nil)
+        def get_contacts(access_token, params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -45,12 +45,11 @@ module ConstantContact
         # Add a new contact to the Constant Contact account
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Contact] contact - Contact to add
-        # @param [Boolean] action_by_visitor - is the action being taken by the visitor
+        # @param [Boolean] params - query params to be appended to the request
         # @return [Contact]
-        def add_contact(access_token, contact, action_by_visitor = false)
+        def add_contact(access_token, contact, params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
-          param = action_by_visitor ? {'action_by' => 'ACTION_BY_VISITOR'} : nil
-          url = build_url(url, param)
+          url = build_url(url, params)
           payload = contact.to_json
           response = RestClient.post(url, payload, get_headers(access_token))
           Components::Contact.create(JSON.parse(response.body))
@@ -84,7 +83,7 @@ module ConstantContact
         # Delete a contact from a specific contact list
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] contact_id - Contact id to be removed
-        # @param [Integer] list_id - ContactList to remove the contact from
+        # @param [Integer] list_id - ContactList id to remove the contact from
         # @return [Boolean]
         def delete_contact_from_list(access_token, contact_id, list_id)
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact_list'), contact_id, list_id)
@@ -97,12 +96,11 @@ module ConstantContact
         # Update contact details for a specific contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Contact] contact - Contact to be updated
-        # @param [Boolean] action_by_visitor - is the action being taken by the visitor
+        # @param [Hash] params - query params to be appended to the request
         # @return [Contact]
-        def update_contact(access_token, contact, action_by_visitor = false)
+        def update_contact(access_token, contact, params = {})
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact'), contact.id)
-          param = action_by_visitor ? {'action_by' => 'ACTION_BY_VISITOR'} : nil
-          url = build_url(url, param)
+          url = build_url(url, params)
           payload = contact.to_json
           response = RestClient.put(url, payload, get_headers(access_token))
           Components::Contact.create(JSON.parse(response.body))

data/lib/constantcontact/services/contact_tracking_service.rb

@@ -9,15 +9,15 @@ module ConstantContact
     class ContactTrackingService < BaseService
       class << self
 
-        # Get a result set of bounces for a given contact
+        # Get bounces for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity
-        def get_bounces(access_token, contact_id, param = nil)
+        def get_bounces(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_bounces'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -34,12 +34,12 @@ module ConstantContact
         # Get clicks for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
-        def get_clicks(access_token, contact_id, param = nil)
+        def get_clicks(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_clicks'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -56,12 +56,12 @@ module ConstantContact
         # Get forwards for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
-        def get_forwards(access_token, contact_id, param = nil)
+        def get_forwards(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_forwards'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -78,12 +78,12 @@ module ConstantContact
         # Get opens for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
-        def get_opens(access_token, contact_id, param = nil)
+        def get_opens(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_opens'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -100,12 +100,12 @@ module ConstantContact
         # Get sends for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
-        def get_sends(access_token, contact_id, param = nil)
+        def get_sends(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_sends'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
@@ -122,19 +122,19 @@ module ConstantContact
         # Get unsubscribes for a given contact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] contact_id - Contact id
-        # @param [Hash] param - query parameters to be appended to request
+        # @param [Hash] params - query parameters to be appended to request
         # @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
-        def get_unsubscribes(access_token, contact_id, param = nil)
+        def get_unsubscribes(access_token, contact_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact_tracking_unsubscribes'), contact_id)
-          url = build_url(url, param)
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)
 
           unsubscribes = []
           body['results'].each do |unsubscribe_activity|
-            unsubscribes[] = Components::UnsubscribeActivity.create(unsubscribe_activity)
+            unsubscribes << Components::UnsubscribeActivity.create(unsubscribe_activity)
           end
 
           Components::ResultSet.new(unsubscribes, body['meta'])

data/lib/constantcontact/services/email_marketing_service.rb

@@ -21,16 +21,14 @@ module ConstantContact
           Components::Campaign.create(JSON.parse(response.body))
         end
 
-				# Get a set of campaigns
-				# @param [String] access_token Constant Contact OAuth2 access token
-				# @param [Hash] opts query parameters to be appended to the request
-				# @option opts [String] status email campaigns status of DRAFT, RUNNING, SENT, SCHEDULED.
-				# @option opts [String] modified_since ISO-8601 date string to return campaigns modified since then.
-				# @option opts [Integer] limit number of campaigns to return, 1 to 50.
-				# @return [ResultSet<Campaign>]
-				def get_campaigns(access_token, opts = {})
-					url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
-					url = build_url(url, opts)
+
+        # Get a set of campaigns
+        # @param [String] access_token Constant Contact OAuth2 access token
+        # @param [Hash] params - query parameters to be appended to the request
+        # @return [ResultSet<Campaign>]
+        def get_campaigns(access_token, params = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
+          url = build_url(url, params)
 
           response = RestClient.get(url, get_headers(access_token))
           body = JSON.parse(response.body)

data/lib/constantcontact/services/event_spot_service.rb

@@ -0,0 +1,254 @@
+#
+# event_spot_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class EventSpotService < BaseService
+      class << self
+
+        # Create a new event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Event] event - Event to be created
+        # @return [Event]
+        def add_event(access_token, event)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.events')
+          url = build_url(url)
+          payload = event.to_json
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::Event.create(JSON.parse(response.body))
+        end
+
+
+        # Get a set of events
+        # @param [String] access_token Constant Contact OAuth2 access token
+        # @param [Hash] opts query parameters to be appended to the request
+        # @option opts [String] status email campaigns status of DRAFT, RUNNING, SENT, SCHEDULED.
+        # @option opts [String] modified_since ISO-8601 date string to return campaigns modified since then.
+        # @option opts [Integer] limit number of campaigns to return, 1 to 50.
+        # @return [ResultSet<Event>]
+        def get_events(access_token, opts = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.events')
+          url = build_url(url, opts)
+
+          response = RestClient.get(url, get_headers(access_token))
+          body = JSON.parse(response.body)
+
+          events = body['results'].collect do |event|
+            Components::Event.create_summary(event)
+          end
+
+          Components::ResultSet.new(events, body['meta'])
+        end
+
+
+        # Get event details for a specific event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @return [Event]
+        def get_event(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event'), event_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+          Components::Event.create(JSON.parse(response.body))
+        end
+
+
+        # Delete an EventSpot event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @return [Boolean]
+        def delete_event(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event'), event_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers(access_token))
+          response.code == 204
+        end
+
+
+        # Update a specific EventSpot event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Event] event - Event to be updated
+        # @return [Event]
+        def update_event(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event'), event_id)
+          url = build_url(url)
+          payload = event.to_json
+          response = RestClient.put(url, payload, get_headers(access_token))
+          Components::Event.create(JSON.parse(response.body))
+        end
+
+
+        # Publish a specific EventSpot event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Event] event - Event to be updated
+        # @return [Event]
+        def publish_event(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event'), event_id)
+          url = build_url(url)
+          payload = [{:op => "REPLACE", :path => "#/status", :value => "ACTIVE"}].to_json
+          response = RestClient.patch(url, payload, get_headers(access_token))
+          Components::Event.create(JSON.parse(response.body))
+        end
+
+
+        # Cancel a specific EventSpot event
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Event] event - Event to be updated
+        # @return [Event]
+        def cancel_event(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event'), event_id)
+          url = build_url(url)
+          payload = [{ :op => "REPLACE", :path => "#/status", :value => "CANCELLED" }].to_json
+          response = RestClient.patch(url, payload, get_headers(access_token))
+          Components::Event.create(JSON.parse(response.body))
+        end
+
+
+        # Create a new event fee
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @param [Fee] fee - Event fee to be created
+        # @return [Fee]
+        def add_fee(access_token, event, fee)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fees'), event_id)
+          url = build_url(url)
+          payload = fee.to_json
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::Fee.create(JSON.parse(response.body))
+        end
+
+
+        # Get a set of event fees
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @return [ResultSet<Fee>]
+        def get_fees(access_token, event)
+          event_id = get_id_for(event)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fees'), event_id)
+          url = build_url(url)
+
+          response = RestClient.get(url, get_headers(access_token))
+          body = JSON.parse(response.body)
+          
+          fees = body.collect do |fee|
+            Components::Fee.create(fee)
+          end
+        end
+
+
+        # Get an individual event fee
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @param [Integer] fee - Valid fee id
+        # @return [Fee]
+        def get_fee(access_token, event, fee)
+          event_id  = get_id_for(event)
+          fee_id    = get_id_for(fee)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fee'), event_id, fee_id)
+          url = build_url(url)
+
+          response = RestClient.get(url, get_headers(access_token))
+         fee = Components::Fee.create(JSON.parse(response.body))
+        end
+
+
+        # Update an individual event fee
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @param [Integer] fee - Valid fee id
+        # @return [Fee]
+        def update_fee(access_token, event, fee)
+          event_id  = get_id_for(event)
+          if fee.kind_of?(ConstantContact::Components::Fee)
+            fee_id = fee.id
+          elsif fee.kind_of?(Hash)
+            fee_id = fee['id']
+          else
+            raise ArgumentError.new "Fee must be a Hash or ConstantContact::Components::Fee"
+          end
+
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fee'), event_id, fee_id)
+          url = build_url(url)
+          payload = fee.to_json
+
+          response = RestClient.put(url, payload, get_headers(access_token))
+         fee = Components::Fee.create(JSON.parse(response.body))
+        end
+
+
+        # Delete an individual event fee
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @param [Integer] fee - Valid fee id
+        # @return [Fee]
+        def delete_fee(access_token, event, fee)
+          event_id  = get_id_for(event)
+          fee_id    = get_id_for(fee)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fee'), event_id, fee_id)
+          url = build_url(url)
+
+          response = RestClient.delete(url, get_headers(access_token))
+          response.code == 204
+        end
+
+
+        # Get a set of event registrants
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @return [ResultSet<Registrant>]
+        def get_registrants(access_token, event)
+          event_id  = event.kind_of?(ConstantContact::Components::Event) ? event.id : event
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_registrants'), event_id)
+          url = build_url(url)
+
+          response = RestClient.get(url, get_headers(access_token))
+          body = JSON.parse(response.body)
+
+          registrants = body['results'].collect do |registrant|
+            Components::Registrant.create(registrant)
+          end
+
+          Components::ResultSet.new(registrants, body['meta'])
+        end
+
+
+        # Get an individual event registant
+        # @param [String] access_token - Constant Contact OAuth2 access token
+        # @param [Integer] event - Valid event id
+        # @param [Integer] registrant - Valid fee id
+        # @return [Fee]
+        def get_registrant(access_token, event, registrant)
+          event_id      = get_id_for(event)
+          registrant_id  = get_id_for(registrant)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_fee'), event_id, registrant_id)
+          url = build_url(url)
+
+          response = RestClient.get(url, get_headers(access_token))
+         registrant = Components::Registrant.create(JSON.parse(response.body))
+        end
+
+      end
+    end
+  end
+end