acts_as_icontact 0.1.5 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/acts_as_icontact.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_icontact}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2009-07-25}
+  s.date = %q{2009-07-26}
   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
@@ -24,10 +24,13 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "acts_as_icontact.gemspec",
+     "init.rb",
      "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/rails.rb",
+     "lib/acts_as_icontact/rails/macro.rb",
      "lib/acts_as_icontact/resource.rb",
      "lib/acts_as_icontact/resource_collection.rb",
      "lib/acts_as_icontact/resources/account.rb",
@@ -35,8 +38,11 @@ Gem::Specification.new do |s|
      "lib/acts_as_icontact/resources/contact.rb",
      "lib/acts_as_icontact/resources/list.rb",
      "lib/acts_as_icontact/resources/message.rb",
+     "rails/init.rb",
      "spec/config_spec.rb",
      "spec/connection_spec.rb",
+     "spec/examples/schema.rb",
+     "spec/rails_spec.rb",
      "spec/resource_collection_spec.rb",
      "spec/resource_spec.rb",
      "spec/resources/account_spec.rb",
@@ -45,8 +51,10 @@ Gem::Specification.new do |s|
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
      "spec/spec.opts",
-     "spec/spec_fakeweb.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/support/active_record/connection_adapters/nulldb_adapter.rb",
+     "spec/support/nulldb_rspec.rb",
+     "spec/support/spec_fakeweb.rb"
   ]
   s.homepage = %q{http://github.com/SFEley/acts_as_icontact}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -57,6 +65,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/config_spec.rb",
      "spec/connection_spec.rb",
+     "spec/examples/schema.rb",
+     "spec/rails_spec.rb",
      "spec/resource_collection_spec.rb",
      "spec/resource_spec.rb",
      "spec/resources/account_spec.rb",
@@ -64,8 +74,10 @@ Gem::Specification.new do |s|
      "spec/resources/contact_spec.rb",
      "spec/resources/list_spec.rb",
      "spec/resources/message_spec.rb",
-     "spec/spec_fakeweb.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/support/active_record/connection_adapters/nulldb_adapter.rb",
+     "spec/support/nulldb_rspec.rb",
+     "spec/support/spec_fakeweb.rb"
   ]
 
   if s.respond_to? :specification_version then

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/acts_as_icontact/rails/macro.rb

@@ -0,0 +1,15 @@
+module ActsAsIcontact
+  module Rails
+    module ClassMethods
+      module Macro
+
+        # The core macro for ActsAsIcontact's Rails integration.  Establishes callbacks to keep Rails models in
+        # sync with iContact.  See the README for more on what it does.
+        def acts_as_icontact(options = {})
+          true
+        end
+
+      end
+    end
+  end
+end

data/lib/acts_as_icontact/rails.rb

@@ -0,0 +1,21 @@
+# Load all of our Rails files
+Dir[File.join(File.dirname(__FILE__), 'rails', '*.rb')].sort.each do |path|
+  filename = File.basename(path, '.rb')
+  require "acts_as_icontact/rails/#{filename}"
+end
+
+module ActsAsIcontact
+  module Rails
+    module ClassMethods
+      include Macro
+    end
+  end
+end
+
+if defined?(::ActiveRecord)
+  module ::ActiveRecord
+    class Base
+      extend ActsAsIcontact::Rails::ClassMethods
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Load our Rails integration code
+require 'acts_as_icontact'
+require 'acts_as_icontact/rails'

data/spec/examples/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+  create_table "people", :force => true do |t|
+    t.string   "firstName"                         
+    t.string  "surname"        
+    t.string   "email",                              :null => false
+    t.string  "icontact_status"
+    t.string  "status"
+    t.string  "icontact_id"
+    t.datetime  "icontact_created"
+    t.string  "bounces"
+    t.string  "custom_field"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/spec/rails_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'activerecord'
+require 'rails/init'
+
+# Dummy model
+class Person < ActiveRecord::Base
+  # create_table "people", :force => true do |t|
+  #   t.string   "firstName"                         
+  #   t.string  "surname"        
+  #   t.string   "email",                              :null => false
+  #   t.string  "icontact_status"
+  #   t.string  "status"
+  #   t.string  "icontact_id"
+  #   t.datetime  "icontact_created"
+  #   t.string  "bounces"
+  #   t.string  "custom_field"
+  #   t.datetime "created_at"
+  #   t.datetime "updated_at"
+  # end
+  
+  acts_as_icontact
+end
+
+describe "Rails integration" do
+  before(:all) do
+    ActiveRecord::Base.establish_connection :adapter => :nulldb,
+                                            :schema => File.dirname(__FILE__) + '/examples/schema.rb'
+  end
+  
+  it "relies on a model with an email address" do
+    @person = Person.new(:email => "john@example.org")
+    @person.email.should == "john@example.org"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,10 +1,13 @@
 require 'spec'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'acts_as_icontact'
 
-require 'spec_fakeweb'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 Spec::Runner.configure do |config|
   # config.after(:each) do

data/spec/support/active_record/connection_adapters/nulldb_adapter.rb

