SFEley-acts_as_icontact 0.2.0 → 0.2.1

data/README.markdown

@@ -152,9 +152,13 @@ When you call the `acts_as_icontact` method in an ActiveRecord class declaration
 4. If an `icontact_status` field exists, creates named scopes on the model class for each iContact status.  _(Pending)_
 
 ### Options
-Option values and field mappings can be passed to the `acts_as_icontact` declaration to set default behavior for the model class.  Right now there's only one option:
+Option values and field mappings can be passed to the `acts_as_icontact` declaration to set default behavior for the model class.
 
-`default_lists` -- _The name or ID number of a list to subscribe new contacts to automatically, or an array of said names or numbers_
+`list` -- _The name or ID number of a list to subscribe new contacts to automatically_  
+`lists` -- _Like `list` but takes an array of names or numbers; new contacts will be subscribed to all of them_  
+`exception_on_failure` -- _If true, throws an ActsAsIcontact::SyncError when synchronization fails.  Defaults to false._  
+
+A note about failure: problems with synchronization are always logged to the standard Rails log.  For most applications, however, updating iContact is a secondary consideration; if a new user is registering, you _probably_ don't want exceptions bubbling up and the whole transaction rolling back just because of a transient iContact server outage.  So exceptions are something you have to deliberately enable.
 
 ### Field Mappings
 You can add contact integration to any ActiveRecord model that tracks an email address.  (If your model _doesn't_ include email but you want to use iContact with it, you are very, very confused.)
@@ -162,13 +166,13 @@ You can add contact integration to any ActiveRecord model that tracks an email a
 Any fields that are named the same as iContact's personal information fields, or custom fields you've previously declared, will be autodiscovered.  Otherwise you can map them:
 
     class Customer < ActiveRecord::Base
-      acts_as_icontact :default_lists => ['New Customers', 'All Users']  # Puts new contact on two lists
-                       :given_name => :firstName, # Key is Rails field, value is iContact field
-                       :family_name => :lastName,
-                       :address1 => :street,
-                       :address2 => :street2,
-                       :id => :rails_id, # Custom field created in iContact
-                       :preferred? => :preferred_customer # Custom field
+      acts_as_icontact :lists => ['New Customers', 'All Users']  # Puts new contact on two lists
+                       :firstName => :given_name, # Key is iContact field, value is Rails field
+                       :lastName => :family_name,
+                       :street => :address1,
+                       :street2 => :address2,
+                       :rails_id => :id  # Custom field created in iContact
+                       :preferred_customer => :preferred? # Custom field
     end
 
 A few iContact-specific fields are exceptions, and have different autodiscovery names to avoid collisions with other attributes in your application:

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/acts_as_icontact.gemspec

@@ -2,17 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2009-07-26}
+  s.date = %q{2009-07-27}
+  s.default_executable = %q{icontact}
   s.description = %q{ActsAsIcontact connects Ruby applications with the iContact e-mail marketing service using the iContact API v2.0.  Building on the RestClient gem, it offers two significant feature sets:
 
 * Simple, consistent access to all resources in the iContact API; and
 * Automatic synchronizing between ActiveRecord models and iContact contact lists for Rails applications.
 }
   s.email = %q{sfeley@gmail.com}
+  s.executables = ["icontact"]
   s.extra_rdoc_files = [
     "README.markdown"
   ]
@@ -24,18 +26,22 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "acts_as_icontact.gemspec",
+     "bin/icontact",
      "init.rb",
      "lib/acts_as_icontact.rb",
      "lib/acts_as_icontact/config.rb",
      "lib/acts_as_icontact/connection.rb",
      "lib/acts_as_icontact/exceptions.rb",
      "lib/acts_as_icontact/rails.rb",
+     "lib/acts_as_icontact/rails/callbacks.rb",
      "lib/acts_as_icontact/rails/macro.rb",
