roda-mailer_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dd5819628c0cdd98aa1ba6d494d0703afddb332
+  data.tar.gz: bc0d720572692281273cbf4d21f447f83b47fdfb
+SHA512:
+  metadata.gz: d53cedf87191c1163e78ce3af26a77728f6d86492ca913d6c9e956de6f9bb7faa948167fbd3c92e2646a1b507561cab80e05071de046cc29041864e5063b1295
+  data.tar.gz: c2d7424846f6c6570cb13743abf942059eb2378efd347c1feb657406a840bfadba0668c0225999cc5f7d2e1bf388176e1bb7fd0796fc7eebfff9ce31ac047fa9

data/README.md

@@ -0,0 +1,48 @@
+# Roda Mailer Extensions
+
+A few helpful extensions to the Roda mailer plugin.
+
+## Installation
+
+Add this line ot your application's Gemfile:
+
+```ruby
+gem "roda-mailer_ext"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roda-mailer_ext
+
+## Usage
+
+Simply configure this plugin as you would any other plugin. Without any options,
+the plugin is a no-op. You will want to use the `log` or `prevent_delivery` options
+to make the plugin useful.
+
+I like to pair this plugin with the [environments](http://roda.jeremyevans.net/rdoc/classes/Roda/RodaPlugins/Environments.html)
+plugin to configure depending on current `RACK_ENV`.
+
+    plugin :environments
+    plugin :mailer_ext,
+      log: (development? or production?),
+      prevent_delivery: !production?
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/roda-mailer_ext.
+
+I love pull requests! If you fork this project and modify it, please ping me to see
+if your changes can be incorporated back into this project.
+
+That said, if your feature idea is nontrivial, you should probably open an issue to
+[discuss it](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)
+before attempting a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "rake/testtask"
+require "rdoc/task"
+require "rubygems/tasks"
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+  t.verbose = true
+end
+
+Gem::Tasks.new
+
+task default: :test

data/lib/roda/plugins/mailer_ext.rb

@@ -0,0 +1,66 @@
+# frozen-string-literal: true
+
+require "roda"
+
+module Roda::RodaPlugins # :nodoc:
+  # The mailer_ext plugin extends the mailer plugin with enhanced logging and
+  # configuration options.
+  #
+  #   plugin :mailer_ext, log: (ENV["RACK_ENV"] != "test"),
+  #                       prevent_delivery: (ENV["RACK_ENV"] != "production")
+  #
+  # = Plugin Options
+  #
+  # The following plugin options are supported:
+  #
+  # :log :: Output the body of the email to STDOUT before delivery
+  # :prevent_delivery :: Uses the +Mail+ test mailer instead of actually
+  #                      attempting the delivery to a SMTP server.
+  #
+  # = Testing
+  #
+  # With +:prevent_delivery+ set to true, any outgoing emails are stored inside
+  # the +Mail+ test mailer. You can access these during your tests.
+  #
+  #   refute_empty Mail::TestMailer.deliveries
+  module MailerExt
+    module ResponseMethods # :nodoc:
+      def finish
+        value = super
+
+        _log_mail(value) if _should_log_mail(value)
+
+        value
+      end
+
+      def _log_mail(message)
+        puts <<~EOM
+
+        ==> Sending email to #{message.to.join(", ")}
+        #{message}
+
+        EOM
+      end
+
+      def _should_log_mail(value)
+        value.is_a?(Mail::Message) && roda_class.opts[:mailer_ext][:log]
+      end
+    end
+
+    def self.load_dependencies(app, opts = {}) # :nodoc:
+      app.plugin :mailer
+    end
+
+    def self.configure(app, opts = {}) # :nodoc:
+      app.opts[:mailer_ext] = { log: false, prevent_delivery: false }.merge(opts).freeze
+
+      if app.opts[:mailer_ext][:prevent_delivery]
+        Mail.defaults do
+          delivery_method :test
+        end
+      end
+    end
+  end
+
+  register_plugin :mailer_ext, MailerExt
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: roda-mailer_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  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'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: |2
+    This plugin adds some extensions to the Roda mailer plugin, specifically the ability
+    to log outgoing emails, or to prevent actual delivery.
+email: adam@mediadrive.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/roda/plugins/mailer_ext.rb
+homepage: https://github.com/adam12/roda-mailer_ext
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A few helpful extensions to the Roda mailer plugin
+test_files: []