constantcontact 1.3.2 → 2.0.0

data/lib/constantcontact/services/account_service.rb

@@ -10,24 +10,22 @@ module ConstantContact
       class << self
 
         # Get a summary of account information
-        # @param [String] access_token
-        # @return
-        def get_account_info(access_token)
+        # @return [AccountInfo]
+        def get_account_info()
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.account_info')
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           Components::AccountInfo.create(JSON.parse(response.body))
         end
 
 
         # 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, params)
+        def get_verified_email_addresses(params)
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.account_verified_addresses')
           url = build_url(url, params)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           email_addresses = []
           JSON.parse(response.body).each do |email_address|
             email_addresses << Components::VerifiedEmailAddress.create(email_address)

data/lib/constantcontact/services/activity_service.rb

@@ -10,13 +10,12 @@ module ConstantContact
       class << self
 
         # Get a set of activities
-        # @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, params = {})
+        def get_activities(params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.activities')
           url = build_url(url, params)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
 
           activities = []
           JSON.parse(response.body).each do |activity|
@@ -28,84 +27,78 @@ module ConstantContact
 
 
         # Get an array of activities
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] activity_id - Activity id
         # @return [Activity]
-        def get_activity(access_token, activity_id)
+        def get_activity(activity_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.activity'), activity_id)
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           Components::Activity.create(JSON.parse(response.body))
         end
 
 
         # Create an Add Contacts Activity
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [AddContacts] add_contacts
         # @return [Activity]
-        def create_add_contacts_activity(access_token, add_contacts)
+        def create_add_contacts_activity(add_contacts)
           url = Util::Config.get('endpoints.base_url') +
                 Util::Config.get('endpoints.add_contacts_activity')
           url = build_url(url)
           payload = add_contacts.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::Activity.create(JSON.parse(response.body))
         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)
+        def create_add_contacts_activity_from_file(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))
+          response = RestClient.post(url, payload, get_headers())
           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
         # @return [Activity]
-        def add_clear_lists_activity(access_token, lists)
+        def add_clear_lists_activity(lists)
           url = Util::Config.get('endpoints.base_url') +
                 Util::Config.get('endpoints.clear_lists_activity')
           url = build_url(url)
           payload = {'lists' => lists}.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::Activity.create(JSON.parse(response.body))
         end
 
 
         # Create an Export Contacts Activity
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [ExportContacts] export_contacts
         # @return [Activity]
-        def add_export_contacts_activity(access_token, export_contacts)
+        def add_export_contacts_activity(export_contacts)
           url = Util::Config.get('endpoints.base_url') +
                 Util::Config.get('endpoints.export_contacts_activity')
           url = build_url(url)
           payload = export_contacts.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::Activity.create(JSON.parse(response.body))
         end
 
 
         # Create a Remove Contacts From Lists Activity
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [<Array>EmailAddress] email_addresses
         # @param [<Array>RemoveFromLists] lists
         # @return [Activity]
-        def add_remove_contacts_from_lists_activity(access_token, email_addresses, lists)
+        def add_remove_contacts_from_lists_activity(email_addresses, lists)
           url = Util::Config.get('endpoints.base_url') +
                 Util::Config.get('endpoints.remove_from_lists_activity')
           url = build_url(url)
@@ -116,25 +109,24 @@ module ConstantContact
           end
           payload = payload.to_json
 
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           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)
+        def add_remove_contacts_from_lists_activity_from_file(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))
+          response = RestClient.post(url, payload, get_headers())
           Components::Activity.create(JSON.parse(response.body))
         end
 

data/lib/constantcontact/services/base_service.rb

@@ -8,19 +8,18 @@ module ConstantContact
   module Services
     class BaseService
       class << self
-        attr_accessor :api_key
+        attr_accessor :api_key, :access_token
 
         protected
 
         # 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, content_type = 'application/json')
