acts_as_icontact 0.1.1 → 0.1.5

data/README.markdown

@@ -23,26 +23,26 @@ Using ActsAsIcontact is easy, but going through iContact's authorization process
 
        $ sudo gem install acts_as_icontact
 
-2. _Optional but recommended:_ Go to <http://beta.icontact.com> and sign up for an iContact Beta account. This will let you test your app without risk of blowing away your production mailing lists.
+2. _Optional but recommended:_ Go to <http://sandbox.icontact.com> and sign up for an iContact Sandbox account. This will let you test your app without risk of blowing away your production mailing lists.
 
-3. Enable the ActsAsIcontact gem for use with your iContact account. The URL and credentials you'll use are different between the beta and production environments:  
+3. Enable the ActsAsIcontact gem for use with your iContact account. The URL and credentials you'll use are different between the sandbox and production environments:  
   
-     * **BETA:** Go to <http://app.beta.icontact.com/icp/core/externallogin> and enter `Ml5SnuFhnoOsuZeTOuZQnLUHTbzeUyhx` for the Application Id. Choose a password for ActsAsIcontact that's different from your account password.  
+     * **Sandbox:** Go to <http://app.sandbox.icontact.com/icp/core/externallogin> and enter `Ml5SnuFhnoOsuZeTOuZQnLUHTbzeUyhx` for the Application Id. Choose a password for ActsAsIcontact that's different from your account password.  
   
      * **PRODUCTION:** Go to <http://app.icontact.com/icp/core/externallogin> and enter `IYDOhgaZGUKNjih3hl1ItLln7zpAtWN2` for the Application Id. Choose a password for ActsAsIcontact that's different from your account password.
   
-4. Set your _(beta, if applicable)_ account username and the password you just chose for API access. You can either set the environment variables `ICONTACT_MODE`, `ICONTACT_USERNAME`, and `ICONTACT_PASSWORD`, or you can explicitly do it with calls to the Config module:  
+4. Set your _(sandbox, if applicable)_ account username and the password you just chose for API access. You can either set the environment variables `ICONTACT_MODE`, `ICONTACT_USERNAME`, and `ICONTACT_PASSWORD`, or you can explicitly do it with calls to the Config module:  
 
         require 'rubygems'
         require 'acts_as_icontact'
     
-        ActsAsIcontact::Config.mode = :beta
-        ActsAsIcontact::Config.username = my_beta_username
+        ActsAsIcontact::Config.mode = :sandbox
+        ActsAsIcontact::Config.username = my_sandbox_username
         ActsAsIcontact::Config.password = my_api_password  
   
     If you're using Rails, the recommended approach is to require the gem with `config.gem 'acts_as_icontact'` in your **config/environment.rb** file, and then set up an initializer (i.e. **config/initializers/acts\_as\_icontact.rb**) with the above code.  See more about Rails below.
 
-5. Rinse and repeat with production credentials when you're ready to move out of the beta environment.  
+5. Rinse and repeat with production credentials when you're ready to move out of the sandbox environment.  
 
 API Access
 ----------
@@ -120,20 +120,20 @@ Rails Integration
 The _real_ power of ActsAsIcontact is its automatic syncing with ActiveRecord.  At this time this feature is focused entirely on Contacts.  
 
 ### Activation
-First add the line `config.gem 'acts_as_icontact'` to your **config/environment.rb** file.  Then create an initializer (e.g. **config/initializers/acts\_as\_icontact.rb**) and set it up with your username and password.  If applicable, you can give it both the beta _and_ production credentials:
+First add the line `config.gem 'acts_as_icontact'` to your **config/environment.rb** file.  Then create an initializer (e.g. **config/initializers/acts\_as\_icontact.rb**) and set it up with your username and password.  If applicable, you can give it both the sandbox _and_ production credentials:
 
     module ActsAsIcontact
       case Config.mode
-			when :beta
-        Config.username = my_beta_username
-        Config.password = my_beta_password
+			when :sandbox
+        Config.username = my_sandbox_username
+        Config.password = my_sandbox_password
       when :production
         Config.username = my_production_username
         Config.password = my_production_password
       end
     end
 
-If ActsAsIcontact detects that it's running in a Rails app, the default behavior is to set the mode to `:production` if RAILS\_ENV is equal to "production" and `:beta` if RAILS\_ENV is set to anything else.  (Incidentally, if you're _not_ in a Rails app but running Rack, the same logic applies for the RACK\_ENV environment variable.)
+If ActsAsIcontact detects that it's running in a Rails app, the default behavior is to set the mode to `:production` if RAILS\_ENV is equal to "production" and `:sandbox` if RAILS\_ENV is set to anything else.  (Incidentally, if you're _not_ in a Rails app but running Rack, the same logic applies for the RACK\_ENV environment variable.)
 
 Finally, enable one of your models to synchronize with iContact with a simple declaration:
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.5

data/acts_as_icontact.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.1.1"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2009-07-24}
+  s.date = %q{2009-07-25}
   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
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
      "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/list.rb",
