subscribed_to 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "activerecord"
+gem "hominid", ">= 3.0.2"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "sqlite3-ruby", :require => "sqlite3"
+  gem "factory_girl_rails", "1.0.1"
+  gem "mocha", "0.9.12"
+  gem "rspec-rails", "2.5.0"
+  gem "generator_spec"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "simplecov", ">=0.4.0"
+  gem "hanna"
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.3)
+    factory_girl_rails (1.0.1)
+      factory_girl (~> 1.3)
+      railties (>= 3.0.0)
+    generator_spec (0.8.3)
+      rails (~> 3.0)
+      rspec-rails
+    git (1.2.5)
+    haml (2.2.24)
+    hanna (0.1.12)
+      haml (~> 2.2.8)
+      rake (~> 0.8.2)
+      rdoc (~> 2.3.0)
+    hominid (3.0.2)
+    i18n (0.5.0)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mocha (0.9.12)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rdoc (2.3.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.0.0)
+  factory_girl_rails (= 1.0.1)
+  generator_spec
+  hanna
+  hominid (>= 3.0.2)
+  jeweler (~> 1.6.0)
+  mocha (= 0.9.12)
+  rspec-rails (= 2.5.0)
+  simplecov (>= 0.4.0)
+  sqlite3-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 whtt-eric
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,113 @@
+= SubscribedTo
+
+Abstraction layer for managing mailing list subscription information for your user model. It makes the basic mailing list management tasks super simple.
+
+The gem creates callbacks on your model for <tt>after_create</tt> and <tt>after_update</tt>.
+
+The <tt>after_create</tt> callback registers the user for the mailing list if <tt>subscribed_to_list</tt> is true (ie: the user chooses checks the "Join the mailing list" box on the registration form).
+
+The <tt>after_update</tt> callback will update the user subscription or member details. It will either:
+
+* Unsubscribe the user from the mailing list if they have so requested
+* Subscribe the user to the list if they weren't already subscribed
+* Update the user's member subscription details on the mailing list for any specified <tt>merge_vars</tt> when they change
+* Do nothing if neither the subscription status nor the attributes specified in the <tt>merge_vars</tt> hash change
+
+=== Requirements
+
+* Rails 3.x
+
+=== Supported Services
+
+<b>MailChimp</b>
+
+via the Hominid gem - http://github.com/terra-firma/hominid
+
+API v1.3 - http://apidocs.mailchimp.com/1.3
+
+* listSubscribe
+* listUnsubscribe
+* listUpdateMember
+
+
+<b>Constant Contact</b>
+
+Planned
+
+== Installation
+
+Add the gem to your Gemfile
+
+  gem "subscribed_to"
+
+Install the gem using bundler
+
+  bundle install
+
+Run the generator. You must specify the name of your user model.
+Other options:
+
+<tt>--skip-migration</tt>::    Do not generate the migration file to add the required column
+<tt>--service=SERVICE</tt>::   Specify which mailing list service you subscribe to (currently only supports "mail_chimp")
+
+  rails generate subscribed_to:install MODEL
+
+If you run the generator with <tt>--skip-migration</tt>, then you must be sure to to include the <tt>subscribed_to_list</tt> column in some other migration.
+
+  t.boolean :subscribed_to_list, :default => false
+
+Be sure to run the migration before you continue.
+
+=== Initializer Configuration
+
+After the initializer has been generated, you must set your mail service configuration options. The initializer is located at: <tt>config/initializers/subscribe_to.rb</tt>
+
+==== Mail Chimp
+
+Set your API key
+
+  mail_chimp_config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+
+Set up your mailing lists to subscribe users to. List names can be any valid symbol.
+
+<tt>:id</tt>::          id of list - get this from the "Settings" page of your list
+<tt>:merge_vars</tt>::  hash of merge vars on list. The key is a string which corresponds to a merge var on your mailing list. The value is a symbol corresponding to the attribute/method on the user model related to the specified merge var. It MUST at least include "EMAIL" (do not use "MERGE0").
+
+  mail_chimp_config.lists = {
+    :mailing_list => {
+      :id => "xxxxxxxx",
+      :merge_vars => {"FNAME" => :first_name, "LNAME" => :last_name, "EMAIL" => :email}}}
+
+=== User Model Configuration
+
+You must enable *SubscribedTo* in your user model with <tt>subscribed_to</tt>.
+
+The only paramter it takes is a symbol which corresponds to a list in the <tt>mail_chimp_config.lists</tt> hash.
+
+  subscribed_to :mailing_list
+
+You may also need to specify <tt>subscribed_to_list</tt> as an accessible attribute.
+
+  attr_accessible :subscribed_to_list
+
+=== View Configuration
+
+To get things working with the view, just include a checkbox input on your user registration/edit forms.
+
+  = f.check_box :subscribed_to_list
+  = f.label :subscribed_to_list, "Join the mailing list"
+
+== Contributing to subscribed_to
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eric Salczynski. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/subscribed_to/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "subscribed_to"
+  gem.homepage = "http://github.com/whtt-eric/subscribed_to"
+  gem.license = "MIT"
+  gem.summary = %Q{Abstract layer for managing mailing list subscriptions}
+  gem.description = %Q{Abstract layer for managing mailing list subscriptions}
+  gem.email = "eric@wehaventthetime.com"
+  gem.authors = ["whtt-eric"]
+  gem.version = SubscribedTo::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'hanna/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "subscribed_to #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/subscribed_to/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Add an initializer and migration for SubscribedTo.
+
+Example:
+    rails generate subscribed_to:install User
+
+    This will create:
+        config/initializers/subscribed_to.rb
+        db/migrate/add_subscribed_to_list_to_user.rb