@@ -0,0 +1,217 @@
+require 'logger'
+require 'stringio'
+require 'singleton'
+require 'activerecord'
+require 'active_record/connection_adapters/abstract_adapter'
+
+class ActiveRecord::Base
+  # Instantiate a new NullDB connection.  Used by ActiveRecord internally.
+  def self.nulldb_connection(config)
+    ActiveRecord::ConnectionAdapters::NullDBAdapter.new(config)
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::NullDBAdapter <
+    ActiveRecord::ConnectionAdapters::AbstractAdapter
+
+  class Statement
+    attr_reader :entry_point, :content
+
+    def initialize(entry_point, content = "")
+      @entry_point, @content = entry_point, content
+    end
+
+    def ==(other)
+      self.entry_point == other.entry_point
+    end
+  end
+
+  class Checkpoint < Statement
+    def initialize
+      super(:checkpoint, "")
+    end
+
+    def ==(other)
+      self.class == other.class
+    end
+  end
+
+  TableDefinition = ActiveRecord::ConnectionAdapters::TableDefinition
+
+  class NullObject
+    def method_missing(*args, &block)
+      nil
+    end
+  end
+
+  # A convenience method for integratinginto RSpec.  See README for example of
+  # use.
+  def self.insinuate_into_spec(config)
+    config.before :all do
+      ActiveRecord::Base.establish_connection(:adapter => :nulldb)
+    end
+
+    config.after :all do
+      ActiveRecord::Base.establish_connection(:test)
+    end
+  end
+
+  # Recognized options:
+  #
+  # [+:schema+] path to the schema file, relative to RAILS_ROOT
+  def initialize(config={})
+    @log            = StringIO.new
+    @logger         = Logger.new(@log)
+    @last_unique_id = 0
+    @tables         = {'schema_info' =>  TableDefinition.new(nil)}
+    @schema_path    = config.fetch(:schema){ "db/schema.rb" }
+    super(nil, @logger)
+  end
+
+  # A log of every statement that has been "executed" by this connection adapter
+  # instance.
+  def execution_log
+    (@execution_log ||= [])
+  end
+
+  # A log of every statement that has been "executed" since the last time
+  # #checkpoint! was called, or since the connection was created.
+  def execution_log_since_checkpoint
+    checkpoint_index = @execution_log.rindex(Checkpoint.new)
+    checkpoint_index = checkpoint_index ? checkpoint_index + 1 : 0
+    @execution_log[(checkpoint_index..-1)]
+  end
+
+  # Inserts a checkpoint in the log.  See also #execution_log_since_checkpoint.
+  def checkpoint!
+    self.execution_log << Checkpoint.new
+  end
+
+  def adapter_name
+    "NullDB"
+  end
+
+  def supports_migrations?
+    true
+  end
+
+  def create_table(table_name, options = {})
+    table_definition = ActiveRecord::ConnectionAdapters::TableDefinition.new(self)
+    unless options[:id] == false
+      table_definition.primary_key(options[:primary_key] || "id")
+    end
+
+    yield table_definition
+
+    @tables[table_name] = table_definition
+  end
+
+  def add_fk_constraint(*args)
+    # NOOP
+  end
+
+  def add_pk_constraint(*args)
+    # NOOP
+  end
+
+  # Retrieve the table names defined by the schema
+  def tables
+    @tables.keys.map(&:to_s)
+  end
+
+  # Retrieve table columns as defined by the schema
+  def columns(table_name, name = nil)
+    if @tables.size <= 1
+      ActiveRecord::Migration.verbose = false
+      Kernel.load(File.join(@schema_path))
+    end
+    table = @tables[table_name]
+    table.columns.map do |col_def|
+      ActiveRecord::ConnectionAdapters::Column.new(col_def.name.to_s,
+                                                    col_def.default,
+                                                    col_def.type,
+                                                    col_def.null)
+    end
+  end
+
+  def execute(statement, name = nil)
+    self.execution_log << Statement.new(entry_point, statement)
+    NullObject.new
+  end
+
+  def insert(statement, name, primary_key, object_id, sequence_name)
+    returning(object_id || next_unique_id) do
+      with_entry_point(:insert) do
+        super(statement, name, primary_key, object_id, sequence_name)
+      end
+    end
+  end
+
+  def update(statement, name=nil)
+    with_entry_point(:update) do
+      super(statement, name)
+    end
+  end
+
+  def delete(statement, name=nil)
+    with_entry_point(:delete) do
+      super(statement, name)
+    end
+  end
+
+  def select_all(statement, name=nil)
+    with_entry_point(:select_all) do
+      super(statement, name)
+    end
+  end
+
+  def select_one(statement, name=nil)
+    with_entry_point(:select_one) do
+      super(statement, name)
+    end
+  end
+
+  def select_value(statement, name=nil)
+    with_entry_point(:select_value) do
+      super(statement, name)
+    end
+  end
+
+  protected
+
+  def select(statement, name)
+    returning([]) do
+      self.execution_log << Statement.new(entry_point, statement)
+    end
+  end
+
+  private
+
+  def next_unique_id
+    @last_unique_id += 1
+  end
+
+  def with_entry_point(method)
+    if entry_point.nil?
+      with_thread_local_variable(:entry_point, method) do
+        yield
+      end
+    else
+      yield
+    end
+  end
+
+  def entry_point
+    Thread.current[:entry_point]
+  end
+
+  def with_thread_local_variable(name, value)
+    old_value = Thread.current[name]
+    Thread.current[name] = value
+    begin
+      yield
+    ensure
+      Thread.current[name] = old_value
+    end
+  end
+end

