constantcontact 1.0.2 → 1.1.0

data/spec/constantcontact/auth/oauth2_spec.rb

@@ -7,7 +7,7 @@
 require 'spec_helper'
 
 describe ConstantContact::Auth::OAuth2 do
-  
+
   before(:all) {
     ConstantContact::Util::Config.configure do |config|
       config[:auth].delete :api_key
@@ -15,21 +15,21 @@ describe ConstantContact::Auth::OAuth2 do
       config[:auth].delete :redirect_uri
     end
   }
-  
-	describe "#new" do
-		it "fails without arguments and no configuration" do
-			lambda {
-				ConstantContact::Auth::OAuth2.new
-			}.should raise_error(ArgumentError)
-		end
-    
-		it "takes one argument" do
-			opts = {:api_key => 'api key', :api_secret => 'secret', :redirect_url => 'redirect url'}
-			lambda {
-				ConstantContact::Auth::OAuth2.new(opts)
-			}.should_not raise_error
-		end
-	end
+
+  describe "#new" do
+    it "fails without arguments and no configuration" do
+      lambda {
+        ConstantContact::Auth::OAuth2.new
+      }.should raise_error(ArgumentError)
+    end
+
+    it "takes one argument" do
+      opts = {:api_key => 'api key', :api_secret => 'secret', :redirect_url => 'redirect url'}
+      lambda {
+        ConstantContact::Auth::OAuth2.new(opts)
+      }.should_not raise_error
+    end
+  end
 
   context "with middle-ware configuration" do
     before(:all) do
@@ -39,9 +39,9 @@ describe ConstantContact::Auth::OAuth2 do
         config[:auth][:redirect_uri] = "config_redirect_uri"
       end
     end
-		let(:proc) { lambda { ConstantContact::Auth::OAuth2.new } }
+    let(:proc) { lambda { ConstantContact::Auth::OAuth2.new } }
     it "without error" do
-		  proc.should_not raise_error
+      proc.should_not raise_error
     end
     let(:oauth) { proc.call }
     it "has correct api_key" do
@@ -53,7 +53,7 @@ describe ConstantContact::Auth::OAuth2 do
     it "has correct redirect_uri" do
       oauth.redirect_uri.should == "config_redirect_uri"
     end
-	end
+  end
 
   context "with middle-ware configuration and explicit opts" do
     before(:all) do
@@ -63,9 +63,9 @@ describe ConstantContact::Auth::OAuth2 do
         config[:auth][:redirect_uri] = "config_redirect_uri"
       end
     end
-		let(:proc) { lambda { ConstantContact::Auth::OAuth2.new :api_key => 'explicit_api_key', :api_secret => 'explicit_api_secret', :redirect_url => 'explicit_redirect_uri' } }
+    let(:proc) { lambda { ConstantContact::Auth::OAuth2.new :api_key => 'explicit_api_key', :api_secret => 'explicit_api_secret', :redirect_url => 'explicit_redirect_uri' } }
     it "without error" do
-		  proc.should_not raise_error
+      proc.should_not raise_error
     end
     let(:oauth) { proc.call }
     it "has correct api_key" do
@@ -77,36 +77,49 @@ describe ConstantContact::Auth::OAuth2 do
     it "has correct redirect_uri" do
       oauth.redirect_uri.should == "explicit_redirect_uri"
     end
-	end
+  end
 
-	it "with explicit arguments and no configuration" do
-		lambda {
-			ConstantContact::Auth::OAuth2.new  :api_key => "api_key", :api_secret => "api_secret", :redirect_uri => "redirect_uri"
-		}.should raise_error(ArgumentError)
-	end
+  it "with explicit arguments and no configuration" do
+    lambda {
+      ConstantContact::Auth::OAuth2.new  :api_key => "api_key", :api_secret => "api_secret", :redirect_url => "redirect_uri"
+    }.should_not raise_error
+  end
 
+  let(:proc) { lambda { ConstantContact::Auth::OAuth2.new(:api_key => "api_key", :api_secret => "api_secret", :redirect_url => "redirect_uri") } }
+  let(:oauth) { proc.call }
 