+     "lib/acts_as_icontact/rails/mappings.rb",
      "lib/acts_as_icontact/resource.rb",
      "lib/acts_as_icontact/resource_collection.rb",
      "lib/acts_as_icontact/resources/account.rb",
      "lib/acts_as_icontact/resources/client.rb",
      "lib/acts_as_icontact/resources/contact.rb",
+     "lib/acts_as_icontact/resources/custom_field.rb",
      "lib/acts_as_icontact/resources/list.rb",
      "lib/acts_as_icontact/resources/message.rb",
      "rails/init.rb",
@@ -43,11 +49,14 @@ Gem::Specification.new do |s|
      "spec/connection_spec.rb",
      "spec/examples/schema.rb",
      "spec/rails_spec.rb",
+     "spec/rails_spec/callbacks_spec.rb",
+     "spec/rails_spec/mappings_spec.rb",
      "spec/resource_collection_spec.rb",
      "spec/resource_spec.rb",
      "spec/resources/account_spec.rb",
      "spec/resources/client_spec.rb",
      "spec/resources/contact_spec.rb",
+     "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
      "spec/spec.opts",
@@ -60,18 +69,21 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{actsasicontact}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Automatic bridge between iContact e-mail marketing service and Rails ActiveRecord}
   s.test_files = [
     "spec/config_spec.rb",
      "spec/connection_spec.rb",
      "spec/examples/schema.rb",
+     "spec/rails_spec/callbacks_spec.rb",
+     "spec/rails_spec/mappings_spec.rb",
      "spec/rails_spec.rb",
      "spec/resource_collection_spec.rb",
      "spec/resource_spec.rb",
      "spec/resources/account_spec.rb",
      "spec/resources/client_spec.rb",
      "spec/resources/contact_spec.rb",
+     "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
      "spec/spec_helper.rb",

data/bin/icontact

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'acts_as_icontact'
+require 'rubygems'
+require 'readline'
+require 'bond'
+require 'bond/completion'
+
+module ActsAsIcontact
+  # Lifted from: http://tagaholic.me/2009/07/23/mini-irb-and-mini-script-console.html
+  history_file = File.join(ENV["HOME"], '.icontact_history')
+  IO.readlines(history_file).each {|e| Readline::HISTORY << e.chomp } if File.exists?(history_file)
+  print "# ActsAsIcontact command line (type 'exit' to quit)\n"
+  while (input = Readline.readline('>> ', true)) != 'exit'
+    begin puts "=> #{eval(input).inspect}"; rescue Exception; puts "Error: #{$!}" end
+  end
+  File.open(history_file, 'w') {|f| f.write Readline::HISTORY.to_a.join("\n") }
+  
+end
+
+exit!

data/lib/acts_as_icontact/rails/callbacks.rb

@@ -0,0 +1,31 @@
+module ActsAsIcontact
+  module Rails
+    module Callbacks
+      
+      protected
+      # Called after a new record has been saved.  Creates a new contact in iContact.
+      def icontact_after_create
+        c = ActsAsIcontact::Contact.new
+        self.class.icontact_mappings.each do |rails, iContact|
+          if (value = self.send(rails))
+            ic = (iContact.to_s + '=').to_sym   # Blah. This feels like it should be easier.
+            c.send(ic, value)
+          end
+        end
+        if c.save
+          # Update with iContact fields returned
+          @icontact_in_progress = true
+          self.class.icontact_mappings.each do |rails, iContact|
+            unless (value = c.send(iContact)).blank?
+              r = (rails.to_s + '=').to_sym   # Blah. This feels like it should be easier.
+              self.send(r, value)
+            end
+          end
+          self.save
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/acts_as_icontact/rails/macro.rb

@@ -6,7 +6,20 @@ module ActsAsIcontact
         # The core macro for ActsAsIcontact's Rails integration.  Establishes callbacks to keep Rails models in
         # sync with iContact.  See the README for more on what it does.
         def acts_as_icontact(options = {})
-          true
+          # Fail on exceptions?
+          @icontact_exception_on_failure = options.delete(:exception_on_failure) || false
+          
+          # Combines :list and :lists parameters into one array
+          @icontact_default_lists = []
+          @icontact_default_lists << options.delete(:list) if options.has_key?(:list)
+          @icontact_default_lists += options.delete(:lists) if options.has_key?(:lists)
+          
+          # Set up field mappings
+          set_mappings(options)
+          
+          # If we haven't flaked out so far, we must be doing okay.  Make magic happen.
+          include ActsAsIcontact::Rails::Callbacks
+          after_create :icontact_after_create
         end
 
       end

data/lib/acts_as_icontact/rails/mappings.rb

@@ -0,0 +1,74 @@
+module ActsAsIcontact
+  module Rails
+    module ClassMethods
+      module Mappings
+        
+        ICONTACT_DEFAULT_MAPPINGS = {
+          :contactId => [:icontact_id, :icontactId],
+          :email => [:email, :email_address, :eMail, :emailAddress],
+          :firstName => [:firstName, :first_name, :fname],
+          :lastName => [:lastName, :last_name, :lname], 
+          :street => [:street, :street1, :address, :address1],
+          :street2 => [:street2, :address2],
+          :city => [:city],
+          :state => [:state, :province, :state_or_province],
+          :postalCode => [:postalCode, :postal_code, :zipCode, :zip_code, :zip],
+          :phone => [:phone, :phoneNumber, :phone_number],
+          :fax => [:fax, :faxNumber, :fax_number],
+          :business => [:business, :company, :companyName, :company_name, :businessName, :business_name],
+          :status => [:icontact_status, :icontactStatus],
+          :createDate => [:icontact_created, :icontactCreated, :icontact_create_date, :icontactCreateDate],
+          :bounceCount => [:icontact_bounces, :icontactBounces, :icontact_bounce_count, :icontactBounceCount]
+        }
+
+        # A hash containing the final list of iContact-to-Rails mappings.  The mappings take into account both
+        # analysis of existing field names and explicit mappings on the `acts_as_icontact` macro line.
+        def icontact_mappings
+          @icontact_mappings
+        end
+        
+        # A two-element array indicating the association used to uniquely identify this record between Rails and iContact.
+        # The first element is the Rails field; the second element is the iContact field.
+        # First uses whatever field maps the contactId; if none, looks for a mapping from the Rails ID.  Uses the email address
+        # mapping (which is required) as a last resort.
+        def icontact_identity_map
+          icontact_mappings.rassoc(:contactId) or icontact_mappings.assoc(:id) or icontact_mappings.rassoc(:email)
+        end
+        
+        protected
+        
+        # Sets up the mapping hash from iContact fields to Rails fields.
+        def set_mappings(options)
+          @icontact_mappings = {}
+          set_default_mappings
+          set_custom_field_mappings
+          @icontact_mappings.merge!(options)
+        end
+        
+        private
+        def set_default_mappings
+          ICONTACT_DEFAULT_MAPPINGS.each do |iContactField, candidates|
+            candidates.each do |candidate|
+              if rails_field?(candidate)
+                @icontact_mappings[candidate] = iContactField
+                break
+              end
+            end
+          end
+        end
+        
+        def set_custom_field_mappings
+          @icontact_custom_fields ||= CustomField.list
+          @icontact_custom_fields.each do |field|
+            f = field.to_sym
+            @icontact_mappings[f] = f if rails_field?(f)
+          end
+        end
+        
+        def rails_field?(field)
+          column_names.include?(field.to_s) or instance_methods.include?(field) 
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_icontact/rails.rb

@@ -4,18 +4,20 @@ Dir[File.join(File.dirname(__FILE__), 'rails', '*.rb')].sort.each do |path|
   require "acts_as_icontact/rails/#{filename}"
 end
 
-module ActsAsIcontact
-  module Rails
-    module ClassMethods
-      include Macro
-    end
-  end
-end
+# module ActsAsIcontact
+#   module Rails
+#     module ClassMethods
+#       extend Mappings
+#       extend Macro
+#     end
+#   end
+# end
 
 if defined?(::ActiveRecord)
   module ::ActiveRecord
     class Base
-      extend ActsAsIcontact::Rails::ClassMethods
+      extend ActsAsIcontact::Rails::ClassMethods::Mappings
+      extend ActsAsIcontact::Rails::ClassMethods::Macro
     end
   end
 end

data/lib/acts_as_icontact/resource.rb

@@ -102,7 +102,7 @@ module ActsAsIcontact
       @errors
     end
     
-    # Returns an array of resources starting at the base.
+    # Returns a resource or collection of resources.  
     def self.find(type, options={})
       case type
       when :first
@@ -111,6 +111,8 @@ module ActsAsIcontact
         all(options)
       when Integer
         find_by_id(type)
+      when String
+        find_by_string(type)  # Implemented in subclasses
       else
         raise ActsAsIcontact::QueryError, "Don't know how to find '#{type.to_s}'"
       end
@@ -137,8 +139,10 @@ module ActsAsIcontact
     def self.find_by_id(id)
       response = self.connection[id].get
       parsed = JSON.parse(response)
-      raise ActsAsiContact::QueryError, "iContact's response did not contain a #{resource_name}!" unless parsed[resource_name]
+      raise ActsAsIcontact::QueryError, "iContact's response did not contain a #{resource_name}!" unless parsed[resource_name]
       self.new(parsed[resource_name])
+    rescue RestClient::ResourceNotFound
+      raise ActsAsIcontact::QueryError, "The #{resource_name} with id #{id} could not be found"
     end
     
     # Two resources are identical if they have exactly the same property array.
@@ -196,6 +200,11 @@ module ActsAsIcontact
       base[uri_component]
     end
     
+    # Allows some subclasses to implement finding by a key identifier string.  The base resource just throws an exception.
+    def self.find_by_string(value)
+      raise ActsAsIcontact::QueryError, "You cannot search on #{collection_name} with a string value!"
+    end
+    
     # The primary key field for this resource.  Used on updates.
     def self.primary_key
       resource_name + "Id"

data/lib/acts_as_icontact/resources/contact.rb

@@ -3,7 +3,7 @@ module ActsAsIcontact
     
     # Email is required
     def self.required_on_create
-      super << ['email']
+      super << 'email'
     end
     
     # Derived from clientFolder

data/lib/acts_as_icontact/resources/custom_field.rb

@@ -0,0 +1,51 @@
+module ActsAsIcontact
+  class CustomField < Resource
+    
+    # Has a default fieldType of "text" and displayToUser of "false" if not overridden as options.
+    def initialize(properties={})
+      # Capture privateName as the ID field if it was passed in
+      @customFieldId = properties["privateName"] || properties[:privateName]
+      super({:fieldType => "text", :displayToUser => false}.merge(properties))
+    end
+    
+    # Uses privateName as its ID in resource URLs.  The custom field resource is just weird that way.
+    def id
+      @customFieldId
+    end
+    
+    # privateName must not contain certain punctuation; fieldType must be "text" or "checkbox".
+    def validate_on_save(fields)
+      raise ActsAsIcontact::ValidationError, "privateName cannot contain spaces, quotes, slashes or brackets" if fields["privateName"] =~ /[\s\"\'\/\\\[\]]/
+      raise ActsAsIcontact::ValidationError, "fieldType must be 'text' or 'checkbox'" unless fields["fieldType"] =~ /^(text|checkbox)$/
+    end
+      
+    
+    # Searches on privateName.  For this class it's the proper way to find by the primary key anyway.
+    def self.find_by_string(value)
+      find_by_id(value)
+    end
+    
+    # Requires privateName, displayToUser, fieldType
+    def self.required_on_create
+      super + %w(privateName displayToUser fieldType)
+    end
+    
+    # Treats displayToUser as a boolean field (accepts true and false)
+    def self.boolean_fields
+      super << "displayToUser"
+    end
+    
+    # Uses privateName as its primary key field
+    def self.primary_key
+      "privateName"
+    end
+    
+    # Returns an array listing all custom fields.  This is very convenient for certain tasks (e.g. the mapping in our Rails integration).
+    def self.list
+      list = []
+      fields = self.all
+      fields.each {|f| list << f.privateName}
+      list
+    end
+  end
+end

data/lib/acts_as_icontact/resources/list.rb

@@ -5,6 +5,11 @@ module ActsAsIcontact
       ActsAsIcontact.client
     end
     
+    # Searches on list name.
+    def self.find_by_string(value)
+      first(:name => value)
+    end
+    
     # Requires name, emailOwnerOnChange, welcomeOnManualAdd, welcomeOnSignupAdd, and welcomeMessageId.
     def self.required_on_create
       super << "name" << "emailOwnerOnChange" << "welcomeOnManualAdd" << "welcomeOnSignupAdd" << "welcomeMessageId"

data/spec/examples/schema.rb

@@ -5,9 +5,13 @@ ActiveRecord::Schema.define do
     t.string   "email",                              :null => false
     t.string  "icontact_status"
     t.string  "status"
-    t.string  "icontact_id"
-    t.datetime  "icontact_created"
-    t.string  "bounces"
+    t.integer  "icontact_id"
+    t.string  "address"
+    t.string  "state_or_province"
+    t.string  "zip"
+    t.string  "business"
+    t.datetime  "icontactCreated"
+    t.integer  "bounces"
     t.string  "custom_field"
     t.datetime "created_at"
     t.datetime "updated_at"

data/spec/rails_spec/callbacks_spec.rb

@@ -0,0 +1,19 @@
+share_as :Callbacks do
+  context "callbacks" do
+    before(:each) do
+      @class.acts_as_icontact :list => "First Test", :surname => :lastName
+      @person = @class.new(:firstName => "John", :surname => "Smith", :email => "john@example.org")
+    end
+    
+    it "will create a new contact after record creation" do
+#      ActsAsIcontact::Contact.any_instance.expects(:save).returns(true)
+      @person.save
+    end
+    
+    it "updates the Person with the results of the contact save" do
+      @person.save
+      @person.icontact_id.should == 333444
+    end
+    
+  end
+end

data/spec/rails_spec/mappings_spec.rb

@@ -0,0 +1,61 @@
+share_as :Mappings do
+  
+  context "mappings" do
+    before(:each) do
+      @class.acts_as_icontact :list => 444444, :surname => :lastName
+    end
+    
+    it "uses any non-option keys as field mappings" do
+      @class.icontact_mappings[:surname].should == :lastName
+    end
+    
+    it "does not map option keys" do
+      @class.icontact_mappings.should_not have_key(:list)
+    end
+    
+    it "maps fields it can find from the default list" do
+      @class.icontact_mappings[:firstName].should == :firstName
+    end
+    
+    it "maps second choices when it can find them" do
+      @class.icontact_mappings[:zip].should == :postalCode
+    end
+    
+    it "maps the icontact_ exception names" do
+      @class.icontact_mappings[:icontactCreated].should == :createDate
+    end
+    
+    it "does not map the default form of exception names" do
+      @class.icontact_mappings.should_not have_key(:status)
+    end
+    
+    it "maps icontact_status" do
+      @class.icontact_mappings[:icontact_status].should == :status
+    end
+    
+    it "maps the address field" do
+      @class.icontact_mappings[:address].should == :street
+    end
+    
+    it "maps custom fields" do
+      @class.icontact_mappings[:custom_field].should == :custom_field
+    end
+  end
+  
+  context "identity mapping" do
+    it "looks for contactId first" do
+      @class.acts_as_icontact
+      @class.icontact_identity_map.should == [:icontact_id, :contactId]
+    end
+    
+    it "looks for a Rails ID custom field second" do
+      @class.acts_as_icontact :icontact_id => nil, :id => :test_field
+      @class.icontact_identity_map.should == [:id, :test_field]
+    end
+    
+    it "uses email as last resort" do
+      @class.acts_as_icontact :icontact_id => nil
+      @class.icontact_identity_map.should == [:email, :email]
+    end
+  end
+end

data/spec/rails_spec.rb

@@ -3,24 +3,9 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'activerecord'
 require 'rails/init'
 
-# Dummy model
-class Person < ActiveRecord::Base
-  # create_table "people", :force => true do |t|
-  #   t.string   "firstName"                         
-  #   t.string  "surname"        
-  #   t.string   "email",                              :null => false
-  #   t.string  "icontact_status"
-  #   t.string  "status"
-  #   t.string  "icontact_id"
-  #   t.datetime  "icontact_created"
-  #   t.string  "bounces"
-  #   t.string  "custom_field"
-  #   t.datetime "created_at"
-  #   t.datetime "updated_at"
-  # end
-  
-  acts_as_icontact
-end
+# Spreading out our Rails specs
+Dir["#{File.dirname(__FILE__)}/rails_spec/*.rb"].each {|f| load f}
+
 
 describe "Rails integration" do
   before(:all) do
@@ -28,9 +13,70 @@ describe "Rails integration" do
                                             :schema => File.dirname(__FILE__) + '/examples/schema.rb'
   end
   
-  it "relies on a model with an email address" do
-    @person = Person.new(:email => "john@example.org")
-    @person.email.should == "john@example.org"
+  before(:each) do
+    # Create each Person class in a different module so that we can try different permutations.
+    @module = Module.new do
+      # Dummy model - comes from spec/examples/schema.rb and using the nullDB adapter
+      class Person < ActiveRecord::Base
+        # create_table "people", :force => true do |t|
+        #   t.string   "firstName"                         
+        #   t.string  "surname"        
+        #   t.string   "email",                              :null => false
+        #   t.string  "icontact_status"
+        #   t.string  "status"
+        #   t.string  "icontact_id"
+        #   t.string  "address"
+        #   t.string  "state_or_province"
+        #   t.string  "zip"
+        #   t.string  "business"
+        #   t.datetime  "icontactCreated"
+        #   t.string  "bounces"
+        #   t.string  "custom_field"
+        #   t.datetime "created_at"
+        #   t.datetime "updated_at"
+        # end
+        
+        # Fake out ActiveRecord's column introspection
+        def self.name
+          "Person"
+        end
+      end
+      
+    end
+    
+    @class = @module.module_eval("Person")
+  end
+
+  it "allows the acts_as_icontact macro method" do
+    @class.should respond_to(:acts_as_icontact)
+  end
+  
+  it "sets whether to throw exceptions on failure" do
+    @class.acts_as_icontact :exception_on_failure => true
+    @class.instance_variable_get(:@icontact_exception_on_failure).should be_true
+  end
+  
+  it "defaults to NOT setting exceptions on failure" do
+    @class.acts_as_icontact
+    @class.instance_variable_get(:@icontact_exception_on_failure).should be_false
+  end
+    
+  it "sets default lists from a single list in the options" do
+    @class.acts_as_icontact :list => 444444
+    @class.instance_variable_get(:@icontact_default_lists).should == [444444]
+  end
+
+  it "sets default lists from an array of lists in the options" do
+    @class.acts_as_icontact :lists => [444555, "Test List 3"]
+    @class.instance_variable_get(:@icontact_default_lists).should == [444555, "Test List 3"]
+  end
+  
+  it "sets default lists from both a list _and_ an array of lists in the options" do
+    @class.acts_as_icontact :lists => [444555, "Test List 3"], :list => 444444
+    @class.instance_variable_get(:@icontact_default_lists).should == [444444, 444555, "Test List 3"]
   end
   
+  include Mappings
+  include Callbacks
+    
 end

data/spec/resource_spec.rb

@@ -80,6 +80,11 @@ describe ActsAsIcontact::Resource do
       a.too.should == "sar"
     end 
     
+    it "can attempt to find a single resource by string identifier" do
+      ActsAsIcontact::Resource.expects(:find_by_string).returns(nil)
+      ActsAsIcontact::Resource.find("bar")
+    end
+    
   end
   
   it "knows its properties" do

data/spec/resources/custom_field_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact::CustomField do
+  it "requires privateName, displayToUser, fieldType" do
+    cf = ActsAsIcontact::CustomField.new(:displayToUser => nil, :fieldType => nil)
+    lambda{cf.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: privateName, displayToUser, fieldType")
+  end
+  
+  it "uses true and false to assign boolean fields" do
+    cf = ActsAsIcontact::CustomField.new
+    cf.displayToUser = true
+    cf.instance_variable_get(:@properties)["displayToUser"].should == 1
+  end
+
+  it "defaults displayToUser to false" do
+    cf = ActsAsIcontact::CustomField.new
+    cf.displayToUser.should be_false
+  end
+  
+  it "defaults fieldType to text" do
+    cf = ActsAsIcontact::CustomField.new
+    cf.fieldType.should == "text"
+  end
+  
+  it "uses privateName as its primary key" do
+    ActsAsIcontact::CustomField.primary_key.should == "privateName"
+  end
+  
+  it "uses privateName as its resource ID" do
+    cf = ActsAsIcontact::CustomField.new(:privateName => "blah")
+    cf.connection.url.should =~ /blah/
+  end
+     
+  it "can find fields by string" do
+    cf = ActsAsIcontact::CustomField.find("test_field")
+    cf.publicName.should == "Test Field"
+  end
+  
+  it "validates the format of the privateName" do
+    cf = ActsAsIcontact::CustomField.new(:privateName => "This isn't a valid [privateName].")
+    lambda{cf.save}.should raise_error(ActsAsIcontact::ValidationError, "privateName cannot contain spaces, quotes, slashes or brackets")
+  end
+  
+  it "validates the value of fieldType" do
+    cf = ActsAsIcontact::CustomField.new(:fieldType => "radio", :privateName => "test")
+    lambda{cf.save}.should raise_error(ActsAsIcontact::ValidationError, "fieldType must be 'text' or 'checkbox'")
+  end
+  
+  it "can easily retrieve a list of custom field names" do
+    ActsAsIcontact::CustomField.list.should == %w(test_field custom_field)
+  end
+end

data/spec/resources/list_spec.rb

@@ -21,6 +21,11 @@ describe ActsAsIcontact::List do
     l.welcomeOnManualAdd.should be_true
   end
   
+  it "can find a list by name" do
+    l = ActsAsIcontact::List.find("First Test")
+    l.id.should == 444444
+  end
+  
   context "associations" do
     # Create one good list
     before(:each) do

data/spec/support/spec_fakeweb.rb

@@ -30,6 +30,7 @@ FakeWeb.register_uri(:get, "#{i}/a/111111/c?limit=500", :body => %q<{"clientfold
 
 # Contacts
 FakeWeb.register_uri(:get, "#{ic}/contacts?limit=1&status=total&firstName=John&lastName=Test", :body => %q<{"contacts":[{"email":"john@example.org","firstName":"John","lastName":"Test","status":"normal","contactId":"333333","createDate":"2009-07-24 01:00:00"}]}>)
+FakeWeb.register_uri(:post, "#{ic}/contacts", :body => %q<{"contacts":[{"email":"john@example.org","firstName":"John","lastName":"Smith","status":"normal","contactId":"333444","createDate":"2009-07-24 01:00:00","street":"","street2":"","prefix":"","suffix":"","fax":"","phone":"","city":"","state":"","postalCode":"","bounceCount":0,"custom_field":"","test_field":"","business":""}]}>)
 
 #  Lists
 FakeWeb.register_uri(:get, "#{ic}/lists?limit=1&name=First%20Test", :body => %q<{"lists":[{"listId":"444444","name":"First Test","emailOwnerOnChange":"0","welcomeOnManualAdd":"0","welcomeOnSignupAdd":"0","welcomeMessageId":"555555","description":"Just a test list."}]}>)
@@ -40,3 +41,7 @@ FakeWeb.register_uri(:get, "#{ic}/messages/555555", :body => %q<{"message":{"mes
 
 #### Test message for associations originating from Message spec
 FakeWeb.register_uri(:get, "#{ic}/messages?limit=1&subject=Test%20Message", :body => %q<{"messages":[{"messageId":"666666","subject":"Test Message","messageType":"normal","textBody":"Hi there!\nThis is just a test.","htmlBody":"<p><b>Hi there!</b></p><p>This is just a <i>test.</i></p>","createDate":"20090725 14:53:33"}]}>)
+
+# CustomField
+FakeWeb.register_uri(:get, "#{ic}/customfields?limit=500", :body => %q<{"customfields":[{"privateName":"test_field","publicName":"Test Field","displayToUser":"0","fieldType":"text"},{"privateName":"custom_field","publicName":"This is for the Rails integration specs","displayToUser":1,"fieldType":"text"}],"total":2}>)
+FakeWeb.register_uri(:get, "#{ic}/customfields/test_field", :body => %q<{"customfield":{"privateName":"test_field","publicName":"Test Field","displayToUser":"0","fieldType":"text"}}>)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: SFEley-acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Stephen Eley
@@ -9,14 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -07:00
-default_executable: 
+date: 2009-07-27 00:00:00 -07:00
+default_executable: icontact
 dependencies: []
 
 description: "ActsAsIcontact connects Ruby applications with the iContact e-mail marketing service using the iContact API v2.0.  Building on the RestClient gem, it offers two significant feature sets:  * Simple, consistent access to all resources in the iContact API; and * Automatic synchronizing between ActiveRecord models and iContact contact lists for Rails applications."
 email: sfeley@gmail.com
-executables: []
-
+executables: 
+- icontact
 extensions: []
 
 extra_rdoc_files: 
@@ -29,18 +29,22 @@ files:
 - Rakefile
 - VERSION
 - acts_as_icontact.gemspec
+- bin/icontact
 - init.rb
 - lib/acts_as_icontact.rb
 - lib/acts_as_icontact/config.rb
 - lib/acts_as_icontact/connection.rb
 - lib/acts_as_icontact/exceptions.rb
 - lib/acts_as_icontact/rails.rb
+- lib/acts_as_icontact/rails/callbacks.rb
 - lib/acts_as_icontact/rails/macro.rb
+- lib/acts_as_icontact/rails/mappings.rb
 - lib/acts_as_icontact/resource.rb
 - lib/acts_as_icontact/resource_collection.rb
 - lib/acts_as_icontact/resources/account.rb
 - lib/acts_as_icontact/resources/client.rb
 - lib/acts_as_icontact/resources/contact.rb
+- lib/acts_as_icontact/resources/custom_field.rb
 - lib/acts_as_icontact/resources/list.rb
 - lib/acts_as_icontact/resources/message.rb
 - rails/init.rb
@@ -48,11 +52,14 @@ files:
 - spec/connection_spec.rb
 - spec/examples/schema.rb
 - spec/rails_spec.rb
+- spec/rails_spec/callbacks_spec.rb
+- spec/rails_spec/mappings_spec.rb
 - spec/resource_collection_spec.rb
 - spec/resource_spec.rb
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
 - spec/spec.opts
@@ -62,6 +69,7 @@ files:
 - spec/support/spec_fakeweb.rb
 has_rdoc: false
 homepage: http://github.com/SFEley/acts_as_icontact
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -82,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: actsasicontact
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Automatic bridge between iContact e-mail marketing service and Rails ActiveRecord
@@ -90,12 +98,15 @@ test_files:
 - spec/config_spec.rb
 - spec/connection_spec.rb
 - spec/examples/schema.rb
+- spec/rails_spec/callbacks_spec.rb
+- spec/rails_spec/mappings_spec.rb
 - spec/rails_spec.rb
 - spec/resource_collection_spec.rb
 - spec/resource_spec.rb
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
 - spec/spec_helper.rb