constantcontact-ruby 2.2.0

data/lib/constantcontact/services/library_service.rb

@@ -0,0 +1,281 @@
+#
+# library_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class LibraryService < BaseService
+      class << self
+
+        # Retrieve MyLibrary usage information
+        # @return [LibrarySummary]
+        def get_library_info()
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_info')
+
+          response = RestClient.get(url, get_headers())
+          Components::LibrarySummary.create(JSON.parse(response.body).first)
+        end
+
+
+        # Retrieve a list of MyLibrary folders
+        # @param [Hash] params - hash of query parameters and values to append to the request.
+        #     Allowed parameters include:
+        #     sort_by - The method to sort by, valid values are :
+        #         CREATED_DATE - sorts by date folder was added, ascending (earliest to latest)
+        #         CREATED_DATE_DESC - (default) sorts by date folder was added, descending (latest to earliest)
+        #         MODIFIED_DATE - sorts by date folder was last modified, ascending (earliest to latest)
+        #         MODIFIED_DATE_DESC - sorts by date folder was last modified, descending (latest to earliest)
+        #         NAME - sorts alphabetically by folder name, a to z
+        #         NAME_DESC - sorts alphabetically by folder name, z to a
+        #     limit -  Specifies the number of results displayed per page of output, from 1 - 50, default = 50.
+        # @return [ResultSet<LibraryFolder>]
+        def get_library_folders(params)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_folders')
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          folders = []
+          body = JSON.parse(response.body)
+          body['results'].each do |folder|
+            folders << Components::LibraryFolder.create(folder)
+          end
+          Components::ResultSet.new(folders, body['meta'])
+        end
+
+
+        # Create a new MyLibrary folder
+        # @param [LibraryFolder] folder - MyLibrary folder to be created
+        # @return [LibraryFolder]
+        def add_library_folder(folder)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_folders')
+          url = build_url(url)
+          payload = folder.to_json
+          response = RestClient.post(url, payload, get_headers())
+          Components::LibraryFolder.create(JSON.parse(response.body))
+        end
+
+
+        # Retrieve a specific MyLibrary folder using the folder_id path parameter
+        # @param [String] folder_id - The ID for the folder to return
+        # @return [LibraryFolder]
+        def get_library_folder(folder_id)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.library_folder'), folder_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::LibraryFolder.create(JSON.parse(response.body))
+        end
+
+
+        # Update a specific MyLibrary folder
+        # @param [LibraryFolder] folder - MyLibrary folder to be updated
+        # @return [LibraryFolder]
+        def update_library_folder(folder)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.library_folder'), folder.id)
+          url = build_url(url)
+          payload = folder.to_json
+          response = RestClient.put(url, payload, get_headers())
+          Components::LibraryFolder.create(JSON.parse(response.body))
+        end
+
+
+        # Delete a MyLibrary folder
+        # @param [String] folder_id - The ID for the MyLibrary folder to delete
+        # @return [Boolean]
+        def delete_library_folder(folder_id)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.library_folder'), folder_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers())
+          response.code == 204
+        end
+
+
+        # Retrieve all files in the Trash folder
+        # @param [Hash] params - hash of query parameters and values to append to the request.
+        #     Allowed parameters include:
+        #     type - Specifies the type of files to retrieve, valid values are : ALL, IMAGES, or DOCUMENTS
+        #     sort_by - The method to sort by, valid values are :
+        #         ADDED_DATE - sorts by date folder was added, ascending (earliest to latest)
+        #         ADDED_DATE_DESC - (default) sorts by date folder was added, descending (latest to earliest)
+        #         MODIFIED_DATE - sorts by date folder was last modified, ascending (earliest to latest)
+        #         MODIFIED_DATE_DESC - sorts by date folder was last modified, descending (latest to earliest)
+        #         NAME - sorts alphabetically by file name, a to z
+        #         NAME_DESC - sorts alphabetically by file name, z to a
+        #         SIZE - sorts by file size, smallest to largest
+        #         SIZE_DESC - sorts by file size, largest to smallest
+        #         DIMENSION - sorts by file dimensions (hxw), smallest to largest
+        #         DIMENSION_DESC - sorts by file dimensions (hxw), largest to smallest
+        #     limit -  Specifies the number of results displayed per page of output, from 1 - 50, default = 50.
+        # @return [ResultSet<LibraryFile>]
+        def get_library_trash(params)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_folder_trash')
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          files = []
+          body = JSON.parse(response.body)
+          body['results'].each do |file|
+            files << Components::LibraryFile.create(file)
+          end
+          Components::ResultSet.new(files, body['meta'])
+        end
+
+
+        # Permanently deletes all files in the Trash folder
+        # @return [Boolean]
+        def delete_library_trash()
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_folder_trash')
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers())
+          response.code == 204
+        end
+
+
+        # Retrieve a collection of MyLibrary files in the Constant Contact account
+        # @param [Hash] params - hash of query parameters and values to append to the request.
+        #     Allowed parameters include:
+        #     type - Specifies the type of files to retrieve, valid values are : ALL, IMAGES, or DOCUMENTS
+        #     source - Specifies to retrieve files from a particular source, valid values are :
+        #         ALL - (default) files from all sources
+        #         MyComputer
+        #         StockImage
+        #         Facebook
+        #         Instagram
+        #         Shutterstock
+        #         Mobile
+        #     limit -  Specifies the number of results displayed per page of output, from 1 - 1000, default = 50.
+        # @return [ResultSet<LibraryFile>]
+        def get_library_files(params = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_files')
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          files = []
+          body = JSON.parse(response.body)
+          body['results'].each do |file|
+            files << Components::LibraryFile.create(file)
+          end
+          Components::ResultSet.new(files, body['meta'])
+        end
+
+
+        # Retrieves all files from a MyLibrary folder specified by the folder_id path parameter
+        # @param [String] folder_id  - Specifies the folder from which to retrieve files
+        # @param [Hash] params - hash of query parameters and values to append to the request.
+        #     Allowed parameters include:
+        #     limit - Specifies the number of results displayed per page of output, from 1 - 50, default = 50.
+        # @return [ResultSet<LibraryFile>]
+        def get_library_files_by_folder(folder_id, params = {})
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.library_files_by_folder'), folder_id)
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          files = []
+          body = JSON.parse(response.body)
+          body['results'].each do |file|
+            files << Components::LibraryFile.create(file)
+          end
+          Components::ResultSet.new(files, body['meta'])
+        end
+
+
+        # Retrieve a MyLibrary file using the file_id path parameter
+        # @param [String] file_id - Specifies the MyLibrary file for which to retrieve information
+        # @return [LibraryFile]
+        def get_library_file(file_id)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.library_file'), file_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::LibraryFile.create(JSON.parse(response.body))
+        end
+
+
+        # Adds a new MyLibrary file using the multipart content-type
+        # @param [String] file_name - The name of the file (ie: dinnerplate-special.jpg)
+        # @param [String] folder_id - Folder id to add the file to
+        # @param [String] description - The description of the file provided by user 
+        # @param [String] source - indicates the source of the original file; 
+        #                          image files can be uploaded from the following sources :
+        #                          MyComputer, StockImage, Facebook - MyLibrary Plus customers only,
+        #                          Instagram - MyLibrary Plus customers only, Shutterstock, Mobile
+        # @param [String] file_type - Specifies the file type, valid values are: JPEG, JPG, GIF, PDF, PNG 
+        # @param [String] contents - The content of the file
+        # @return [LibraryFile]
+        def add_library_file(file_name, folder_id, description, source, file_type, contents)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.library_files')
+          url = build_url(url)
+
+          payload = { :file_name => file_name, :folder_id => folder_id, 
+                      :description => description, :source => source, :file_type => file_type, 
+                      :data => contents, :multipart => true }
+
+          response = RestClient.post(url, payload, get_headers())
+          location = response.headers[:location] || ''
+          location.split('/').last
+        end
+
+
+        # Update information for a specific MyLibrary file
+        # @param [LibraryFile] file - Library File to be updated
+        # @return [LibraryFile]
+        def update_library_file(file)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.library_file'), file.id)
+          url = build_url(url)
+          payload = file.to_json
+          response = RestClient.put(url, payload, get_headers())
+          Components::LibraryFile.create(JSON.parse(response.body))
+        end
+
+
+        # Delete one or more MyLibrary files specified by the fileId path parameter; 
+        # separate multiple file IDs with a comma. 
+        # Deleted files are moved from their current folder into the system Trash folder, and its status is set to Deleted.
+        # @param [String] file_id - Specifies the MyLibrary file to delete
+        # @return [Boolean]
+        def delete_library_file(file_id)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.library_file'), file_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers())
+          response.code == 204
+        end
+
+
+        # Retrieve the upload status for one or more MyLibrary files using the file_id path parameter; 
+        # separate multiple file IDs with a comma
+        # @param [String] file_id - Specifies the files for which to retrieve upload status information
+        # @return [Array<UploadStatus>]
+        def get_library_files_upload_status(file_id)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.library_file_upload_status'), file_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          statuses = []
+          JSON.parse(response.body).each do |status|
+            statuses << Components::UploadStatus.create(status)
+          end
+          statuses
+        end
+
+
+        # Move one or more MyLibrary files to a different folder in the user's account
+        # specify the destination folder using the folder_id path parameter. 
+        # @param [String] folder_id - Specifies the destination MyLibrary folder to which the files will be moved
+        # @param [String] file_id - Specifies the files to move, in a string of comma separated file ids (e.g. 8,9)
+        # @return [Array<MoveResults>]
+        def move_library_files(folder_id, file_id)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.library_file_move'), folder_id)
+          url = build_url(url)
+ 
+          payload = file_id.split(',').map {|id| id.strip}.to_json
+          response = RestClient.put(url, payload, get_headers())
+          results = []
+          JSON.parse(response.body).each do |result|
+            results << Components::MoveResults.create(result)
+          end
+          results
+        end
+
+      end
+    end
+  end
+end

data/lib/constantcontact/services/list_service.rb

@@ -0,0 +1,81 @@
+#
+# list_service.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Services
+    class ListService < BaseService
+      class << self
+
+        # Get lists within an account
+        # @param [Hash] params - query parameters to be appended to the request
+        # @return [Array<ContactList>]
+        def get_lists(params = {})
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.lists')
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          lists = []
+          JSON.parse(response.body).each do |contact|
+            lists << Components::ContactList.create(contact)
+          end
+          lists
+        end
+
+
+        # Add a new list to the Constant Contact account
+        # @param [ContactList] list
+        # @return [ContactList]
+        def add_list(list)
+          url = Util::Config.get('endpoints.base_url') + Util::Config.get('endpoints.lists')
+          url = build_url(url)
+          payload = list.to_json
+          response = RestClient.post(url, payload, get_headers())
+          Components::ContactList.create(JSON.parse(response.body))
+        end
+
+
+        # Update a Contact List
+        # @param [ContactList] list - ContactList to be updated
+        # @return [ContactList]
+        def update_list(list)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list'), list.id)
+          url = build_url(url)
+          payload = list.to_json
+          response = RestClient.put(url, payload, get_headers())
+          Components::ContactList.create(JSON.parse(response.body))
+        end
+
+
+        # Get an individual contact list
+        # @param [Integer] list_id - list id
+        # @return [ContactList]
+        def get_list(list_id)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list'), list_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers())
+          Components::ContactList.create(JSON.parse(response.body))
+        end
+
+
+        # Get all contacts from an individual list
+        # @param [Integer] list_id - list id to retrieve contacts for
+        # @param [Hash] params - query parameters to attach to request
+        # @return [Array<Contact>]
+        def get_contacts_from_list(list_id, params = nil)
+          url = Util::Config.get('endpoints.base_url') + sprintf(Util::Config.get('endpoints.list_contacts'), list_id)
+          url = build_url(url, params)
+          response = RestClient.get(url, get_headers())
+          contacts = []
+          body = JSON.parse(response.body)
+          body['results'].each do |contact|
+            contacts << Components::Contact.create(contact)
+          end
+          Components::ResultSet.new(contacts, body['meta'])
+        end
+
+      end
+    end
+  end
+end

data/lib/constantcontact/util/config.rb

@@ -0,0 +1,180 @@
+#
+# config.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Util
+    class Config
+
+      # Return a hash of configuration strings
+      # @return [Hash] - hash of configuration properties
+      @props = {
+        # REST endpoints
+        :endpoints => {
+          :api_url                        => 'https://api.constantcontact.com',
+          :base_url                       => 'https://api.constantcontact.com/v2/',
+
+          :activity                       => 'activities/%s',
+          :activities                     => 'activities',
+          :export_contacts_activity       => 'activities/exportcontacts',
+          :clear_lists_activity           => 'activities/clearlists',
+          :remove_from_lists_activity     => 'activities/removefromlists',
+          :add_contacts_activity          => 'activities/addcontacts',
+
+          :account_verified_addresses     => 'account/verifiedemailaddresses',
+          :account_info                   => 'account/info',
+
+          :contact                        => 'contacts/%s',
+          :contacts                       => 'contacts',
+          :lists                          => 'lists',
+          :list                           => 'lists/%s',
+          :list_contacts                  => 'lists/%s/contacts',
+          :contact_lists                  => 'contacts/%s/lists',
+          :contact_list                   => 'contacts/%s/lists/%s',
+
+          :campaigns                      => 'emailmarketing/campaigns',
+          :campaign                       => 'emailmarketing/campaigns/%s',
+          :campaign_preview               => 'emailmarketing/campaigns/%s/preview',
+          :campaign_schedules             => 'emailmarketing/campaigns/%s/schedules',
+          :campaign_schedule              => 'emailmarketing/campaigns/%s/schedules/%s',
+          :campaign_test_sends            => 'emailmarketing/campaigns/%s/tests',
+          :campaign_tracking_summary      => 'emailmarketing/campaigns/%s/tracking/reports/summary',
+          :campaign_tracking_bounces      => 'emailmarketing/campaigns/%s/tracking/bounces',
+          :campaign_tracking_clicks       => 'emailmarketing/campaigns/%s/tracking/clicks',
+          :campaign_tracking_forwards     => 'emailmarketing/campaigns/%s/tracking/forwards',
+          :campaign_tracking_opens        => 'emailmarketing/campaigns/%s/tracking/opens',
+          :campaign_tracking_sends        => 'emailmarketing/campaigns/%s/tracking/sends',
+          :campaign_tracking_unsubscribes => 'emailmarketing/campaigns/%s/tracking/unsubscribes',
+          :campaign_tracking_link         => 'emailmarketing/campaigns/%s/tracking/clicks/%s',
+
+          :events                         => 'eventspot/events',
+          :event                          => 'eventspot/events/%s',
+          :event_fees                     => 'eventspot/events/%s/fees',
+          :event_fee                      => 'eventspot/events/%s/fees/%s',
+          :event_registrants              => 'eventspot/events/%s/registrants',
+          :event_registrant               => 'eventspot/events/%s/registrants/%s',
+          :event_items                    => 'eventspot/events/%s/items',
+          :event_item                     => 'eventspot/events/%s/items/%s',
+          :event_item_attributes          => 'eventspot/events/%s/items/%s/attributes',
+          :event_item_attribute           => 'eventspot/events/%s/items/%s/attributes/%s',
+          :event_promocodes               => 'eventspot/events/%s/promocodes',
+          :event_promocode                => 'eventspot/events/%s/promocodes/%s',
+
+          :contact_tracking_summary       => 'contacts/%s/tracking/reports/summary',
+          :contact_tracking_bounces       => 'contacts/%s/tracking/bounces',
+          :contact_tracking_clicks        => 'contacts/%s/tracking/clicks',
+          :contact_tracking_forwards      => 'contacts/%s/tracking/forwards',
+          :contact_tracking_opens         => 'contacts/%s/tracking/opens',
+          :contact_tracking_sends         => 'contacts/%s/tracking/sends',
+          :contact_tracking_unsubscribes  => 'contacts/%s/tracking/unsubscribes',
+          :contact_tracking_link          => 'contacts/%s/tracking/clicks/%s',
+
+          :library_info                   => 'library/info',
+          :library_files                  => 'library/files',
+          :library_files_by_folder        => 'library/folders/%s/files',
+          :library_folders                => 'library/folders',
+          :library_folder                 => 'library/folders/%s',
+          :library_folder_trash           => 'library/folders/trash/files',
+          :library_file                   => 'library/files/%s',
+          :library_file_upload_status     => 'library/files/uploadstatus/%s',
+          :library_file_move              => 'library/folders/%s/files'
+        },
+
+        # OAuth2 Authorization related configuration options
+        :auth => {
+          :base_url                      => 'https://oauth2.constantcontact.com/oauth2/',
+          :response_type_code            => 'code',
+          :response_type_token           => 'token',
+          :authorization_code_grant_type => 'authorization_code',
+          :authorization_endpoint        => 'oauth/siteowner/authorize',
+          :token_endpoint                => 'oauth/token',
+          :token_info                    => 'tokeninfo.htm',
+          :api_key                       => '',
+          :api_secret                    => '',
+          :redirect_uri                  => ''
+        },
+
+        # Column names used with bulk activities
+        :activities_columns => {
+          :email            => 'EMAIL',
+          :first_name       => 'FIRST NAME',
+          :middle_name      => 'MIDDLE NAME',
+          :last_name        => 'LAST NAME',
+          :birthday_day     => 'BIRTHDAY_DAY',
+          :birthday_month   => 'BIRTHDAY_MONTH',
+          :anniversary      => 'ANNIVERSARY',
+          :job_title        => 'JOB TITLE',
+          :company_name     => 'COMPANY NAME',
+          :work_phone       => 'WORK PHONE',
+          :home_phone       => 'HOME PHONE',
+          :address1         => 'ADDRESS LINE 1',
+          :address2         => 'ADDRESS LINE 2',
+          :address3         => 'ADDRESS LINE 3',
+          :city             => 'CITY',
+          :state            => 'STATE',
+          :state_province   => 'US STATE/CA PROVINCE',
+          :country          => 'COUNTRY',
+          :postal_code      => 'ZIP/POSTAL CODE',
+          :sub_postal_code  => 'SUB ZIP/POSTAL CODE',
+          :custom_field_1   => 'CUSTOM FIELD 1',
+          :custom_field_2   => 'CUSTOM FIELD 2',
+          :custom_field_3   => 'CUSTOM FIELD 3',
+          :custom_field_4   => 'CUSTOM FIELD 4',
+          :custom_field_5   => 'CUSTOM FIELD 5',
+          :custom_field_6   => 'CUSTOM FIELD 6',
+          :custom_field_7   => 'CUSTOM FIELD 7',
+          :custom_field_8   => 'CUSTOM FIELD 8',
+          :custom_field_9   => 'CUSTOM FIELD 9',
+          :custom_field_10  => 'CUSTOM FIELD 10',
+          :custom_field_11  => 'CUSTOM FIELD 11',
+          :custom_field_12  => 'CUSTOM FIELD 12',
+          :custom_field_13  => 'CUSTOM FIELD 13',
+          :custom_field_14  => 'CUSTOM FIELD 14',
+          :custom_field_15  => 'CUSTOM FIELD 15'
+        },
+
+        # Errors to be returned for various exceptions
+        :errors => {
+          :api_key_missing      => 'api_key required either explicitly or in configuration.',
+          :access_token_missing => 'access_token required explicitly.',
+          :id_or_object         => 'Only an id or %s object are allowed for this method.',
+          :invalid_webhook      => 'Invalid Webhook. The x-ctct-hmac-sha256 does not correspond to message encryption.',
+          :api_secret_missing   => 'The api_secret is missing in explicit call or configuration.'
+        }
+      }
+
+      class << self
+        attr_accessor :props
+
+         def configure 
+          yield props if block_given?
+        end
+
+        # Get a configuration property given a specified location, example usage: Config::get('auth.token_endpoint')
+        # @param [String] index - location of the property to obtain
+        # @return [String]
+        def get(index)
+          properties = index.split('.')
+          get_value(properties, props)
+        end
+
+        private
+
+        # Navigate through a config array looking for a particular index
+        # @param [Array] index The index sequence we are navigating down
+        # @param [Hash, String] value The portion of the config array to process
+        # @return [String]
+        def get_value(index, value)
+          index = index.is_a?(Array) ? index : [index]
+          key = index.shift.to_sym
+          value.is_a?(Hash) and value[key] and value[key].is_a?(Hash) ?
+          get_value(index, value[key]) :
+          value[key]
+        end
+      end
+
+    end
+  end
+end

data/lib/constantcontact/util/helpers.rb

@@ -0,0 +1,27 @@
+#
+# helpers.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Util
+    class Helpers
+      class << self
+
+        # Build the HTTP query from the given parameters
+        # @param [Hash] params
+        # @return [String] query string
+        def http_build_query(params)
+          params.collect{ |k,v| "#{k.to_s}=#{encode(v.to_s)}" }.reverse.join('&')
+        end
+
+        # Escape special characters
+        # @param [String] str
+        def encode(str)
+          CGI.escape(str).gsub('.', '%2E').gsub('-', '%2D')
+        end
+      end
+    end
+  end
+end

data/lib/constantcontact/version.rb

@@ -0,0 +1,12 @@
+#
+# version.rb
+# ConstantContact
+#
+# Copyright (c) 2015 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module SDK
+    # Gem version
+    VERSION = "2.2.0"
+  end
+end

data/lib/constantcontact/webhooks/helpers/validator.rb

@@ -0,0 +1,30 @@
+#
+# validator.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Webhooks
+    module Helpers
+      class Validator
+        class << self
+
+          # Validate the request received from Constant Contact.
+          # Compute the HMAC digest and compare it to the value in the x-ctct-hmac-sha256 header.
+          # If they match, you can be sure that the webhook was sent by Constant Contact and the message has not been compromised.
+          # @param [String] secret The Constant Contact secret key
+          # @param [String] hmac The value received in the x-ctct-hmac-sha256 header.
+          # @param [String] data The body message from the POST received from ConstantContact in Webhook callback.
+          # @return true if the computed vs. received values match; false otherwise.
+          def validate(secret, hmac, data)
+            digest = OpenSSL::Digest.new('sha256')
+            calculated_hmac = Base64.encode64(OpenSSL::HMAC.digest(digest, secret, data)).strip
+            calculated_hmac == hmac
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/constantcontact/webhooks/models/billing_change_notification.rb

@@ -0,0 +1,27 @@
+#
+# billing_change_notification.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Webhooks
+    module Models
+      class BillingChangeNotification
+        attr_accessor :event_type, :url
+
+        # Factory method to create a BillingChangeNotification model object from a hash
+        # @param [Hash] props - hash of properties to create object from
+        # @return [BillingChangeNotification]
+        def self.create(props)
+          obj = BillingChangeNotification.new
+          props.each do |key, value|
+            key = key.to_s
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end if props
+          obj
+        end
+      end
+    end
+  end
+end