constantcontact-ruby 2.2.0

data/lib/constantcontact/services/campaign_tracking_service.rb

@@ -0,0 +1,152 @@
+#
+# campaign_tracking_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class CampaignTrackingService < BaseService
+      class << self
+
+        # Get bounces for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          bounces = []
+          body['results'].each do |bounce_activity|
+            bounces << Components::BounceActivity.create(bounce_activity)
+          end
+
+          Components::ResultSet.new(bounces, body['meta'])
+        end
+
+
+        # Get clicks for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          clicks = []
+          body['results'].each do |click_activity|
+            clicks << Components::ClickActivity.create(click_activity)
+          end
+
+          Components::ResultSet.new(clicks, body['meta'])
+        end
+
+
+        # Get forwards for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          forwards = []
+          body['results'].each do |forward_activity|
+            forwards << Components::ForwardActivity.create(forward_activity)
+          end
+
+          Components::ResultSet.new(forwards, body['meta'])
+        end
+
+
+        # Get opens for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          opens = []
+          body['results'].each do |open_activity|
+            opens << Components::OpenActivity.create(open_activity)
+          end
+
+          Components::ResultSet.new(opens, body['meta'])
+        end
+
+
+        # Get sends for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          sends = []
+          body['results'].each do |send_activity|
+            sends << Components::SendActivity.create(send_activity)
+          end
+
+          Components::ResultSet.new(sends, body['meta'])
+        end
+
+
+        # Get unsubscribes for a given campaign
+        # @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(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())
+          body = JSON.parse(response.body)
+
+          unsubscribes = []
+          body['results'].each do |unsubscribe_activity|
+            unsubscribes << Components::UnsubscribeActivity.create(unsubscribe_activity)
+          end
+
+          Components::ResultSet.new(unsubscribes, body['meta'])
+        end
+
+
+        # Get a summary of reporting data for a given campaign
+        # @param [Integer] campaign_id - Campaign id
+        # @return [TrackingSummary]
+        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())
+          Components::TrackingSummary.create(JSON.parse(response.body))
+        end
+
+      end
+    end
+  end
+end

data/lib/constantcontact/services/contact_service.rb

@@ -0,0 +1,105 @@
+#
+# contact_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class ContactService < BaseService
+      class << self
+
+        # Get an array of contacts
+        # @param [Hash] params - query parameters to be appended to the request
+        # @return [ResultSet<Contact>]
+        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())
+          body = JSON.parse(response.body)
+
+          contacts = []
+          body['results'].each do |contact|
+            contacts << Components::Contact.create(contact)
+          end
+
+          Components::ResultSet.new(contacts, body['meta'])
+        end
+
+
+        # Get contact details for a specific contact
+        # @param [Integer] contact_id - Unique contact id
+        # @return [Contact]
+        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())
+          Components::Contact.create(JSON.parse(response.body))
+        end
+
+
+        # Add a new contact to the Constant Contact account
+        # @param [Contact] contact - Contact to add
+        # @param [Boolean] params - query params to be appended to the request
+        # @return [Contact]
+        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())
+          Components::Contact.create(JSON.parse(response.body))
+        end
+
+
+        # Delete contact details for a specific contact
+        # @param [Integer] contact_id - Unique contact id
+        # @return [Boolean]
+        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())
+          response.code == 204
+        end
+
+
+        # Delete a contact from all contact lists
+        # @param [Integer] contact_id - Contact id to be removed from lists
+        # @return [Boolean]
+        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())
+          response.code == 204
+        end
+
+
+        # Delete a contact from a specific contact list
+        # @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(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())
+          response.code == 204
+        end
+
+
+        # Update contact details for a specific contact
+        # @param [Contact] contact - Contact to be updated
+        # @param [Hash] params - query params to be appended to the request
+        # @return [Contact]
+        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())
+          Components::Contact.create(JSON.parse(response.body))
+        end
+
+      end
+    end
+  end
+end

data/lib/constantcontact/services/contact_tracking_service.rb

