constant_contact 1.0.0

data/lib/constant_contact/contact_event.rb

@@ -0,0 +1,7 @@
+module ConstantContact
+  class ContactEvent < Base
+    self.site += "/contacts/:contact_id"
+  end
+end
+
+

data/lib/constant_contact/email_address.rb

@@ -0,0 +1,6 @@
+# http://developer.constantcontact.com/doc/settingsemails
+module ConstantContact
+  class EmailAddress < Base
+    self.element_name = 'settings/emailaddresses'
+  end
+end

data/lib/constant_contact/formats.rb

@@ -0,0 +1,3 @@
+directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, 'formats','atom_format')
+require File.join(directory, 'formats','html_encoded_format')

data/lib/constant_contact/formats/atom_format.rb

@@ -0,0 +1,78 @@
+require 'rexml/document'
+module ActiveResource
+  module Formats
+    module AtomFormat
+      extend self
+
+      def extension
+        "atom"
+      end
+
+      def mime_type
+        "application/atom+xml"
+      end
+
+      def encode(hash, options={})
+        hash.to_xml(options)
+      end
+
+      def decode(xml)
+        return [] if no_content?(xml)
+        result = Hash.from_xml(from_atom_data(xml))
+        is_collection?(xml) ? result['records'] : result.values.first
+      end
+      
+
+      private
+      
+      def from_atom_data(xml)
+        if is_collection?(xml)
+          return content_from_collection(xml)
+        else
+          return content_from_single_record(xml)
+        end
+      end
+      
+      def no_content?(xml)
+        doc = REXML::Document.new(xml)
+        REXML::XPath.match(doc,'//content').size == 0
+      end
+      
+      def is_collection?(xml)
+        doc = REXML::Document.new(xml)
+        REXML::XPath.match(doc,'//content').size > 1
+      end
+
+      def content_from_single_record(xml)
+        doc = REXML::Document.new(xml)
+        str = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+        REXML::XPath.each(doc, '//content') do |e|
+          content = e.children[1]
+          str << content.to_s
+        end
+        str
+      end
+      
+      def content_from_collection(xml)
+        doc = REXML::Document.new(xml)
+        str = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><records type=\"array\">"
+        REXML::XPath.each(doc, '//content') do |e|
+          content = e.children[1]
+          str << content.to_s
+        end
+        str << "</records>" 
+        str
+      end
+      
+      def content_from_member(xml)
+        doc = REXML::Document.new(xml)
+        str = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+        REXML::XPath.each(doc, '//content') do |e|
+         content = e.children[1].children
+         str << content.to_s
+        end
+        str
+      end
+    end
+  end
+end

data/lib/constant_contact/formats/html_encoded_format.rb

@@ -0,0 +1,17 @@
+module ActiveResource
+  module Formats
+    module HtmlEncodedFormat
+      extend self
+      def mime_type
+        "application/x-www-form-urlencoded"
+      end
+      
+      
+      def decode(xml)
+        {}
+      end
+      
+
+    end
+  end
+end

data/lib/constant_contact/list.rb

@@ -0,0 +1,11 @@
+module ConstantContact
+  class List < Base
+
+    # @@column_names = [:contact_count, :display_on_signup, :members, :name, :opt_in_default, :short_name, :sort_order]    
+    
+    def self.find_by_name(name)
+      lists = self.find :all
+      lists.find{|list| list.Name == name}
+    end
+  end
+end

data/lib/constant_contact/member.rb

@@ -0,0 +1,5 @@
+module ConstantContact
+  class Member < Base
+    self.site += "/lists/:list_id"
+  end
+end

data/lib/constant_contact/version.rb

@@ -0,0 +1,3 @@
+module ConstantContact
+  Version = '1.0.0'.freeze
+end

data/test/constant_contact/activity_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class Activity < Test::Unit::TestCase
+  
+  context 'encode' do
+    setup do 
+      @contacts = []
+      3.times do |n|
+        @contacts << ConstantContact::Contact.new(:first_name => "Fred#{n}",
+                                                  :last_name => "Test#{n}",
+                                                  :email_address => "email#{n}@gmail.com")
+      end        
+      @activity = ConstantContact::Activity.new(:activity_type => "SV_ADD")
+      @activity.contacts = @contacts
+      @list = ConstantContact::List.new
+      @list.stubs(:id).returns('http://api.constantcontact.com/ws/customers/joesflowers/lists/2')
+      @activity.lists = [@list]
+    end
+    
+    should 'include activity type' do
+      assert_match(/activityType=SV_ADD/, @activity.encode)
+    end
+    
+    should 'include contacts data' do
+      assert_match(/\&data\=Email\+Address\%2CFirst\+Name\%2CLast\+Name\%0A/, @activity.encode)
+      assert_match(/email0\%40gmail\.com\%2C\+Fred0\%2C\+Test0\%0A/, @activity.encode)
+    end
+    
+    should 'include lists' do
+      assert_match(/Test2\&lists\=http\%3A\%2F\%2Fapi\.constantcontact\.com\%2Fws\%2Fcustomers\%2Fjoesflowers\%2Flists\%2F2/, @activity.encode)
+    end
+    
+  end
+  
+  context 'format' do 
+    should 'be html encoded' do 
+      assert_equal ActiveResource::Formats[:html_encoded], ConstantContact::Activity.connection.format
+    end
+  end
+  
+end

