SFEley-acts_as_icontact 0.3.2 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/acts_as_icontact.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2009-08-08}
+  s.date = %q{2009-08-10}
   s.default_executable = %q{icontact}
   s.description = %q{ActsAsIcontact connects Ruby applications with the iContact e-mail marketing service using the iContact API v2.0.  Building on the RestClient gem, it offers two significant feature sets:
 
@@ -32,6 +32,8 @@ Gem::Specification.new do |s|
      "bin/icontact",
      "init.rb",
      "lib/acts_as_icontact.rb",
+     "lib/acts_as_icontact/command_line/completion.rb",
+     "lib/acts_as_icontact/command_line/variables.rb",
      "lib/acts_as_icontact/config.rb",
      "lib/acts_as_icontact/connection.rb",
      "lib/acts_as_icontact/exceptions.rb",
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
      "lib/acts_as_icontact/resources/campaign.rb",
      "lib/acts_as_icontact/resources/client.rb",
      "lib/acts_as_icontact/resources/contact.rb",
+     "lib/acts_as_icontact/resources/contact_history.rb",
      "lib/acts_as_icontact/resources/custom_field.rb",
      "lib/acts_as_icontact/resources/list.rb",
      "lib/acts_as_icontact/resources/message.rb",
@@ -62,6 +65,7 @@ Gem::Specification.new do |s|
      "spec/resources/account_spec.rb",
      "spec/resources/campaign_spec.rb",
      "spec/resources/clientfolder_spec.rb",
+     "spec/resources/contact_history_spec.rb",
      "spec/resources/contact_spec.rb",
      "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",
@@ -91,6 +95,7 @@ Gem::Specification.new do |s|
      "spec/resources/account_spec.rb",
      "spec/resources/campaign_spec.rb",
      "spec/resources/clientfolder_spec.rb",
+     "spec/resources/contact_history_spec.rb",
      "spec/resources/contact_spec.rb",
      "spec/resources/custom_field_spec.rb",
      "spec/resources/list_spec.rb",

data/bin/icontact

@@ -1,19 +1,30 @@
 #!/usr/bin/env ruby
 
 $:.unshift File.dirname(__FILE__) + "/../lib"
-require 'acts_as_icontact'
 require 'rubygems'
+require 'acts_as_icontact'
 require 'readline'
-require 'bond'
-require 'bond/completion'
+require 'acts_as_icontact/command_line/completion'
+require 'acts_as_icontact/command_line/variables'
 
 module ActsAsIcontact
+
   # Lifted from: http://tagaholic.me/2009/07/23/mini-irb-and-mini-script-console.html
   history_file = File.join(ENV["HOME"], '.icontact_history')
   IO.readlines(history_file).each {|e| Readline::HISTORY << e.chomp } if File.exists?(history_file)
-  print "# ActsAsIcontact command line (type 'exit' to quit)\n"
-  while (input = Readline.readline("\n>> ", true)) != 'exit'
-    begin puts "=> #{eval(input).inspect}"; rescue Exception; puts "Error: #{$!}" end
+  print "# ActsAsIcontact command line (type 'quit' or 'exit' to quit)\n"
+  loop do
+    case input = Readline.readline("\n>> ", true)
+    when /^(exit|quit)$/
+      break
+    when /^[a-z][\w\d_]*\s*=/  # Keep local variable assignments from becoming black holes
+      input = "self." + input
+    end
+    begin 
+      puts "=> #{eval(input).inspect}"
+    rescue Exception
+      puts "Error: #{$!}" 
+    end
   end
   File.open(history_file, 'w') {|f| f.write Readline::HISTORY.to_a.join("\n") }
   

data/lib/acts_as_icontact.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rest_client'
-require 'json'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'acts_as_icontact/exceptions'

data/lib/acts_as_icontact/command_line/completion.rb

@@ -0,0 +1,50 @@
+require 'bond'
+
+module Bond
+      
+  module Actions
+    # ActsAsIcontact resource classes
+    def icontact_classes(input)
+      ActsAsIcontact::Resource.subclasses.map{|c| c.sub(/ActsAsIcontact\:\:/,'')}
+    end
+    
+    
+    # ActsAsIcontact resource properties
+    def icontact_properties(input)
+      receiver = ActsAsIcontact.instance_eval(input.matched[1])
+      if receiver.respond_to?(:property_names)
+        (receiver.property_names + receiver.methods - Object.methods).sort
+      else
+        (receiver.methods - Object.methods).sort
+      end
+    end
+    
+  end
+  debrief(:eval_binding => binding)
+  debrief(:default_search => :ignore_case)
+  debrief(:default_mission => :icontact_classes)
+  
+end
+
+# Complete ActsAsIcontact resources
+Bond.complete(:on=>/([A-Z][^.\s]*)+$/, :action=>:icontact_classes)
+
+# ActsAsIcontact resource class methods
+Bond.complete(:on=>/([A-Z][^.\s]*)\.([^.\s]*)$/, :search => false) do |input|  
+  receiver = ActsAsIcontact.const_get(input.matched[1].to_sym)
+  methods = (receiver.methods - Class.methods).sort
+  methods.grep(/^#{input.matched[2]}/i).collect{|m| "#{input.matched[1]}.#{m}"}
+end
+  
+
+# ActsAsIcontact resource properties
+Bond.complete(:on=>/([^.\s]+)\.([^.\s]*)$/, :search => false) do |input|
+  receiver = ActsAsIcontact.instance_eval(input.matched[1])
+  if receiver.respond_to?(:property_names)
+    methods = (receiver.property_names + receiver.methods - Object.methods).sort
+  else
+    methods = (receiver.methods - Object.methods).sort
+  end
+  methods.grep(/^#{input.matched[2]}/i).collect{|m| "#{input.matched[1]}.#{m}"}  
+end
+

data/lib/acts_as_icontact/command_line/variables.rb

@@ -0,0 +1,16 @@
+module ActsAsIcontact
+  
+  # Allows local variables to be set in the command line client.  :nodoc:
+  def self.method_missing(method, *params)
+    @variables ||= {}
+    variable = method.to_s
+    if variable =~ /(.*)=$/  # It's a variable assignment
+      @variables[variable.sub(/=$/,'')] = params[0]
+      @variables
+    else
+      @variables[variable]
+    end
+  end
+  
+end
+  

data/lib/acts_as_icontact/exceptions.rb

@@ -8,9 +8,12 @@ module ActsAsIcontact
   # Thrown before saving if iContact validation rules are not met.
   class ValidationError < StandardError; end
   
+  # Thrown by attempts to save a read-only resource.
+  class ReadOnlyError < StandardError; end
+  
   # Thrown when a resource calls save! and fails. Contains the +.errors+ array from
   # the resource.
-  class RecordNotSaved < StandardError
+  class SaveError < StandardError
     attr_reader :errors
     
     def initialize(errors = [])

data/lib/acts_as_icontact/resource.rb

@@ -1,6 +1,5 @@
 require 'activesupport'
 require 'uri'
-require 'YAML'
 
 module ActsAsIcontact
   # Base class for shared functionality between iContact resources.  Supports getting, finding, saving,
@@ -87,10 +86,10 @@ module ActsAsIcontact
       false
     end
     
-    # Like +save+, but raises an ActsAsIcontact::RecordNotSaved exception if the save
+    # Like +save+, but raises an ActsAsIcontact::SaveError exception if the save
     # failed.  The exception message contains the first error from iContact.
     def save!
-      save or raise ActsAsIcontact::RecordNotSaved.new(errors)
+      save or raise ActsAsIcontact::SaveError.new(errors)
     end
     
     # The first message from the +errors+ array.
@@ -156,6 +155,11 @@ module ActsAsIcontact
       properties.to_yaml
     end
     
+    # An array of all defined property keys for this resource.
+    def property_names
+      properties.symbolize_keys.keys
+    end
+    
     protected
     # The minimum set of fields that must be sent back to iContact on an update.
     # Includes any fields that changed or were added, the primary key, and anything

data/lib/acts_as_icontact/resource_collection.rb

@@ -2,9 +2,10 @@ module ActsAsIcontact
   class ResourceCollection < Enumerator
     attr_reader :total, :retrieved, :offset, :collection_name
     
-    def initialize(klass, collection, forwardTo=nil)
+    def initialize(klass, collection, options={})
       @klass = klass
-      @forwardTo = forwardTo
+      @forwardTo = options.delete(:forwardTo)
+      @parent = options.delete(:parent)
       
       @collection_name = klass.collection_name
       @collection = collection[collection_name]
@@ -48,6 +49,10 @@ module ActsAsIcontact
     
     private 
     def resource(properties)
+      # If this is a subresource, include the parent object as a property
+      properties.merge!(:parent => @parent) if @parent
+      
+      # "Forward to" is used to link Contacts and Lists via Subscriptions in a has_many :through
       if @forwardTo
         id = @forwardTo.primary_key
         @forwardTo.find(properties[id])

data/lib/acts_as_icontact/resources/contact.rb

@@ -23,5 +23,9 @@ module ActsAsIcontact
       s.save
     end
     
+    # Returns a collection of ContactHistory resources for this contact.  The usual iContact search options (limit, offset, search terms, etc.) can be passed.
+    def history(options={})
+      ActsAsIcontact::ContactHistory.scoped_find(self, options)
+    end
   end
 end

data/lib/acts_as_icontact/resources/contact_history.rb

@@ -0,0 +1,57 @@
+module ActsAsIcontact
+  # The read-only list of actions attached to every Contact.  Because of this intrinsic association, the usual #find methods don't
+  # work; contact history _must_ be obtained using the individual contact's #history method.  
+  # Property updates and saving are also prohibited (returning a ReadOnlyError exception.)
+  class ContactHistory < Resource
+    attr_reader :parent
+    alias_method :contact, :parent
+    
+    # Should only be called by ResourceCollection.  Raises an exception if a parent object is not passed.
+    def initialize(properties={})
+      @parent = properties.delete(:parent) or raise ActsAsIcontact::ValidationError, "Contact History requires a Contact" 
+      super
+    end
+    
+    # Properties of this class are read-only.
+    def method_missing(method, *params)
+      raise ActsAsIcontact::ReadOnlyError, "Contact History is read-only!" if method.to_s =~ /(.*)=$/ 
+      super
+    end
+    
+    
+    # Returns the ContactHistory collection for the passed contact.  Takes the usual iContact search parameters.
+    def self.scoped_find(parent, options = {})
+      query_options = default_options.merge(options)
+      validate_options(query_options)
+      uri_extension = uri_component + build_query(query_options)
+      response = parent.connection[uri_extension].get
+      parsed = JSON.parse(response)
+      ResourceCollection.new(self, parsed, :parent => parent)
+    end
+  
+
+    class <<self
+      # Replace all search methods with an exception
+      def cannot_query(*arguments)
+        raise ActsAsIcontact::QueryError, "Contact History must be obtained using the contact.history method."
+      end
+      alias_method :all, :cannot_query
+      alias_method :first, :cannot_query
+      alias_method :find, :cannot_query
+    end
+    
+    # Replace save methods with an exception
+    def cannot_save(*arguments)
+      raise ActsAsIcontact::ReadOnlyError, "Contact History is read-only!"
+    end
+    alias_method :save, :cannot_save
+    alias_method :save!, :cannot_save
+    
+  protected
+    # An oddball resource class; iContact's URL for it is 'actions', not 'contact_histories'.
+    def self.resource_name
+      'action'
+    end
+    
+  end
+end

data/lib/acts_as_icontact/resources/subscription.rb

@@ -35,7 +35,7 @@ module ActsAsIcontact
       query_options = default_options.merge(options)
       validate_options(query_options)
       result = query_collection(query_options)
-      ResourceCollection.new(self, result, forwardTo)
+      ResourceCollection.new(self, result, :forwardTo => forwardTo)
     end
     
     # Returns a collection of all contacts matching the query.  Unfortunately, this has to be performed by looking up

data/spec/resource_spec.rb

@@ -220,7 +220,7 @@ describe ActsAsIcontact::Resource do
       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")
+        lambda{@bad.save!}.should raise_error(ActsAsIcontact::SaveError,"You did not provide a foo. foo is a required field. Please provide a foo")
       end
     end
     
@@ -244,7 +244,7 @@ describe ActsAsIcontact::Resource do
       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")
+        lambda{@bad.save!}.should raise_error(ActsAsIcontact::SaveError,"You did not provide a clue. Clue is a required field. Please provide a clue")
       end
     end
     
@@ -324,7 +324,7 @@ describe ActsAsIcontact::Resource do
       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")
+        lambda{@res.save!}.should raise_error(ActsAsIcontact::SaveError,"You did not provide a foo. foo is a required field. Please provide a foo")
       end
     end
     
@@ -349,7 +349,7 @@ describe ActsAsIcontact::Resource do
       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")
+        lambda{@res.save!}.should raise_error(ActsAsIcontact::SaveError,"You did not provide a clue. Clue is a required field. Please provide a clue")
       end
     end
     

data/spec/resources/contact_history_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActsAsIcontact::ContactHistory do
+  before(:each) do
+    @contact = ActsAsIcontact::Contact.find(333333)
+    @this = @contact.history.first
+  end
+  
+  it "knows its contact" do
+    @this.contact.email.should == "john@example.org"
+  end
+  
+  it "cannot be altered" do
+    lambda{@this.actor = 333333}.should raise_error(ActsAsIcontact::ReadOnlyError, "Contact History is read-only!")
+  end
+  
+  it "cannot be saved" do
+    lambda{@this.save}.should raise_error(ActsAsIcontact::ReadOnlyError, "Contact History is read-only!")
+  end
+      
+  it "does not allow .find" do
+    lambda{ActsAsIcontact::ContactHistory.find(:all)}.should raise_error(ActsAsIcontact::QueryError, "Contact History must be obtained using the contact.history method.")
+  end
+
+  it "does not allow .first" do
+    lambda{ActsAsIcontact::ContactHistory.first}.should raise_error(ActsAsIcontact::QueryError, "Contact History must be obtained using the contact.history method.")
+  end
+
+  it "does not allow .all" do
+    lambda{ActsAsIcontact::ContactHistory.all}.should raise_error(ActsAsIcontact::QueryError, "Contact History must be obtained using the contact.history method.")
+  end
+  
+  it "requires a contactId" do
+    lambda{ActsAsIcontact::ContactHistory.new(contact: nil)}.should raise_error(ActsAsIcontact::ValidationError, "Contact History requires a Contact")
+  end
+end

data/spec/resources/contact_spec.rb

@@ -29,7 +29,9 @@ describe ActsAsIcontact::Contact do
       @john.subscribe(444444)
     end
     
-    it "knows its history"
+    it "knows its history" do
+      @john.history.count.should == 4
+    end
   end
     
 end

data/spec/support/spec_fakeweb.rb

@@ -34,6 +34,10 @@ FakeWeb.register_uri(:post, "#{ic}/contacts", :body => %q<{"contacts":[{"email":
 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"}}>)
 
+# Contact History
+FakeWeb.register_uri(:get, "#{ic}/contacts/333333/actions?limit=500", :body => %q<{"actions":[{"actionType":"EditFields","actionTime":"2009-08-01T16:02:44-0400","actor":"407118","details":{"email":"susan_smith@example.org"}},{"actionType":"EditFields","actionTime":"2009-08-01T16:02:13-0400","actor":"407118","details":{"firstName":"Susan","lastName":"Smith","custom_test":"hello 4"}},{"actionType":"EditSubscription","actionTime":"2009-08-01T16:00:31-0400","actor":"407118","details":{"listId":"174137","newStatus":"normal"}},{"actionType":"AddContact","actionTime":"2009-08-01T16:00:30-0400","actor":"407118","details":[]}],"limit":50,"offset":0,"total":4}>)
+FakeWeb.register_uri(:get, "#{ic}/contacts/333333/actions?limit=1", :body => %q<{"actions":[{"actionType":"EditFields","actionTime":"2009-08-01T16:02:44-0400","actor":"407118","details":{"email":"susan_smith@example.org"}},{"actionType":"EditFields","actionTime":"2009-08-01T16:02:13-0400","actor":"407118","details":{"firstName":"Susan","lastName":"Smith","custom_test":"hello 4"}},{"actionType":"EditSubscription","actionTime":"2009-08-01T16:00:31-0400","actor":"407118","details":{"listId":"174137","newStatus":"normal"}},{"actionType":"AddContact","actionTime":"2009-08-01T16:00:30-0400","actor":"407118","details":[]}],"limit":50,"offset":0,"total":4}>)
+
 #  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."}}>)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: SFEley-acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Stephen Eley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-08 00:00:00 -07:00
+date: 2009-08-10 00:00:00 -07:00
 default_executable: icontact
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,6 +91,8 @@ files:
 - bin/icontact
 - init.rb
 - lib/acts_as_icontact.rb
+- lib/acts_as_icontact/command_line/completion.rb
+- lib/acts_as_icontact/command_line/variables.rb
 - lib/acts_as_icontact/config.rb
 - lib/acts_as_icontact/connection.rb
 - lib/acts_as_icontact/exceptions.rb
@@ -105,6 +107,7 @@ files:
 - lib/acts_as_icontact/resources/campaign.rb
 - lib/acts_as_icontact/resources/client.rb
 - lib/acts_as_icontact/resources/contact.rb
+- lib/acts_as_icontact/resources/contact_history.rb
 - lib/acts_as_icontact/resources/custom_field.rb
 - lib/acts_as_icontact/resources/list.rb
 - lib/acts_as_icontact/resources/message.rb
@@ -121,6 +124,7 @@ files:
 - spec/resources/account_spec.rb
 - spec/resources/campaign_spec.rb
 - spec/resources/clientfolder_spec.rb
+- spec/resources/contact_history_spec.rb
 - spec/resources/contact_spec.rb
 - spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb
@@ -171,6 +175,7 @@ test_files:
 - spec/resources/account_spec.rb
 - spec/resources/campaign_spec.rb
 - spec/resources/clientfolder_spec.rb
+- spec/resources/contact_history_spec.rb
 - spec/resources/contact_spec.rb
 - spec/resources/custom_field_spec.rb
 - spec/resources/list_spec.rb