@@ -0,0 +1,152 @@
+#
+# contact_tracking_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class ContactTrackingService < BaseService
+      class << self
+
+        # Get bounces for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<BounceActivity>] - Containing a results array of BounceActivity
+        def get_bounces(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_bounces'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          bounces = []
+          body['results'].each do |bounce_activity|
+            bounces << Components::BounceActivity.create(bounce_activity)
+          end
+
+          Components::ResultSet.new(bounces, body['meta'])
+        end
+
+
+        # Get clicks for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<ClickActivity>] - Containing a results array of ClickActivity
+        def get_clicks(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_clicks'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          clicks = []
+          body['results'].each do |click_activity|
+            clicks << Components::ClickActivity.create(click_activity)
+          end
+
+          Components::ResultSet.new(clicks, body['meta'])
+        end
+
+
+        # Get forwards for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<ForwardActivity>] - Containing a results array of ForwardActivity
+        def get_forwards(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_forwards'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          forwards = []
+          body['results'].each do |forward_activity|
+            forwards << Components::ForwardActivity.create(forward_activity)
+          end
+
+          Components::ResultSet.new(forwards, body['meta'])
+        end
+
+
+        # Get opens for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<OpenActivity>] - Containing a results array of OpenActivity
+        def get_opens(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_opens'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          opens = []
+          body['results'].each do |open_activity|
+            opens << Components::OpenActivity.create(open_activity)
+          end
+
+          Components::ResultSet.new(opens, body['meta'])
+        end
+
+
+        # Get sends for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<SendActivity>] - Containing a results array of SendActivity
+        def get_sends(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_sends'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          sends = []
+          body['results'].each do |send_activity|
+            sends << Components::SendActivity.create(send_activity)
+          end
+
+          Components::ResultSet.new(sends, body['meta'])
+        end
+
+
+        # Get unsubscribes for a given contact
+        # @param [String] contact_id - Contact id
+        # @param [Hash] params - query parameters to be appended to request
+        # @return [ResultSet<UnsubscribeActivity>] - Containing a results array of UnsubscribeActivity
+        def get_unsubscribes(contact_id, params = {})
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_unsubscribes'), contact_id)
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          unsubscribes = []
+          body['results'].each do |unsubscribe_activity|
+            unsubscribes << Components::UnsubscribeActivity.create(unsubscribe_activity)
+          end
+
+          Components::ResultSet.new(unsubscribes, body['meta'])
+        end
+
+
+        # Get a summary of reporting data for a given contact
+        # @param [String] contact_id - Contact id
+        # @return [TrackingSummary]
+        def get_summary(contact_id)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.contact_tracking_summary'), contact_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::TrackingSummary.create(JSON.parse(response.body))
+        end
+
+      end
+    end
+  end
+end

data/lib/constantcontact/services/email_marketing_service.rb

@@ -0,0 +1,94 @@
+#
+# email_marketing_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class EmailMarketingService < BaseService
+      class << self
+
+        # Create a new campaign
+        # @param [Campaign] campaign - Campaign to be created
+        # @return [Campaign]
+        def add_campaign(campaign)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
+          url = build_url(url)
+          payload = campaign.to_json
+          response = RestClient.post(url, payload, get_headers())
+          Components::Campaign.create(JSON.parse(response.body))
+        end
+
+
+        # Get a set of campaigns
+        # @param [Hash] params - query parameters to be appended to the request
+        # @return [ResultSet<Campaign>]
+        def get_campaigns(params = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.campaigns')
+          url = build_url(url, params)
+
+          response = RestClient.get(url, get_headers())
+          body = JSON.parse(response.body)
+
+          campaigns = []
+          body['results'].each do |campaign|
+            campaigns << Components::Campaign.create_summary(campaign)
+          end
+
+          Components::ResultSet.new(campaigns, body['meta'])
+        end
+
+
+        # Get campaign details for a specific campaign
+        # @param [Integer] campaign_id - Valid campaign id
+        # @return [Campaign]
+        def get_campaign(campaign_id)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.campaign'), campaign_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::Campaign.create(JSON.parse(response.body))
+        end
+
+
+        # Get the preview of the given campaign
+        # @param [Integer] campaign_id - Valid campaign id
+        # @return [CampaignPreview]
+        def get_campaign_preview(campaign_id)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.campaign_preview'), campaign_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::CampaignPreview.create(JSON.parse(response.body))
+        end
+
+
+        # Delete an email campaign
+        # @param [Integer] campaign_id - Valid campaign id
+        # @return [Boolean]
+        def delete_campaign(campaign_id)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.campaign'), campaign_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers())
+          response.code == 204
+        end
+
+
+        # Update a specific email campaign
+        # @param [Campaign] campaign - Campaign to be updated
+        # @return [Campaign]
+        def update_campaign(campaign)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.campaign'), campaign.id)
+          url = build_url(url)
+          payload = campaign.to_json
+          response = RestClient.put(url, payload, get_headers())
+          Components::Campaign.create(JSON.parse(response.body))
+        end
+
+      end
+    end
+  end
+end