+     "lib/acts_as_icontact/resources/message.rb",
      "spec/config_spec.rb",
      "spec/connection_spec.rb",
      "spec/resource_collection_spec.rb",
@@ -40,6 +42,8 @@ Gem::Specification.new do |s|
      "spec/resources/account_spec.rb",
      "spec/resources/client_spec.rb",
      "spec/resources/contact_spec.rb",
+     "spec/resources/list_spec.rb",
+     "spec/resources/message_spec.rb",
      "spec/spec.opts",
      "spec/spec_fakeweb.rb",
      "spec/spec_helper.rb"
@@ -58,6 +62,8 @@ Gem::Specification.new do |s|
      "spec/resources/account_spec.rb",
      "spec/resources/client_spec.rb",
      "spec/resources/contact_spec.rb",
+     "spec/resources/list_spec.rb",
+     "spec/resources/message_spec.rb",
      "spec/spec_fakeweb.rb",
      "spec/spec_helper.rb"
   ]

data/lib/acts_as_icontact/config.rb

@@ -3,15 +3,15 @@ module ActsAsIcontact
   # required by the iContact API for authentication.
   module Config
     
-    # Sets :production or :beta.  This changes the AppId and URL.
+    # Sets :production or :sandbox.  This changes the AppId and URL.
     def self.mode=(val)
       @mode = val
     end
     
-    # Determines whether to return the beta or production AppId and URL.  
+    # Determines whether to return the sandbox or production AppId and URL.  
     # If not explicitly set, it will first look for an ICONTACT_MODE environment variable.
     # If it doesn't find one, it will attempt to detect a Rails or Rack environment; in either
-    # case it will default to :production if RAILS_ENV or RACK_ENV is 'production', and :beta
+    # case it will default to :production if RAILS_ENV or RACK_ENV is 'production', and :sandbox
     # otherwise.  If none of these conditions apply, it assumes :production.  (Because that
     # probably means someone's doing ad hoc queries.)
     def self.mode
@@ -19,9 +19,9 @@ module ActsAsIcontact
       when ENV["ICONTACT_MODE"] 
         ENV["ICONTACT_MODE"].to_sym
       when Object.const_defined?(:Rails)
-        (ENV["RAILS_ENV"] == 'production' ? :production : :beta)
+        (ENV["RAILS_ENV"] == 'production' ? :production : :sandbox)
       when Object.const_defined?(:Rack)
-        (ENV["RACK_ENV"] == 'production' ? :production : :beta)
+        (ENV["RACK_ENV"] == 'production' ? :production : :sandbox)
       else
         :production
       end
@@ -32,7 +32,7 @@ module ActsAsIcontact
     # to change this.  Ever.
     def self.app_id
       case mode
-      when :beta
+      when :beta, :sandbox
         "Ml5SnuFhnoOsuZeTOuZQnLUHTbzeUyhx" 
       when :production
         "IYDOhgaZGUKNjih3hl1ItLln7zpAtWN2"
@@ -45,14 +45,16 @@ module ActsAsIcontact
     end
     
     # Prefixed to the beginning of every API request.  You can override this if you have some special 
-    # need (e.g. working against a testing server, or if iContact takes their API out of beta and 
-    # changes the URI before the gem gets updated), but for the most part you can leave it alone.
+    # need (e.g. working against a testing server, or if iContact changes their URL and you have to
+    # fix it before the gem gets updated), but for the most part you can leave it alone.
     def self.url
       @url ||= case mode
-      when :beta
-        "https://app.beta.icontact.com/icp/"
       when :production
         "https://app.icontact.com/icp/"
+      when :sandbox
+        "https://app.sandbox.icontact.com/icp/"
+      when :beta  # The 'beta' environment still works as of 7/25/2009
+        "https://app.beta.icontact.com/icp/"
       end
     end
     

data/lib/acts_as_icontact/exceptions.rb

@@ -2,6 +2,12 @@ module ActsAsIcontact
   # Thrown when a configuration value isn't provided or is invalid.
   class ConfigError < StandardError; end
   
+  # Thrown when a bad parameter is passed to a resource find.
+  class QueryError < StandardError; end
+  
+  # Thrown before saving if iContact validation rules are not met.
+  class ValidationError < StandardError; end
+  
   # Thrown when a resource calls save! and fails. Contains the +.errors+ array from
   # the resource.
   class RecordNotSaved < StandardError

data/lib/acts_as_icontact/resource.rb

@@ -8,11 +8,10 @@ module ActsAsIcontact
     
     # Creates a new resource object from a values hash.  (Which is passed to us via the magic of JSON.)
     def initialize(properties={})
-      @properties = properties
+      @properties = clean_properties(properties)
       @new_record = !@properties.has_key?(self.class.primary_key)
       # Initialize other useful attributes
       @errors = []
-      
     end
     
     # Returns the primary key ID for an existing resource.  Returns nil if the resource is a new record.
