SFEley-acts_as_icontact 0.1.3 → 0.1.4

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/acts_as_icontact.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
@@ -33,6 +33,7 @@ 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",
      "spec/config_spec.rb",
      "spec/connection_spec.rb",
      "spec/resource_collection_spec.rb",
@@ -40,6 +41,7 @@ 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/spec.opts",
      "spec/spec_fakeweb.rb",
      "spec/spec_helper.rb"
@@ -58,6 +60,7 @@ 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/spec_fakeweb.rb",
      "spec/spec_helper.rb"
   ]

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

@@ -33,10 +33,18 @@ module ActsAsIcontact
       if property =~ /(.*)=$/  # It's a value assignment
         @newvalues ||= []
         @newvalues << $1
-        @properties[$1] = params[0]
+        if self.class.boolean_fields.include?($1)
+          @properties[$1] = params[0] ? 1 : 0
+        else
+          @properties[$1] = params[0]
+        end
       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,11 +64,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
-        response = self.class.connection.post([create_fields].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?
@@ -97,7 +109,10 @@ module ActsAsIcontact
     
     # Returns an array of resources starting at the base.
     def self.find(type, options={})
-      uri_extension = uri_component + build_query(options)
+      query_options = default_options.merge(options)
+      query_options.merge(:limit => 1) if type == :first  # Minor optimization
+      validate_options(query_options)
+      uri_extension = uri_component + build_query(query_options)
       response = base[uri_extension].get
       parsed = JSON.parse(response)
       case type
@@ -109,13 +124,13 @@ module ActsAsIcontact
     end
     
     # Returns an array of resources starting at the base.
-    def self.all
-      find(:all)
+    def self.all(options={})
+      find(:all, options)
     end
     
     # Returns the first account associated with this username.
-    def self.first
-      find(:first)
+    def self.first(options={})
+      find(:first, options)
     end
     
     protected
@@ -173,6 +188,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
       []
@@ -193,11 +213,41 @@ 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)
+    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)
+    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 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/contact.rb

@@ -1,11 +1,19 @@
 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
+      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,17 @@
+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
+  end
+end

data/spec/resource_spec.rb

@@ -51,6 +51,30 @@ 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(:find).with(:first,{:foo=>:bar}).returns(nil)
+      ActsAsIcontact::Resource.first(:foo=>:bar)
+    end
+      
+    it "maps the 'all' method to find(:all)" do
+      ActsAsIcontact::Resource.expects(:find).with(:all,{:foo=>:bar}).returns(nil)
+      ActsAsIcontact::Resource.all(:foo=>:bar)
+    end
+    
   end
   
   it "knows its properties" do
@@ -94,6 +118,7 @@ describe ActsAsIcontact::Resource do
     ActsAsIcontact::Resource.never_on_create.should == ["resourceId"]
   end
   
+    
   context "updating records" do
     before(:each) do
       @res = ActsAsIcontact::Resource.first
@@ -117,6 +142,11 @@ describe ActsAsIcontact::Resource do
       @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
       before(:each) do
         @res.too = "sar"

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,32 @@
+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"
+  end
+end

data/spec/spec_fakeweb.rb

@@ -2,22 +2,31 @@ require 'rubygems'
 require 'fakeweb'
 
 FakeWeb.allow_net_connect = false
+i = "https://app.beta.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, "#{i}/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, "#{i}/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, "#{i}/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, "#{i}/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, "#{i}/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, "#{i}/resources/1", :body => %q<{"resource":{"foo":"bar","resourceId":"1","too":"sar"}}>)
+FakeWeb.register_uri(:post, "#{i}/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, "#{i}/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=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=500", :body => %q<{"clientfolders":[{"clientFolderId":"222222","logoId":null,"emailRecipient":"bob@example.org"}],"total":1}>)
+
+# Contacts
+FakeWeb.register_uri(:get, "#{ic}/contacts?limit=500&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=500&name=First%20Test", :body => %q<{"lists":[{"listId":"444444","name":"First Test","emailOwnerOnChange":"0","welcomeOnManualAdd":"0","welcomeOnSignupAdd":"0","welcomeMessageId":"555555","description":"Just a test list."}]}>)
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: SFEley-acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Stephen Eley
@@ -38,6 +38,7 @@ 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
 - spec/config_spec.rb
 - spec/connection_spec.rb
 - spec/resource_collection_spec.rb
@@ -45,6 +46,7 @@ files:
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/list_spec.rb
 - spec/spec.opts
 - spec/spec_fakeweb.rb
 - spec/spec_helper.rb
@@ -82,5 +84,6 @@ test_files:
 - spec/resources/account_spec.rb
 - spec/resources/client_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/list_spec.rb
 - spec/spec_fakeweb.rb
 - spec/spec_helper.rb