-	describe "#get_authorization_url" do
-		before(:each) do
-			opts = {:api_key => 'api key', :api_secret => 'secret', :redirect_url => 'redirect url'}
-			@auth = ConstantContact::Auth::OAuth2.new(opts)
-		end
+  describe "#get_authorization_url" do
+    it "returns a string" do
+      oauth.get_authorization_url.should be_kind_of(String)
+      oauth.get_authorization_url(true, 'my_param').should match('state=my_param')
+    end
+  end
 
-		it "returns a string" do
-			@auth.get_authorization_url.should be_kind_of(String)
-		end
-	end
+  describe "#get_access_token" do
+    it "returns a Hash" do
+      json = load_file('access_token.json')
+      RestClient.stub(:post).and_return(json)
+      oauth.get_access_token('token').should be_kind_of(Hash)
+    end
 
-	describe "#get_access_token" do
-		before(:each) do
-			opts = {:api_key => 'api key', :api_secret => 'secret', :redirect_url => 'redirect url'}
-			@auth = ConstantContact::Auth::OAuth2.new(opts)
-		end
+    it "throws an OAuth2Exception in case of error" do
+      json = load_file('access_token_error.json')
+      RestClient.stub(:post).and_return(json)
+      lambda {
+        oauth.get_access_token('token')
+      }.should raise_exception(ConstantContact::Exceptions::OAuth2Exception, 
+        'The resource owner or authorization server denied the request.')
+    end
+  end
+
+  describe "#get_token_info" do
+    it "returns a Hash" do
+      json = load_file('token_info.json')
+      RestClient.stub(:post).and_return(json)
+      info = oauth.get_token_info('token')
+      info.should be_kind_of(Hash)
+      info['user_name'].should eq('ctcttest')
+    end
+  end
 
-		it "returns a Hash" do
-			json = load_json('access_token.json')
-			RestClient.stub(:post).and_return(json)
-			@auth.get_access_token('token').should be_kind_of(Hash)
-		end
-	end
 end

data/spec/constantcontact/components/contacts/address_spec.rb

@@ -9,7 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Components::Address do
   describe "#from_list" do
     it "should return an address" do
-      json = load_json('address.json')
+      json = load_file('address.json')
       address = ConstantContact::Components::Address.create(JSON.parse(json))
 
       address.line1.should eq('6 Main Street')

data/spec/constantcontact/components/contacts/contact_list_spec.rb

@@ -9,7 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Components::ContactList do
   describe "#from_list" do
     it "should return a list" do
-      json = load_json('list.json')
+      json = load_file('list.json')
       list = ConstantContact::Components::ContactList.create(JSON.parse(json))
 
       list.name.should eq('Fake List')

data/spec/constantcontact/components/contacts/contact_spec.rb

@@ -9,7 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Components::Contact do
   describe "#from_list" do
     it "should return a contact" do
-      json = load_json('contact.json')
+      json = load_file('contact.json')
       contact = ConstantContact::Components::Contact.create(JSON.parse(json))
 
       contact.last_name.should eq('Smith')

data/spec/constantcontact/components/contacts/email_address_spec.rb

@@ -9,7 +9,7 @@ require 'spec_helper'
 describe ConstantContact::Components::EmailAddress do
   describe "#from_list" do
     it "should return an email address" do
-      json = load_json('email_address.json')
+      json = load_file('email_address.json')
       email = ConstantContact::Components::EmailAddress.create(JSON.parse(json))
 
       email.email_address.should eq('wm2q7rwtp77m@roving.com')

data/spec/constantcontact/services/activity_service_spec.rb