@@ -33,10 +32,14 @@ module ActsAsIcontact
       if property =~ /(.*)=$/  # It's a value assignment
         @newvalues ||= []
         @newvalues << $1
-        @properties[$1] = params[0]
-      else
+        @properties[$1] = clean_value(params[0])
+       else
         if @properties.has_key?(property)
-          @properties[property]
+          if self.class.boolean_fields.include?(property)
+            (@properties[property] == 1)
+          else
+            @properties[property]
+          end
         else
           super
         end
@@ -56,12 +59,15 @@ module ActsAsIcontact
     # error, raises an exception with it.
     def save
       if new_record?
+        fields = create_fields
+        validate_on_create(fields)
         result_type = self.class.collection_name
-        payload = {self.class.collection_name => [create_fields]}
-        response = self.class.connection.post(payload.to_json)
+        response = self.class.connection.post([fields].to_json)
       else
+        fields = update_fields
+        validate_on_update(fields)
         result_type = self.class.resource_name
-        response = connection.post(update_fields.to_json)
+        response = connection.post(fields.to_json)
       end
       parsed = JSON.parse(response)
       if parsed[result_type].empty?
@@ -98,25 +104,46 @@ module ActsAsIcontact
     
     # Returns an array of resources starting at the base.
     def self.find(type, options={})
-      uri_extension = uri_component + build_query(options)
-      response = base[uri_extension].get
-      parsed = JSON.parse(response)
       case type
-      when :first then
-        self.new(parsed[collection_name].first) if parsed[collection_name]
-      when :all then
-        ResourceCollection.new(self, parsed)
+      when :first
+        first(options)
+      when :all
+        all(options)
+      when Integer
+        find_by_id(type)
+      else
+        raise ActsAsIcontact::QueryError, "Don't know how to find '#{type.to_s}'"
       end
     end
     
     # Returns an array of resources starting at the base.
-    def self.all
-      find(:all)
+    def self.all(options={})
+      query_options = default_options.merge(options)
+      validate_options(query_options)
+      result = query_collection(query_options)
+      ResourceCollection.new(self, result)
     end
     
     # Returns the first account associated with this username.
-    def self.first
-      find(:first)
+    def self.first(options={})
+      query_options = default_options.merge(options).merge(:limit => 1) # Minor optimization
+      validate_options(query_options)
+      result = query_collection(query_options)
+      self.new(result[collection_name].first)
+    end
+    
+    # Returns the single resource at the URL identified by the passed integer.  Takes no options; this is 
+    # not a search, this is a single record retrieval.  Raises an exception if the record can't be found.
+    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]
+      self.new(parsed[resource_name])
+    end
+    
+    # Two resources are identical if they have exactly the same property array.
+    def ==(obj)
+      properties == obj.properties
     end
     
     protected
@@ -139,10 +166,10 @@ module ActsAsIcontact
       @properties
     end
     
-    # The base RestClient resource that this particular class nests from.  Starts with 
-    # the resource connection at 'https://api.icontact.com/icp/' and works its way up.
+    # The base RestClient resource that this particular class nests from.  Defaults to 
+    # the clientFolders path since that's the most common case.
     def self.base
-      ActsAsIcontact.connection
+      ActsAsIcontact.client
     end
     
     # The name of the singular resource type pulled from iContact.  Defaults to the lowercase
@@ -174,6 +201,11 @@ module ActsAsIcontact
       resource_name + "Id"
     end
     
+    # Options that are always passed on 'find' requests unless overridden.
+    def self.default_options
+      {:limit => 500}
+    end
+      
     # Fields that _must_ be included for this resource upon creation.
     def self.required_on_create
       []
@@ -194,11 +226,86 @@ module ActsAsIcontact
       []
     end
     