data/lib/generators/subscribed_to/install_generator.rb

@@ -0,0 +1,34 @@
+module SubscribedTo
+  module Generators #:nodoc:
+    class InstallGenerator < Rails::Generators::NamedBase #:nodoc:
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Create SubscribedTo initializer and migration. Pass the name of the model to hook up with SubscribedTo."
+      class_option :migration, :type => :boolean, :default => true, :desc => "Include migration for required columns"
+      class_option :service, :type => :string, :default => "mail_chimp", :desc => "Mailing list service to connect to [mail_chimp, constant_contact]"
+
+      def self.next_migration_number(dirname)
+        @next_migration_number ||= Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_initializer
+        template "subscribed_to.rb", "config/initializers/subscribed_to.rb"
+      end
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/#{migration_name}" if options.migration?
+      end
+
+      private
+
+      def migration_name
+        "add_subscribed_to_list_to_#{table_name}"
+      end
+
+      def table_name
+        name.tableize
+      end
+    end
+  end
+end

data/lib/generators/subscribed_to/templates/migration.rb

@@ -0,0 +1,9 @@
+class <%= migration_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name.to_sym %>, :subscribed_to_list, :boolean, :default => false
+  end
+
+  def self.down
+    remove_column :<%= table_name.to_sym %>, :subscribed_to_list
+  end
+end

data/lib/generators/subscribed_to/templates/subscribed_to.rb

@@ -0,0 +1,21 @@
+SubscribedTo.setup do |config|
+  config.service = :<%= options.service.to_sym %>
+
+  <%- if options.service == "mail_chimp" -%>
+  config.mail_chimp do |mail_chimp_config|
+    # Your MailChimp API key.
+    mail_chimp_config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+
+    # A hash of mailing lists to subscribe users to.
+    # List names can be any valid symbol.
+    #
+    # Required:
+    #   :id - id of list
+    #   :merge_vars - hash of merge vars on list, MUST at least include "EMAIL" (do not use "MERGE0")
+    mail_chimp_config.lists = {
+      :mailing_list => {
+        :id => "xxxxxxxx",
+        :merge_vars => {"FNAME" => :first_name, "LNAME" => :last_name, "EMAIL" => :email}}}
+  end
+  <%- end -%>
+end

