thincloud-postmark 0.2.0 → 0.3.0

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle
@@ -6,6 +7,7 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
+bin
 coverage
 doc/
 lib/bundler/man
@@ -15,3 +17,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -2,8 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
 group :test do
   platforms :ruby do
     gem "simplecov"
+    gem "sqlite3"
   end
 end

data/README.md

@@ -2,7 +2,12 @@
 
 ## Description
 
-[Postmark](http://postmarkapp.com) configuration for Rails apps.
+Rails Engine to provide [Postmark](http://postmarkapp.com) configuration for Thincloud applications.
+
+The Thincloud::Postmark engine:
+
+* Manages all of the `Postmark` dependencies for your application
+* Optionally registers a `Mail` interceptor
 
 ## Requirements
 
@@ -23,11 +28,7 @@ Add this line to your application's Gemfile:
 gem "thincloud-postmark"
 ```
 
-And then execute:
-
-```
-$ bundle
-```
+* Run `bundle`
 
 Or install it yourself as:
 
@@ -37,12 +38,114 @@ $ gem install thincloud-postmark
 
 ## Usage
 
-This gem adds a generator to Rails, `thincloud:postmark`. Running the generator will install a mail interceptor for non-production environments and a configuration initializer in `config/initializers/thincloud_postmark.rb` where your API key or environment variable can be defined.
+### Configuration
+
+Thincloud::Postmark configuration options are available to customize the engine behavior. Available options and their default values:
+
+```ruby
+api_key                   = "POSTMARK_API_TEST"
+interceptor_to            = nil
+interceptor_cc            = nil
+interceptor_bcc           = nil
+
+# Rails environment(s) as a symbol that should have mail intercepted
+interceptor_environments  = []
+```
+
+_Note: Don't forget to set the `default_url_options`_
+
+```ruby
+config.action_mailer.default_url_options = { host: "mydomain.com" }
+```
+
+#### Environment Variables
+
+Several of the options will use environment variables when found.
+
+```
+api_key         -> ENV["POSTMARK_API_KEY"]
+secure          -> ENV["POSTMARK_SECURE"]
+interceptor_to  -> ENV["THINCLOUD_INTERCEPTOR_TO"]
+interceptor_cc  -> ENV["THINCLOUD_INTERCEPTOR_CC"]
+interceptor_bcc -> ENV["THINCLOUD_INTERCEPTOR_BCC"]
+```
+
+#### Configuration Block
+
+The `Thincloud::Postmark` module accepts a `configure` block that takes the same options listed above. This block can be put into an initializer or inside of a `config\environments` file.
 
-* Invoke the generator:
+```ruby
+Thincloud::Postmark do |config|
+  config.api_key        = "MY_API_KEY"
+  config.secure         = true
+  config.interceptor_to = "keymaster@zuul.com"
+  config.interceptor_cc = "gatekeeper@zuul.com"
+  config.interceptor_environments = [:test, :development]
+  # ...
+end
+```
+
+#### Rails Configuration
+
+You can also access the configuration via the Rails configuration object. In fact, the engine uses the Rails config as storage when the block syntax is used. The `Thincloud::Postmark::Configuration` object is made available under `config.thincloud.postmark`. You can access this configuration in `config/application.rb` or in your `config/environments` files.
 
+```ruby
+#...
+config.thincloud.postmark.api_key = "MY_API_KEY"
+config.thincloud.postmark.secure  = false
+config.thincloud.postmark.interceptor_environments = [:staging]
+#...
 ```
-$ rails generate thincloud:postmark
+
+_Note: Configuration values take precendence over environment variables._
+
+#### Default Interceptor
+
+The default interceptor is registered for environments included in the `interceptor_environments` array. It replaces the recipients with those contained in the configuration and replaces the subject of outgoing email with the original `to` combined with the original `subject`.
+
+```ruby
+class Thincloud::Postmark::Interceptor
+  # ...
+  def self.delivering_email(message)
+    message.subject = "#{message.to} #{message.subject}"
+    message.to      = self.to
+    message.cc      = self.cc
+    message.bcc     = self.bcc
+    message
+  end
+end
+```
+
+#### Overriding the Interceptor
+
+You may find that the default Interceptor does not meet your requirements. In that case you can easily create your own and prevent the default from being registered.
+
+* Disable the default interceptor
+
+```ruby
+interceptor_environments = []
+```
+
+* Create your interceptor
+
+```ruby
+# Public: Mail Interceptor to use when overriding defaults
+class MailInterceptor
+  def self.delivering_email(message)
+    message.subject = "#{message.to} #{message.subject}"
+    message.to      = "#{ENV["USER"]}@localhost"
+    message.cc      = nil
+    message.bcc     = nil
+  end
+end
+```
+
+* Register your interceptor in an initializer
+
+```ruby
+require "mail_interceptor"
+
+Mail.register_interceptor(MailInterceptor) unless Rails.env.production?
 ```
 
 ## Contributing
@@ -56,7 +159,6 @@ $ rails generate thincloud:postmark
 
 ## License
 
-* Freely distributable and licensed under the MIT-style license. See LICENSE file for details.
-* Copyright (c) 2012 New Leaders
+* Freely distributable and licensed under the [MIT license](http://newleaders.mit-license.org/2012/license.html).
+* Copyright (c) 2012 New Leaders ([opensource@newleaders.com](opensource@newleaders.com))
 * [https://newleaders.com](https://newleaders.com)
-

data/lib/thincloud/postmark/configuration.rb

@@ -6,15 +6,40 @@ module Thincloud
 
     def self.configure
       self.configuration ||= Configuration.new
-      yield configuration
+      yield configuration if block_given?
+      configuration
     end
 
     # Public: Configuration options for the Thincloud::Postmark module
     class Configuration
       attr_accessor :api_key
+      attr_accessor :interceptor_to
+      attr_accessor :interceptor_cc
+      attr_accessor :interceptor_bcc
+      attr_accessor :interceptor_environments
 
       def initialize
-        @api_key = "POSTMARK_API_TEST"
+        api_key         = ENV["POSTMARK_API_KEY"] || "POSTMARK_API_TEST"
+        secure          = ENV["POSTMARK_SECURE"] || true
+        interceptor_to  = ENV["THINCLOUD_INTERCEPTOR_TO"]
+        interceptor_cc  = ENV["THINCLOUD_INTERCEPTOR_CC"]
+        interceptor_bcc = ENV["THINCLOUD_INTERCEPTOR_BCC"]
+
+        @api_key         ||= api_key
+        @interceptor_to  ||= interceptor_to
+        @interceptor_cc  ||= interceptor_cc
+        @interceptor_bcc ||= interceptor_bcc
+
+        @interceptor_environments = []
+        self.secure = secure
+      end
+
+      def secure=(s)
+        ::Postmark.secure = s
+      end
+
+      def secure
+        ::Postmark.secure
       end
     end
   end

data/lib/thincloud/postmark/engine.rb

@@ -1,19 +1,44 @@
-class Engine < ::Rails::Engine
+module Thincloud
+  module Postmark
+    # Public: Thincloud Postmark Engine
+    class Engine < ::Rails::Engine
 
-  # Require the config initializer in advance so it is available for
-  # the "thincloud.postmark.action_mailer" initializer
-  initializer "thincloud.postmark.configuration", before: "thincloud.postmark.action_mailer" do
-    config_initializer = File.expand_path("config/initializers/thincloud_postmark.rb")
-    require config_initializer if File.exists?(config_initializer)
-  end
+      # convenience method for engine options / configuration
+      def configuration
+        Thincloud::Postmark.configuration
+      end
+
+      # initialize the configuration so it is available during rails init
+      ActiveSupport.on_load :before_configuration do
+        unless config.respond_to? :thincloud
+          config.thincloud = ActiveSupport::OrderedOptions.new
+        end
+
+        config.thincloud.postmark ||= Thincloud::Postmark.configure
+      end
+
+      initializer "thincloud.postmark.interceptor", after: "finisher_hook" do
+        interceptor = Thincloud::Postmark::Interceptor.tap do |i|
+          i.to  = configuration.interceptor_to
+          i.cc  = configuration.interceptor_cc
+          i.bcc = configuration.interceptor_bcc
+        end
+
+        if configuration.interceptor_environments.include?(Rails.env.to_sym)
+          ::Mail.register_interceptor(interceptor)
+        end
+      end
+
+      # Apply the postmark settings just before ActionMailer applies them
+      initializer "thincloud.postmark.settings", after: "finisher_hook" do |app|
+        if configuration.api_key
+          postmark_settings = { api_key: configuration.api_key }
+
+          config.action_mailer.delivery_method = :postmark
+          config.action_mailer.postmark_settings = postmark_settings
+        end
+      end
 
-  # Apply the postmark settings just before ActionMailer applies them
-  initializer "thincloud.postmark.action_mailer", before: "action_mailer.set_configs" do
-    if api_key = Thincloud::Postmark.configuration.try(:api_key)
-      Postmark.secure = true
-      Rails.application.config.action_mailer.delivery_method = :postmark
-      Rails.application.config.action_mailer.postmark_settings = { api_key: api_key }
     end
   end
-
-end
+end

data/lib/thincloud/postmark/interceptor.rb

@@ -0,0 +1,20 @@
+module Thincloud
+  module Postmark
+    # Public: Default Rails mail interceptor
+    class Interceptor
+      class << self
+        attr_accessor :to
+        attr_accessor :cc
+        attr_accessor :bcc
+      end
+
+      def self.delivering_email(message)
+        message.subject = "#{message.to} #{message.subject}"
+        message.to      = self.to
+        message.cc      = self.cc
+        message.bcc     = self.bcc
+        message
+      end
+    end
+  end
+end

data/lib/thincloud/postmark/version.rb

@@ -1,5 +1,5 @@
 module Thincloud
   module Postmark
-    VERSION = "0.2.0 "
+    VERSION = "0.3.0 "
   end
 end

data/lib/thincloud-postmark.rb

@@ -1,6 +1,7 @@
 require "rails"
 require "postmark-rails"
 require "thincloud/postmark/configuration"
+require "thincloud/postmark/interceptor"
 require "thincloud/postmark/engine"
 require "thincloud/postmark/version"
 

data/test/configuration_test.rb

@@ -1,21 +1,38 @@
 require "minitest_helper"
 
 describe Thincloud::Postmark::Configuration do
+  let(:config) { Thincloud::Postmark::Configuration.new }
 
-  describe "api_key" do
-    describe "default" do
-      it { Thincloud::Postmark::Configuration.new.api_key.must_equal "POSTMARK_API_TEST" }
-    end
+  it { config.must_be_kind_of Thincloud::Postmark::Configuration }
+  it { config.must_respond_to :api_key }
+  it { config.must_respond_to :api_key= }
+  it { config.must_respond_to :secure }
+  it { config.must_respond_to :secure= }
+  it { config.must_respond_to :interceptor_environments }
+  it { config.must_respond_to :interceptor_to }
+  it { config.must_respond_to :interceptor_to= }
+  it { config.must_respond_to :interceptor_bcc }
+  it { config.must_respond_to :interceptor_bcc= }
 
-    describe "provided" do
-      before do
-        Thincloud::Postmark.configure do |config|
-          config.api_key = "abc123"
-        end
-      end
+  describe "defaults" do
+    it { config.api_key.must_equal "POSTMARK_API_TEST" }
+    it { config.secure.must_equal true }
+    it { ::Postmark.secure.must_equal true }
+    it { config.interceptor_environments.must_equal [] }
+    it { config.interceptor_to.must_be_nil }
+    it { config.interceptor_cc.must_be_nil }
+    it { config.interceptor_bcc.must_be_nil }
+  end
 
-      it { Thincloud::Postmark.configuration.api_key.must_equal "abc123" }
+  describe "changes Postmark secure setting" do
+    before do
+      @original_setting = ::Postmark.secure
+      config.secure = false
     end
-  end
 
+    after { ::Postmark.secure = @original_setting }
+
+    it { config.secure.must_equal false }
+    it { ::Postmark.secure.must_equal false }
+  end
 end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end