data/test/constant_contact/atom_format_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class AtomFormatter
+  include ActiveResource::Formats::AtomFormat
+end
+class AtomFormatTest < Test::Unit::TestCase
+  
+  context 'decode' do
+    should 'convert an xml collection into an array' do
+      c = AtomFormatter.new
+      assert_kind_of Array, c.decode(fixture_file('contactlistscollection.xml'))
+    end
+    
+    should 'convert xml for a single record into a something' do
+      c = AtomFormatter.new
+      assert_kind_of Hash, c.decode(fixture_file('contactlistsindividuallist.xml'))      
+    end
+    
+    should 'return empty error if no content' do
+      c = AtomFormatter.new
+      assert_kind_of Array, c.decode(fixture_file('nocontent.xml'))      
+    end
+    
+  end
+  
+end
+
+

data/test/constant_contact/base_test.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../test_helper'
+# require 'activeresource'
+class BaseTest < Test::Unit::TestCase
+  
+  # def test_should_use_site_prefix_and_credentials
+  #   assert_equal 'https://baz%25foo:bar@api.constantcontact.com', ConstantContact::List.site.to_s    
+  # end
+  
+  def test_should_accept_setting_user
+    ConstantContact::List.api_key = 'api_key'
+    ConstantContact::List.user = 'david'
+    assert_equal('david', ConstantContact::List.user)
+    assert_equal('api_key%david', ConstantContact::List.connection.user)
+  end
+  
+  def test_should_accept_setting_api_key
+    ConstantContact::List.api_key = 'david'
+    assert_equal('david', ConstantContact::List.api_key)
+  end
+  
+  
+  def test_should_accept_setting_password
+    ConstantContact::List.password = 'test123'
+    assert_equal('test123', ConstantContact::List.password)
+    assert_equal('test123', ConstantContact::List.connection.password)
+  end
+    
+  def test_credentials_from_site_are_decoded
+    actor = Class.new(ConstantContact::Base)
+    actor.site = 'http://my%40email.com:%31%32%33@cinema'
+    assert_equal("my@email.com", actor.user)
+    assert_equal("123", actor.password)
+  end
+  
+  def test_collection_name
+    assert_equal "lists", ConstantContact::List.collection_name
+  end
+  
+  def test_collection_path
+    ConstantContact::Base.user = 'joesflowers'
+    assert_equal '/ws/customers/joesflowers/lists', ConstantContact::List.collection_path
+  end
+  
+  def test_element_path
+    ConstantContact::Base.user = 'joesflowers'
+    assert_equal '/ws/customers/joesflowers/bases/1', ConstantContact::Base.element_path(1)
+  end
+  
+  def test_should_use_site_prefix_and_credentials
+     ConstantContact::Base.user = "joesflowers"
+     ConstantContact::Base.password = "password"
+     ConstantContact::Base.api_key = "api_key"
+     assert_equal 'https://api.constantcontact.com/', ConstantContact::List.site.to_s
+     assert_equal 'https://api.constantcontact.com/lists/:list_id/', ConstantContact::Member.site.to_s
+  end
+  
+  
+  context 'find' do
+    setup do
+      ConstantContact::Base.user = "joesflowers"
+      ConstantContact::Base.password = "password"
+      ConstantContact::Base.api_key = "api_key"
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/lists', 'contactlistscollection.xml')      
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/lists/1', 'contactlistsindividuallist.xml')      
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/lists/1/members', 'memberscollection.xml')      
+    end
+    
+    should 'find one' do
+      list = ConstantContact::List.find(1)
+      assert_equal "General Interest", list.name
+    end
+        
+    should 'find all' do
+      lists = ConstantContact::List.find(:all)
+      assert_equal 5, lists.size
+      assert_equal 'Clients', lists.last.name
+    end
+    
+    should 'allow nested finds' do
+      members = ConstantContact::Member.find :all, :params => {:list_id => 1}
+      assert_equal 50, members.size
+    end
+  end
+  
+end