+    # Fields that operate as 0/1 boolean toggles.  Can be assigned to with true and false.
+    def self.boolean_fields
+      []
+    end
+    
+    # Validation rules that ensure proper parameters are passed to iContact on querying.
+    def self.validate_options(options)
+      # See: http://developer.icontact.com/forums/api-beta-moderated-support/there-upper-limit-result-sets#comment-136
+      raise ActsAsIcontact::QueryError, "Limit must be between 1 and 500" if options[:limit].to_i < 1 or options[:limit].to_i > 500 
+    end
+    
+    # Validation rules that ensure proper data is passed to iContact on resource creation.
+    def validate_on_create(fields)
+      check_required_fields(fields, self.class.required_on_create)
+      validate_on_save(fields)
+    end
+
+    # Validation rules that ensure proper data is passed to iContact on resource update.
+    def validate_on_update(fields)
+      check_required_fields(fields, self.class.required_on_update)
+      validate_on_save(fields)
+    end
+    
+    # Validation rules that apply to both creates and updates.  The method on the abstract Resource class is just a placeholder;
+    # this is intended to be used by resource subclasses.
+    def validate_on_save(fields)
+    end
+    
+    # Finesses the properties hash passed in to make iContact and Ruby idioms compatible.  
+    # Turns symbol keys into strings and runs the clean_value method on values.
+    # Subclasses may add additional conversions.
+    def clean_properties(properties)
+      newhash = {}
+      properties.each_pair do |key, value|
+        newhash[key.to_s] = clean_value(value)
+      end
+      newhash
+    end
+    
+    # Finesses values passed in to properties to make iContact and Ruby idioms compatible.
+    # Turns symbols into strings, numbers into integers or floats, true/false into 1 and 0,
+    # and empty strings into nil. Subclasses may add additional conversions.
+    def clean_value(value)
+      case value
+      when Symbol then value.to_s
+      when TrueClass then 1
+      when FalseClass then 0
+      when /^\d+$/ then value.to_i  # Integer
+      when /^\d+(\.\d+)?([eE]\d+)?$/ then value.to_f  # Float
+      when blank? then nil
+      else value
+      end 
+    end
+    
+    # The properties array, for comparison against other resources or debugging.
+    def properties
+      @properties
+    end
+    
     private
     def self.build_query(options={})
       return "" if options.empty?
       terms = options.collect{|k,v| "#{k}=#{URI.escape(v.to_s)}"}
       build = "?" + terms.join('&')
     end
+    
+    def self.query_collection(options={})
+      uri_extension = uri_component + build_query(options)
+      response = base[uri_extension].get
+      parsed = JSON.parse(response)
+      parsed
+    end
+    
+    def check_required_fields(fields, required)
+      # Check that all required fields are filled in
+      missing = required.select{|f| fields[f].blank?}
+      unless missing.empty?
+        missing_fields = missing.join(', ')
+        raise ActsAsIcontact::ValidationError, "Missing required fields: #{missing_fields}"
+      end
+    end
   end
 end

data/lib/acts_as_icontact/resources/account.rb

@@ -2,6 +2,11 @@ module ActsAsIcontact
   # The top-level Accounts resource from iContact.  Currently only supports retrieval -- and is 
   # highly targeted toward the _first_ account, since that seems to be the dominant use case.
   class Account < Resource
+    # This is the one major resource that comes directly from the main path.
+    def self.base
+      ActsAsIcontact.connection
+    end
+    
     def self.uri_component
       'a'
     end
@@ -15,7 +20,7 @@ module ActsAsIcontact
   # The accountId retrieved from iContact.  Can also be set manually for performance optimization,
   # but remembers it so that it won't be pulled more than once anyway.
   def self.account_id
-    @account_id ||= Account.first.accountId.to_i
+    @account_id ||= Account.first.id.to_i
   end
   
   # Manually sets the accountId used in subsequent calls.  Setting this in your initializer will save

data/lib/acts_as_icontact/resources/client.rb

@@ -2,6 +2,11 @@ module ActsAsIcontact
   # The nested Client Folder resource from iContact.  Currently only supports retrieval -- and is 
   # highly targeted toward the _first_ client folder, since that seems to be the dominant use case.
   class Client < Resource
+    # Derives from the Account resource.
+    def self.base
+      ActsAsIcontact.account
+    end
+    
     def self.resource_name
       'clientfolder'
     end

data/lib/acts_as_icontact/resources/contact.rb

@@ -1,7 +1,20 @@
 module ActsAsIcontact
   class Contact < Resource
+    
+    # Email is required
     def self.required_on_create
-      ['email']
+      super << ['email']
     end
+    
+    # Derived from clientFolder
+    def self.base
+      ActsAsIcontact.client
+    end
+    
+    # Defaults to status=total to return contacts on or off lists
+    def self.default_options
+      super.merge(:status=>:total)
+    end
+    
   end
 end

data/lib/acts_as_icontact/resources/list.rb

@@ -0,0 +1,24 @@
+module ActsAsIcontact
+  class List < Resource
+    # Derives from clientFolder.
+    def self.base
+      ActsAsIcontact.client
+    end
+    
+    # Requires name, emailOwnerOnChange, welcomeOnManualAdd, welcomeOnSignupAdd, and welcomeMessageId.
+    def self.required_on_create
+      super << "name" << "emailOwnerOnChange" << "welcomeOnManualAdd" << "welcomeOnSignupAdd" << "welcomeMessageId"
+    end
+    
+    def self.boolean_fields
+      super << "emailOwnerOnChange" << "welcomeOnManualAdd" << "welcomeOnSignupAdd"
+    end
+    
+    # The welcome message pointed to by the welcomeMessageId.
+    def welcomeMessage
+      return nil unless welcomeMessageId
+      ActsAsIcontact::Message.find(welcomeMessageId)
+    end
+    
+  end
+end

data/lib/acts_as_icontact/resources/message.rb

