campaign_monitor_subscriber 0.6.3 → 1.0.0

data/campaign_monitor_subscriber.gemspec

@@ -1,32 +1,22 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{campaign_monitor_subscriber}
-  s.version = "0.6.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Gary Greyling"]
-  s.date = %q{2011-04-05}
+  s.name        = "campaign_monitor_subscriber"
+  s.version     = '1.0.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Gary Greyling"]
+  s.email       = ["gary@mpowered.co.za"]
+  s.homepage    = "https://github.com/mpowered/campaign_monitor_subscriber"
+  s.summary     = %q{Sync user emails with Campaign Monitor mailing lists}
   s.description = %q{Sync user emails with Campaign Monitor mailing lists}
-  s.email = %q{gary@mpowered.co.za}
-  s.extra_rdoc_files = ["README.rdoc", "lib/campaign_monitor_subscriber.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "lib/campaign_monitor_subscriber.rb", "campaign_monitor_subscriber.gemspec"]
-  s.homepage = %q{http://github.com/mpowered/campaign_monitor_subscriber}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Campaign_monitor_subscriber", "--main", "README.rdoc"]
+
+  s.files         = `git ls-files -- {lib/*,vendor/*,*.gemspec}`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{campaign_monitor_subscriber}
-  s.rubygems_version = %q{1.4.1}
-  s.summary = %q{Sync user emails with Campaign Monitor mailing lists}
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_dependency 'createsend', '>= 1.0.4'
+  s.add_development_dependency 'active_support', '>= 3.0.0'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<campaigning>, [">= 0.15.0"])
-    else
-      s.add_dependency(%q<campaigning>, [">= 0.15.0"])
-    end
-  else
-    s.add_dependency(%q<campaigning>, [">= 0.15.0"])
-  end
+  ruby_minor_version = RUBY_VERSION.split('.')[1].to_i
 end

data/lib/campaign_monitor_subscriber.rb

@@ -1,31 +1,4 @@
-module CampaignMonitorSubscriber
-  require 'campaigning'
-  CM_CONFIG = YAML::load_file(File.join(RAILS_ROOT, "config/campaign_monitor_subscriber_config.yml"))
-  ::CAMPAIGN_MONITOR_API_KEY = CM_CONFIG['api_key']  
+require 'campaign_monitor_subscriber/basic_configuration'
+require 'campaign_monitor_subscriber/macro'
 
-  def subscribe_me_using(email_field)
-    return if CM_CONFIG[RAILS_ENV] == false
-
-    after_create do |record|
-      begin
-        s = Campaigning::Subscriber.new(record.send(email_field))
-        s.add!(cm_list_id)
-      rescue RuntimeError
-      end
-    end
-
-    after_destroy do |record|
-      begin
-        Campaigning::Subscriber.unsubscribe!(record.send(email_field), cm_list_id)
-      rescue RuntimeError
-      end
-    end
-  end
-
-  private
-    def cm_list_id
-      YAML::load_file(File.join(RAILS_ROOT, "config/campaign_monitor_subscriber_config.yml"))['list_id']
-    end
-end
-
-ActiveRecord::Base.extend(CampaignMonitorSubscriber)
+ActiveRecord::Base.extend(CampaignMonitorSubscriber::Macro)

data/lib/campaign_monitor_subscriber/basic_configuration.rb

@@ -0,0 +1,16 @@
+# These methods become part of all models that call #subscribe_me_using regardless
+# of the environment and other qualifying criteria.
+# We keep this light so that if the current environment fails to qualify for subscription
+# we haven't created a lot of bootstrapping overhead.
+module CampaignMonitorSubscriber
+  module BasicConfiguration
+    require 'yaml'
+
+    private
+      # All yaml config is namespaced under the environment name (the same way
+      # database.yml does it)
+      def raw_cms_config
+        @raw_cms_config ||= YAML::load_file(File.join("config/campaign_monitor_subscriber.yml"))[::Rails.env]
+      end
+  end
+end

data/lib/campaign_monitor_subscriber/configuration.rb

@@ -0,0 +1,32 @@
+# These methods become class methods on a model that calls #subscribe_me_using.
+# They provide config bootstrapping easy access to loaded configuration.
+module CampaignMonitorSubscriber
+  module Configuration
+    # Load config from yaml and #subscribe_me_using arguments.
+    def load_cms_configuration(email_field, options)
+      options.stringify_keys!
+      # Load the list_id from the yaml file. If a list is specified in #subscribe_me_using
+      # then load the id under the '*given_list_name*_id' key.
+      # Otherwise use the value as defined under the 'list_id' key.
+      cms_config.list_id = raw_cms_config.fetch("#{options.delete('list')}_list_id", raw_cms_config['list_id'])
+
+      # Load the API key from the yaml file.
+      CreateSend.api_key raw_cms_config['api_key']
+
+      # Extract config from the options supplied to #subscribe_me_using.
+      cms_config.email_field = email_field
+      cms_config.name_field = options.delete('name')
+      cms_config.custom_fields = options
+    end
+
+    def cms_config
+      @cms_config ||= CMSConfig.new.config     
+    end
+
+    # We namespace the AS::config in case this
+    # model already uses AS's configurable. Because we care :)
+    class CMSConfig
+      include ActiveSupport::Configurable
+    end
+  end
+end

data/lib/campaign_monitor_subscriber/instance_methods.rb

@@ -0,0 +1,21 @@
+# These methosd became instance methods on a model that calls #subscribe_me_using.
+# They provide easy access to parsed CMS config values.
+module CampaignMonitorSubscriber 
+  module InstanceMethods
+    def cms_custom_fields
+      cms_config.custom_fields.inject({}) { |h, (k, v)| h[k] = send(v); h }
+    end
+
+    def cms_email
+      send(cms_config.email_field)
+    end
+
+    def cms_name
+      cms_config.name_field ? send(cms_config.name_field) : cms_email
+    end
+
+    def cms_config
+      self.class.cms_config
+    end
+  end
+end

data/lib/campaign_monitor_subscriber/macro.rb

@@ -0,0 +1,26 @@
+module CampaignMonitorSubscriber
+  module Macro
+    def subscribe_me_using(email_field, options = {})
+      extend CampaignMonitorSubscriber::BasicConfiguration
+      # Don't active CMS hooks if there is no configuration for the
+      # current environment.
+      return if raw_cms_config.nil?
+
+      # Now that we know CMS subscription is relevant we
+      # include the required libraries and bootstrap the hooks
+      require 'createsend'
+      require 'campaign_monitor_subscriber/configuration'
+      require 'campaign_monitor_subscriber/instance_methods'
+      require 'campaign_monitor_subscriber/subscription_hooks'
+
+      # Load configuration from the yaml file and this macro's options
+      extend CampaignMonitorSubscriber::Configuration
+      load_cms_configuration(email_field, options)
+
+      # Include CMS config accessors to this model
+      include CampaignMonitorSubscriber::InstanceMethods
+      # Include CMS subscription hooks in this model
+      include CampaignMonitorSubscriber::SubscriptionHooks
+    end
+  end
+end

data/lib/campaign_monitor_subscriber/subscription_hooks.rb

@@ -0,0 +1,45 @@
+# This module defines the CMS subscription callbacks.
+# The callbacks are included in a model that calls #subscribe_me_using.
+module CampaignMonitorSubscriber
+  module SubscriptionHooks
+
+    extend ActiveSupport::Concern
+
+    included do
+      require 'logger'
+      @@log = Logger.new('log/cm_subscriber.log')
+
+      after_create do |record|
+        @@log.info "\n* Adding '#{record.cms_email}' to CM"
+
+        begin
+          CreateSend::Subscriber.add(
+            cms_config.list_id,
+            record.cms_email,
+            record.cms_name,
+            [record.cms_custom_fields],
+            true
+          )
+        rescue CreateSend::CreateSendError => err
+          @@log.info err.message
+        end
+      end
+
+
+      after_destroy do |record|
+        @@log.info "\n* Removing '#{record.cms_email}' from CM"
+
+        begin
+          s = CreateSend::Subscriber.new(
+            cms_config.list_id,
+            record.cms_email
+          )
+          s.unsubscribe
+        rescue CreateSend::CreateSendError => err
+          @@log.info err.message
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,93 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: campaign_monitor_subscriber
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 3
-  version: 0.6.3
 platform: ruby
-authors: 
+authors:
 - Gary Greyling
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-05 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: campaigning
+date: 2012-06-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: createsend
+  requirement: &2169567680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *2169567680
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &2169567200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 15
-        - 0
-        version: 0.15.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2169567200
 description: Sync user emails with Campaign Monitor mailing lists
-email: gary@mpowered.co.za
+email:
+- gary@mpowered.co.za
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-- lib/campaign_monitor_subscriber.rb
-files: 
-- Manifest
-- README.rdoc
-- Rakefile
-- lib/campaign_monitor_subscriber.rb
+extra_rdoc_files: []
+files:
 - campaign_monitor_subscriber.gemspec
-has_rdoc: true
-homepage: http://github.com/mpowered/campaign_monitor_subscriber
+- lib/campaign_monitor_subscriber.rb
+- lib/campaign_monitor_subscriber/basic_configuration.rb
+- lib/campaign_monitor_subscriber/configuration.rb
+- lib/campaign_monitor_subscriber/instance_methods.rb
+- lib/campaign_monitor_subscriber/macro.rb
+- lib/campaign_monitor_subscriber/subscription_hooks.rb
+homepage: https://github.com/mpowered/campaign_monitor_subscriber
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Campaign_monitor_subscriber
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: campaign_monitor_subscriber
-rubygems_version: 1.4.1
+rubyforge_project: 
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Sync user emails with Campaign Monitor mailing lists
 test_files: []
-

data/Manifest

@@ -1,4 +0,0 @@
-Manifest
-README.rdoc
-Rakefile
-lib/campaign_monitor_subscriber.rb

data/README.rdoc

@@ -1,59 +0,0 @@
-= campaign_monitor_subscriber
-
-http://github.com/mpowered/campaign_monitor_subscriber
-
-== DESCRIPTION:
-
-Automatically push/delete a model's email address to a Campaign Monitor mailing when the model is created or destroyed.
-
-== FEATURES:
-
-* Push email addresses to CM on create
-* Delete email address from CM on destroy
-
-== SYNOPSIS:
-
-Specify the model's email address field name:
-  Class User < ActiveRecord::Base
-    subscribe_me_using :email
-  end
-
-Set the list id & api key in config/campaign_monitor_subscriber_config.yml:
-  list_id: 12oeu0089oe8gf9794oe498587o5
-  api_key: 23rbmoe351sd123d12134hbi1234
-	development: false # disable in development
-
-Thats it!
-
-== REQUIREMENTS:
-
-* campaigning gem
-
-== INSTALL:
-
-  gem install campaign_monitor_subscriber
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010 FIX
-
-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.st

data/Rakefile

@@ -1,13 +0,0 @@
-# -*- ruby -*-
-require 'rubygems'
-require 'rake'
-require 'echoe'
-
-Echoe.new('campaign_monitor_subscriber', '0.6.3') do |p|
-  p.description    = "Sync user emails with Campaign Monitor mailing lists"
-  p.url            = "http://github.com/mpowered/campaign_monitor_subscriber"
-  p.author         = "Gary Greyling"
-  p.email          = "gary@mpowered.co.za"
-  p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = [['campaigning', '>= 0.15.0']]
-end