data/spec/support/nulldb_rspec.rb

@@ -0,0 +1,93 @@
+require 'active_record/connection_adapters/nulldb_adapter'
+
+module NullDB
+  module RSpec
+  end
+end
+
+module NullDB::RSpec::NullifiedDatabase
+  NullDBAdapter = ActiveRecord::ConnectionAdapters::NullDBAdapter
+
+  class HaveExecuted
+
+    def initialize(entry_point)
+      @entry_point = entry_point
+    end
+
+    def matches?(connection)
+      log = connection.execution_log_since_checkpoint
+      if entry_point == :anything
+        not log.empty?
+      else
+        log.include?(NullDBAdapter::Statement.new(@entry_point))
+      end
+    end
+
+    def description
+      "connection should execute #{@entry_point} statement"
+    end
+
+    def failure_message
+      " did not execute #{@entry_point} statement when it should have"
+    end
+
+    def negative_failure_message
+      " executed #{@entry_point} statement when it should not have"
+    end
+  end
+
+  def self.globally_nullify_database
+    Spec::Runner.configure do |config|
+      nullify_database(config)
+    end
+  end
+
+  def self.contextually_nullify_database(context)
+    nullify_database(context)
+  end
+
+  # A matcher for asserting that database statements have (or have not) been
+  # executed.  Usage:
+  #
+  #   ActiveRecord::Base.connection.should have_executed(:insert)
+  #
+  # The types of statement that can be matched mostly mirror the public
+  # operations available in
+  # ActiveRecord::ConnectionAdapters::DatabaseStatements:
+  # - :select_one
+  # - :select_all
+  # - :select_value
+  # - :insert
+  # - :update
+  # - :delete
+  # - :execute
+  #
+  # There is also a special :anything symbol that will match any operation.
+  def have_executed(entry_point)
+    HaveExecuted.new(entry_point)
+  end
+
+  private
+
+  def self.included(other)
+    if other.ancestors.include?(Spec::Rails::Example::RailsExampleGroup)
+      contextually_nullify_database(other)
+    else
+      globally_nullify_database
+    end
+  end
+
+  def self.nullify_database(receiver)
+    receiver.before :all do
+      ActiveRecord::Base.establish_connection(:adapter => :nulldb)
+    end
+
+    receiver.before :each do
+      ActiveRecord::Base.connection.checkpoint!
+    end
+
+    receiver.after :all do
+      ActiveRecord::Base.establish_connection(:test)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_icontact
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Stephen Eley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-25 00:00:00 -04:00
+date: 2009-07-26 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -34,10 +34,13 @@ files:
 - Rakefile
 - VERSION
 - acts_as_icontact.gemspec
+- init.rb
 - 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/rails.rb
+- lib/acts_as_icontact/rails/macro.rb
 - lib/acts_as_icontact/resource.rb
 - lib/acts_as_icontact/resource_collection.rb
 - lib/acts_as_icontact/resources/account.rb
@@ -45,8 +48,11 @@ files:
 - lib/acts_as_icontact/resources/contact.rb
 - lib/acts_as_icontact/resources/list.rb
 - lib/acts_as_icontact/resources/message.rb
+- rails/init.rb
 - spec/config_spec.rb
 - spec/connection_spec.rb
+- spec/examples/schema.rb
+- spec/rails_spec.rb
 - spec/resource_collection_spec.rb
 - spec/resource_spec.rb
 - spec/resources/account_spec.rb
@@ -55,8 +61,10 @@ files:
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
 - spec/spec.opts
-- spec/spec_fakeweb.rb
 - spec/spec_helper.rb
+- spec/support/active_record/connection_adapters/nulldb_adapter.rb
+- spec/support/nulldb_rspec.rb
+- spec/support/spec_fakeweb.rb
 has_rdoc: true
 homepage: http://github.com/SFEley/acts_as_icontact
 licenses: []
@@ -88,6 +96,8 @@ summary: Automatic bridge between iContact e-mail marketing service and Rails Ac
 test_files: 
 - spec/config_spec.rb
 - spec/connection_spec.rb
+- spec/examples/schema.rb
+- spec/rails_spec.rb
 - spec/resource_collection_spec.rb
 - spec/resource_spec.rb
 - spec/resources/account_spec.rb
@@ -95,5 +105,7 @@ test_files:
 - spec/resources/contact_spec.rb
 - spec/resources/list_spec.rb
 - spec/resources/message_spec.rb
-- spec/spec_fakeweb.rb
 - spec/spec_helper.rb
+- spec/support/active_record/connection_adapters/nulldb_adapter.rb
+- spec/support/nulldb_rspec.rb
+- spec/support/spec_fakeweb.rb