constant-contact-ruby 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 BatchBlue Software, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,75 @@
+= constant-contact-ruby
+
+Ruby wrapper for the Constant Contact REST API
+
+== Requirements
+
+HTTParty gem - http://rubygems.org/gems/httparty
+
+== Usage
+
+  require 'constant-contact-ruby'
+  include ConstantContact
+
+  ### Contacts ###
+
+  all_contacts = Contact.all 
+
+  contact_7 = Contact.get( 7 ) 
+  contact_7.update_attributes!( :first_name => 'John', :last_name => 'Doe' )
+  contact_7.add_to_list!( 3 )
+  contact_7.remove_from_list!( 3 )
+  contact_7.replace_contact_lists!( 1, 3, 9 )
+
+  new_contact = Contact.add( :email_address => 'john@example.com', :first_name => 'John', :last_name => 'Doe' )
+
+  john_doe = Contact.search_by_email( 'john@example.com' )
+
+
+  ### Contact Lists ###
+
+  all_lists = ContactList.all
+
+  list_1 = ContactList.get( 1 )
+  list_1_members = ContactList.members( list_1.uid )
+  list_1.clear_contacts!    # remove all contacts from list
+  ContactList.delete( 1 )   # delete the list
+
+  new_list = ContactList.add( 'my new list' )
+
+
+  ### Bulk Activities (involving multiple contacts) ###
+
+  activities = Activity.all # list all activities in the system
+  
+  activity_details = Activity.get( activities.first.uid )
+  
+  Activity.remove_all_contacts_from_lists( 1, 3, 4 )    # remove all contacts from lists 1, 3, and 4
+
+  new_contacts = [
+    { :email_address = 'user1@example.com', :first_name => 'User1', :last_name => 'test' },
+    { :email_address = 'user2@example.com', :first_name => 'User2', :last_name => 'test 2' },
+    { :email_address = 'user3@example.com', :first_name => 'User1' },
+    { :email_address = 'user4@example.com' }
+  ]
+  Activity.add_contacts_to_lists( new_contacts, 3, 4 )    # all the users array to lists 3 and 4
+  Activity.remove_contacts_from_lists( new_contacts, 4 )  # remove the users from list 4
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Authors
+
+Craig P Jolicoeur - http://craigjolicoeur.com
+
+== Copyright
+
+Copyright (c) 2010 BatchBlue Software, LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "constant-contact-ruby"
+    gem.summary = %Q{Constant Contact Ruby API Wrapper}
+    gem.description = %Q{Ruby wrapper around the Constant Contact REST API}
+    gem.email = "cpjolicoeur@gmail.com"
+    gem.homepage = "http://github.com/cpjolicoeur/constant-contact-ruby"
+    gem.authors = ["Craig P Jolicoeur"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "constant-contact-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1 @@
+add export feature to Activities

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 2
+:build: 
+:patch: 1

data/constant-contact-ruby.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{constant-contact-ruby}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Craig P Jolicoeur"]
+  s.date = %q{2010-03-03}
+  s.description = %q{Ruby wrapper around the Constant Contact REST API}
+  s.email = %q{cpjolicoeur@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION.yml",
+     "constant-contact-ruby.gemspec",
+     "constant-contact-ruby.rb",
+     "lib/constant_contact.rb",
+     "lib/constant_contact/activity.rb",
+     "lib/constant_contact/base_resource.rb",
+     "lib/constant_contact/contact.rb",
+     "lib/constant_contact/contact_list.rb",
+     "test/fixtures/get_contact.xml",
+     "test/fixtures/get_contacts.xml",
+     "test/fixtures/post_contacts.xml",
+     "test/helper.rb",
+     "test/test_constant-contact-ruby.rb",
+     "test/test_contacts.rb"
+  ]
+  s.homepage = %q{http://github.com/cpjolicoeur/constant-contact-ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Constant Contact Ruby API Wrapper}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_constant-contact-ruby.rb",
+     "test/test_contacts.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/constant-contact-ruby.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'httparty'
+
+require 'lib/constant_contact'
+require 'lib/constant_contact/base_resource'
+require 'lib/constant_contact/contact'
+require 'lib/constant_contact/contact_list'
+require 'lib/constant_contact/activity'

data/lib/constant_contact.rb

@@ -0,0 +1,18 @@
+module ConstantContact
+
+    include HTTParty
+    format :xml
+    headers 'Accept'        => 'application/atom+xml'
+    headers 'Content-Type'  => 'application/atom+xml'
+    
+    API_KEY = "59ca4bb4-51e9-4c08-a2b2-a34aac7bb78f"
+
+    class << self
+      # Create a connection to the Constant Contact API using your login credentials
+      def setup( user, pass )
+        basic_auth "#{API_KEY}%#{user}", pass
+        base_uri "https://api.constantcontact.com/ws/customers/#{user.downcase}"
+      end
+    end
+
+end

data/lib/constant_contact/activity.rb

@@ -0,0 +1,196 @@
+module ConstantContact 
+  class Activity < BaseResource
+
+    ADD_CONTACTS        = 'ADD_CONTACTS'.freeze
+    REMOVE_CONTACTS     = 'REMOVE_CONTACTS_FROM_LISTS'.freeze
+    CLEAR_CONTACTS      = 'CLEAR_CONTACTS_FROM_LISTS'.freeze
+    EXPORT_CONTACTS     = 'EXPORT_CONTACTS'.freeze
+
+    attr_reader :uid, :original_xml
+
+    def initialize( params={}, orig_xml='' ) #:nodoc:
+      return false if params.empty?
+
+      @uid = params['id'].split('/').last
+      @original_xml = orig_xml
+
+      fields = params['content']['Activity']
+      
+      if errors = fields.delete( 'Errors' )
+        # FIXME: handle the <Errors> node properly
+      end
+          
+      fields.each do |k,v|
+        underscore_key = underscore( k )
+
+        instance_eval %{
+          @#{underscore_key} = "#{v}"
+
+          def #{underscore_key}
+            @#{underscore_key}
+          end
+        }
+      end
+
+    end
+
+    # List all activities
+    def self.all( options={} )
+      activities = []
+
+      data = ConstantContact.get( '/activities', options )
+      return activities if ( data.nil? or data.empty? or data['feed']['entry'].nil? )
+
+      data['feed']['entry'].each do |entry|
+        activities << new( entry )
+      end
+
+      activities
+    end
+
+    # Get the details of a specific activity
+    def self.get( id, options={} )
+      activity = ConstantContact.get( "/activities/#{id.to_s}", options )
+      return nil if ( activity.nil? or activity.empty? )
+      new( activity['entry'], activity.body )
+    end
+
+    # Add multiple users to one or more contact lists
+    def self.add_contacts_to_lists( users=[], *lists )
+      data_param = build_data_param( users )
+      list_param = build_lists_param( *lists )
+
+      data = ConstantContact.post( '/activities', 
+                                  :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, 
+                                  :body => { 'activityType' => ADD_CONTACTS, :data => data_param, :lists => list_param } )
+
+      if data.code == 201
+        new( data['entry'] )
+      else
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return false
+      end
+    end
+
+    # Remove multiple users from a contact list
+    def self.remove_contacts_from_lists( users=[], *lists )
+      data_param = build_data_param( users )
+      list_param = build_lists_param( *lists )
+
+      data = ConstantContact.post( '/activities', 
+                                  :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, 
+                                  :body => { 'activityType' => REMOVE_CONTACTS, :data => data_param, :lists => list_param } )
+
+      if data.code == 201
+        new( data['entry'] )
+      else
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return false
+      end
+    end
+
+    # Remove all users from a specific contact list
+    def self.remove_all_contacts_from_lists( *lists )
+      list_param = build_lists_param( *lists )
+
+      data = ConstantContact.post( '/activities', 
+                                  :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, 
+                                  :body => { 'activityType' => CLEAR_CONTACTS, :lists => list_param } )
+
+      if data.code == 201
+        new( data['entry'] )
+      else
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return false
+      end
+    end
+
+    # Export subscribers list to a file
+    #
+    # @param [Integer/String] list_id is the uid of the list to export
+    # @param [Array] fields is an array of fields to export for list contacts
+    #
+    def self.export( list_id, *fields )
+      export_columns = build_export_columns( *fields )
+
+      data = ConstantContact.post( '/activities',
+                                  :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+                                  :body => { 
+                                    'activityType' => EXPORT_CONTACTS,
+                                    'fileType' => 'CSV',
+                                    'exportOptDate' => true,
+                                    'exportOptSource' => true,
+                                    'exportListName' => true,
+                                    'sortBy' => 'EMAIL_ADDRESS',
+                                    'listId' => ContactList.url_for( list_id ),
+                                    :columns => export_columns
+                                  } )
+
+      if data.code == 201
+        new( data['entry'] )
+      else
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return false
+      end
+    end
+
+    private
+
+    # Build the data= query param for a POST request
+    #
+    # @param [Array] Users - an array of user hash objects
+    #
+    def self.build_data_param( users )
+      return '' if users.empty? 
+      data_start, data_end = '', ''
+      keys, fields = [], []
+
+      # get a list of all the key fields and then create values
+      users.each do |u| 
+        u.each_key do |k| 
+          readable_key = underscore(k).split('_').map{|x| x.capitalize}.join(' ')
+          packet = { :original => k, :readable => readable_key }
+          keys << packet unless keys.include?( packet )
+        end 
+      end
+      data_start = keys.map { |k| k[:readable] }.join(',') + "\n"
+
+      # now build the data fields
+      users.each do |u|
+        tmp = ''
+        keys.each { |k| tmp << "#{u[k[:original]]}," }
+        fields << tmp.chomp(',') + "\n"
+      end
+      data_end = fields.join
+
+      return data_start + data_end
+    end
+
+    # Build the lists= param for a POST request
+    #
+    # @param [Array] lists - an array of list ids
+    # @return [String] a usable string for the list param in a POST
+    def self.build_lists_param( *lists )
+      # list_param = lists.map { |list| ContactList.url_for( list.to_s ) }
+      # 
+      # FIXME: this is hack because passing in an array of lists wasnt working because of Hash.to_params
+      #         Hash#to_params returns lists[]=foo&lists[]=bar instead of lists=foo&lists=bar
+      #         I can't even find where Hash#to_params is defined!!!
+      list_param = ''
+      lists.each do |list|
+        list_param << "#{ContactList.url_for( list.to_s )}&lists="
+      end
+      list_param.chomp('&lists=')
+    end
+
+    def self.build_export_columns( *fields )
+      columns_param = ''
+      fields.each do |field|
+        readable_col = underscore( field ).split('_').map{ |x| x.upcase }.join(' ')
+        columns_param << "#{readable_col}&columns="
+      end
+      columns_param.chomp('&columns=')
+    end
+
+  end # class Activity
+end # module ConstantContact

data/lib/constant_contact/base_resource.rb

@@ -0,0 +1,23 @@
+module ConstantContact
+  class BaseResource #:nodoc:
+    
+    private 
+
+    def self.camelize( string )
+      string.split( /[^a-z0-9]/i ).map{ |w| w.capitalize }.join
+    end
+
+    def camelize( string )
+      BaseResource.camelize( string )
+    end
+
+    def self.underscore( string )
+      string.to_s.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+    end
+    
+    def underscore( string )
+      BaseResource.underscore( string )
+    end
+    
+  end
+end

data/lib/constant_contact/contact.rb

@@ -0,0 +1,323 @@
+module ConstantContact
+  class Contact < BaseResource
+
+    attr_reader :uid, :contact_lists, :original_xml
+
+    def initialize( params={}, orig_xml='', from_contact_list=false ) #:nodoc:
+      return false if params.empty?
+
+      @uid = params['id'].split('/').last
+      @original_xml = orig_xml
+      @contact_lists = []
+
+      if from_contact_list
+        fields = params['content']['ContactListMember']
+      else
+        fields = params['content']['Contact']
+      end
+
+      if lists = fields.delete( 'ContactLists' )
+        if lists['ContactList'].is_a?( Array )
+          @contact_lists = lists['ContactList'].collect { |list| list['id'].split('/').last }
+        else
+          @contact_lists << lists['ContactList']['id'].split('/').last
+        end
+      end
+
+      fields.each do |k,v|
+        underscore_key = underscore( k )
+        
+        instance_eval %{
+          @#{underscore_key} = "#{v}"
+
+          def #{underscore_key}
+            @#{underscore_key}
+          end
+        }
+      end
+
+    end # def initialize
+
+    # Update a single contact record
+    #
+    # NOTE: you cannot update a Contact's ContactList subscriptions through
+    # this method.  Use the apropriate ContactList methods instead
+    #
+    def update_attributes!( params={} )
+      return false unless full_record? # TODO: raise some kind of specific error here
+
+      params.each do |key,val|
+        self.instance_variable_set("@#{key.to_s}", val)
+      end
+
+      data = ConstantContact.put( "/contacts/#{self.uid}", :body => self.send(:to_xml) )
+      if data.code == 204 # success
+        return true
+      else
+        return false # probably should raise an error here instead
+      end
+    end
+
+    # Add user to a contact list
+    def add_to_list!( list_id, options={} )
+      list_id = list_id.to_s
+      xml = update_contact_lists( *(self.contact_lists + [list_id]) )
+
+      # FIXME: clean up the following code - it appears in 3 methods in this class!
+      options.merge!({ :body => xml })
+      data = ConstantContact.put( "/contacts/#{self.uid}", options )
+
+      if data.code == 204 # success
+        self.contact_lists << list_id unless self.contact_lists.include?( list_id )
+        return true
+      else
+        return false # probably should raise an error here instead
+      end
+    end
+
+    # Remove user from a contact list
+    def remove_from_list!( list_id, options={} )
+      list_id = list_id.to_s
+      xml = update_contact_lists( *(self.contact_lists - [list_id]) )
+
+      # FIXME: clean up the following code - it appears in 3 methods in this class!
+      options.merge!({ :body => xml })
+      data = ConstantContact.put( "/contacts/#{self.uid}", options )
+      
+      if data.code == 204 # success
+        self.contact_lists.delete( list_id )
+        return true
+      else
+        return false # probably should raise an error here instead
+      end
+    end
+
+    # Set a users contact lists
+    def replace_contact_lists!( *lists )
+      xml = update_contact_lists( *lists )
+
+      # FIXME: clean up the following code - it appears in 3 methods in this class!
+      options = { :body => xml }
+      data = ConstantContact.put( "/contacts/#{self.uid}", options )
+      
+      if data.code == 204 # success
+        @contact_lists = lists.map { |l| l.to_s }
+        return true
+      else
+        return false # probably should raise an error here instead
+      end
+    end
+
+    # Opt-out from all contact lists
+    #
+    # Contact will be removed from all lists and become a member of the 
+    # Do-Not_Mail special list
+    def opt_out!( options={} )
+      data = ConstantContact.delete( "/contacts/#{self.uid}", options )
+
+      if data.code == 204
+        @contact_lists = []
+        return true
+      else
+        return false
+      end
+    end
+
+    # Opt-in a user who has previously opted out
+    #--
+    # FIXME: this isn't currently working.  Currently I keep getting a 403-Forbidden response
+    #        should this really even be in the API wrapper at all?
+    def opt_in!( *lists )
+      # # NOTE: same as replace_contact_lists but must set to ACTION_BY_CONTACT
+      # xml = update_contact_lists( *lists ).gsub( /<\/ContactLists>/, %Q(<OptInSource>ACTION_BY_CONTACT</OptInSource>\n\t</ContactLists>) )
+
+      # # FIXME: clean up the following code - it appears in 3 methods in this class!
+      # options = { :body => xml }
+      # data = ConstantContact.put( "/contacts/#{self.uid}", options )
+      # 
+      # if data.code == 204 # success
+      #   @contact_lists = lists.map { |l| l.to_s }
+      #   return true
+      # else
+      #   return false # probably should raise an error here instead
+      # end
+    end
+
+    # Get a summary list all contacts
+    def self.all( options={} )
+      contacts = []
+
+      data = ConstantContact.get( '/contacts', options )
+      return contacts if ( data.nil? or data.empty? )
+
+      data['feed']['entry'].each do |entry|
+        contacts << new( entry )
+      end
+
+      contacts
+    end
+    
+    # Add a new contact
+    #
+    # Required data fields:
+    # * EmailAddress => String
+    # * ContactLists => Array of list IDs
+    #
+    # Options data fields:
+    # * EmailType
+    # * FirstName
+    # * MiddleName
+    # * LastName
+    # * JobTitle
+    # * CompanyName
+    # * HomePhone
+    # * WorkPhone
+    # * Addr1
+    # * Addr2
+    # * Addr3
+    # * City
+    # * StateCode => Must be valid US/Canada Code (http://ui.constantcontact.com/CCSubscriberAddFileFormat.jsp#states)
+    # * StateName
+    # * CountryCode = Must be valid code (http://constantcontact.custhelp.com/cgi-bin/constantcontact.cfg/php/enduser/std_adp.php?p_faqid=3614)
+    # * CountryName
+    # * PostalCode
+    # * SubPostalCode
+    # * Note
+    # * CustomField[1-15]
+    # * OptInSource
+    # * OptOutSource
+    # 
+    def self.add( data={}, opt_in='ACTION_BY_CUSTOMER', options={} )
+      xml = build_contact_xml_packet( data, opt_in )
+
+      options.merge!({ :body => xml })
+      data = ConstantContact.post( "/contacts", options )
+
+      # check response.code
+      if data.code == 201 # Entity Created
+        return new( data['entry'] )
+      else
+        # data.code == 409 # Conflict ( probably a duplicate )
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return nil
+      end
+    end
+    
+    # Get detailed record for a single contact by id
+    def self.get( id, options={} )
+      data = ConstantContact.get( "/contacts/#{id.to_s}", options )
+      return nil if ( data.nil? or data.empty? )
+      new( data['entry'], data.body )
+    end
+    
+    # Search for a contact by last updated date
+    # 
+    # Valid options:
+    # * :updated_since => Time object
+    # * :list_type => One of 'active'|'removed'|'do-not-mail'
+    #
+    # def self.search_by_date( options={} )
+    # end
+
+    # Search for a contact by email address
+    # 
+    # @param [String] email => "user@example.com"
+    #
+    def self.search_by_email( email )
+      data = ConstantContact.get( '/contacts', :query => { :email => email.downcase } )
+      return [] if ( data.nil? )
+      
+      if data.code == 500
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return false
+      else
+        new( data['feed']['entry'] )
+      end
+    end
+
+    # Returns the objects API URI
+    def self.url_for( id )
+      "#{ConstantContact.base_uri}/contacts/#{id}"
+    end
+
+    private
+
+    def update_contact_lists( *lists )
+      str = %Q(<ContactLists>\n)
+      lists.each do |list|
+        str << %Q(        <ContactList id="#{ContactList.url_for( list )}" />\n)
+      end
+      str << %Q(      </ContactLists>)
+
+      # self.original_xml.gsub(/<ContactLists>.*<\/ContactLists>/m, str)
+      if self.original_xml =~ /<ContactLists>.*<\/ContactLists>/m
+        self.original_xml.gsub( /#{$&}/, str)
+      else
+        self.original_xml.gsub( /<\/Contact>/m, "#{str}\n</Contact>" )
+      end
+    end
+
+    def self.build_contact_xml_packet( data={}, opt_in='ACTION_BY_CUSTOMER' )
+      xml = <<EOF
+<entry xmlns="http://www.w3.org/2005/Atom">
+  <title type="text"> </title>
+  <updated>#{Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z")}</updated>
+  <author> </author>
+  <id>data:,none</id>
+  <summary type="text">Contact</summary>
+  <content type="application/vnd.ctct+xml">
+    <Contact xmlns="http://ws.constantcontact.com/ns/1.0/">
+EOF
+      
+      data.each do |key, val|
+        node = camelize(key.to_s)
+
+        if key == :contact_lists
+          xml << %Q(      <ContactLists>\n)
+          val.each do |list_id|
+            xml<< %Q(       <ContactList id="#{ContactList.url_for( list_id )}" />\n)
+          end
+          xml << %Q(      </ContactLists>\n)
+        else
+          xml << %Q(      <#{node}>#{val}</#{node}>\n)
+        end
+      end
+
+      xml += <<EOF
+      <OptInSource>#{opt_in}</OptInSource>
+    </Contact>
+  </content>
+</entry>
+EOF
+      xml
+    end # def build_contact_xml_packet
+
+    # Is this a full contact record?
+    def full_record?
+      !self.contact_lists.empty?
+    end
+
+    # convert a full Contact record into XML format
+    def to_xml
+      return nil unless full_record?
+
+      do_not_process =  [ "@contact_lists", "@original_source", "@original_xml", "@uid", "@xmlns" ]
+
+      xml = self.original_xml
+
+      self.instance_variables.each do |ivar|
+        next if do_not_process.include?( ivar )
+
+        var = camelize( ivar.gsub(/@/,'') )
+
+        xml.gsub!( /<#{var}>(.*)<\/#{var}>/ , "<#{var}>#{self.instance_variable_get(ivar)}</#{var}>" )
+      end
+
+      # replace <updated> node with current time
+      xml.gsub( /<updated>.*<\/updated>/, Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z") )
+
+      xml
+    end
+
+  end # class Contact
+end # module ConstantContact

data/lib/constant_contact/contact_list.rb

@@ -0,0 +1,152 @@
+module ConstantContact 
+  class ContactList < BaseResource
+
+    attr_reader :uid, :original_xml
+
+    def initialize( params={}, orig_xml='' ) #:nodoc:
+      return false if params.empty?
+
+      @uid = params['id'].split('/').last
+      @original_xml = orig_xml
+
+      params['content']['ContactList'].each do |k,v|
+        underscore_key = underscore( k )
+
+        instance_eval %{
+          @#{underscore_key} = "#{v}"
+
+          def #{underscore_key}
+            @#{underscore_key}
+          end
+        }
+      end
+    end
+
+    # Update a contacts attributes
+    def update_attributes!( params={} )
+      return false unless full_record?
+
+      params.each do |key,val|
+        self.instance_variable_set("@#{key.to_s}", val)
+      end
+
+      data = ConstantContact.put( "/lists/#{self.uid}", :body => self.send(:to_xml) )
+
+      if data.code == 204
+        return true
+      else
+        return data # probably should raise an error here instead
+      end
+    end
+
+    # Remove all contacts from the contact list
+    def clear_contacts!
+      Activity.remove_all_contacts_from_lists( self.uid )
+    end
+
+    # Get all contact lists
+    def self.all( options={} )
+      lists = []
+
+      data = ConstantContact.get( '/lists', options )
+      return lists if ( data.nil? or data.empty? )
+
+      data['feed']['entry'].each do |entry|
+        lists << new( entry )
+      end
+
+      lists
+    end
+
+    # Add a new contact list
+    def self.add( name, opt_in=false, sort_order=99, options={} )
+      return nil if( name.nil? || name.empty? )
+
+      xml = build_contact_list_xml_packet( name, opt_in, sort_order )
+
+      options.merge!({ :body => xml })
+      data = ConstantContact.post( "/lists", options )
+
+      if data.code == 201
+        return new( data['entry'] )
+      else
+        puts "HTTP Status Code: #{data.code}, message: #{data.message}"
+        return nil
+      end
+    end
+
+    # Delete a contact list
+    def self.delete( id, options={} )
+      data = ConstantContact.delete( "/lists/#{id.to_s}", options )
+      return ( data.code == 204 ) ? true : false
+    end
+
+    # Get a single contact list
+    def self.get( id, options={} )
+      list = ConstantContact.get( "/lists/#{id.to_s}", options )
+      return nil if ( list.nil? or list.empty? )
+      new( list['entry'], list.body )
+    end
+
+    # Get a lists members
+    def self.members( id, options={} )
+      members = ConstantContact.get( "/lists/#{id.to_s}/members", options )
+      return nil if ( members.nil? or members.empty? )
+      members['feed']['entry'].collect { |entry| Contact.new( entry, '', true ) }
+    end
+
+    # Returns the objects API URI
+    def self.url_for( id )
+      "#{ConstantContact.base_uri}/lists/#{id}"
+    end
+
+    private
+
+    def self.build_contact_list_xml_packet( name, opt_in=false, sort=99 )
+      xml = <<EOF
+<entry xmlns="http://www.w3.org/2005/Atom">
+  <updated>#{Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z")}</updated>
+  <title  />
+  <author />
+  <id>data:,none</id>
+  <content type="application/vnd.ctct+xml">
+    <ContactList xmlns="http://ws.constantcontact.com/ns/1.0/">
+      <Name>#{name}</Name>
+      <SortOrder>#{sort}</SortOrder>
+      <OptInDefault>#{opt_in.to_s}</OptInDefault>
+    </ContactList>
+  </content>
+</entry>
+EOF
+      xml
+    end
+
+    # Is this a full record or a summary record?
+    def full_record?
+      !self.members.emtpy?
+    end
+
+    # Convert the object into the needed API XML format
+    def to_xml
+      return nil unless full_record?
+
+      do_not_process = [ "@original_xml", "@uid", "@members" ]
+
+      xml = self.original_xml
+
+      self.instance_variables.each do |ivar|
+        next if do_not_process.include?( ivar )
+
+        var = camelize( ivar.gsub(/@/,'') )
+
+        xml.gsub!( /<#{var}>(.*)<\/#{var}>/ , "<#{var}>#{self.instance_variable_get(ivar)}</#{var}>" )
+      end
+      
+      # replace <updated> node with current time
+      xml.gsub( /<updated>.*<\/updated>/, Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z") )
+
+      xml
+    end
+
+  end # class ContactList
+end # module ConstantContact

data/test/fixtures/get_contact.xml

@@ -0,0 +1,72 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<entry xmlns="http://www.w3.org/2005/Atom">
+  <link href="/ws/customers/joesflowers/contacts/22199" rel="edit" />
+  <id>http://api.constantcontact.com/ws/customers/joesflowers/contacts/22199</id>
+  <title type="text">Contact: joe@example.com</title>
+  <updated>2009-11-20T20:41:19.243Z</updated>
+  <author>
+    <name>Constant Contact</name>
+  </author>
+  <content type="application/vnd.ctct+xml">
+    <Contact xmlns="http://ws.constantcontact.com/ns/1.0/" id="http://api.constantcontact.
+    com/ws/customers/joesflowers/contacts/22199">
+      <Status>Active</Status>
+      <EmailAddress>joe@example.com</EmailAddress>
+      <EmailType>HTML</EmailType>
+      <Name>Customer Joe</Name>
+      <FirstName>Joe</FirstName>
+      <MiddleName></MiddleName>
+      <LastName>Smith</LastName>
+      <JobTitle></JobTitle>
+      <CompanyName></CompanyName>
+      <HomePhone></HomePhone>
+      <WorkPhone></WorkPhone>
+      <Addr1></Addr1>
+      <Addr2></Addr2>
+      <Addr3></Addr3>
+      <City></City>
+      <StateCode>MA</StateCode>
+      <StateName>Massachusetts</StateName>
+      <CountryCode>us</CountryCode>
+      <CountryName>United States</CountryName>
+      <PostalCode>02154</PostalCode>
+      <SubPostalCode>1781</SubPostalCode>
+      <Note></Note>
+      <CustomField1></CustomField1>
+      <CustomField2></CustomField2>
+      <CustomField3></CustomField3>
+      <CustomField4></CustomField4>
+      <CustomField5></CustomField5>
+      <CustomField6></CustomField6>
+      <CustomField7></CustomField7>
+      <CustomField8></CustomField8>
+      <CustomField9></CustomField9>
+      <CustomField10></CustomField10>
+      <CustomField11></CustomField11>
+      <CustomField12></CustomField12>
+      <CustomField13></CustomField13>
+      <CustomField14></CustomField14>
+      <CustomField15></CustomField15>
+      <ContactLists>
+        <ContactList id="http://api.constantcontact.com/ws/customers/joesflowers/lists/3">
+          <link xmlns="http://www.w3.org/2005/Atom" href="/ws/customers/joesflowers/lists/3" rel="self" />
+          <OptInSource>ACTION_BY_CONTACT</OptInSource>
+          <OptInTime>2009-11-20T20:41:06.595Z</OptInTime>
+        </ContactList>
+      </ContactLists>
+      <Confirmed>false</Confirmed>
+      <InsertTime>2009-11-20T20:41:06.593Z</InsertTime>
+      <LastUpdateTime>2009-11-20T20:41:19.243Z</LastUpdateTime>
+    </Contact>
+  </content>
+  <source>
+    <id>http://api.constantcontact.com/ws/customers/joesflowers/contacts</id>
+    <title type="text">Contacts for Customer: joesflowers</title>
+    <link href="contacts" />
+    <link href="contacts" rel="self" />
+    <author>
+      <name>joesflowers</name>
+    </author>
+    <updated>2009-11-20T20:45:44.199Z</updated>
+  </source>
+</entry>

data/test/fixtures/get_contacts.xml

@@ -0,0 +1,54 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <id>http://api.constantcontact.com/ws/customers/joesflowers/contacts</id>
+  <title type="text">Contacts for Customer: joesflowers</title>
+  <link href="contacts" />
+  <link href="contacts" rel="self" />
+  <author>
+    <name>joesflowers</name>
+  </author>
+  <updated>2009-11-19T14:49:21.928Z</updated>
+  <link href="/ws/customers/joesflowers/contacts?next=g24umerp-fymhqg" rel="next" />
+  <link href="/ws/customers/joesflowers/contacts" rel="first" />
+  <link href="/ws/customers/joesflowers/contacts" rel="current" />
+  <entry>
+    <link href="/ws/customers/joesflowers/contacts/21930" rel="edit" />
+    <id>http://api.constantcontact.com/ws/customers/joesflowers/contacts/21930</id>
+    <title type="text">Contact: 1258642119407@example.com</title>
+    <updated>2009-11-19T14:49:23.203Z</updated>
+    <author>
+      <name>Constant Contact</name>
+    </author>
+    <content type="application/vnd.ctct+xml">
+      <Contact xmlns="http://ws.constantcontact.com/ns/1.0/" id="http://api.constantcontact.
+      com/ws/customers/joesflowers/contacts/21930">
+        <Status>Active</Status>
+        <EmailAddress>1258642119407@example.com</EmailAddress>
+        <EmailType>HTML</EmailType>
+        <Name>Customer 1</Name>
+        <OptInTime>2009-11-19T14:48:41.761Z</OptInTime>
+        <OptInSource>ACTION_BY_CONTACT</OptInSource>
+      </Contact>
+    </content>
+  </entry>
+  <entry>
+    <link href="/ws/customers/joesflowers/contacts/21929" rel="edit" />
+    <id>http://api.constantcontact.com/ws/customers/joesflowers/contacts/21929</id>
+    <title type="text">Contact: 1258641848349@example.com</title>
+    <updated>2009-11-19T14:49:23.204Z</updated>
+    <author>
+      <name>Constant Contact</name>
+    </author>
+    <content type="application/vnd.ctct+xml">
+      <Contact xmlns="http://ws.constantcontact.com/ns/1.0/" id="http://api.constantcontact.
+      com/ws/customers/joesflowers/contacts/21929">
+        <Status>Active</Status>
+        <EmailAddress>1258641848349@example.com</EmailAddress>
+        <EmailType>HTML</EmailType>
+        <Name>Customer 2</Name>
+        <OptInTime>2009-11-19T14:44:10.873Z</OptInTime>
+        <OptInSource>ACTION_BY_CONTACT</OptInSource>
+      </Contact>
+    </content>
+  </entry>
+</feed>

data/test/fixtures/post_contacts.xml

@@ -0,0 +1,18 @@
+<entry xmlns="http://www.w3.org/2005/Atom">
+  <title type="text"> </title>
+  <updated>2008-07-23T14:21:06.407Z</updated>
+  <author></author>
+  <id>data:,none</id>
+  <summary type="text">Contact</summary>
+  <content type="application/vnd.ctct+xml">
+    <Contact xmlns="http://ws.constantcontact.com/ns/1.0/">
+      <EmailAddress>test_100@example.com</EmailAddress>
+      <FirstName>First</FirstName>
+      <LastName>Last</LastName>
+      <OptInSource>ACTION_BY_CONTACT</OptInSource>
+      <ContactLists>
+        <ContactList id="http://api.constantcontact.com/ws/customers/geeksquad/joesflowers/lists/1" />
+      </ContactLists>
+    </Contact>
+  </content>
+</entry>

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'constant_contact'))
+require 'constant-contact-ruby'
+
+class Test::Unit::TestCase
+
+  fixtures_path = File.join( File.dirname( __FILE__ ), 'fixtures' )
+  
+  # setup FakeWeb 
+  FakeWeb.allow_net_connect = false
+  # GET /contacts
+  FakeWeb.register_uri( :get, %r{https://.+:.+@api\.constantcontact\.com/ws/customers/.+/contacts$}, :body => File.read( File.join( fixtures_path, 'get_contacts.xml' ) ) )
+  # GET /contact/:id
+  FakeWeb.register_uri( :get, %r{https://.+:.+@api\.constantcontact\.com/ws/customers/.+/contact/\d+$}, :body => File.read( File.join( fixtures_path, 'get_contact.xml' ) ) )
+
+end

data/test/test_constant-contact-ruby.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+class TestConstantContactRuby < Test::Unit::TestCase
+  def test_setup
+    ConstantContact.setup( 'u', 'p' )
+    assert_equal 'https://api.constantcontact.com/ws/customers/u', ConstantContact.base_uri
+  end
+end

data/test/test_contacts.rb

@@ -0,0 +1,49 @@
+require 'helper'
+require 'contact'
+
+class TestContact < Test::Unit::TestCase
+
+  def setup
+    ConstantContact.setup( 'user', 'password' )
+  end
+
+  def test_all_contacts
+    contacts = ConstantContact::Contact.all
+    assert !contacts.nil?
+    assert_equal 2, contacts.size
+    assert_equal ConstantContact::Contact, contacts.first.class
+
+    assert_equal 'Customer 1', contacts.first.name
+    assert_equal '21930', contacts.first.uid
+  end
+
+  def test_all_contacts_with_bad_credentials
+    # FakeWeb.register_uri( :get, %r{https://.+:.+@api\.constantcontact\.com/ws/customers/.+/contacts}, :body => '', :status => ['403', 'Not Authorized'] )
+    # contacts = ConstantContact::Contact.all
+    # assert contacts.empty?
+  end
+
+  def test_get_contact
+    contact = ConstantContact::Contact.get( 22199 )
+    assert_equal 'Customer Joe', contact.name
+    assert_equal '22199', contact.uid
+    assert_equal 'joe@example.com', contact.emailaddress
+
+    # TODO: contactLists
+  end
+
+  def test_add_contact
+    # c = ConstantContact::Contact.add(
+    #   :email_address => 'test@example.com',
+    #   :first_name => 'First',
+    #   :last_name => 'Name',
+    #   :opt_in_source => 'ACTION_BY_CONTACT', # or ACTION_BY_CUSTOMER
+    #   :contact_lists => [1]
+    # )
+
+    # assert_equal 'test@example.com', c.email_address
+    # 
+    # contact = ConstantContact::Contact.get( c.uid )
+    # assert_equal 'test@example.com', contact.email_address
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: constant-contact-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Craig P Jolicoeur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-03 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Ruby wrapper around the Constant Contact REST API
+email: cpjolicoeur@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION.yml
+- constant-contact-ruby.gemspec
+- constant-contact-ruby.rb
+- lib/constant_contact.rb
+- lib/constant_contact/activity.rb
+- lib/constant_contact/base_resource.rb
+- lib/constant_contact/contact.rb
+- lib/constant_contact/contact_list.rb
+- test/fixtures/get_contact.xml
+- test/fixtures/get_contacts.xml
+- test/fixtures/post_contacts.xml
+- test/helper.rb
+- test/test_constant-contact-ruby.rb
+- test/test_contacts.rb
+has_rdoc: true
+homepage: http://github.com/cpjolicoeur/constant-contact-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Constant Contact Ruby API Wrapper
+test_files: 
+- test/helper.rb
+- test/test_constant-contact-ruby.rb
+- test/test_contacts.rb