+        def get_headers(content_type = 'application/json')
           {
             :content_type   => content_type,
             :accept         => 'application/json',
-            :authorization  => "Bearer #{access_token}",
+            :authorization  => "Bearer #{BaseService.access_token}",
             :user_agent     => "AppConnect Ruby SDK v#{ConstantContact::SDK::VERSION} (#{RUBY_DESCRIPTION})",
             :x_ctct_request_source => "sdk.ruby.#{ConstantContact::SDK::VERSION}"
           }

data/lib/constantcontact/services/campaign_schedule_service.rb

@@ -10,29 +10,27 @@ module ConstantContact
       class << self
 
         # Create a new schedule for a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id to be scheduled
         # @param [Schedule] schedule - Schedule to be created
         # @return [Schedule]
-        def add_schedule(access_token, campaign_id, schedule)
+        def add_schedule(campaign_id, schedule)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_schedules'), campaign_id)
           url = build_url(url)
           payload = schedule.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::Schedule.create(JSON.parse(response.body))
         end
 
 
         # Get a list of schedules for a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id to be scheduled
         # @return [Array<Schedule>]
-        def get_schedules(access_token, campaign_id)
+        def get_schedules(campaign_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_schedules'), campaign_id)
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           schedules = []
@@ -45,59 +43,55 @@ module ConstantContact
 
 
         # Get a specific schedule for a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id to get a schedule for
         # @param [Integer] schedule_id - Schedule id to retrieve
         # @return [Schedule]
-        def get_schedule(access_token, campaign_id, schedule_id)
+        def get_schedule(campaign_id, schedule_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule_id)
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           Components::Schedule.create(JSON.parse(response.body))
         end
 
 
         # Delete a specific schedule for a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id to delete a schedule for
         # @param [Integer] schedule_id - Schedule id to delete
         # @return [Boolean]
-        def delete_schedule(access_token, campaign_id, schedule_id)
+        def delete_schedule(campaign_id, schedule_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule_id)
           url = build_url(url)
-          response = RestClient.delete(url, get_headers(access_token))
+          response = RestClient.delete(url, get_headers())
           response.code == 204
         end
 
 
         # Update a specific schedule for a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id to be scheduled
         # @param [Schedule] schedule - Schedule to retrieve
         # @return [Schedule]
-        def update_schedule(access_token, campaign_id, schedule)
+        def update_schedule(campaign_id, schedule)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_schedule'), campaign_id, schedule.id)
           url = build_url(url)
           payload = schedule.to_json
-          response = RestClient.put(url, payload, get_headers(access_token))
+          response = RestClient.put(url, payload, get_headers())
           Components::Schedule.create(JSON.parse(response.body))
         end
 
 
         # Send a test send of a campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Id of campaign to send test of
         # @param [TestSend] test_send - Test send details
         # @return [TestSend]
-        def send_test(access_token, campaign_id, test_send)
+        def send_test(campaign_id, test_send)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_test_sends'), campaign_id)
           url = build_url(url)
           payload = test_send.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::TestSend.create(JSON.parse(response.body))
         end
 

data/lib/constantcontact/services/campaign_tracking_service.rb

@@ -10,16 +10,15 @@ module ConstantContact
       class << self
 
         # Get bounces for a given campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [String] campaign_id - Campaign id
         # @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, params = {})
+        def get_bounces(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_bounces'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           bounces = []
@@ -32,16 +31,15 @@ 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] params - query parameters to be appended to request
         # @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
-        def get_clicks(access_token, campaign_id, params = {})
+        def get_clicks(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_clicks'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           clicks = []
@@ -54,16 +52,15 @@ 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] params - query parameters to be appended to request
         # @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
-        def get_forwards(access_token, campaign_id, params = {})
+        def get_forwards(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_forwards'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           forwards = []
@@ -76,16 +73,15 @@ 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] params - query parameters to be appended to request
         # @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
-        def get_opens(access_token, campaign_id, params = {})
+        def get_opens(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_opens'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           opens = []
@@ -98,16 +94,15 @@ 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] params - query parameters to be appended to request
         # @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
-        def get_sends(access_token, campaign_id, params = {})
+        def get_sends(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_sends'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           sends = []
@@ -120,16 +115,15 @@ 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] params - query params to be appended to request
         # @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
-        def get_unsubscribes(access_token, campaign_id, params = {})
+        def get_unsubscribes(campaign_id, params = {})
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_unsubscribes'), campaign_id)
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           unsubscribes = []
@@ -142,14 +136,13 @@ module ConstantContact
 
 
         # Get a summary of reporting data for a given campaign
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] campaign_id - Campaign id
         # @return [TrackingSummary]
