newsletterable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25e624e8412c36225fbf5abeca8dc9719a9f862b
+  data.tar.gz: b189d86b3c90404fcb0a23598ab2deb8b7192589
+SHA512:
+  metadata.gz: adb51010471ea00c312979fcee7b589973110ce232922b1873fef2dcb826b6f4eb3e1c8c057a40ddb1459f864517c7b582ae3dfccbbef80736363ef211ef586c
+  data.tar.gz: b46d19892e07d937806632b92d6b54fe827f285b82774f3ddff756a89bc765cdced395e7362ad96e49925c8ab92424e9930508309272edba23527791f3e1b1a8

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newsletterable.gemspec
+gemspec
+
+group :development do
+	gem 'pry-byebug'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Stan Bondi
+
+MIT License
+
+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.md

@@ -0,0 +1,101 @@
+# Newsletterable
+
+Keep mailing list subscriptions in sync with your
+ActiveRecord or Mongoid (ActiveModel) models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newsletterable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newsletterable
+
+## Usage
+
+Your initializer:
+
+
+```ruby
+Newsletterable.configure do |config|
+	# Mailchimp API key
+	config.api_key = ENV['api_key']
+
+	# Default lists
+	config.default_lists = {
+		newsletter: '123abc',
+		everyone: 'cba321'
+	}
+
+	# Specify worker class or custom callback for enqueuing to your worker.
+	# Workers usually include Newsletterable::Worker (defines the perform method)
+	config.worker = MyWorker
+	# or define a callable which will enqueue anyway you like, or synchonously
+	config.worker = lambda { |id| SleepyWorker.perform_async('NewsletterTask', id.to_s) }
+end
+```
+
+Your subscriber model e.g User class
+Must respond_to `email` (TODO: make this configurable)
+
+```ruby
+class User < ActiveRecord::Base
+	include Newsletterable::Subscriber
+
+	has_many :newsletter_subscriptions, as: :subscribable
+
+	# Boolean fields `newsletter` and `everyone`
+	subscribe_on :newsletter
+	# will unsubscribe if the subscriber class is destroyed
+	subscribe_on :everyone, unsubscribe_on_destroy: true
+end
+```
+
+Your Subscription model (each row is a subscription to a mailchimp list)
+Here using mongoid so that we can easier see the required methods/fields.
+
+```ruby
+class NewsletterSubscription
+	include Mongoid::Document
+	include Newsletterable::Model
+
+	# This must be an association to the subscribable object
+	belongs_to :subscribable, polymorphic: true
+
+	# Used to store old email addresses when object is destroyed or email updated
+	field :old_email, type: String
+	# List id of suibscription
+	field :list, type: String
+	# Either pending subscribed unsubscribed out_of_date or error
+	field :state, type: String
+end
+
+```
+
+Add a worker (using anything you like)
+
+```ruby
+
+class MyWorker
+	include Sidekiq::Worker
+	include Newsletterable::Worker
+
+	sidekiq_options ....
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/fixate/newsletterable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/newsletterable.rb

@@ -0,0 +1,58 @@
+require "active_model"
+require "active_support/concern"
+require "active_support/core_ext"
+
+require "newsletterable/version"
+require "newsletterable/configuration"
+require "newsletterable/errors"
+require "newsletterable/model"
+require "newsletterable/service"
+require "newsletterable/subscriber"
+require "newsletterable/worker"
+require "newsletterable/orm_adapters/adapter"
+require "newsletterable/railtie" if defined?(Rails)
+
+module Newsletterable
+	extend self
+	@@lock = Mutex.new
+
+	def configuration
+		@@lock.synchronize do
+			@@configuration ||= Configuration.new(defaults)
+		end
+	end
+
+	def configure
+		yield configuration
+	end
+
+  def self.eager_load!
+    # No autoloads
+  end
+
+	private
+
+	def defaults
+		{
+			worker: Newsletterable::Worker,
+			list_resolver: default_list_resolver
+		}
+	end
+
+	def default_list_resolver
+		proc do |subscriber, list_name, lists|
+			result = case lists
+			when String, Array
+				lists
+			when Hash
+				lists[list_name]
+			else
+				if lists.respond_to?(:call)
+					lists.call(subscriber)
+				end
+			end
+
+			Array.wrap(result)
+		end
+	end
+end

data/lib/newsletterable/configuration.rb

@@ -0,0 +1,12 @@
+module Newsletterable
+	class Configuration
+		attr_accessor :api_key, :default_lists, :subscriptions_model, :worker,
+			:list_resolver, :orm_adapter
+
+		def initialize(attrs = {})
+			attrs.each do |k, v|
+				send(:"#{k}=", v)
+			end
+		end
+	end
+end

data/lib/newsletterable/errors.rb

@@ -0,0 +1,3 @@
+module Newsletterable
+	class ConfigurationError < RuntimeError; end
+end

data/lib/newsletterable/model.rb

@@ -0,0 +1,67 @@
+module Newsletterable
+	module Model
+    extend ActiveSupport::Concern
+
+    included do
+			Newsletterable.configuration.subscriptions_model = self
+
+			define_newsletterable_state_methods(self)
+			define_newsletterable_callbacks(self)
+    end
+
+		def email
+			subscribable.nil? ? self.old_email : subscribable.email
+		end
+
+		def enqueue_subscription
+			worker = Newsletterable.configuration.worker
+			case worker
+			when Symbol, String
+				# Get worker from method in model
+				self.send(worker)
+			else
+				# Get worker from lambda function
+				if worker.respond_to?(:call)
+					worker.call(self.id)
+				# worker is already a Worker class, call perform_async
+				# TODO: should we require perform_async, make it configurable or make this an adapter
+				elsif worker.respond_to?(:perform_async)
+					worker.perform_async(self.id)
+				else
+					raise ConfigurationError, "config.worker is nil or invalid."
+				end
+			end
+		end
+
+		module ClassMethods
+			def define_newsletterable_callbacks(klass)
+				klass.class_eval do
+					opts =[:enqueue_subscription, {
+						if: proc { |n| !n.subscribed? },
+						on: [:create, :update]
+					}]
+
+					if respond_to?(:after_commit)
+						after_commit(*opts)
+					else
+						after_save(*opts)
+					end
+				end
+			end
+
+			def define_newsletterable_state_methods(klass)
+				%i{ pending subscribed unsubscribed out_of_date error }.each do |state|
+					klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+						def #{state}!
+							self.state = '#{state}'
+						end
+
+						def #{state}?
+							self.state.to_s == '#{state}'
+						end
+					RUBY
+				end
+			end
+		end
+	end
+end

data/lib/newsletterable/orm_adapters/active_model.rb

@@ -0,0 +1,21 @@
+module Newsletterable
+	module OrmAdapters
+		class ActiveModel < Adapter
+			def query_subscription(query, initialize = false)
+				scope = subscriptions_model.where(query)
+
+				if initialize
+					scope.first_or_initialize do |s|
+						s.pending!
+					end
+				else
+					scope.first
+				end
+			end
+
+			def save(record)
+				record.save!
+			end
+		end
+	end
+end

data/lib/newsletterable/orm_adapters/active_record.rb

@@ -0,0 +1,8 @@
+require 'newsletterable/orm_adapters/active_model'
+
+module Newsletterable
+	module OrmAdapters
+		class ActiveRecord < ActiveModel
+		end
+	end
+end

data/lib/newsletterable/orm_adapters/adapter.rb

@@ -0,0 +1,20 @@
+module Newsletterable
+	module OrmAdapters
+		class Adapter
+
+			def self.factory(name)
+				klass = "Newsletterable::OrmAdapters::#{name.to_s.camelize}"
+				unless (Module.const_get(klass).is_a?(Class) rescue false)
+					require "newsletterable/orm_adapters/#{name}"
+				end
+				klass.constantize.new
+			end
+
+			protected
+
+			def subscriptions_model
+				Newsletterable.configuration.subscriptions_model
+			end
+		end
+	end
+end

data/lib/newsletterable/orm_adapters/mongoid.rb

@@ -0,0 +1,22 @@
+require 'newsletterable/orm_adapters/active_model'
+
+module Newsletterable
+	module OrmAdapters
+		class Mongoid < ActiveModel
+			def query_subscription(query, initialize = true)
+				# Work around for https://github.com/mongoid/mongoid/issues/4101
+				if initialize && query[:subscribable]
+					subscribable = query.delete(:subscribable)
+					query[:subscribable_id] = subscribable.id
+					query[:subscribable_type] = subscribable.class.to_s
+				end
+
+				super(query, initialize)
+			end
+
+			def save(record)
+				record.with(safe: true).save!
+			end
+		end
+	end
+end

data/lib/newsletterable/railtie.rb

@@ -0,0 +1,17 @@
+require "rails"
+
+module MandrillQueue
+  class Railtie < Rails::Railtie # :nodoc:
+    config.eager_load_namespaces << Newsletterable
+
+    initializer "newsletterable.initialize" do |app|
+			Newsletterable.configure do |config|
+				if defined?(ActiveRecord)
+					config.orm_adapter = :active_record
+				elsif defined?(Mongoid)
+					config.orm_adapter = :mongoid
+				end
+			end
+    end
+  end
+end

data/lib/newsletterable/service.rb

@@ -0,0 +1,61 @@
+module Newsletterable
+	class Service
+		attr_reader :subscribable
+
+		def initialize(subscribable)
+			@subscribable = subscribable
+		end
+
+		def subscribe(lists)
+			lists.each do |list|
+				subscription = orm_adapter.query_subscription({
+					subscribable: subscribable,
+					list: list
+				}, true)
+
+				if subscription.unsubscribed? || subscription.error?
+					subscription.pending!
+				end
+
+				orm_adapter.save(subscription) unless subscription.subscribed?
+			end
+		end
+
+		def unsubscribe(lists)
+			lists.each do |list|
+				subscription = orm_adapter.query_subscription(
+					subscribable: subscribable,
+					list: list
+				)
+				unless subscription.nil?
+					subscription.old_email = subscribable.email
+					subscription.unsubscribed!
+					orm_adapter.save(subscription)
+				end
+			end
+		end
+
+		def update(lists, old_email)
+			lists.each do |list|
+				subscription = orm_adapter.query_subscription(
+					subscribable: subscribable,
+					list: list
+				)
+
+				if subscription.nil?
+					raise RuntimeError, "No subscription to update for subscribable #{subscribable.id}."
+				end
+
+				subscription.out_of_date!
+				subscription.old_email = old_email
+				orm_adapter.save(subscription)
+			end
+		end
+
+		private
+
+		def orm_adapter
+			@orm_adapter ||= OrmAdapters::Adapter.factory(Newsletterable.configuration.orm_adapter)
+		end
+	end
+end

data/lib/newsletterable/subscriber.rb

@@ -0,0 +1,84 @@
+module Newsletterable
+	module Subscriber
+		extend ActiveSupport::Concern
+
+		included do
+			class_eval %(
+				class << self; attr_accessor :__newsletterable_options; end
+			)
+		end
+
+		def subscription_service
+			@subscription_service ||= Service.new(self)
+		end
+
+		def manage_subscription(list_name)
+			field = field_for(list_name)
+			list_ids = resolve_list(list_name)
+
+			if send(field)
+				subscription_service.subscribe(list_ids)
+			else
+				subscription_service.unsubscribe(list_ids)
+			end
+		end
+
+		def resolve_list(list_name)
+			options = options_for(list_name)
+			lists = options[:lists] || Newsletterable.configuration.default_lists
+
+			resolver = options[:resolver] || Newsletterable.configuration.list_resolver
+
+			if resolver.is_a?(Symbol)
+				self.send(resolver, list_name, lists)
+			elsif resolver.respond_to?(:call)
+				resolver.call(self, list_name, lists)
+			else
+				raise ConfigurationError, 'Newsletterable resolver should be a Symbol or callable.'
+			end
+		end
+
+		def update_subscription(list_name)
+			old_email = email_was
+
+			yield
+
+			list_ids = resolve_list(list_name)
+			subscription_service.update(list_ids, old_email)
+		end
+
+		def remove_subscription(list_name)
+			list_ids = resolve_list(list_name)
+			subscription_service.unsubscribe(list_ids)
+		end
+
+		def options_for(list_name)
+			self.class.__newsletterable_options[list_name]
+		end
+
+		def field_for(list_name)
+			if options = options_for(list_name)
+				options[:field]
+			else
+				nil
+			end
+		end
+
+		module ClassMethods
+
+			def subscribe_on(list_name, options = {})
+				field = options[:field] || list_name
+
+				self.__newsletterable_options ||= {}
+				self.__newsletterable_options[list_name] = options.merge(field: field)
+
+				after_save     -> { manage_subscription(list_name) }, if: :"#{field}_changed?"
+				around_update  -> { update_subscription(list_name) }, if: -> { send(:"#{field}?") && email_changed? }
+				unless options[:unsubscribe_on_destroy]
+					before_destroy -> { remove_subscription(list_name) }, if: :"#{field}?"
+				end
+			end
+
+		end
+	end
+end

data/lib/newsletterable/version.rb

@@ -0,0 +1,3 @@
+module Newsletterable
+  VERSION = "0.0.1"
+end

data/lib/newsletterable/worker.rb

@@ -0,0 +1,74 @@
+require 'mailchimp'
+
+module Newsletterable
+	module Worker
+		extend ActiveSupport::Concern
+
+		def perform(subscription_id)
+			@subscription = orm_adapter.query_subscription(id: subscription_id)
+
+			if @subscription.nil?
+				logger.warn "No subscription with id #{subscription_id} exists. Ignoring."
+			else
+				process
+			end
+		end
+
+		def process
+			logger.info "Processing mailing list subscription for #{@subscription.email}..."
+			logger.debug "Status: [#{@subscription.state}]"
+
+			case @subscription.state.to_sym
+			when :pending || :error
+				logger.info "Subscribing #{@subscription.email} to '#{@subscription.list}' list"
+				logger.info "Trying to subscribe after previous error!" if @subscription.error?
+				add(@subscription)
+				@subscription.subscribed!
+				@subscription.save!
+			when :unsubscribed
+				logger.info "Unsubscribing #{@subscription.email} from '#{@subscription.list}' list"
+				remove(@subscription)
+				@subscription.destroy!
+			when :out_of_date
+				logger.info "Updating subscription for #{@subscription.email}"
+				update(@subscription)
+				@subscription.old_email = nil
+				@subscription.subscribed!
+				@subscription.save!
+			end
+
+		rescue Mailchimp::Error => ex
+			logger.error "#{@subscription.email}: #{ex.message || 'Unknown error.'}"
+			@subscription.error!
+			@subscription.save
+			raise
+		end
+
+		private
+
+		def orm_adapter
+			@orm_adapter ||= OrmAdapters::Adapter.factory(Newsletterable.configuration.orm_adapter)
+		end
+
+		def mailchimp
+      @mailchimp_api ||= Mailchimp::API.new(Newsletterable.configuration.api_key)
+		end
+
+		def add(subscription)
+			mailchimp.lists.subscribe(subscription.list, { email: subscription.email }, {}, 'html', false)
+		rescue Mailchimp::ListAlreadySubscribedError
+			logger.warn "#{subscription.email} already subscribed to '#{subscription.list}'."
+		end
+
+		def remove(subscription)
+			mailchimp.lists.unsubscribe(subscription.list, { email: subscription.email })
+		rescue Mailchimp::ListNotSubscribedError
+			logger.warn "#{subscription.email} is not subscribed to '#{subscription.list}'."
+		end
+
+		def update(subscription)
+			raise UpdateError, "old_email required to update subscription for subscription #{subscription.id}." if subscription.old_email.nil?
+			mailchimp.lists.subscribe(subscription.list, { email: subscription.old_email }, { 'new-email' => subscription.email }, 'html', true, true)
+		end
+	end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: newsletterable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stan Bondi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: mailchimp-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stan@fixate.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/newsletterable.rb
+- lib/newsletterable/configuration.rb
+- lib/newsletterable/errors.rb
+- lib/newsletterable/model.rb
+- lib/newsletterable/orm_adapters/active_model.rb
+- lib/newsletterable/orm_adapters/active_record.rb
+- lib/newsletterable/orm_adapters/adapter.rb
+- lib/newsletterable/orm_adapters/mongoid.rb
+- lib/newsletterable/railtie.rb
+- lib/newsletterable/service.rb
+- lib/newsletterable/subscriber.rb
+- lib/newsletterable/version.rb
+- lib/newsletterable/worker.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Keep mailing list subscriptions in sync with your models
+test_files: []