idlemailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3ef0ca694fb5628659b30090fbaec75f6da934b
+  data.tar.gz: fe37ada9cca45b12ec8f7f0f98fe3fbf090209c8
+SHA512:
+  metadata.gz: 4f090285bb04f67482db2dc1a29a03612f6deb46cf40c597358ff90333074c2418578f79c0cb347117bee2bba7c0e0dae2e8e599f4d18b21f0ffdcb371a4dd3e
+  data.tar.gz: b8edf7286d8a143955dcf288aeb34e06a7a48e8dc87c773d036146a657ab0d9751cb1f3008c71ae51011f8bd879d3fc384e979107aaa4d47beac51f418eef01c

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jordan Hollinger
+
+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,83 @@
+# IdleMailer
+
+A lightweight alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
+
+## Installation
+
+    $ [sudo] gem install idlemailer
+    # Or add "idlemailer" to your Gemfile
+
+## Use
+
+IdleMailer is all about providing mailer classes and templates. But [the mail gem](http://www.rubydoc.info/gems/mail) has a great API, so you have unfettered access to it in your mailers through the "mail" object.
+
+    # Define your mailer class
+    class WidgetMailer
+      include IdleMailer::Mailer
+
+      def initialize(user, widget)
+        mail.to = user.email
+        mail.subject = "Widget #{widget.sku}"
+        @widget = widget
+      end
+    end
+
+    # Create widget.html.erb and/or widget.text.erb templates.
+    # They'll have access to instance variables like @widget above.
+
+    # Send your mail
+    mailer = WidgetMailer.new(current_user, widget)
+    mailer.deliver
+
+## Configure
+
+These are the default options. Salt to taste.
+
+    IdleMailer.config do |config|
+      # Directory containing the mailer templates
+      config.templates = Pathname.new(Dir.getwd).join('templates')
+
+      # Name of the layout template. Here, the file(s) would be named
+      # mailer_layout.html.erb and/or mailer_layout.text.erb.
+      config.layout = 'mailer_layout'
+
+      # Email delivery method (mail gem). Set to :test when testing or when developing locally
+      config.delivery_method = :smtp
+
+      # Delivery options (mail gem)
+      config.delivery_options = {
+        user_name: ENV['MAIL_USER'],
+        password: ENV['MAIL_PASSWORD'],
+        domain: ENV['MAIL_DOMAIN'],
+        address: ENV['MAIL_ADDRESS'],
+        port: ENV['MAIL_PORT'] || 587,
+        authentication: ENV['MAIL_AUTHENTICATION'] || 'plain',
+        enable_starttls_auto: (ENV['MAIL_TLS'] ? true : false)
+      }
+
+      # Default "from" address for all mailers
+      config.default_from = nil
+
+      # Write all deliveries to $stdout
+      config.log = false
+    end
+
+## Testing
+
+Put the mailer in testing mode:
+
+    IdleMailer.config do |config|
+      config.delivery_method = :test
+    end
+
+Then use mail gem's built in testing helpers in your specs:
+
+    sent = Mail::TestMailer.deliveries.any? { |mail| mail.to.include? @user.email }
+
+## License
+
+MIT License. See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2015 Jordan Hollinger

data/lib/idlemailer/config.rb

@@ -0,0 +1,17 @@
+module IdleMailer
+  # Struct for holding IdleMailer config
+  #   templates A Pathname object pointing to the mail templates directory (defaults to ./templates)
+  #   layout Name of layout file, minus extention (defaults to mailer_layout)
+  #   delivery_method Symbol like :smtp or :test (see the mail gem for all options)
+  #   delivery_options Hash of delivery options (see the mail gem for all options)
+  #   default_from Default "from" address if it's left blank
+  #   log When true, writes delivered messages to $stdout (default false)
+  Config = Struct.new(:templates, :layout, :delivery_method, :delivery_options, :default_from, :log)
+  @config = Config.new
+
+  # Takes a block and hands it an IdleMailer::Config object
+  def self.config
+    yield @config if block_given?
+    @config
+  end
+end

data/lib/idlemailer/defaults.rb

@@ -0,0 +1,16 @@
+IdleMailer.config do |config|
+  config.templates = Pathname.new(Dir.getwd).join('templates')
+  config.layout = 'mailer_layout'
+  config.delivery_method = :smtp
+  config.delivery_options = {
+    user_name: ENV['MAIL_USER'],
+    password: ENV['MAIL_PASSWORD'],
+    domain: ENV['MAIL_DOMAIN'],
+    address: ENV['MAIL_ADDRESS'],
+    port: ENV['MAIL_PORT'] || 587,
+    authentication: ENV['MAIL_AUTHENTICATION'] || 'plain',
+    enable_starttls_auto: (ENV['MAIL_TLS'] ? true : false)
+  }
+  config.default_from = nil
+  config.log = false
+end

data/lib/idlemailer/mailer.rb

@@ -0,0 +1,39 @@
+module IdleMailer
+  # Module to include in your mailer classes. Example:
+  #
+  #  class WidgetMailer
+  #    include IdleMailer::Mailer
+  #
+  #    def initialize(address, widget)
+  #      mail.to = address
+  #      mail.subject = "Widget #{widget.sku}"
+  #      # See mail gem docs for more options - http://www.rubydoc.info/gems/mail
+  #      @widget = widget
+  #    end
+  #  end
+  #
+  #  # Name your templates "widget.html.erb" and "widget.text.erb". They'll have access to "@widget".
+  #
+  #  mailer = WidgetMailer.new(current_user.email, widget)
+  #  mailer.deliver
+  #
+  module Mailer
+    # Deliver mail
+    def deliver
+      mailer = IdleMailer::Message.new(mail, self)
+      mailer.deliver!
+    end
+
+    # Render an ERB template with the mailer's binding
+    def render(template)
+      template.result(binding { yield })
+    end
+
+    private
+
+    # Mail config object
+    def mail
+      @mail ||= Mail.new
+    end
+  end
+end

data/lib/idlemailer/message.rb

@@ -0,0 +1,71 @@
+module IdleMailer
+  # Renders templates and delivers message
+  class Message
+    # Mail object to deliver
+    attr_reader :mail
+    # The IdleMailer::Mailer object
+    attr_reader :mailer
+
+    # Initialize a new message
+    def initialize(mail, mailer)
+      @mail = mail
+      @mailer = mailer
+    end
+
+    # Deliver mail
+    def deliver!
+      log_to_stdout if IdleMailer.config.log
+      mail.from IdleMailer.config.default_from if mail.from.nil?
+      if has_template? 'html'
+        html_body = layout('html') { body('html') }
+        mail.html_part do
+          content_type 'text/html; charset=UTF-8'
+          body html_body
+        end
+      end
+      if has_template? 'text'
+        text_body = layout('text') { body('text') }
+        mail.text_part { body text_body }
+      end
+      mail.delivery_method IdleMailer.config.delivery_method, IdleMailer.config.delivery_options
+      mail.deliver
+    end
+
+    private
+
+    def body(type)
+      render template_path(template_name, type)
+    end
+
+    def layout(type)
+      has_layout?(type) ? render(template_path(IdleMailer.config.layout, type)) { yield } : yield
+    end
+
+    def render(path)
+      mailer.render(ERB.new(File.read(path))) { yield }
+    end
+
+    def has_template?(type)
+      File.exists? template_path(template_name, type)
+    end
+
+    def has_layout?(type)
+      File.exists? template_path(IdleMailer.config.layout, type)
+    end
+
+    def template_name
+      @name ||= mailer.class.name.sub(/Mailer$/, '').gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase
+    end
+
+    def template_path(name, type)
+      IdleMailer.config.templates.join("#{name}.#{type}.erb")
+    end
+
+    def log_to_stdout
+      $stdout.puts [mail.to, mail.cc, mail.bcc].flatten.compact.join('; ')
+      $stdout.puts mail.subject
+      $stdout.puts(layout('html') { body('html') }) if has_template? 'html'
+      $stdout.puts(layout('text') { body('text') }) if has_template? 'text'
+    end
+  end
+end

data/lib/idlemailer/version.rb

@@ -0,0 +1,5 @@
+# IdleMailer module
+module IdleMailer
+  # Version number
+  VERSION = '0.0.1'
+end

data/lib/idlemailer.rb

@@ -0,0 +1,8 @@
+require 'erb'
+require 'pathname'
+require 'mail'
+require 'idlemailer/config'
+require 'idlemailer/defaults'
+require 'idlemailer/message'
+require 'idlemailer/mailer'
+require 'idlemailer/version'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: idlemailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Hollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides non-Rails projects with a lightweight ActionMailer-like wrapper
+  around the mail gem
+email: jordan@jordanhollinger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/idlemailer.rb
+- lib/idlemailer/config.rb
+- lib/idlemailer/defaults.rb
+- lib/idlemailer/mailer.rb
+- lib/idlemailer/message.rb
+- lib/idlemailer/version.rb
+homepage: https://github.com/jhollinger/idlemailer
+licenses: []
+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: A lightweight alternative to ActionMailer
+test_files: []