-        def get_summary(access_token, campaign_id)
+        def get_summary(campaign_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.campaign_tracking_summary'), campaign_id)
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           Components::TrackingSummary.create(JSON.parse(response.body))
         end
 

data/lib/constantcontact/services/contact_service.rb

@@ -10,14 +10,13 @@ module ConstantContact
       class << self
 
         # Get an array of contacts
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Hash] params - query parameters to be appended to the request
         # @return [ResultSet<Contact>]
-        def get_contacts(access_token, params = {})
+        def get_contacts(params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
           url = build_url(url, params)
 
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           body = JSON.parse(response.body)
 
           contacts = []
@@ -30,79 +29,73 @@ module ConstantContact
 
 
         # Get contact details for a specific contact
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] contact_id - Unique contact id
         # @return [Contact]
-        def get_contact(access_token, contact_id)
+        def get_contact(contact_id)
           url = Util::Config.get('endpoints.base_url') +
                 sprintf(Util::Config.get('endpoints.contact'), contact_id)
           url = build_url(url)
-          response = RestClient.get(url, get_headers(access_token))
+          response = RestClient.get(url, get_headers())
           Components::Contact.create(JSON.parse(response.body))
         end
 
 
         # 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] params - query params to be appended to the request
         # @return [Contact]
-        def add_contact(access_token, contact, params = {})
+        def add_contact(contact, params = {})
           url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.contacts')
           url = build_url(url, params)
           payload = contact.to_json
-          response = RestClient.post(url, payload, get_headers(access_token))
+          response = RestClient.post(url, payload, get_headers())
           Components::Contact.create(JSON.parse(response.body))
         end
 
 
         # Delete contact details for a specific contact
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] contact_id - Unique contact id
         # @return [Boolean]
-        def delete_contact(access_token, contact_id)
+        def delete_contact(contact_id)
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact'), contact_id)
           url = build_url(url)
-          response = RestClient.delete(url, get_headers(access_token))
+          response = RestClient.delete(url, get_headers())
           response.code == 204
         end
 
 
         # Delete a contact from all contact lists
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] contact_id - Contact id to be removed from lists
         # @return [Boolean]
-        def delete_contact_from_lists(access_token, contact_id)
+        def delete_contact_from_lists(contact_id)
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact_lists'), contact_id)
           url = build_url(url)
-          response = RestClient.delete(url, get_headers(access_token))
+          response = RestClient.delete(url, get_headers())
           response.code == 204
         end
 
 
         # 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 id to remove the contact from
         # @return [Boolean]
-        def delete_contact_from_list(access_token, contact_id, list_id)
+        def delete_contact_from_list(contact_id, list_id)
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact_list'), contact_id, list_id)
           url = build_url(url)
-          response = RestClient.delete(url, get_headers(access_token))
+          response = RestClient.delete(url, get_headers())
           response.code == 204
         end
 
 
         # Update contact details for a specific contact
-        # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Contact] contact - Contact to be updated
         # @param [Hash] params - query params to be appended to the request
         # @return [Contact]
-        def update_contact(access_token, contact, params = {})
+        def update_contact(contact, params = {})
           url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.contact'), contact.id)
           url = build_url(url, params)
           payload = contact.to_json
-          response = RestClient.put(url, payload, get_headers(access_token))
+          response = RestClient.put(url, payload, get_headers())
           Components::Contact.create(JSON.parse(response.body))
         end