constantcontact 2.2.1 → 3.0.0

data/lib/constantcontact/services/list_service.rb

@@ -7,75 +7,73 @@
 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
+      # 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
+      # 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
+      # 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 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'])
+      # 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

data/lib/constantcontact/version.rb

@@ -7,6 +7,6 @@
 module ConstantContact
   module SDK
     # Gem version
-    VERSION = "2.2.0"
+    VERSION = "3.0.0"
   end
 end

data/spec/constantcontact/api_spec.rb

@@ -30,7 +30,6 @@ describe ConstantContact::Api do
 
   context "with middle-ware configuration" do
     before(:all) do
-      ConstantContact::Services::BaseService.api_key = nil
       ConstantContact::Util::Config.configure do |config|
         config[:auth][:api_key] = "config_api_key"
         config[:auth][:api_secret] = "config_api_secret"
@@ -42,13 +41,12 @@ describe ConstantContact::Api do
       proc.should raise_error(ArgumentError, ConstantContact::Util::Config.get('errors.access_token_missing'))
     end
     it "has the correct implicit api key" do
-      ConstantContact::Services::BaseService.api_key.should == "config_api_key"
+      ConstantContact::Api.new(nil, "access_token").api_key.should == "config_api_key"
     end
   end
 
   context "with middle-ware configuration" do
     before(:all) do
-      ConstantContact::Services::BaseService.api_key = nil
       ConstantContact::Util::Config.configure do |config|
         config[:auth][:api_key] = "config_api_key"
         config[:auth][:api_secret] = "config_api_secret"
@@ -57,7 +55,7 @@ describe ConstantContact::Api do
       ConstantContact::Api.new('explicit_api_key', 'access_token')
     end
     it "has the correct explicit api key" do
-      ConstantContact::Services::BaseService.api_key.should == "explicit_api_key"
+      ConstantContact::Api.new('explicit_api_key', "access_token").api_key.should == "explicit_api_key"
     end
   end
 

data/spec/constantcontact/services/account_service_spec.rb

@@ -9,6 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Services::AccountService do
   before(:each) do
     @request = double('http request', :user => nil, :password => nil, :url => 'http://example.com', :redirection_history => nil)
+    @client = ConstantContact::Api.new('explicit_api_key', "access_token")
   end
 
   describe "#get_account_info" do
@@ -19,7 +20,7 @@ describe ConstantContact::Services::AccountService do
       response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      result = ConstantContact::Services::AccountService.get_account_info()
+      result = ConstantContact::Services::AccountService.new(@client).get_account_info()
       result.should be_kind_of(ConstantContact::Components::AccountInfo)
       result.website.should eq('http://www.example.com')
       result.organization_addresses.first.should be_kind_of(ConstantContact::Components::AccountAddress)
@@ -36,7 +37,7 @@ describe ConstantContact::Services::AccountService do
       RestClient.stub(:get).and_return(response)
 
       params = {}
-      email_addresses = ConstantContact::Services::AccountService.get_verified_email_addresses(params)
+      email_addresses = ConstantContact::Services::AccountService.new(@client).get_verified_email_addresses(params)
 
       email_addresses.should be_kind_of(Array)
       email_addresses.first.should be_kind_of(ConstantContact::Components::VerifiedEmailAddress)

data/spec/constantcontact/services/activity_service_spec.rb

@@ -9,6 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Services::ActivityService do
   before(:each) do
     @request = double('http request', :user => nil, :password => nil, :url => 'http://example.com', :redirection_history => nil)
+    @client = ConstantContact::Api.new('explicit_api_key', "access_token")
   end
 
   describe "#get_activities" do
@@ -19,7 +20,7 @@ describe ConstantContact::Services::ActivityService do
       response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      activities = ConstantContact::Services::ActivityService.get_activities()
+      activities = ConstantContact::Services::ActivityService.new(@client).get_activities()
       activities.first.should be_kind_of(ConstantContact::Components::Activity)
       activities.first.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
     end
@@ -33,7 +34,7 @@ describe ConstantContact::Services::ActivityService do
       response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      activity = ConstantContact::Services::ActivityService.get_activity('a07e1ilbm7shdg6ikeo')
+      activity = ConstantContact::Services::ActivityService.new(@client).get_activity('a07e1ilbm7shdg6ikeo')
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
     end
@@ -123,7 +124,7 @@ describe ConstantContact::Services::ActivityService do
 
       JSON.parse(json_request).should eq(JSON.parse(JSON.generate(add_contact)))
 
-      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity(add_contact)
+      activity = ConstantContact::Services::ActivityService.new(@client).create_add_contacts_activity(add_contact)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('ADD_CONTACTS')
     end
@@ -139,7 +140,7 @@ describe ConstantContact::Services::ActivityService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:post).and_return(response)
 
