SFEley-acts_as_icontact 0.2.1 → 0.2.3

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.3

data/acts_as_icontact.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.2.1"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
@@ -44,6 +44,7 @@ Gem::Specification.new do |s|
      "lib/acts_as_icontact/resources/custom_field.rb",
      "lib/acts_as_icontact/resources/list.rb",
      "lib/acts_as_icontact/resources/message.rb",
+     "lib/acts_as_icontact/resources/subscription.rb",
      "rails/init.rb",
      "spec/config_spec.rb",
      "spec/connection_spec.rb",
@@ -59,6 +60,7 @@ Gem::Specification.new do |s|
      "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
+     "spec/resources/subscription_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/support/active_record/connection_adapters/nulldb_adapter.rb",
@@ -86,6 +88,7 @@ Gem::Specification.new do |s|
      "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
+     "spec/resources/subscription_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/active_record/connection_adapters/nulldb_adapter.rb",
      "spec/support/nulldb_rspec.rb",

data/lib/acts_as_icontact/resource.rb

@@ -266,7 +266,7 @@ module ActsAsIcontact
     # 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)
+    def clean_properties(properties={})
       newhash = {}
       properties.each_pair do |key, value|
         newhash[key.to_s] = clean_value(value)

data/lib/acts_as_icontact/resource_collection.rb

@@ -1,17 +1,20 @@
 module ActsAsIcontact
   class ResourceCollection < Enumerator
-    attr_reader :total
+    attr_reader :total, :retrieved
     
-    def initialize(klass, collection)
+    def initialize(klass, collection, forwardTo=nil)
       @klass = klass
+      @forwardTo = forwardTo
+      
       @collection = collection[klass.collection_name]
       # Get number of elements
-      @total = @collection.size
+      @retrieved = @collection.size
+      @total = collection["total"]
       
       enumcode = Proc.new do |yielder|
         counter = 0
-        while counter < @total
-          yielder.yield klass.new(@collection[counter])
+        while counter < @retrieved
+          yielder.yield resource(@collection[counter])
           counter += 1
         end
       end
@@ -20,8 +23,23 @@ module ActsAsIcontact
     end
     
     def [](index)
-      @klass.new(@collection[index]) if @collection[index]
+      resource(@collection[index]) if @collection[index]
+    end
+    
+    # Calls "next" to kick off the enumerator.  This is more in line with what users would expect.
+    def first
+      self.rewind
+      self.next
     end
     
+    private 
+    def resource(properties)
+      if @forwardTo
+        id = @forwardTo.primary_key
+        @forwardTo.find(properties[id])
+      else
+        @klass.new(properties)
+      end
+    end
   end
 end

data/lib/acts_as_icontact/resources/contact.rb

@@ -15,6 +15,11 @@ module ActsAsIcontact
     def self.default_options
       super.merge(:status=>:total)
     end
+   
+    # Returns the lists to which this contact is subscribed (via the Subscription class).
+    def lists
+      @lists ||= ActsAsIcontact::Subscription.lists(:contactId => id)
+    end
     
   end
 end

data/lib/acts_as_icontact/resources/list.rb

@@ -25,5 +25,10 @@ module ActsAsIcontact
       ActsAsIcontact::Message.find(welcomeMessageId)
     end
     
+    # Returns the contacts subscribed to this list (via the Subscription class).
+    def subscribers
+      @subscribers ||= ActsAsIcontact::Subscription.contacts(:listId => id)
+    end
+    
   end
 end

data/lib/acts_as_icontact/resources/subscription.rb