@@ -0,0 +1,201 @@
+#
+# activity_service_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Services::ActivityService do
+  describe "#get_activities" do
+    it "gets a set of activities" do
+      json_response = load_file('activities_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {})
+      RestClient.stub(:get).and_return(response)
+
+      activities = ConstantContact::Services::ActivityService.get_activities('token')
+      activities.first.should be_kind_of(ConstantContact::Components::Activity)
+      activities.first.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
+    end
+  end
+
+  describe "#get_activity" do
+    it "gets an activity" do
+      json_response = load_file('activity_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {})
+      RestClient.stub(:get).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.get_activity('token', 'a07e1ilbm7shdg6ikeo')
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
+    end
+  end
+
+  describe "#create_add_contacts_activity" do
+    it "creates an Add Contacts Activity" do
+      json_add_contacts = load_file('add_contacts_response.json')
+      json_lists = load_file('lists_response.json')
+      json_contacts = load_file('contacts_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_add_contacts, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      import = ConstantContact::Components::AddContactsImportData.new
+      address = ConstantContact::Components::Address.create(
+        :line1 => "1601 Trapelo Rd",
+        :city => "Waltham",
+        :state => "MA"
+      )
+      import.add_address(address)
+
+      custom_field = ConstantContact::Components::CustomField.create(
+        :name => "custom_field_1",
+        :value => "my custom value"
+      )
+      import.add_custom_field(custom_field)
+      import.add_email("abc@def.com")
+
+      contacts = []
+      contacts << import
+      contacts_objects = JSON.parse(json_contacts)
+      contacts_objects['results'].each do |contact|
+        contacts << ConstantContact::Components::Contact.create(contact)
+      end
+
+      lists = []
+      lists_objects = JSON.parse(json_lists)
+      lists_objects.each do |list|
+        lists << ConstantContact::Components::ContactList.create(list)
+      end
+
+      add_contact = ConstantContact::Components::AddContacts.new(contacts, lists)
+
+      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity(
+        'token', add_contact)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('ADD_CONTACTS')
+    end
+  end
+
+  describe "#create_add_contacts_activity_from_file" do
+    it "creates an Add Contacts Activity from a file" do
+      content = load_file('add_contacts_request.csv')
+      json = load_file('add_contacts_response.json')
+      lists = 'list1, list2'
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity_from_file(
+        'token', 'contacts.txt', content, lists)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('ADD_CONTACTS')
+    end
+  end
+
+  describe "#add_clear_lists_activity" do
+    it "creates a Clear Lists Activity" do
+      json_clear_lists = load_file('clear_lists_response.json')
+      json_list = load_file('list_response.json')
+
+      lists = []
+      lists <<  ConstantContact::Components::ContactList.create(JSON.parse(json_list))
+
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_clear_lists, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.add_clear_lists_activity(
+        'token', lists)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('CLEAR_CONTACTS_FROM_LISTS')
+    end
+  end
+
+  describe "#add_remove_contacts_from_lists_activity" do
+    it "creates a Remove Contacts From Lists Activity" do
+      json = load_file('remove_contacts_response.json')
+      lists = 'list1, list2'
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+      email_addresses = ["djellesma@constantcontact.com"]
+
+      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity(
+        'token', email_addresses, lists)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
+    end
+  end
+
+  describe "#add_remove_contacts_from_lists_activity_from_file" do
+    it "creates a Remove Contacts Activity from a file" do
+      content = load_file('remove_contacts_request.txt')
+      json = load_file('remove_contacts_response.json')
+      lists = 'list1, list2'
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity_from_file(
+        'token', 'contacts.txt', content, lists)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
+    end
+  end
+
+  describe "#add_export_contacts_activity" do
+    it "creates an Export Contacts Activity" do
+      json_request = load_file('export_contacts_request.json')
+      json_response = load_file('export_contacts_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      export_contacts = ConstantContact::Components::ExportContacts.new(JSON.parse(json_request))
+
+      activity = ConstantContact::Services::ActivityService.add_export_contacts_activity(
+        'token', export_contacts)
+      activity.should be_kind_of(ConstantContact::Components::Activity)
+      activity.type.should eq('EXPORT_CONTACTS')
+    end
+  end
+
+  describe "#add_remove_contacts_from_lists_activity" do
+    it "creates a Remove Contacts From Lists Activity" do
+      json_request = load_file('remove_contacts_from_lists_request.json')
+      json_response = load_file('remove_contacts_from_lists_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+
+      request_object = JSON.parse(json_request)
+      
+      lists = [], email_addresses = []
+      request_object['lists'].each do |list|
+        lists << ConstantContact::Components::ContactList.create(:id => list)
+      end
+      request_object['import_data'].each do |data|
+        data['email_addresses'].each do |email_address|
+          email_addresses << email_address
+        end
+      end
+
+      activity = ConstantContact::Services::ActivityService.add_remove_contacts_from_lists_activity(
+        'token', email_addresses, lists)
+
+      activity.type.should eq('REMOVE_CONTACTS_FROM_LISTS')
+    end
+  end
+end

data/spec/constantcontact/services/base_service_spec.rb

@@ -0,0 +1,27 @@
+#
+# base_service_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Services::BaseService do
+  describe "#get_headers" do
+    it "gets a hash of headers" do
+      token = 'foo'
+      headers = ConstantContact::Services::BaseService.send(:get_headers, token)
+      
+      expect(headers).to be_a Hash
+      expect(headers[:content_type]).to be_a String
+      expect(headers[:content_type]).to eq('application/json')
+      expect(headers[:accept]).to be_a String
+      expect(headers[:accept]).to eq('application/json')
+      expect(headers[:authorization]).to be_a String
+      expect(headers[:authorization]).to eq("Bearer #{token}")
+     expect(headers[:user_agent]).to be_a String
+     expect(headers[:user_agent].include?("Ruby SDK v#{ConstantContact::SDK::VERSION}")).to be_true
+     expect(headers[:user_agent].include?(RUBY_DESCRIPTION)).to be_true
+   end
+ end
+end

data/spec/constantcontact/services/campaign_schedule_service_spec.rb

@@ -0,0 +1,111 @@
+#
+# campaign_schedule_service_service_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Services::CampaignScheduleService do
+  describe "#add_schedule" do
+    it "creates a new schedule for a campaign" do
+      campaign_id = 1
+      json = load_file('schedule_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+      new_schedule = ConstantContact::Components::Schedule.create(JSON.parse(json))
+
+      schedule = ConstantContact::Services::CampaignScheduleService.add_schedule(
+        'token', campaign_id, new_schedule)
+      schedule.should be_kind_of(ConstantContact::Components::Schedule)
+      schedule.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
+    end
+  end
+
+  describe "#get_schedules" do
+    it "gets a list of schedules for a campaign" do
+      campaign_id = 1
+      json = load_file('schedules_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:get).and_return(response)
+
+      schedules = ConstantContact::Services::CampaignScheduleService.get_schedules(
+        'token', campaign_id)
+      schedules.first.should be_kind_of(ConstantContact::Components::Schedule)
+      schedules.first.scheduled_date.should eq('2012-12-16T11:07:43.626Z')
+    end
+  end
+
+  describe "#get_schedule" do
+    it "gets a specific schedule for a campaign" do
+      campaign_id = 1
+      schedule_id = 1
+
+      json = load_file('schedule_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:get).and_return(response)
+
+      schedule = ConstantContact::Services::CampaignScheduleService.get_schedule(
+        'token', campaign_id, schedule_id)
+      schedule.should be_kind_of(ConstantContact::Components::Schedule)
+      schedule.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
+    end
+  end
+
+  describe "#delete_schedule" do
+    it "deletes a specific schedule for a campaign" do
+      campaign_id = 1
+      schedule_id = 1
+      net_http_resp = Net::HTTPResponse.new(1.0, 204, 'No Content')
+
+      response = RestClient::Response.create('', net_http_resp, {})
+      RestClient.stub(:delete).and_return(response)
+
+      result = ConstantContact::Services::CampaignScheduleService.delete_schedule(
+        'token', campaign_id, schedule_id)
+      result.should be_true
+    end
+  end
+
+  describe "#update_schedule" do
+    it "updates a specific schedule for a campaign" do
+      campaign_id = 1
+      json = load_file('schedule_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json, net_http_resp, {})
+      RestClient.stub(:put).and_return(response)
+      schedule = ConstantContact::Components::Schedule.create(JSON.parse(json))
+
+      result = ConstantContact::Services::CampaignScheduleService.update_schedule(
+        'token', campaign_id, schedule)
+      result.should be_kind_of(ConstantContact::Components::Schedule)
+      result.scheduled_date.should eq('2013-05-10T11:07:43.626Z')
+    end
+  end
+
+  describe "#send_test" do
+    it "sends a test send of a campaign" do
+      campaign_id = 1
+      json_request = load_file('test_send_request.json')
+      json_response = load_file('test_send_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {})
+      RestClient.stub(:post).and_return(response)
+      test_send = ConstantContact::Components::TestSend.create(JSON.parse(json_request))
+
+      result = ConstantContact::Services::CampaignScheduleService.send_test(
+        'token', 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.')
+    end
+  end
+
+end