data/lib/subscribed_to/mail_chimp/config.rb

@@ -0,0 +1,29 @@
+module SubscribedTo
+  module MailChimp
+    class Config < Hash  #:nodoc:
+      # Creates an accessor that simply sets and reads a key in the hash:
+      # Borrowed from Warden: https://github.com/hassox/warden/blob/master/lib/warden/config.rb
+      def self.hash_accessor(*names) #:nodoc:
+        names.each do |name|
+          class_eval <<-METHOD, __FILE__, __LINE__ + 1
+            def #{name}
+              self[:#{name}]
+            end
+
+            def #{name}=(value)
+              self[:#{name}] = value
+            end
+          METHOD
+        end
+      end
+
+      hash_accessor :api_key, :lists
+
+      def initialize(config = {})
+        merge!(config)
+        self[:api_key] ||= nil
+        self[:lists]   ||= {}
+      end
+    end
+  end
+end

data/lib/subscribed_to/mail_chimp.rb

@@ -0,0 +1,51 @@
+require 'subscribed_to/mail_chimp/config'
+require 'hominid'
+
+module SubscribedTo
+  # Module for MailChimp subscription interaction
+  module MailChimp
+    module InstanceMethods
+      private
+
+      # Subscribe the user to the mailing list
+      def subscribe_to_list  #:doc:
+        merge_vars = self.class.merge_vars.dup
+
+        if subscribed_to_list
+          h = Hominid::API.new(SubscribedTo.mail_chimp_config.api_key)
+          h.list_subscribe(self.class.list_id, self.email, merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) })
+        end
+      rescue Hominid::APIError => e
+        Rails.logger.warn e
+      end
+
+      # Update attributes of existing member
+      def update_list_member  #:doc:
+        config     = SubscribedTo.mail_chimp_config
+        merge_vars = self.class.merge_vars.dup
+
+        # only do the update if either the subscription preference has changed (the user wants to be (un)subscribed),
+        # or if one of the attributes in mail_chimp_config.merge_vars has changed
+        if !(self.changed & merge_vars.collect { |key, method| method.to_s }.push("subscribed_to_list")).empty?
+          api_key          = config.api_key
+          list_id          = self.class.list_id
+          email_attr       = merge_vars["EMAIL"]
+          subscribed_email = self.changed.include?(email_attr.to_s) ? changed_attributes[email_attr.to_s] : self.send(email_attr)
+          h                = Hominid::API.new(api_key)
+
+          if self.changed.include?("subscribed_to_list")
+            if !subscribed_to_list
+              h.list_unsubscribe(list_id, subscribed_email)
+            else
+              h.list_subscribe(list_id, subscribed_email, merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) })
+            end
+          elsif subscribed_to_list && !(self.changed & merge_vars.collect { |key, method| method.to_s }).empty?
+            h.listUpdateMember(list_id, subscribed_email, merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) })
+          end
+        end
+      rescue Hominid::APIError => e
+        Rails.logger.warn e
+      end
+    end
+  end
+end

data/lib/subscribed_to/version.rb

@@ -0,0 +1,10 @@
+module SubscribedTo
+  module Version  #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/lib/subscribed_to.rb

