constantcontact-ruby 2.2.0

data/spec/constantcontact/auth/oauth2_spec.rb

@@ -0,0 +1,125 @@
+  #
+# oauth2_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Auth::OAuth2 do
+
+  before(:all) {
+    ConstantContact::Util::Config.configure do |config|
+      config[:auth].delete :api_key
+      config[:auth].delete :api_secret
+      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
+
+  context "with middle-ware configuration" do
+    before(:all) do
+      ConstantContact::Util::Config.configure do |config|
+        config[:auth][:api_key] = "config_api_key"
+        config[:auth][:api_secret] = "config_api_secret"
+        config[:auth][:redirect_uri] = "config_redirect_uri"
+      end
+    end
+    let(:proc) { lambda { ConstantContact::Auth::OAuth2.new } }
+    it "without error" do
+      proc.should_not raise_error
+    end
+    let(:oauth) { proc.call }
+    it "has correct api_key" do
+      oauth.client_id.should == "config_api_key"
+    end
+    it "has correct api_secret" do
+      oauth.client_secret.should == "config_api_secret"
+    end
+    it "has correct redirect_uri" do
+      oauth.redirect_uri.should == "config_redirect_uri"
+    end
+  end
+
+  context "with middle-ware configuration and explicit opts" do
+    before(:all) do
+      ConstantContact::Util::Config.configure do |config|
+        config[:auth][:api_key] = "config_api_key"
+        config[:auth][:api_secret] = "config_api_secret"
+        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' } }
+    it "without error" do
+      proc.should_not raise_error
+    end
+    let(:oauth) { proc.call }
+    it "has correct api_key" do
+      oauth.client_id.should == "explicit_api_key"
+    end
+    it "has correct api_secret" do
+      oauth.client_secret.should == "explicit_api_secret"
+    end
+    it "has correct redirect_uri" do
+      oauth.redirect_uri.should == "explicit_redirect_uri"
+    end
+  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
+    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
+
+  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
+
+    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
+
+end

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

@@ -0,0 +1,18 @@
+#
+# address_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Components::Address do
+  describe "#from_list" do
+    it "should return an address" do
+      json = load_file('address.json')
+      address = ConstantContact::Components::Address.create(JSON.parse(json))
+
+      address.line1.should eq('6 Main Street')
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+#
+# contact_list_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Components::ContactList do
+  describe "#from_list" do
+    it "should return a list" do
+      json = load_file('list.json')
+      list = ConstantContact::Components::ContactList.create(JSON.parse(json))
+
+      list.name.should eq('Fake List')
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+#
+# contact_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Components::Contact do
+  describe "#from_list" do
+    it "should return a contact" do
+      json = load_file('contact.json')
+      contact = ConstantContact::Components::Contact.create(JSON.parse(json))
+
+      contact.last_name.should eq('Smith')
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+#
+# custom_field_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Components::CustomField do
+  describe "#from_list" do
+    it "should return a custom field" do
+      json = '{"name":"Property", "value":"Private"}'
+      field = ConstantContact::Components::CustomField.create(JSON.parse(json))
+
+      field.name.should eq('Property')
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+#
+# email_address_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::Components::EmailAddress do
+  describe "#from_list" do
+    it "should return an email address" do
+      json = load_file('email_address.json')
+      email = ConstantContact::Components::EmailAddress.create(JSON.parse(json))
+
+      email.email_address.should eq('wm2q7rwtp77m@roving.com')
+    end
+  end
+end

data/spec/constantcontact/sdk_spec.rb

@@ -0,0 +1,24 @@
+#
+# api_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+require 'spec_helper'
+
+describe ConstantContact::SDK do
+  
+  let(:dummy_class) { Class.new { include ConstantContact::SDK } }
+  
+  it "should respond to VERSION" do
+    expect((dummy_class.const_get("VERSION") rescue nil)).to be_true
+  end
+  
+  it "should have a VERSION of type string" do
+    expect(dummy_class::VERSION).to be_a String
+  end
+  
+  it "should have a VERSION of the format x.y.z" do
+    expect(dummy_class::VERSION.match(/[1-9]+\.\d+\.\d+/)).to_not be_nil
+  end
+end

data/spec/constantcontact/services/account_service_spec.rb

@@ -0,0 +1,46 @@
+#
+# account_service_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+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)
+  end
+
+  describe "#get_account_info" do
+    it "gets a summary of account information" do
+      json_response = load_file('account_info_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
+      RestClient.stub(:get).and_return(response)
+
+      result = ConstantContact::Services::AccountService.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)
+      result.organization_addresses.first.city.should eq('Anytown')
+    end
+  end
+
+  describe "#get_verified_email_addresses" do
+    it "gets all verified email addresses associated with an account" do
+      json_response = load_file('verified_email_addresses_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
+      RestClient.stub(:get).and_return(response)
+
+      params = {}
+      email_addresses = ConstantContact::Services::AccountService.get_verified_email_addresses(params)
+
+      email_addresses.should be_kind_of(Array)
+      email_addresses.first.should be_kind_of(ConstantContact::Components::VerifiedEmailAddress)
+      email_addresses.first.email_address.should eq('abc@def.com')
+    end
+  end
+end

data/spec/constantcontact/services/activity_service_spec.rb

@@ -0,0 +1,244 @@
+#
+# activity_service_spec.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+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)
+  end
+
+  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, {}, @request)
+      RestClient.stub(:get).and_return(response)
+
+      activities = ConstantContact::Services::ActivityService.get_activities()
+      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, {}, @request)
+      RestClient.stub(:get).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.get_activity('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_request = load_file('add_contacts_request.json')
+      json_response = load_file('add_contacts_response.json')
+      net_http_resp = Net::HTTPResponse.new(1.0, 200, 'OK')
+
+      response = RestClient::Response.create(json_response, net_http_resp, {}, @request)
+      RestClient.stub(:post).and_return(response)
+
+      contacts = []
+
+      # first contact
+      import = ConstantContact::Components::AddContactsImportData.new({
+          :first_name     => "John",
+          :last_name      => "Smith",
+          :birthday_month => "1",
+          :birthday_day   => "25",
+          :anniversary    => "03/12/2005",
+          :job_title      => "",
+          :company_name   => "My Company",
+          :home_phone     => "5555551212"
+      })
+
+      # add emails
+      import.add_email("user1@example.com")
+
+      # add addresses
+      address = ConstantContact::Components::Address.create(
+        :line1        => "123 Partridge Lane",
+        :line2        => "Apt. 3",
+        :city         => "Anytown",
+        :address_type => "PERSONAL",
+        :state_code   => "NH",
+        :country_code => "US",
+        :postal_code  => "02145"
+      )
+      import.add_address(address)
+
+      contacts << import
+
+      # second contact
+      import = ConstantContact::Components::AddContactsImportData.new({
+        :first_name     => "Jane",
+        :last_name      => "Doe",
+        :job_title      => "",
+        :company_name   => "Acme, Inc.",
+        :home_phone     => "5555551213"
+      })
+
+      # add emails
+      import.add_email("user2@example.com")
+
+      # add addresses
+      address = ConstantContact::Components::Address.create(
+        :line1        => "456 Jones Road",
+        :city         => "AnyTownShip",
+        :address_type => "PERSONAL",
+        :state_code   => "DE",
+        :country_code => "US",
+        :postal_code  => "01234"
+      )
+      import.add_address(address)
+
+      # add custom fields
+      custom_field = ConstantContact::Components::CustomField.create(
+        :name  => "custom_field_6",
+        :value => "Blue Jeans"
+      )
+      import.add_custom_field(custom_field)
+
+      custom_field = ConstantContact::Components::CustomField.create(
+        :name  => "custom_field_12",
+        :value => "Special Order"
+      )
+      import.add_custom_field(custom_field)
+
+      contacts << import
+
+      lists = ['4', '5', '6']
+
+      add_contact = ConstantContact::Components::AddContacts.new(contacts, lists)
+
+      JSON.parse(json_request).should eq(JSON.parse(JSON.generate(add_contact)))
+
+      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity(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, {}, @request)
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.create_add_contacts_activity_from_file(
+        '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, {}, @request)
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.add_clear_lists_activity(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, {}, @request)
+      RestClient.stub(:post).and_return(response)
+      email_addresses = ["djellesma@constantcontact.com"]
+
+      activity = ConstantContact::Services::ActivityService.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')
+    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, {}, @request)
+      RestClient.stub(:post).and_return(response)
+
+      activity = ConstantContact::Services::ActivityService.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')
+    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, {}, @request)
+      RestClient.stub(:post).and_return(response)
+
+      export_contacts = ConstantContact::Components::ExportContacts.new(JSON.parse(json_request))
+
+      activity = ConstantContact::Services::ActivityService.add_export_contacts_activity(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, {}, @request)
+      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(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,50 @@
+#
+# 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'
+      ConstantContact::Services::BaseService.access_token = token
+      headers = ConstantContact::Services::BaseService.send(:get_headers)
+
+      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
+      expect(headers[:x_ctct_request_source]).to be_a String
+      expect(headers[:x_ctct_request_source].include?(ConstantContact::SDK::VERSION)).to be_true
+    end
+  end
+
+  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('&')
+      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
+      expect(components.include?('arg2=123')).to be_true
+    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")
+      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")
+      expect(url).to eq('http://testing.com?api_key=api+key&next=abcdefg')
+    end
+  end
+end