@@ -0,0 +1,19 @@
+module ActsAsIcontact
+  class Message < Resource
+    # Has a default messageType of "normal" if another isn't passed as an option.
+    def initialize(properties={})
+      super({:messageType => "normal"}.merge(properties))
+    end
+    
+    # Requires messageType and subject
+    def self.required_on_create
+      super << "messageType" << "subject"
+    end
+    
+    # messageType must be one of four values: normal, autoresponder, welcome, or confirmation
+    def validate_on_save(fields)
+      messageType = %w(normal autoresponder welcome confirmation)
+      raise ActsAsIcontact::ValidationError, "messageType must be one of: " + messageType.join(', ') unless messageType.include?(fields["messageType"])
+    end
+  end
+end

data/spec/config_spec.rb

@@ -41,9 +41,9 @@ describe "Configuration" do
         Object.expects(:const_defined?).with(:Rails).returns(true)
       end
       
-      it "is beta if RAILS_ENV is not production" do
+      it "is sandbox if RAILS_ENV is not production" do
         ENV["RAILS_ENV"] = 'staging'
-        ActsAsIcontact::Config.mode.should == :beta
+        ActsAsIcontact::Config.mode.should == :sandbox
       end
       
       it "is production if RAILS_ENV is production" do
@@ -65,9 +65,9 @@ describe "Configuration" do
         Object.expects(:const_defined?).with(:Rack).returns(true)
       end
       
-      it "is beta if RACK_ENV is not production" do
+      it "is sandbox if RACK_ENV is not production" do
         ENV["RACK_ENV"] = 'staging'
-        ActsAsIcontact::Config.mode.should == :beta
+        ActsAsIcontact::Config.mode.should == :sandbox
       end
       
       it "is production if RACK_ENV is production" do
@@ -81,17 +81,17 @@ describe "Configuration" do
     end
 
     
-    context ":beta" do
+    context ":sandbox" do
       before(:each) do
-        ActsAsIcontact::Config.mode = :beta        
+        ActsAsIcontact::Config.mode = :sandbox        
       end
       
-      it "returns the beta AppId" do
+      it "returns the sandbox AppId" do
         ActsAsIcontact::Config.app_id.should == "Ml5SnuFhnoOsuZeTOuZQnLUHTbzeUyhx"
       end
     
-      it "returns the beta URL" do
-        ActsAsIcontact::Config.url.should == "https://app.beta.icontact.com/icp/"
+      it "returns the sandbox URL" do
+        ActsAsIcontact::Config.url.should == "https://app.sandbox.icontact.com/icp/"
       end
       
     end

data/spec/resource_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe ActsAsIcontact::Resource do
   it "has a RestClient connection" do
-    ActsAsIcontact::Resource.connection.url.should == ActsAsIcontact.connection['resources'].url
+    ActsAsIcontact::Resource.connection.url.should == ActsAsIcontact.client['resources'].url
   end
   
   it "can return all resources for the given URL" do
@@ -51,6 +51,35 @@ describe ActsAsIcontact::Resource do
       r.first.foo.should == "kar"
       r[1].foo.should == "yar"
     end
+    
+    it "defaults to a limit of 500" do
+      ActsAsIcontact::Resource.base.expects(:[]).with(regexp_matches(/limit=500/)).returns(stub(:get => '{"resources":[]}'))
+      r = ActsAsIcontact::Resource.find(:all)
+    end
+    
+    it "throws an exception if a limit higher than 500 is attempted" do
+      lambda{r = ActsAsIcontact::Resource.find(:all, :limit => 501)}.should raise_error(ActsAsIcontact::QueryError, "Limit must be between 1 and 500")
+    end
+
+    it "throws an exception if a limit lower than 500 is attempted" do
+      lambda{r = ActsAsIcontact::Resource.find(:all, :limit => 501)}.should raise_error(ActsAsIcontact::QueryError, "Limit must be between 1 and 500")
+    end
+    
+    it "maps the 'first' method to find(:first)" do
+      ActsAsIcontact::Resource.expects(:first).with({:foo=>:bar}).returns(nil)
+      ActsAsIcontact::Resource.find(:first, :foo=>:bar)
+    end
+      
+    it "maps the 'all' method to find(:all)" do
+      ActsAsIcontact::Resource.expects(:all).with({:foo=>:bar}).returns(nil)
+      ActsAsIcontact::Resource.find(:all, :foo=>:bar)
+    end
+    
+    it "can find a single resource by ID" do
+      a = ActsAsIcontact::Resource.find(1)
+      a.too.should == "sar"
+    end 
+    
   end
   
   it "knows its properties" do
@@ -70,7 +99,7 @@ describe ActsAsIcontact::Resource do
   
   it "has its own connection if it's not new" do
     r = ActsAsIcontact::Resource.first
-    r.connection.url.should == ActsAsIcontact.connection['resources/1'].url
+    r.connection.url.should == ActsAsIcontact.client['resources/1'].url
   end
   
   it "does not have a connection if it's new" do
@@ -79,7 +108,7 @@ describe ActsAsIcontact::Resource do
   end
   
   it "knows its REST base resource" do