-      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity_from_file(
+      activity = ConstantContact::Services::ActivityService.new(@client).create_add_contacts_activity_from_file(
         'contacts.txt', content, lists)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('ADD_CONTACTS')
@@ -159,7 +160,7 @@ describe ConstantContact::Services::ActivityService do
       response = RestClient::Response.create(json_clear_lists, net_http_resp, {}, @request)
       RestClient.stub(:post).and_return(response)
 
-      activity = ConstantContact::Services::ActivityService.add_clear_lists_activity(lists)
+      activity = ConstantContact::Services::ActivityService.new(@client).add_clear_lists_activity(lists)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('CLEAR_CONTACTS_FROM_LISTS')
     end
@@ -175,7 +176,7 @@ describe ConstantContact::Services::ActivityService do
       RestClient.stub(:post).and_return(response)
       email_addresses = ["djellesma@constantcontact.com"]
 
-      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity(
+      activity = ConstantContact::Services::ActivityService.new(@client).add_remove_contacts_from_lists_activity(
         email_addresses, lists)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
@@ -192,7 +193,7 @@ describe ConstantContact::Services::ActivityService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:post).and_return(response)
 
-      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity_from_file(
+      activity = ConstantContact::Services::ActivityService.new(@client).add_remove_contacts_from_lists_activity_from_file(
         'contacts.txt', content, lists)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
@@ -210,7 +211,7 @@ describe ConstantContact::Services::ActivityService do
 
       export_contacts = ConstantContact::Components::ExportContacts.new(JSON.parse(json_request))
 
-      activity = ConstantContact::Services::ActivityService.add_export_contacts_activity(export_contacts)
+      activity = ConstantContact::Services::ActivityService.new(@client).add_export_contacts_activity(export_contacts)
       activity.should be_kind_of(ConstantContact::Components::Activity)
       activity.type.should eq('EXPORT_CONTACTS')
     end
@@ -237,7 +238,7 @@ describe ConstantContact::Services::ActivityService do
         end
       end
 
-      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity(email_addresses, lists)
+      activity = ConstantContact::Services::ActivityService.new(@client).add_remove_contacts_from_lists_activity(email_addresses, lists)
       activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
     end
   end

data/spec/constantcontact/services/base_service_spec.rb

@@ -7,11 +7,13 @@
 require 'spec_helper'
 
 describe ConstantContact::Services::BaseService do
+  before(:each) { 
+    @client = ConstantContact::Api.new('api key', "foo")
+  }
   describe "#get_headers" do
     it "gets a hash of headers" do
       token = 'foo'
-      ConstantContact::Services::BaseService.access_token = token
-      headers = ConstantContact::Services::BaseService.send(:get_headers)
+      headers = ConstantContact::Services::BaseService.new(@client).send(:get_headers)
 
       expect(headers).to be_a Hash
       expect(headers[:content_type]).to be_a String
@@ -30,7 +32,7 @@ describe ConstantContact::Services::BaseService do
 
   describe "#build_url" do
     it "combines all the given parameters into the url" do
-      components = ConstantContact::Services::BaseService.send(:build_url, "http://testing.com", :arg1 => 'abc', :arg2 => 123).split('&')
+      components = ConstantContact::Services::BaseService.new(@client).send(:build_url, "http://testing.com", :arg1 => 'abc', :arg2 => 123).split('&')
       expect(components[0]).to eq('http://testing.com?api_key=api+key')
       expect(components.length).to eq(3)
       expect(components.include?('arg1=abc')).to be_true
@@ -38,12 +40,12 @@ describe ConstantContact::Services::BaseService do
     end
 
     it "does not parse the next param when not in next_link format" do
-      url = ConstantContact::Services::BaseService.send(:build_url, "http://testing.com", :next => "abcdef")
+      url = ConstantContact::Services::BaseService.new(@client).send(:build_url, "http://testing.com", :next => "abcdef")
       expect(url).to eq('http://testing.com?api_key=api+key&next=abcdef')
     end
 
     it "parses next id from next param given in next_link format" do
-      url = ConstantContact::Services::BaseService.send(:build_url, "http://testing.com", :next => "/some/path?next=abcdefg")
+      url = ConstantContact::Services::BaseService.new(@client).send(:build_url, "http://testing.com", :next => "/some/path?next=abcdefg")
       expect(url).to eq('http://testing.com?api_key=api+key&next=abcdefg')
     end
   end

data/spec/constantcontact/services/campaign_schedule_service_spec.rb

@@ -9,6 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Services::CampaignScheduleService do
   before(:each) do
     @request = double('http request', :user => nil, :password => nil, :url => 'http://example.com', :redirection_history => nil)
+    @client = ConstantContact::Api.new('explicit_api_key', "access_token")
   end
 
   describe "#add_schedule" do
@@ -21,7 +22,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       RestClient.stub(:post).and_return(response)
       new_schedule = ConstantContact::Components::Schedule.create(JSON.parse(json))
 
-      schedule = ConstantContact::Services::CampaignScheduleService.add_schedule(
+      schedule = ConstantContact::Services::CampaignScheduleService.new(@client).add_schedule(
         campaign_id, new_schedule)
       schedule.should be_kind_of(ConstantContact::Components::Schedule)
       schedule.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
@@ -37,7 +38,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      schedules = ConstantContact::Services::CampaignScheduleService.get_schedules(
+      schedules = ConstantContact::Services::CampaignScheduleService.new(@client).get_schedules(
         campaign_id)
       schedules.first.should be_kind_of(ConstantContact::Components::Schedule)
       schedules.first.scheduled_date.should eq('2012-12-16T11:07:43.626Z')
@@ -55,7 +56,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      schedule = ConstantContact::Services::CampaignScheduleService.get_schedule(
+      schedule = ConstantContact::Services::CampaignScheduleService.new(@client).get_schedule(
         campaign_id, schedule_id)
       schedule.should be_kind_of(ConstantContact::Components::Schedule)
       schedule.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
@@ -71,7 +72,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       response = RestClient::Response.create('', net_http_resp, {}, @request)
       RestClient.stub(:delete).and_return(response)
 
-      result = ConstantContact::Services::CampaignScheduleService.delete_schedule(
+      result = ConstantContact::Services::CampaignScheduleService.new(@client).delete_schedule(
         campaign_id, schedule_id)
       result.should be_true
     end
@@ -87,7 +88,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       RestClient.stub(:put).and_return(response)
       schedule = ConstantContact::Components::Schedule.create(JSON.parse(json))
 
-      result = ConstantContact::Services::CampaignScheduleService.update_schedule(
+      result = ConstantContact::Services::CampaignScheduleService.new(@client).update_schedule(
         campaign_id, schedule)
       result.should be_kind_of(ConstantContact::Components::Schedule)
       result.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
@@ -105,7 +106,7 @@ describe ConstantContact::Services::CampaignScheduleService do
       RestClient.stub(:post).and_return(response)
       test_send = ConstantContact::Components::TestSend.create(JSON.parse(json_request))
 
-      result = ConstantContact::Services::CampaignScheduleService.send_test(
+      result = ConstantContact::Services::CampaignScheduleService.new(@client).send_test(
         campaign_id, test_send)
       result.should be_kind_of(ConstantContact::Components::TestSend)
       result.personal_message.should eq('This is a test send of the email campaign message.')

data/spec/constantcontact/services/campaign_tracking_service_spec.rb

@@ -9,6 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Services::CampaignTrackingService do
   before(:each) do
     @request = double('http request', :user => nil, :password => nil, :url => 'http://example.com', :redirection_history => nil)
+    @client = ConstantContact::Api.new('explicit_api_key', "access_token")
   end
 
   describe "#get_bounces" do
@@ -21,7 +22,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_bounces(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_bounces(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::BounceActivity)
       set.results.first.activity_type.should eq('EMAIL_BOUNCE')
@@ -38,7 +39,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_clicks(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_clicks(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::ClickActivity)
       set.results.first.activity_type.should eq('EMAIL_CLICK')
@@ -55,7 +56,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_forwards(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_forwards(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::ForwardActivity)
       set.results.first.activity_type.should eq('EMAIL_FORWARD')
@@ -72,7 +73,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_opens(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_opens(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::OpenActivity)
       set.results.first.activity_type.should eq('EMAIL_OPEN')
@@ -89,7 +90,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_sends(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_sends(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::SendActivity)
       set.results.first.activity_type.should eq('EMAIL_SEND')
@@ -106,7 +107,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      set = ConstantContact::Services::CampaignTrackingService.get_unsubscribes(campaign_id, params)
+      set = ConstantContact::Services::CampaignTrackingService.new(@client).get_unsubscribes(campaign_id, params)
       set.should be_kind_of(ConstantContact::Components::ResultSet)
       set.results.first.should be_kind_of(ConstantContact::Components::UnsubscribeActivity)
       set.results.first.activity_type.should eq('EMAIL_UNSUBSCRIBE')
@@ -122,7 +123,7 @@ describe ConstantContact::Services::CampaignTrackingService do
       response = RestClient::Response.create(json, net_http_resp, {}, @request)
       RestClient.stub(:get).and_return(response)
 
-      summary = ConstantContact::Services::CampaignTrackingService.get_summary(campaign_id)
+      summary = ConstantContact::Services::CampaignTrackingService.new(@client).get_summary(campaign_id)
       summary.should be_kind_of(ConstantContact::Components::TrackingSummary)
       summary.sends.should eq(15)
     end