data/test/constant_contact/contact_test.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ContactTest < Test::Unit::TestCase
+  
+  context 'class' do
+    setup do 
+      ConstantContact::Base.user = "jonsflowers"
+      @contact = ConstantContact::Contact.new(:email_address => "jon@example.com",
+                             :first_name => "jon",
+                             :last_name => "smith")
+    end
+    
+    should 'respond to encode' do
+      assert_respond_to ConstantContact::Contact.new, :encode
+    end
+    
+    should 'call to_xml' do
+      @contact.expects(:to_xml)
+      @contact.encode
+    end
+  end
+  
+  context 'setting accessible attributes' do
+    setup do
+      ConstantContact::Base.user = "jonsflowers"
+      @contact = ConstantContact::Contact.new(:email_address => "jon@example.com",
+                             :first_name => "jon",
+                             :last_name => "smith")
+    end
+    
+    should 'returns nil when contact list has not been set' do
+      assert_equal nil, @contact.contact_lists
+    end
+    should 'permit assigning ids to the contact list' do
+      @contact.contact_lists = [1,2]
+      assert_equal [1,2], @contact.contact_lists
+    end
+  end
+  
+  context 'to_xml' do
+    setup do 
+      ConstantContact::Base.user = "jonsflowers"
+      @contact = ConstantContact::Contact.new(:email_address => "jon@example.com",
+                             :first_name => "jon",
+                             :last_name => "smith")
+    end
+        
+    should 'have contact tag' do
+      assert_match /<Contact xmlns=\"http:\/\/ws.constantcontact.com\/ns\/1.0\/\"/, @contact.to_xml
+      assert_match /\<\/Contact\>/, @contact.to_xml
+    end
+    
+    should 'have first_name' do
+      assert_match /<FirstName>/, @contact.to_xml
+    end
+    
+    should 'list selected by default' do
+      assert_match /http:\/\/api.constantcontact.com\/ws\/customers\/jonsflowers\/lists\/1/, @contact.to_xml
+    end
+    
+    should 'provide opt in select by default' do
+      assert_match /ACTION_BY_CUSTOMER/, @contact.to_xml
+    end
+    
+    should 'include the default contact list when no lists are specified' do
+      assert_match /<ContactList id="/, @contact.to_xml
+    end
+    
+    should 'include all contact lists configured' do
+      @contact.contact_lists = [1,2]
+      assert_equal [1,2], @contact.contact_lists
+      xml = @contact.to_xml
+      assert_equal 2, xml.scan(/<ContactList /).length, xml
+      assert_match /<ContactList id="#{Regexp.escape(@contact.list_url(1))}"/, xml
+      assert_match /<ContactList id="#{Regexp.escape(@contact.list_url(2))}"/, xml
+    end
+  end
+  
+  context "find with query parameters" do
+    setup do 
+      ConstantContact::Base.user = "joesflowers"
+      ConstantContact::Base.password = "password"
+      ConstantContact::Base.api_key = "api_key"
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/contacts/2', 'single_contact_by_id.xml')
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/contacts/3', 'single_contact_by_id_with_no_contactlists.xml')
+    end
+    
+    should 'find contact with given id' do
+       assert_equal 'jon smith', ConstantContact::Contact.find(2).Name
+    end
+    
+    should 'return an array of lists they are a member of' do
+      c = ConstantContact::Contact.find(2)
+      assert_equal [1], c.contact_lists
+    end
+    should 'return an empty array when no contact lists are present' do
+      c = ConstantContact::Contact.find(3)
+      assert_equal [], c.contact_lists
+    end
+    
+  end
+  
+  context "find with email in query parameters" do
+    setup do 
+      ConstantContact::Base.user = "joesflowers"
+      ConstantContact::Base.password = "password"
+      ConstantContact::Base.api_key = "api_key"
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/contacts', 'all_contacts.xml')
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/contacts?email=jon%40example.com', 'single_contact_by_email.xml')
+    end
+    
+    should 'find contact with email address' do
+       assert_equal 'smith, jon', ConstantContact::Contact.find(:first, :params => {:email => 'jon@example.com'}).Name
+    end
+    
+    should 'return nil when asking for contact_lists' do
+      assert_equal nil, ConstantContact::Contact.find(:first, :params => {:email => 'jon@example.com'}).contact_lists
+    end
+    
+  end
+  
+  context 'list url' do
+    setup do
+      ConstantContact::Base.user = "joesflowers"
+    end
+    should 'apply the default id (1) to a new contact' do
+      c = ConstantContact::Contact.new(:email_address => "jon@example.com",
+                             :first_name => "jon",
+                             :last_name => "smith")
+      assert_equal 'http://api.constantcontact.com/ws/customers/joesflowers/lists/1', c.list_url
+      assert_equal 'http://api.constantcontact.com/ws/customers/joesflowers/lists/2', c.list_url(2)
+    end
+  end
+  
+end

data/test/constant_contact/list_test.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ListTest < Test::Unit::TestCase
+
+  context "find by name" do
+    setup do 
+      ConstantContact::List.user     = "joesflowers"
+      ConstantContact::List.password = "password"
+      ConstantContact::List.api_key  = "api_key"
+      stub_get('https://api_key%25joesflowers:password@api.constantcontact.com/ws/customers/joesflowers/lists', 'contactlistscollection.xml')      
+    end
+    
+    should 'find list for given name' do
+      assert_equal 'Clients', ConstantContact::List.find_by_name("Clients").name
+    end
+  end
+end