@@ -0,0 +1,75 @@
+module ActsAsIcontact
+  
+  # Subscriptions are effectively a "has_many :through" mapping between Contacts and Lists.  They are implemented
+  # that way, with a .lists property on Contact and a .subscribers property on List that both work through the 
+  # Subscription class.
+  class Subscription < Resource
+    
+    STATUSES = %w(normal pending unsubscribed)
+    
+    # Defaults status to "normal"
+    def initialize(properties = {})
+      super({:status => "normal"}.merge(properties))
+    end
+    
+    # Searches on the compound primary key ("listid_contactid").  
+    def self.find_by_string(value)
+      find_by_id(value)
+    end
+          
+    # Requires listId, contactId, and status when creating a record
+    def self.required_on_create
+      super + %w(listId contactId status)
+    end
+    
+    # Never send listId or contactId on update
+    def self.never_on_update
+      super + %w(listId contactId)
+    end
+    
+    
+    # Overrides "all" to pass an optional forwardTo parameter to ResourceCollection.  This instructs ResourceCollection
+    # to look up and create a new object of the given type, rather than the base resource.  (This is how the #lists and 
+    # #contacts methods are implemented.)
+    def self.all(options={}, forwardTo = nil)
+      query_options = default_options.merge(options)
+      validate_options(query_options)
+      result = query_collection(query_options)
+      ResourceCollection.new(self, result, forwardTo)
+    end
+    
+    # Returns a collection of all contacts matching the query.  Unfortunately, this has to be performed by looking up
+    # each one individually.  We forward the Contact class to ResourceCollection to do that work.
+    def self.contacts(options={})
+      all(options, ActsAsIcontact::Contact)
+    end
+
+    # Returns a collection of all lists matching the query.  Unfortunately, this has to be performed by looking up
+    # each one individually.  We forward the List class to ResourceCollection to do that work.
+    def self.lists(options={})
+      all(options, ActsAsIcontact::List)
+    end
+    
+    # status must be one of: normal, pending, unsubscribed
+    def validate_on_save(fields)
+      raise ActsAsIcontact::ValidationError, "Status must be one of: #{STATUSES.join(', ')}" unless STATUSES.include?(fields["status"])
+    end
+    
+    # The list that this subscription is associated with.
+    def list
+      ActsAsIcontact::List.find(listId) if properties["listId"]
+    end
+    
+    # The contact that this subscription is associated with.
+    def contact
+      ActsAsIcontact::Contact.find(contactId) if properties["contactId"]
+    end
+    
+    # The confirmation message for this subscription, if any.
+    def confirmationMessage
+      ActsAsIcontact::Message.find(confirmationMessageId) if properties["confirmationMessageId"]
+    end
+      
+  end
+  
+end

data/spec/resource_collection_spec.rb

@@ -20,4 +20,8 @@ describe ActsAsIcontact::ResourceCollection do
     @this[1].yoo.should == "yar"
   end
     
+  it "treats 'first' as an initial call of 'next'" do
+    @this.first.foo.should == "bar"
+    @this.next.yoo.should == "yar"
+  end
 end

data/spec/resources/contact_spec.rb

@@ -18,7 +18,10 @@ describe ActsAsIcontact::Contact do
       @john = ActsAsIcontact::Contact.first(:firstName => "John", :lastName => "Test")
     end
   
-    it "knows which lists it's subscribed to"
+    it "knows which lists it's subscribed to" do
+      @john.lists.first.should == ActsAsIcontact::List.find(444444)
+    end
+    
     it "knows its history"
   end
     

data/spec/resources/list_spec.rb

@@ -31,7 +31,11 @@ describe ActsAsIcontact::List do
     before(:each) do
       @list = ActsAsIcontact::List.first(:name => "First Test")
     end
-    it "knows its subscribers"
+    
+    it "knows its subscribers" do
+      @list.subscribers.first.should == ActsAsIcontact::Contact.find(333444)
+      @list.subscribers.next.should == ActsAsIcontact::Contact.find(333333)
+    end
     
     it "knows its welcome message" do
       @list.welcomeMessage.should == ActsAsIcontact::Message.find(555555)

data/spec/resources/subscription_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact::Subscription do
+
+  it "requires listId, contactId, status on create" do
+    s = ActsAsIcontact::Subscription.new(:status => nil)
+    lambda{s.save}.should raise_error(ActsAsIcontact::ValidationError, "Missing required fields: listId, contactId, status")
+  end
+  
+  it "validates that status is in (pending, normal, unsubscribed)" do
+    s = ActsAsIcontact::Subscription.new(:status => "foo", :listId => 1, :contactId => 2)
+    lambda{s.save}.should raise_error(ActsAsIcontact::ValidationError, "Status must be one of: normal, pending, unsubscribed")
+  end
+  
+  it "sets status to normal by default" do
+    s = ActsAsIcontact::Subscription.new
+    s.status.should == "normal"
+  end
+  
+  it "can find by the compound primary key" do
+    s = ActsAsIcontact::Subscription.find("444444_333333")
+    s.listId.should == 444444
+    s.contactId.should == 333333
+  end
+  
+  it "can return the contacts for a query as a collection" do
+    collection = ActsAsIcontact::Subscription.contacts(:listId => 444444)
+    collection.first.should == ActsAsIcontact::Contact.find(333444)
+    collection.next.should == ActsAsIcontact::Contact.find(333333)
+  end
+
+  it "can return the lists for a query as a collection" do
+    collection = ActsAsIcontact::Subscription.lists(:contactId => 333444)
+    collection.first.should == ActsAsIcontact::List.find(444444)
+  end
+  
+  context "associations" do
+    # Create one good subscription
+    before(:each) do
+      @sub = ActsAsIcontact::Subscription.first(:contactId => 333444)
+    end
+
+    it "knows its contact" do
+      @sub.contact.should == ActsAsIcontact::Contact.find(333444)
+    end
+
+    it "knows its list" do
+      @sub.list.should == ActsAsIcontact::List.find(444444)
+    end
+
+    it "knows its confirmation message" do
+      @sub.confirmationMessage.should == ActsAsIcontact::Message.find(555666)
+    end
+
+  end
+
+end