-    ActsAsIcontact::Resource.base.should == ActsAsIcontact.connection
+    ActsAsIcontact::Resource.base.should == ActsAsIcontact.client
   end
   
   it "knows its primary key" do
@@ -94,6 +123,16 @@ describe ActsAsIcontact::Resource do
     ActsAsIcontact::Resource.never_on_create.should == ["resourceId"]
   end
   
+  it "accepts symbols for properties on creation" do
+    a = ActsAsIcontact::Resource.new(:foofoo => "bunny")    
+    a.foofoo.should == "bunny"
+  end
+  
+  it "typecasts all integer property values if it can" do
+    a = ActsAsIcontact::Resource.new("indianaPi" => "3")
+    a.indianaPi.should == 3
+  end
+  
   context "updating records" do
     before(:each) do
       @res = ActsAsIcontact::Resource.first
@@ -114,7 +153,12 @@ describe ActsAsIcontact::Resource do
     
     it "knows the minimum set of properties that changed or must be sent" do
       @res.too = "tar"
-      @res.send(:update_fields).should == {"resourceId" => "1", "too" => "tar"}
+      @res.send(:update_fields).should == {"resourceId" => 1, "too" => "tar"}
+    end
+    
+    it "throws an exception if required fields aren't included" do
+      @res.resourceId = nil
+      lambda{@res.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: resourceId")
     end
     
     context "with successful save" do
@@ -219,7 +263,7 @@ describe ActsAsIcontact::Resource do
     
     context "with successful save" do
       before(:each) do
-        FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources", :body => %q<{"resources":[{"resourceId":"100","foo":"flar","kroo":"krar","too":"sar"}]}>)
+        FakeWeb.register_uri(:post, "https://app.sandbox.icontact.com/icp/a/111111/c/222222/resources", :body => %q<{"resources":[{"resourceId":"100","foo":"flar","kroo":"krar","too":"sar"}]}>)
         @res.too = "sar"
       end
       
@@ -249,7 +293,7 @@ describe ActsAsIcontact::Resource do
 
     context "with failed save but status 200" do
       before(:each) do
-        FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources", :body => %q<{"resources":[],"warnings":["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]}>)
+        FakeWeb.register_uri(:post, "https://app.sandbox.icontact.com/icp/a/111111/c/222222/resources", :body => %q<{"resources":[],"warnings":["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]}>)
         @res = ActsAsIcontact::Resource.new
         @res.foo = nil
         @result = @res.save
@@ -274,7 +318,7 @@ describe ActsAsIcontact::Resource do
     
     context "with failed save on HTTP failure exception" do
       before(:each) do
-        FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources", :status => ["400","Bad Request"], :body => %q<{"errors":["You did not provide a clue. Clue is a required field. Please provide a clue"]}>)
+        FakeWeb.register_uri(:post, "https://app.sandbox.icontact.com/icp/a/111111/c/222222/resources", :status => ["400","Bad Request"], :body => %q<{"errors":["You did not provide a clue. Clue is a required field. Please provide a clue"]}>)
         @res = ActsAsIcontact::Resource.new
         @res.foo = nil
         @result = @res.save

data/spec/resources/contact_spec.rb

@@ -1,8 +1,25 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ActsAsIcontact::Contact do
-  it "defaults to a limit of 500"
-  it "defaults to searching on all contacts regardless of list status"
-  it "throws an exception if a limit higher than 500 is attempted"
   
+  it "defaults to searching on all contacts regardless of list status" do
+    ActsAsIcontact::Contact.base.expects(:[]).with(regexp_matches(/status=total/)).returns(stub(:get => '{"contacts":[]}'))
+    r = ActsAsIcontact::Contact.find(:all)
+  end
+  
+  it "requires email address" do
+    c = ActsAsIcontact::Contact.new
+    lambda{c.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: email")
+  end
+  
+  context "associations" do
+    # We have _one_ really good contact set up here
+    before(:each) do
+      @john = ActsAsIcontact::Contact.first(:firstName => "John", :lastName => "Test")
+    end
+  
+    it "knows which lists it's subscribed to"
+    it "knows its history"
+  end
+    
 end

data/spec/resources/list_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact::List do
+  it "requires name, emailOwnerOnChange, welcomeOnManualAdd, welcomeOnSignupAdd, welcomeMessageId" do
+    l = ActsAsIcontact::List.new
+    lambda{l.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: name, emailOwnerOnChange, welcomeOnManualAdd, welcomeOnSignupAdd, welcomeMessageId")
+  end
+  
+  it "uses true and false to assign boolean fields" do
+    l = ActsAsIcontact::List.new
+    l.emailOwnerOnChange = true
+    l.welcomeOnSignupAdd = false
+    l.instance_variable_get(:@properties)["emailOwnerOnChange"].should == 1
+    l.instance_variable_get(:@properties)["welcomeOnSignupAdd"].should == 0
+  end
+
+  it "uses true and false to retrieve boolean fields" do
+    l = ActsAsIcontact::List.new
+    l.instance_variable_set(:@properties,{"welcomeOnManualAdd" => 1, "emailOwnerOnChange" => 0})
+    l.emailOwnerOnChange.should be_false
+    l.welcomeOnManualAdd.should be_true
+  end
+  
+  context "associations" do
+    # Create one good list
+    before(:each) do
+      @list = ActsAsIcontact::List.first(:name => "First Test")
+    end
+    it "knows its subscribers"
+    
+    it "knows its welcome message" do
+      @list.welcomeMessage.should == ActsAsIcontact::Message.find(555555)
+    end
+  end
+end

data/spec/resources/message_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact::Message do
+    
+  it "defaults messageType to normal" do
+    m = ActsAsIcontact::Message.new
+    m.messageType.should == "normal"
+  end
+    
+  it "requires messageType and subject" do
+    m = ActsAsIcontact::Message.new(:messageType => nil)
+    lambda{m.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: messageType, subject")
+  end
+  
+  it "must have an acceptable messageType" do
+    m = ActsAsIcontact::Message.new(:messageType => "dummy", :subject => "test")
+    lambda{m.save}.should raise_error(ActsAsIcontact::ValidationError, "messageType must be one of: normal, autoresponder, welcome, confirmation")
+  end
+  
+  context "associations" do
+    before(:each) do
+      @message = ActsAsIcontact::Message.first(:subject => "Test Message")
+    end
+  
+    it "knows which campaign it has (if any)"
+  end
+    
+end

data/spec/spec_fakeweb.rb

@@ -2,22 +2,41 @@ require 'rubygems'
 require 'fakeweb'
 
 FakeWeb.allow_net_connect = false
+i = "https://app.sandbox.icontact.com/icp"
+ic = "#{i}/a/111111/c/222222"
 
 # Resources (this one's a fake stub for pure testing)
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/resources", :body => %q<{"resources":[{"foo":"bar","resourceId":"1","too":"bar"},{"foo":"aar","resourceId":"2"},{"foo":"far","resourceId":"3"},{"foo":"car","resourceId":"4"},{"foo":"dar","resourceId":"5"},{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"},{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":20,"offset":0}>)
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/resources?limit=5", :body => %q<{"resources":[{"foo":"bar","resourceId":"1"},{"foo":"aar","resourceId":"2"},{"foo":"far","resourceId":"3"},{"foo":"car","resourceId":"4"},{"foo":"dar","resourceId":"5"}],"total":12,"limit":5,"offset":0}>)
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/resources?offset=5", :body => %q<{"resources":[{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"},{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":20,"offset":5}>)
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/resources?offset=5&limit=5", :body => %q<{"resources":[{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"}],"total":12,"limit":5,"offset":5}>)
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/resources?offset=10&limit=5", :body => %q<{"resources":[{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":5,"offset":10}>)
-FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources/1", :body => %q<{"resource":{"foo":"bar","resourceId":"1","too":"sar"}}>)
-FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources/2", :body => %q<{"resource":{},"warnings":["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]}>)
-FakeWeb.register_uri(:post, "https://app.beta.icontact.com/icp/resources/3", :status => ["400","Bad Request"], :body => %q<{"errors":["You did not provide a clue. Clue is a required field. Please provide a clue"]}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?limit=500", :body => %q<{"resources":[{"foo":"bar","resourceId":"1","too":"bar"},{"foo":"aar","resourceId":"2"},{"foo":"far","resourceId":"3"},{"foo":"car","resourceId":"4"},{"foo":"dar","resourceId":"5"},{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"},{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":20,"offset":0}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?limit=1", :body => %q<{"resources":[{"foo":"bar","resourceId":"1","too":"bar"},{"foo":"aar","resourceId":"2"},{"foo":"far","resourceId":"3"},{"foo":"car","resourceId":"4"},{"foo":"dar","resourceId":"5"},{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"},{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":20,"offset":0}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?limit=5", :body => %q<{"resources":[{"foo":"bar","resourceId":"1"},{"foo":"aar","resourceId":"2"},{"foo":"far","resourceId":"3"},{"foo":"car","resourceId":"4"},{"foo":"dar","resourceId":"5"}],"total":12,"limit":5,"offset":0}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?limit=500&offset=5", :body => %q<{"resources":[{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"},{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":20,"offset":5}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?offset=5&limit=5", :body => %q<{"resources":[{"foo":"ear","resourceId":"6"},{"foo":"gar","resourceId":"7"},{"foo":"har","resourceId":"8"},{"foo":"iar","resourceId":"9"},{"foo":"jar","resourceId":"10"}],"total":12,"limit":5,"offset":5}>)
+FakeWeb.register_uri(:get, "#{ic}/resources?offset=10&limit=5", :body => %q<{"resources":[{"foo":"kar","resourceId":"11"},{"foo":"yar","resourceId":"12"}],"total":12,"limit":5,"offset":10}>)
+FakeWeb.register_uri(:get, "#{ic}/resources/1", :body => %q<{"resource":{"foo":"bar","resourceId":"1","too":"sar"}}>)
+FakeWeb.register_uri(:post, "#{ic}/resources/1", :body => %q<{"resource":{"foo":"bar","resourceId":"1","too":"sar"}}>)
+FakeWeb.register_uri(:post, "#{ic}/resources/2", :body => %q<{"resource":{},"warnings":["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]}>)
+FakeWeb.register_uri(:post, "#{ic}/resources/3", :status => ["400","Bad Request"], :body => %q<{"errors":["You did not provide a clue. Clue is a required field. Please provide a clue"]}>)
 
 # Time
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/time", :body => %q<{"time":"2009-07-13T01:28:18-04:00","timestamp":1247462898}>)
+FakeWeb.register_uri(:get, "#{i}/time", :body => %q<{"time":"2009-07-13T01:28:18-04:00","timestamp":1247462898}>)
 
 # Accounts
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/a", :body => %q<{"accounts":[{"billingStreet":"","billingCity":"","billingState":"","billingPostalCode":"","billingCountry":"","city":"Testville","accountId":"111111","companyName":"","country":"United States","email":"bob@example.org","enabled":1,"fax":"","firstName":"Bob","lastName":"Tester","multiClientFolder":"0","multiUser":"0","phone":"","postalCode":"12345","state":"TN","street":"123 Test Street","title":"","accountType":"0","subscriberLimit":"250000"}],"total":1,"limit":20,"offset":0}>)
+FakeWeb.register_uri(:get, "#{i}/a?limit=1", :body => %q<{"accounts":[{"billingStreet":"","billingCity":"","billingState":"","billingPostalCode":"","billingCountry":"","city":"Testville","accountId":"111111","companyName":"","country":"United States","email":"bob@example.org","enabled":1,"fax":"","firstName":"Bob","lastName":"Tester","multiClientFolder":"0","multiUser":"0","phone":"","postalCode":"12345","state":"TN","street":"123 Test Street","title":"","accountType":"0","subscriberLimit":"250000"}],"total":1,"limit":20,"offset":0}>)
+FakeWeb.register_uri(:get, "#{i}/a?limit=500", :body => %q<{"accounts":[{"billingStreet":"","billingCity":"","billingState":"","billingPostalCode":"","billingCountry":"","city":"Testville","accountId":"111111","companyName":"","country":"United States","email":"bob@example.org","enabled":1,"fax":"","firstName":"Bob","lastName":"Tester","multiClientFolder":"0","multiUser":"0","phone":"","postalCode":"12345","state":"TN","street":"123 Test Street","title":"","accountType":"0","subscriberLimit":"250000"}],"total":1,"limit":20,"offset":0}>)
 
 # Clients
-FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/a/111111/c", :body => %q<{"clientfolders":[{"clientFolderId":"222222","logoId":null,"emailRecipient":"bob@example.org"}],"total":1}>)
+FakeWeb.register_uri(:get, "#{i}/a/111111/c?limit=1", :body => %q<{"clientfolders":[{"clientFolderId":"222222","logoId":null,"emailRecipient":"bob@example.org"}],"total":1}>)
+FakeWeb.register_uri(:get, "#{i}/a/111111/c?limit=500", :body => %q<{"clientfolders":[{"clientFolderId":"222222","logoId":null,"emailRecipient":"bob@example.org"}],"total":1}>)
+
+# 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"}]}>)
+
+#  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."}]}>)
+
+# Message
+#### Test message for List association
+FakeWeb.register_uri(:get, "#{ic}/messages/555555", :body => %q<{"message":{"messageId":"555555","subject":"Welcome!","messageType":"welcome","textBody":"Welcome to the Test List!","htmlBody":"<p>Welcome to the <b>Test List</b>!</p>","createDate":"20090725 14:55:12"}}>)
+
+#### 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"}]}>)

data/spec/spec_helper.rb

@@ -14,5 +14,5 @@ Spec::Runner.configure do |config|
   config.mock_with :mocha
   
   # Set up some reasonable testing variables
-  ActsAsIcontact::Config.mode = :beta
+  ActsAsIcontact::Config.mode = :sandbox
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors: 
 - Stephen Eley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-24 00:00:00 -04:00
+date: 2009-07-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,8 @@ files:
 - 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/list.rb
+- lib/acts_as_icontact/resources/message.rb
 - spec/config_spec.rb
 - spec/connection_spec.rb
 - spec/resource_collection_spec.rb
@@ -50,6 +52,8 @@ files:
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/list_spec.rb
+- spec/resources/message_spec.rb
 - spec/spec.opts
 - spec/spec_fakeweb.rb
 - spec/spec_helper.rb
@@ -89,5 +93,7 @@ test_files:
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/list_spec.rb
+- spec/resources/message_spec.rb
 - spec/spec_fakeweb.rb
 - spec/spec_helper.rb