@@ -0,0 +1,81 @@
+require 'rails'
+require 'active_record'
+require 'subscribed_to/mail_chimp'
+
+module SubscribedTo
+  # Mailing list service to interact with.
+  # Options: :mail_chimp, :constant_contact
+  # Currently only supports Mail Chimp
+  mattr_accessor :service
+  @@service = :mail_chimp
+
+  mattr_reader :mail_chimp_config
+  @@mail_chimp_config = nil
+
+  # Set up SubscribedTo
+  def self.setup
+    yield self
+  end
+
+  # Sets Mail Chimp configuration using a block
+  #
+  # Example configuration:
+  #   SubscribedTo.setup do |config|
+  #     config.service = :mail_chimp
+  #
+  #     config.mail_chimp do |mail_chimp_config|
+  #       mail_chimp_config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+  #       mail_chimp_config.lists = {:mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name}
+  #     end
+  #   end
+  def self.mail_chimp(&block)
+    @@mail_chimp_config = SubscribedTo::MailChimp::Config.new
+    block.call @@mail_chimp_config
+  end
+
+  def self.included(base) #:nodoc:
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    # Enable *SubscribedTo* in your user model.
+    # The only paramter it takes is a symbol which corresponds to a list in the <tt>mail_chimp_config.lists</tt> hash.
+    #   subscribed_to :mailing_list
+    def subscribed_to(id)
+      include InstanceMethods
+      include MailChimp::InstanceMethods if SubscribedTo.service == :mail_chimp
+
+      @list_key = id.to_sym
+
+      class_eval do
+        after_create :subscribe_to_list
+        after_update :update_list_member
+      end
+    end
+
+    # Returns the list id for the class as defined in mail_chimp
+    def list_id
+      SubscribedTo.mail_chimp_config.lists[@list_key][:id]
+    end
+
+    # Returns the hash of merge vars for the class as defined in mail_chimp
+    def merge_vars
+      SubscribedTo.mail_chimp_config.lists[@list_key][:merge_vars]
+    end
+  end
+
+  # Provides instance methods which should be overwritten in service modules
+  module InstanceMethods
+    private
+
+    # Override in MailChimp module
+    def subscribe_to_list
+    end
+
+    # Override in MailChimp module
+    def update_list_member
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, SubscribedTo

data/spec/app/models/user.rb

@@ -0,0 +1,43 @@
+class User < ActiveRecord::Base
+  subscribed_to :mailing_list
+end
+
+class MailChimpUser < User
+  subscribed_to :mailing_list
+
+  attr_accessor :callback_result
+
+  # Stubbed for testing
+  def subscribe_to_list
+    if subscribed_to_list
+      merge_vars = self.class.merge_vars.dup
+
+      # use hominid to subscribe user
+      self.callback_result = "Subscribed with: #{merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) }.values.join(", ")}"
+    else  # mocked for test -- subscribed_to_list normally doesn't do anything if !subscribed_to_list
+      self.callback_result = "Not Subscribed"
+    end
+  end
+
+  # Stubbed for testing
+  def update_list_member
+    merge_vars = self.class.merge_vars.dup
+
+    if !(self.changed & merge_vars.collect { |key, method| method.to_s }.push("subscribed_to_list")).empty?
+      if self.changed.include?("subscribed_to_list")
+        if !subscribed_to_list
+          # use hominid to unsubscribe user
+          self.callback_result = "Unsubscribed"
+        else
+          # use hominid to subscribe user
+          self.callback_result = "Subscribed with: #{merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) }.values.join(", ")}"
+        end
+      elsif subscribed_to_list && !(self.changed & merge_vars.collect { |key, method| method.to_s }).empty?
+        # use hominid to update user
+        self.callback_result = "Updated with: #{merge_vars.each { |key, method| merge_vars[key] = self.send(method.to_sym) }.values.join(", ")}"
+      end
+    else  # mocked for test -- update_list_member normally doesn't do anything in this case
+      self.callback_result = "Nothing updated"
+    end
+  end
+end

data/spec/database.yml.example

@@ -0,0 +1,17 @@
+sqlite3:
+  adapter: sqlite3
+  database: subscribed_to.sqlite3
+
+mysql:
+  adapter: mysql
+  hostname: localhost
+  username: root
+  password:
+  database: subscribed_to
+
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: subscribed_to

data/spec/factories/users.rb

