mandrill_queue 0.1.1

data/lib/mandrill_queue/message.rb

@@ -0,0 +1,140 @@
+require 'mandrill_queue/worker'
+require 'mandrill_queue/variables'
+require 'mandrill_queue/errors'
+require 'mandrill_queue/message/recipients'
+require 'mandrill_queue/message/recipient/metadata'
+require 'mandrill_queue/message/merge_vars'
+require 'mandrill_queue/message/attachments'
+require 'mandrill_queue/message/images'
+
+module MandrillQueue
+	module Message
+		class Internal
+			Variables::DSL.include_as(self, :global_merge_vars)
+			Variables::DSL.include_as(self, :metadata)
+
+			include Recipients::DSL
+			include MergeVars::DSL
+			include RecipientMetadata::DSL
+			include Attachments::DSL
+			include Images::DSL
+
+			ACCESSORS = [
+				:html, :text, :from_email, :from_name, :subject,
+				:headers, :important, :track_opens, :track_clicks, :auto_text, :auto_html,
+				:inline_css, :url_strip_qs, :preserve_recipients, :view_content_link,
+				:bcc_address, :tracking_domain, :signing_domain, :return_path_domain,
+				:merge, :tags, :subaccount, :google_analytics_domain,
+				:google_analytics_campaign
+			]
+
+			EXTERNAL_ACCESSORS = [
+				:global_merge_vars, :merge_vars, :recipient_metadata,
+				:metadata, :attachments, :images
+			]
+
+			def initialize(values = nil)
+				set!(values) unless values.nil?
+			end
+
+			ACCESSORS.each do |method|
+				define_method method do |*args|
+					var_sym = "@#{method}".to_sym
+					if args.count > 0
+						instance_variable_set(var_sym, args.first)
+						args.first
+					else
+						instance_variable_get(var_sym)
+					end
+				end
+			end
+
+			alias_method :dsl, :instance_eval
+
+			def nillify!
+				transform_accessors! { |k| nil }
+
+				EXTERNAL_ACCESSORS.each do |key|
+					instance_variable_set("@_#{key}", nil)
+				end
+
+				@_recipients = nil
+				self
+			end
+
+			def set!(values)
+				nillify!
+				values.symbolize_keys!
+				transform_accessors! { |k| values[k] }
+
+				EXTERNAL_ACCESSORS.each do |key|
+					send(key).set!(values[key]) unless values[key].nil?
+				end
+
+				[:to, :cc, :bcc].each do |key|
+					recipients.set!(values[key], key) if values[key]
+				end
+			end
+
+			def content_message?
+				!html.blank? || !text.blank?
+			end
+
+			def validate(errors)
+				errors.push([:message, "Please specify at least one recipient."]) if to.empty?
+
+				EXTERNAL_ACCESSORS.each do |key|
+					sym = "@_#{key}"
+					val = instance_variable_get(sym)
+					val.validate(errors) unless val.nil? || !val.respond_to?(:validate)
+				end
+
+				recipients.validate(errors)
+			end
+
+			def load_attachments!
+				@_attachments.load_all unless @_attachments.nil?
+				@_images.load_all unless @_images.nil?
+				self
+			end
+
+			def to_json(options = {})
+				to_hash(options).to_json
+			end
+
+			def to_hash(options = {})
+				hash = {}
+				hash[:to] = recipients.to_a(options) if @_recipients
+
+				ACCESSORS.each do |key|
+					value = instance_variable_get("@#{key}")
+					next if value.nil? && !options[:include_nils]
+					hash[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+				end
+
+				EXTERNAL_ACCESSORS.each do |key|
+					sym = "@_#{key}".to_sym
+					var = instance_variable_get(sym)
+					if options[:include_nils] || !var.nil?
+						if var.is_a?(Variables::Internal)
+							hash[key] = var.to_key_value_array(options)
+						else
+							hash[key] = (var.to_hash(options) rescue var.to_a(options) rescue var)
+						end
+					end
+				end
+
+				hash
+			end
+
+			protected
+
+			def transform_accessors!
+				ACCESSORS.each do |key|
+					sym = "@#{key}".to_sym
+					instance_variable_set(sym, yield(key))
+				end
+			end
+		end
+	end
+end

data/lib/mandrill_queue/railtie.rb

@@ -0,0 +1,20 @@
+require "rails"
+require "abstract_controller/railties/routes_helpers"
+
+module MandrillQueue
+  class Railtie < Rails::Railtie # :nodoc:
+    config.eager_load_namespaces << MandrillQueue
+
+    initializer "mandrill_queue.initialize" do |app|
+      ActiveSupport.on_load(:mandrill_queue) do
+        include AbstractController::UrlFor
+        extend ::AbstractController::Railties::RoutesHelpers.with(app.routes)
+        include app.routes.mounted_helpers
+
+				unless app.routes.default_url_options.has_key?(:host)
+					app.routes.default_url_options = app.config.action_mailer.default_url_options
+				end
+      end
+    end
+  end
+end

data/lib/mandrill_queue/variables.rb

@@ -0,0 +1,99 @@
+module MandrillQueue
+	module Variables
+		# Define DSL for inclusion in remote classes
+		module DSL
+			def self.include_as(base, name)
+				base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+				def #{name}(values = nil, &block)
+					@_#{name} ||= Variables::Internal.new
+					@_#{name}.merge!(values) if values.is_a?(Hash)
+					@_#{name}.dsl(&block) if block_given?
+					block_given? ? self : @_#{name}
+				end
+				RUBY
+			end
+
+			def self.included(base)
+				include_as(base, :variables)
+			end
+		end
+
+		class Internal
+			def initialize(values = nil, &block)
+				@_variables = values if values.is_a?(Hash)
+				@_variables ||= {}
+				dsl(&block) if block_given?
+			end
+
+			alias_method :dsl, :instance_exec
+
+			def respond_to?(method)
+				super || @_variables.has_key?(method)
+			end
+
+			def to_hash(options = {})
+				if options.has_key?(:include_nils) && options[:include_nils]
+					@_variables
+				else
+					@_variables.reject { |k, v| v.nil? }
+				end
+			end
+
+			def to_key_value_array(options = {})
+				options[:name_key] ||= :name
+				options[:content_key] ||= :content
+
+				result = []
+				@_variables.each do |k, v|
+					if !v.nil? || options[:include_nils]
+						result.push({options[:name_key] => k.to_s, options[:content_key] => v})
+					end
+				end unless @_variables.nil?
+				result
+			end
+
+			def [](key)
+				@_variables[key]
+			end
+
+			def []=(key, value)
+				@_variables[key.to_sym] = value
+			end
+
+			def set!(hash, options = {})
+				case hash
+				when Hash
+					@_variables = hash.symbolize_keys
+				when Array
+					options[:name_key] ||= :name
+					options[:content_key] ||= :content
+					@_variables = {}
+					hash.dup.each do |obj|
+						obj.symbolize_keys!
+						@_variables[obj[options[:name_key]].to_sym] = obj[options[:content_key]]
+					end
+				end
+				self
+			end
+
+			def merge!(hash)
+				@_variables.merge!(hash)
+			end
+
+			def method_missing(method, *args, &block)
+				if method.to_s.end_with?('=')
+					method = method.to_s.chomp('=').to_sym
+				end
+
+				if args.count > 0
+					@_variables[method] = args.first
+					self
+				else
+					raise VariableNotSetError, "#{method} has not been set." \
+						unless @_variables.has_key?(method)
+					@_variables[method]
+				end
+			end
+		end
+	end
+end

data/lib/mandrill_queue/version.rb

@@ -0,0 +1,3 @@
+module MandrillQueue
+	VERSION = '0.1.1'
+end

data/lib/mandrill_queue/worker/hooks.rb

@@ -0,0 +1,21 @@
+require 'pp'
+require 'stringio'
+require 'mandrill_queue/logging'
+
+module MandrillQueue
+	module Hooks
+		extend Logging
+
+		def on_failure_logging(error, message)
+			s = StringIO.new
+			PP.pp(message, s)
+			s.rewind
+			logging.error <<-TXT.strip
+			#{'=' * 50}
+			An exception has occurred for the following message:\n#{pretty(message)}
+			TXT
+			logging.error(error)
+			logging.error('=' * 50)
+		end
+	end
+end

data/lib/mandrill_queue/worker.rb

@@ -0,0 +1,46 @@
+require 'mandrill_queue/mailer'
+require 'mandrill_queue/worker/hooks'
+require 'mandrill_queue/mandrill_api'
+require 'mandrill_queue/logging'
+
+module MandrillQueue
+	class Worker
+		include MandrillApi
+		extend Logging
+		extend Hooks
+
+		def ip_pool
+			"Default Pool"
+		end
+
+		def perform(data)
+			@_mailer = Mailer.new(data)
+			self.class.logging.debug("Got mailer data: #{self.class.pretty(@_mailer.to_hash)}")
+
+			message = @_mailer.message.load_attachments!.to_hash
+			template = @_mailer.template
+			send_at = @_mailer.send_at
+
+			if template.nil?
+				mandrill.messages.send(message, false, ip_pool, send_at)
+			else
+				content = @_mailer.content.to_key_value_array
+				mandrill.messages.send_template(template, content, message, ip_pool, send_at)
+			end
+		end
+
+		def self.perform(*args)
+			result = new.perform(*args)
+		rescue Mandrill::Error => e
+			logging.error("A mandrill error occurred: #{e.class} - #{e.message}")
+			raise
+		else
+			if !result.empty?
+				log_results(result)
+			else
+				logging.error("No messages sent!")
+			end
+		end
+
+	end
+end

data/lib/mandrill_queue.rb

@@ -0,0 +1,52 @@
+require 'mandrill_queue/railtie' if defined?(Rails)
+require 'mandrill_queue/core_ext'
+require 'mandrill_queue/configuration'
+require 'mandrill_queue/mailer'
+
+module MandrillQueue
+	def self.configuration
+		@configuration ||= Configuration.new(defaults)
+	end
+
+	def self.configure
+		yield configuration
+		self
+	end
+
+	def self.defaults
+		{
+			message_defaults: {}
+		}
+	end
+
+	def self.resque
+		configuration.resque || ::Resque
+	end
+
+	# TODO: Support worker adapters
+	# def self.load_adapter(adapter)
+	#   require "mandrill_queue/adapters/#{adapter}"
+	#   "#{adapter.camelize}Adapter".constantize.new
+	# end
+
+	# def self.adapter
+	#   @_adapter ||= begin
+	#     unless adapter = configuration.adapter
+	#       adapter = :resque if defined(::Resque)
+	#       adapter = :sidekiq if defined(::Sidekiq)
+	#       if adapter.nil?
+	#         raise RuntimeError, <<-TXT.strip.tr("\t", '')
+	#           Worker adapter was not configured and cannot be determined.
+	#           Please include a worker gem in your Gemfile. Resque and Sidekiq are supported.
+	#         TXT
+	#       end
+	#     end
+	#     load_adapter(adapter)
+	#   end
+	# end
+
+	def self.reset_config(&block)
+		@configuration = nil
+		configure(&block) if block_given?
+	end
+end

data/lib/rails/generators/mandrill_queue/initializer_generator.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module MandrillQueue
+	module Generators
+		class InitializerGenerator < Rails::Generators::Base
+			source_root File.expand_path('../templates', __FILE__)
+
+			desc "Creates a default MandrillQueue initializer."
+			def create_initializer_file
+				copy_file 'initializer.rb', "config/initializers/mandrill_queue.rb"
+			end
+		end
+	end
+end

data/lib/rails/generators/mandrill_queue/templates/initializer.rb

@@ -0,0 +1,36 @@
+MandrillQueue.configure do |config|
+	# Your Mandrill API key
+	# Only needed for the worker, so leave out if you run your worker
+	# externally to Rails.
+	# config.api_key = 'xxxxxx'
+
+	# Message defaults.
+	# A hash of application-wide default values for messages.
+	# These can be overriden by class level defaults and by method
+	# level defaults.
+	# e.g.
+	# {
+	#		from_email: 'no-reply@example.com',
+	#		preserve_recipients: false,
+	#		global_merge_vars: {
+	#			application_name: 'My super app!'
+	#		}
+	# }
+	# config.message_defaults = {}
+
+	# MandrillQueue will call enqueue on this instead of Resque
+	# config.resque = MyOwnResque
+
+	# Allows you to use your own worker for processing the mandrill
+	# queue. This can be overriden at the class level.
+	# config.default_worker_class = MyWorker
+
+	# Allows you to override the queue name used to enqueue
+	# to resque. This can be overriden at the class level
+	# Defaults to :mailer
+	# config.default_queue = :another_queue
+
+	# Used to set the current logger. This can be any object
+	# that responds to debug, info, warn, error and fatal
+	# config.logger = MyLoggingClass
+end

data/lib/rails/generators/mandrill_queue/templates/worker/worker.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.expand_path('../', __FILE__))
+# Generated by MandrillQueue gem
+# Use this to have a light weight resque worker (no rails environment)
+# which can be run as follows:
+# QUEUES=mailer rake resque:work -r ./worker.rb
+
+require 'bundler/setup'
+
+require 'resque'
+require 'resque/tasks'
+require 'mono_logger' # or log4r or rails logger
+
+# Require the class that actually does the work
+require 'mandrill_queue/worker'
+
+# You can load your rails initializer here:
+# require 'config/initializer/mandrill_queue.rb
+# or configure only what you need for the worker:
+MandrillQueue.configure do |config|
+	config.api_key = ''# TODO: Mandrill api key
+
+	config.logger = MonoLogger.new(STDOUT) # or log4r or Logger or ...
+end

