SFEley-acts_as_icontact 0.1.1

data/spec/resource_spec.rb

@@ -0,0 +1,301 @@
+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
+  end
+  
+  it "can return all resources for the given URL" do
+    ActsAsIcontact::Resource.all.count.should == 12
+  end
+
+  it "can return the first resource" do
+    ActsAsIcontact::Resource.first.should be_a_kind_of(ActsAsIcontact::Resource)
+  end
+  
+  describe "find method" do
+    it "returns a ResourceCollection when given :all" do
+      r = ActsAsIcontact::Resource.find(:all)
+      r.should be_a_kind_of(ActsAsIcontact::ResourceCollection)
+    end
+    
+    it "returns a Resource when given :first" do
+      r = ActsAsIcontact::Resource.find(:first)
+      r.should be_a_kind_of(ActsAsIcontact::Resource)
+    end
+    
+    it "understands the :limit option" do
+      r = ActsAsIcontact::Resource.find(:all, :limit => 5)
+      r.first.foo.should == "bar"
+      r[4].foo.should == "dar"
+      r.count.should == 5
+    end
+    
+    it "understands the :offset option" do
+      r = ActsAsIcontact::Resource.find(:all, :offset => 5)
+      r.count.should == 7
+      r.first.foo.should == "ear"
+      r[6].foo.should == "yar"
+    end
+    
+    it "understands multiple options together (:limit and :offset)" do
+      r = ActsAsIcontact::Resource.find(:all, :offset => 5, :limit => 5)
+      r.first.foo.should == "ear"
+      r[4].foo.should == "jar"
+      r.count.should == 5
+    end
+    
+    it "returns fewer than the limit if it hits the end of the collection" do
+      r = ActsAsIcontact::Resource.find(:all, :offset => 10, :limit => 5)
+      r.count.should == 2
+      r.first.foo.should == "kar"
+      r[1].foo.should == "yar"
+    end
+  end
+  
+  it "knows its properties" do
+    r = ActsAsIcontact::Resource.first
+    r.foo.should == "bar"
+  end
+  
+  it "knows its id if it's not new" do
+    r = ActsAsIcontact::Resource.first
+    r.id.should == 1
+  end
+  
+  it "does not have an id if it's new" do
+    r = ActsAsIcontact::Resource.new("foo" => "bar")
+    r.id.should be_nil
+  end
+  
+  it "has its own connection if it's not new" do
+    r = ActsAsIcontact::Resource.first
+    r.connection.url.should == ActsAsIcontact.connection['resources/1'].url
+  end
+  
+  it "does not have a connection if it's new" do
+    r = ActsAsIcontact::Resource.new("foo" => "bar")
+    r.connection.should be_nil
+  end
+  
+  it "knows its REST base resource" do
+    ActsAsIcontact::Resource.base.should == ActsAsIcontact.connection
+  end
+  
+  it "knows its primary key" do
+    ActsAsIcontact::Resource.primary_key.should == "resourceId"
+  end
+  
+  it "knows that the primary key is required on update" do
+    ActsAsIcontact::Resource.required_on_update.should == ["resourceId"]
+  end
+  
+  it "knows that the primary key MUST NOT be included on create" do
+    ActsAsIcontact::Resource.never_on_create.should == ["resourceId"]
+  end
+  
+  context "updating records" do
+    before(:each) do
+      @res = ActsAsIcontact::Resource.first
+    end
+    it "knows it isn't a new record" do
+      @res.should_not be_a_new_record
+    end
+    
+    it "can set new values on existing fields" do
+      @res.foo = "zar"
+      @res.foo.should == "zar"
+    end
+  
+    it "can add new fields" do
+      @res.zoo = "flar"
+      @res.zoo.should == "flar"
+    end
+    
+    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"}
+    end
+    
+    context "with successful save" do
+      before(:each) do
+        @res.too = "sar"
+        @result = @res.save
+      end
+      
+      it "returns success" do
+        @result.should be_true
+      end
+      
+      it "updates itself with the new values" do
+        @res.too.should == "sar"
+      end
+      
+      it "has no errors" do
+        @res.errors.should be_empty
+      end
+      
+      it "has no error" do
+        @res.error.should be_nil
+      end
+      
+      it "can be called with a bang" do
+        @res.save!.should be_true
+      end
+    end
+
+    context "with failed save but status 200" do
+      before(:each) do
+        @bad = ActsAsIcontact::Resource.all[1]
+        @bad.foo = nil
+        @result = @bad.save
+      end
+      
+      it "returns failure" do
+        @result.should be_false
+      end
+      
+      it "returns the errors list" do
+        @bad.errors.should == ["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]
+      end
+      
+      it "returns the top error" do
+        @bad.error.should == "You did not provide a foo. foo is a required field. Please provide a foo"
+      end
+        
+      it "throws an exception with a bang" do
+        lambda{@bad.save!}.should raise_error(ActsAsIcontact::RecordNotSaved,"You did not provide a foo. foo is a required field. Please provide a foo")
+      end
+    end
+    
+    context "with failed save on HTTP failure exception" do
+      before(:each) do
+        @bad = ActsAsIcontact::Resource.all[2]
+        @bad.foo = nil
+        @result = @bad.save
+      end
+      
+      it "returns failure" do
+        @result.should be_false
+      end
+      
+      it "returns the errors list" do
+        @bad.errors.should == ["You did not provide a clue. Clue is a required field. Please provide a clue"]
+      end
+      
+      it "returns the top error" do
+        @bad.error.should == "You did not provide a clue. Clue is a required field. Please provide a clue"
+      end
+        
+      it "throws an exception with a bang" do
+        lambda{@bad.save!}.should raise_error(ActsAsIcontact::RecordNotSaved,"You did not provide a clue. Clue is a required field. Please provide a clue")
+      end
+    end
+    
+  end
+  
+  context "creating records" do
+    before(:each) do
+      @res = ActsAsIcontact::Resource.new("foo" => "flar", "kroo" => "krar")
+    end
+    it "knows it's a new record" do
+      @res.should be_a_new_record
+    end
+    
+    it "can set new values on existing fields" do
+      @res.foo = "zar"
+      @res.foo.should == "zar"
+    end
+  
+    it "can add new fields" do
+      @res.zoo = "flar"
+      @res.zoo.should == "flar"
+    end
+    
+    it "knows the full set of properties that were added or are required" do
+      ActsAsIcontact::Resource.stubs(:required_on_create).returns(["shoo"])
+      @res.send(:create_fields).should == {"foo" => "flar", "kroo" => "krar", "shoo" => ""}
+    end
+    
+    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"}]}>)
+        @res.too = "sar"
+      end
+      
+      it "returns success" do
+        @res.save.should be_true
+      end
+      
+      it "updates itself with the new values" do
+        @res.save
+        @res.too.should == "sar"
+      end
+      
+      it "has no errors" do
+        @res.save
+        @res.errors.should be_empty
+      end
+      
+      it "has no error" do
+        @res.save
+        @res.error.should be_nil
+      end
+      
+      it "can be called with a bang" do
+        @res.save!.should be_true
+      end
+    end
+
+    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"]}>)
+        @res = ActsAsIcontact::Resource.new
+        @res.foo = nil
+        @result = @res.save
+      end
+      
+      it "returns failure" do
+        @result.should be_false
+      end
+      
+      it "returns the errors list" do
+        @res.errors.should == ["You did not provide a foo. foo is a required field. Please provide a foo","This was not a good record"]
+      end
+      
+      it "returns the top error" do
+        @res.error.should == "You did not provide a foo. foo is a required field. Please provide a foo"
+      end
+        
+      it "throws an exception with a bang" do
+        lambda{@res.save!}.should raise_error(ActsAsIcontact::RecordNotSaved,"You did not provide a foo. foo is a required field. Please provide a foo")
+      end
+    end
+    
+    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"]}>)
+        @res = ActsAsIcontact::Resource.new
+        @res.foo = nil
+        @result = @res.save
+      end
+      
+      it "returns failure" do
+        @result.should be_false
+      end
+      
+      it "returns the errors list" do
+        @res.errors.should == ["You did not provide a clue. Clue is a required field. Please provide a clue"]
+      end
+      
+      it "returns the top error" do
+        @res.error.should == "You did not provide a clue. Clue is a required field. Please provide a clue"
+      end
+        
+      it "throws an exception with a bang" do
+        lambda{@res.save!}.should raise_error(ActsAsIcontact::RecordNotSaved,"You did not provide a clue. Clue is a required field. Please provide a clue")
+      end
+    end
+    
+  end
+end

data/spec/resources/account_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact, "account_id" do
+  it "returns the ID from the first account returned by iContact" do
+    ActsAsIcontact.account_id.should == 111111
+  end
+  
+  it "can be set by the user" do
+    ActsAsIcontact.account_id = 345
+    ActsAsIcontact.account_id.should == 345
+  end
+  
+  after(:each) do
+    ActsAsIcontact.account_id = nil
+  end
+end
+
+
+describe ActsAsIcontact, "account method" do
+  it "returns a RestClient resource" do
+    ActsAsIcontact.account.should be_a_kind_of(RestClient::Resource)
+  end
+  
+  it "builds upon the 'connection' object" do
+    ActsAsIcontact.expects(:connection).returns(ActsAsIcontact.instance_variable_get(:@connection))
+    ActsAsIcontact.account.should_not be_nil
+  end
+  
+  it "can be cleared with the reset_account! method" do
+    ActsAsIcontact.reset_account!
+    ActsAsIcontact.instance_variable_get(:@account).should be_nil
+  end
+  
+  after(:each) do
+    ActsAsIcontact.reset_account!
+  end
+end
+
+describe ActsAsIcontact::Account do    
+  it "can return all accounts" do
+    ActsAsIcontact::Account.all.count.should == 1
+  end
+  
+  it "can return the first account" do
+    ActsAsIcontact::Account.first.should be_a_kind_of(ActsAsIcontact::Account)
+  end
+    
+  it "knows its attributes" do
+    a = ActsAsIcontact::Account.first
+    a.firstName.should == "Bob"
+  end
+end

data/spec/resources/client_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact, "account_id" do
+  it "returns the ID from the first client folder returned by iContact" do
+    ActsAsIcontact.client_id.should == 222222
+  end
+  
+  it "can be set by the user" do
+    ActsAsIcontact.client_id = 456
+    ActsAsIcontact.client_id.should == 456
+  end
+  
+  after(:each) do
+    ActsAsIcontact.client_id = nil
+  end
+end
+
+
+describe ActsAsIcontact, "client method" do
+  it "returns a RestClient resource" do
+    ActsAsIcontact.client.should be_a_kind_of(RestClient::Resource)
+  end
+  
+  it "builds upon the 'account' object" do
+    ActsAsIcontact.expects(:account).returns(ActsAsIcontact.instance_variable_get(:@account))
+    ActsAsIcontact.client.should_not be_nil
+  end
+  
+  it "can be cleared with the reset_account! method" do
+    ActsAsIcontact.reset_client!
+    ActsAsIcontact.instance_variable_get(:@client).should be_nil
+  end
+  
+  after(:each) do
+    ActsAsIcontact.reset_client!
+  end
+end
+
+describe ActsAsIcontact::Client do
+  it "can return all clients for the given account" do
+    ActsAsIcontact::Client.all.count.should == 1
+  end
+  
+  it "can return the first client" do
+    ActsAsIcontact::Client.first.should be_a_kind_of(ActsAsIcontact::Client)
+  end
+    
+  it "knows its properties" do
+    c = ActsAsIcontact::Client.first
+    c.emailRecipient.should == "bob@example.org"
+  end
+end

data/spec/resources/contact_spec.rb

@@ -0,0 +1,8 @@
+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"
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_fakeweb.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+# 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"]}>)
+
+# Time
+FakeWeb.register_uri(:get, "https://app.beta.icontact.com/icp/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}>)
+
+# 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}>)

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_icontact'
+
+require 'spec_fakeweb'
+
+Spec::Runner.configure do |config|
+  # config.after(:each) do
+  #   # Make sure we don't run afoul of iContact's rate limiting
+  #   sleep 1
+  # end
+  config.mock_with :mocha
+  
+  # Set up some reasonable testing variables
+  ActsAsIcontact::Config.mode = :beta
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: SFEley-acts_as_icontact
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Stephen Eley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-24 00:00:00 -07:00
+default_executable: 
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- acts_as_icontact.gemspec
+- 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/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
+- spec/config_spec.rb
+- spec/connection_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/spec.opts
+- spec/spec_fakeweb.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/SFEley/acts_as_icontact
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: actsasicontact
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Automatic bridge between iContact e-mail marketing service and Rails ActiveRecord
+test_files: 
+- spec/config_spec.rb
+- spec/connection_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/spec_fakeweb.rb
+- spec/spec_helper.rb