@@ -0,0 +1,15 @@
+Factory.define :subscribed_user, :class => User do |u|
+  u.first_name          "Eric"
+  u.last_name           "Salczynski"
+  u.email               "eric@wehaventthetime.com"
+  u.subscribed_to_list  true
+  u.password            "abc123"
+end
+
+Factory.define :non_subscribed_user, :class => User do |u|
+  u.first_name          "Ashley"
+  u.last_name           "Beasy"
+  u.email               "ashley@wehaventthetime.com"
+  u.subscribed_to_list  false
+  u.password            "abc123"
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+require "action_controller"
+require "generator_spec/test_case"
+require 'generators/subscribed_to/install_generator'
+
+describe SubscribedTo::Generators::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../../tmp", __FILE__)
+
+  before(:all) { prepare_destination }
+
+  context "when run with default options" do
+    before(:all) { run_generator %w(User) }
+
+    it "should create an initializer" do
+      assert_file "config/initializers/subscribed_to.rb", /config.service = :mail_chimp/
+    end
+
+    it "should create a migration" do
+      assert_file "db/migrate/#{SubscribedTo::Generators::InstallGenerator.next_migration_number("")}_add_subscribed_to_list_to_users.rb"
+    end
+  end
+
+  context "when run with --skip-migration" do
+    before(:all) do
+      prepare_destination
+      run_generator %w(User --skip-migration)
+    end
+
+    it "should not create a migration" do
+      assert_no_file "db/migrate/#{SubscribedTo::Generators::InstallGenerator.next_migration_number("")}_add_subscribed_to_list_to_users.rb"
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :users, :force => true do |t|
+    t.string    :first_name
+    t.string    :last_name
+    t.string    :email
+    t.boolean   :subscribed_to_list
+    t.string    :password
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'factory_girl'
+require 'subscribed_to'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+ENV['DB'] ||= 'sqlite3'
+
+database_yml = File.expand_path('../database.yml', __FILE__)
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)[ENV['DB']]
+
+  ActiveRecord::Base.establish_connection(active_record_configuration)
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "log", "debug.log"))
+
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+
+    load('schema.rb')
+    Dir["#{File.dirname(__FILE__)}/app/**/*.rb"].each {|f| load f}
+    Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| load f}
+  end
+
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end
+
+Rails.logger = Logger.new(File.join(File.dirname(__FILE__), "log", "debug.log"))
+
+def clean_database!
+  models = [User]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

data/spec/subscribed_to/mail_chimp/config_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe SubscribedTo::MailChimp::Config do
+  before(:each) { @config = SubscribedTo::MailChimp::Config.new }
+
+  it "should behave like a hash" do
+    @config[:foo] = :bar
+    @config[:foo].should eq :bar
+  end
+
+  it "should provide hash accessors" do
+    @config.api_key = "1234567890"
+    @config[:api_key].should eq "1234567890"
+    @config[:api_key] = "0987654321"
+    @config.api_key.should eq "0987654321"
+  end
+
+  it "should merge given options on initialization" do
+    SubscribedTo::MailChimp::Config.new(:foo => :bar)[:foo].should eq :bar
+  end
+end