data/lib/rails/generators/mandrill_queue/worker_generator.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module MandrillQueue
+	module Generators
+		class WorkerGenerator < Rails::Generators::Base
+			source_root File.expand_path('../templates', __FILE__)
+
+			desc "Creates an default worker entrypoint for rake resque:work -r ./worker.rb"
+			def create_worker_file
+				copy_file 'worker.rb', "./worker.rb"
+
+				puts 'Worker created! You can run it with the following command:'
+				puts 'cd worker; QUEUES=mailer rake resque:work -r ./worker.rb'
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: mandrill_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Stan Bondi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: mandrill-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.49
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.49
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use MailChimps Mandrill to send mailers through a background worker queue.
+email:
+- stan@fixate.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mandrill_queue.rb
+- lib/rails/generators/mandrill_queue/worker_generator.rb
+- lib/rails/generators/mandrill_queue/initializer_generator.rb
+- lib/rails/generators/mandrill_queue/templates/initializer.rb
+- lib/rails/generators/mandrill_queue/templates/worker/worker.rb
+- lib/mandrill_queue/mailer.rb
+- lib/mandrill_queue/worker.rb
+- lib/mandrill_queue/version.rb
+- lib/mandrill_queue/core_ext.rb
+- lib/mandrill_queue/errors.rb
+- lib/mandrill_queue/variables.rb
+- lib/mandrill_queue/logging.rb
+- lib/mandrill_queue/railtie.rb
+- lib/mandrill_queue/message/recipient/helpers.rb
+- lib/mandrill_queue/message/recipient/metadata.rb
+- lib/mandrill_queue/message/recipient/variable.rb
+- lib/mandrill_queue/message/recipient/data.rb
+- lib/mandrill_queue/message/attachments.rb
+- lib/mandrill_queue/message/merge_vars.rb
+- lib/mandrill_queue/message/images.rb
+- lib/mandrill_queue/message/recipients.rb
+- lib/mandrill_queue/mandrill_api.rb
+- lib/mandrill_queue/worker/hooks.rb
+- lib/mandrill_queue/configuration.rb
+- lib/mandrill_queue/array_metadata.rb
+- lib/mandrill_queue/message.rb
+- Rakefile
+- README.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+homepage: https://github.com/fixate/mandrill_queue/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use MailChimps Mandrill to send mailers through a background worker queue.
+test_files: []