data/spec/support/spec_fakeweb.rb

@@ -30,14 +30,19 @@ 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":""}]}>)
+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":""},{"email":"john@example.org","firstName":"John","lastName":"Test","status":"normal","contactId":"333333","createDate":"2009-07-24 01:00:00"}]}>)
+FakeWeb.register_uri(:get, "#{ic}/contacts/333444", :body => %q<{"contact":{"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":""}}>)
+FakeWeb.register_uri(:get, "#{ic}/contacts/333333", :body => %q<{"contact":{"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."}]}>)
+FakeWeb.register_uri(:get, "#{ic}/lists/444444", :body => %q<{"list":{"listId":"444444","name":"First Test","emailOwnerOnChange":"0","welcomeOnManualAdd":"0","welcomeOnSignupAdd":"0","welcomeMessageId":"555555","description":"Just a test list."}}>)
 
 # Message
-#### Test message for List association
+#### Test welcome 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 confirmation message
+FakeWeb.register_uri(:get, "#{ic}/messages/555666", :body => %q<{"message":{"messageId":"555666","subject":"Confirm!","messageType":"confirmation","textBody":"Please confirm your subscription.","htmlBody":"<p>Please confirm your subscription.</p>","createDate":"20090727 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"}]}>)
@@ -45,3 +50,13 @@ FakeWeb.register_uri(:get, "#{ic}/messages?limit=1&subject=Test%20Message", :bod
 # 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"}}>)
+
+# Subscription
+FakeWeb.register_uri(:get, "#{ic}/subscriptions/444444_333333", :body => %q<{"subscription":{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333333,"listId":444444, "subscriptionId":"444444_333333"}}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions/444444_333444", :body => %q<{"subscription":{"status":"normal","addDate":"2009-07-27T15:37:38-04:00","contactId":333444,"listId":444444, "subscriptionId":"444444_333444"}}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions?limit=500", :body => %q<{"subscriptions":[{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333333,"listId":444444, "subscriptionId":"444444_333333"},{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333333,"listId":444444, "subscriptionId":"444444_333333"}],"total":2}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions?limit=500&listId=444444", :body => %q<{"subscriptions":[{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333444,"listId":444444, "subscriptionId":"444444_333444","confirmationMessageId":555666},{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333333,"listId":444444, "subscriptionId":"444444_333333"}],"total":1}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions?limit=1&contactId=333444", :body => %q<{"subscriptions":[{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333444,"listId":444444, "subscriptionId":"444444_333333","confirmationMessageId":555666}]}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions?limit=500&contactId=333444", :body => %q<{"subscriptions":[{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333444,"listId":444444, "subscriptionId":"444444_333444","confirmationMessageId":555666}]}>)
+FakeWeb.register_uri(:get, "#{ic}/subscriptions?limit=500&contactId=333333", :body => %q<{"subscriptions":[{"status":"normal","addDate":"2009-07-27T15:36:37-04:00","contactId":333333,"listId":444444, "subscriptionId":"444444_333333","confirmationMessageId":555666}]}>)
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: SFEley-acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors: 
 - Stephen Eley
@@ -47,6 +47,7 @@ files:
 - lib/acts_as_icontact/resources/custom_field.rb
 - lib/acts_as_icontact/resources/list.rb
 - lib/acts_as_icontact/resources/message.rb
+- lib/acts_as_icontact/resources/subscription.rb
 - rails/init.rb
 - spec/config_spec.rb
 - spec/connection_spec.rb
@@ -62,6 +63,7 @@ files:
 - spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
+- spec/resources/subscription_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/active_record/connection_adapters/nulldb_adapter.rb
@@ -109,6 +111,7 @@ test_files:
 - spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
+- spec/resources/subscription_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record/connection_adapters/nulldb_adapter.rb
 - spec/support/nulldb_rspec.rb