data/spec/subscribed_to/mail_chimp_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'hominid'
+
+describe SubscribedTo::MailChimp do
+  before(:each) do
+    SubscribedTo.mail_chimp do |config|
+      config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+      config.lists = {:mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name, "LNAME" => :last_name, "EMAIL" => :email}}}
+    end
+  end
+
+  context "for a new user" do
+    it "should subscribe the user" do
+      @user = MailChimpUser.create(Factory.attributes_for(:subscribed_user))
+      @user.callback_result.should eq "Subscribed with: Eric, Salczynski, eric@wehaventthetime.com"
+    end
+
+    it "should not subscribe the user" do
+      @user = MailChimpUser.create(Factory.attributes_for(:non_subscribed_user))
+      @user.callback_result.should eq "Not Subscribed"
+    end
+  end
+
+  context "for an existing user" do
+    context "who is not subscribed to the mailing list" do
+      before { @user = MailChimpUser.create(Factory.attributes_for(:non_subscribed_user)) }
+
+      it "should subscribe the user" do
+        @user.update_attributes({:subscribed_to_list => true})
+        @user.callback_result.should eq "Subscribed with: #{[@user.first_name, @user.last_name, @user.email].join(", ")}"
+      end
+    end
+
+    context "who is subscribed to the mailing list" do
+      before(:each) { @user = MailChimpUser.create(Factory.attributes_for(:subscribed_user)) }
+
+      it "should unsubscribe the user" do
+        @user.update_attributes({:subscribed_to_list => false})
+        @user.callback_result.should eq "Unsubscribed"
+      end
+
+      it "should update list member attributes for the user" do
+        @user.update_attributes({:first_name => "Ed", :last_name => "Salczynski", :email => "ed@whtt.me"})
+        @user.callback_result.should eq "Updated with: Ed, Salczynski, ed@whtt.me"
+      end
+
+      it "should not update list member when attributes not defined in merge vars are changed" do
+        @user.update_attributes({:password => "zyx321"})
+        @user.callback_result.should eq "Nothing updated"
+      end
+    end
+  end
+end

data/spec/subscribed_to_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SubscribedTo do
+  it "should yield self on setup" do
+    SubscribedTo.setup do |config|
+      config.should eq SubscribedTo
+    end
+  end
+
+  it "should configure MailChimp through a block" do
+    SubscribedTo.mail_chimp do |config|
+      config.should be_an_instance_of SubscribedTo::MailChimp::Config
+      config.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+      config.lists = {:mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name}}}
+    end
+
+    SubscribedTo.mail_chimp_config.api_key.should eq "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1"
+    SubscribedTo.mail_chimp_config.lists.should eq :mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name}}
+  end
+
+  it "should include the default instance methods" do
+    User.included_modules.should include SubscribedTo::InstanceMethods
+  end
+
+  it "should add subscribe and update methods to the callback chain" do
+    @user = Factory.build(:subscribed_user)
+    @user.expects(:subscribe_to_list).once
+    @user.save
+
+    @user.first_name = "Edward"
+    @user.expects(:update_list_member).once
+    @user.save
+  end
+
+  # the default service is MailChimp
+  context "for MailChimp" do
+    it "should include the MailChimp instance methods" do
+      User.included_modules.should include SubscribedTo::MailChimp::InstanceMethods
+    end
+
+    it "should provide the class with list_id and merge_vars methods" do
+      SubscribedTo.mail_chimp do |config|
+        config.lists = {:mailing_list => {:id => "123456", :merge_vars => {"FNAME" => :first_name}}}
+      end
+
+      User.list_id.should eq "123456"
+      User.merge_vars.should eq "FNAME" => :first_name
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification 
+name: subscribed_to
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- whtt-eric
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hominid
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: factory_girl_rails
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: generator_spec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: hanna
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id011
+description: Abstract layer for managing mailing list subscriptions
+email: eric@wehaventthetime.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/generators/subscribed_to/USAGE
+- lib/generators/subscribed_to/install_generator.rb
+- lib/generators/subscribed_to/templates/migration.rb
+- lib/generators/subscribed_to/templates/subscribed_to.rb
+- lib/subscribed_to.rb
+- lib/subscribed_to/mail_chimp.rb
+- lib/subscribed_to/mail_chimp/config.rb
+- lib/subscribed_to/version.rb
+- spec/app/models/user.rb
+- spec/database.yml.example
+- spec/factories/users.rb
+- spec/generators/install_generator_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/subscribed_to/mail_chimp/config_spec.rb
+- spec/subscribed_to/mail_chimp_spec.rb
+- spec/subscribed_to_spec.rb
+has_rdoc: true
+homepage: http://github.com/whtt-eric/subscribed_to
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1335917726808869519
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Abstract layer for managing mailing list subscriptions
+test_files: []
+