maily 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4dc5bfc8c0387e53578ab0b5324f1f50d184ac8
-  data.tar.gz: 10d08a1155c7e3e4e1719282c864294b037c5d40
+  metadata.gz: de8e4fc672413008f9fba27e3bd37063f544035a
+  data.tar.gz: e4e16a797ec0e23dcfd8aefa73f04b6343f95a7b
 SHA512:
-  metadata.gz: 9972a049fd991c8ac044e6d25621975b8125becc783a7a78d619267f33b617111aaf7194000531cc7230908277f793aea7674fb6e7594b29591b0712a502db6d
-  data.tar.gz: 38d7d037c52e6bec3bf7bfcef49b14727bbe21d63e5849a6277e15f6aef8a3a04733b53eae23184745f7b5e5565135eb7a7f1fabcc5ce727c77aaab82a61964a
+  metadata.gz: d01ba2a9b7c0433dd369d32ec26da9ebc86922caca2aae774bf9fa01d199c91aa82c1b5f584dbbb8fcc58c5f1af245b5d688d868212e3db8acb40cd05103f181
+  data.tar.gz: 9ea9c77b7bb632d0c279cbf788ad9f44b476ade72f3289f09abade83de6d4a693ff7ad63b64c25ed669bd740a591cd631b20647b3fa992010b2cd3d00b51b5dc

data/README.md

@@ -13,7 +13,7 @@ Maily is a Rails Engine to preview, follow up, test and edit the emails of your
 * Template edition
 * Email delivery
 * Features configurables per environment
-* Customizable parent controller (define permissions in your own controller)
+* Flexible authorization
 * Minimalistic interface (thanks to [@gnatok](https://github.com/gnatok))
 * Easy way (named hooks) to define data for emails
 * Generator to handle a comfortable installation
@@ -21,6 +21,7 @@ Maily is a Rails Engine to preview, follow up, test and edit the emails of your
 ![](screenshot.png)
 
 ## Installation
+
 Add this line to you Gemfile:
 
 ```
@@ -40,41 +41,48 @@ This installator makes some tasks for you:
 * Adds a file (into `lib/maily_hooks.rb`) to define hooks
 
 ## Initialization and configuration
-You should configure Maily via this initializer. You can set these options per environment:
+
+You should configure Maily via the initializer. You can set these options per environment:
 
 ```ruby
-  Maily.enabled = ENV['MAILY_ENABLED']
+Maily.enabled = ENV['MAILY_ENABLED']
+
+Maily.enabled = Rails.env.production? ? false : true
 ```
 
-This is a sample of the file with the full list of options:
+Initializer sample (full options list):
 
-```ruby
+ ```ruby
 # config/initializers/maily.rb
 Maily.setup do |config|
-  # Enable/disable engine
+  # On/off engine
   # config.enabled = Rails.env.production? ? false : true
 
-  # Allow to edit templates
+  # Allow templates edition
   # config.allow_edition = Rails.env.production? ? false : true
 
   # Allow deliveries
   # config.allow_delivery = Rails.env.production? ? false : true
 
-  # Define I18n available locales
+  # I18n.available_locales by default
   # config.available_locales = [:en, :es, :pt, :fr]
 
-  # Define parent controller. Allow to run engine under a custom controller
+  # Run maily under different controller ('ActionController::Base' by default)
   # config.base_controller = '::AdminController'
+
+  # Http basic authentication (nil by default)
+  # config.http_authorization = { username: 'admin', password: 'secret' }
 end
 ```
 
 ### Templates edition (`allow_edition` option)
+
 This feature was designed for `development` environment. Since it's just a file edition and running `production` mode, code is not reloaded between requests, Rails doesn't take in account this change (without restarting the server). Also, allow arbitrary ruby code evaluation is potentially dangerous, that's not a good idea for `production`.
 
 So, templates edition is not allowed running `production` mode.
 
-
 ## Hooks
+
 Most of emails need to populate data to consume it and do intersting things. Hooks are used to define this data with a little DSL. Example:
 
 ```ruby
@@ -101,15 +109,16 @@ Maily.hooks_for('YourMailerClass') do |mailer|
 end
 ```
 
-## Customize Authorization
-By default `Maily` runs under `ActionController::Base`, but you are able to customize that parent controller (`Maily.base_controller` option) in order to achieve (using `before_action`) a kind of access control. For example, set a different base controller:
+## Authorization
+
+Basically, you have 2 ways to restrict the access to `Maily`.
+
+### Custom base controller
+
+By default `Maily` runs under `ActionController::Base`, but you are able to customize that parent controller (`Maily.base_controller` option) in order to achieve (using `before_action`) a kind of access control system. For example, set a different base controller:
 
 ```ruby
-Maily.setup do |config|
-  ...
-  config.base_controller = '::AdminController'
-  ...
-end
+Maily.base_controller = '::AdminController'
 ```
 
 And write your own authorization rules in the defined `base_controller`:
@@ -126,10 +135,20 @@ class AdminController < ActionController::Base
 end
 ```
 
+### HTTP basic authentication
+
+You can also authorize yours users via HTTP basic authentication, simply use this option:
+
+```ruby
+Maily.http_authorization = { username: 'admin', password: 'secret' }
+```
+
 ## Notes
+
 Rails 4.1 introduced a built-in mechanism to preview the application emails. It is in fact a port of [basecamp/mail_view](https://github.com/basecamp/mail_view) gem to the core.
 
 Alternatively, there are some other plugins to get a similar functionality with different approaches and options. For example, [ryanb/letter_opener](https://github.com/ryanb/letter_opener), [sj26/mailcatcher](https://github.com/sj26/mailcatcher) or [glebm/rails_email_preview](https://github.com/glebm/rails_email_preview).
 
 ## License
+
 Copyright (c) 2013-2014 Marc Anguera. Maily is released under the [MIT](MIT-LICENSE) License.

data/app/controllers/maily/application_controller.rb

@@ -1,6 +1,6 @@
 module Maily
   class ApplicationController < Maily.base_controller.constantize
-    before_filter :maily_enabled?
+    before_filter :maily_enabled?, :http_authorization
 
     layout 'maily/application'
 
@@ -9,5 +9,13 @@ module Maily
     def maily_enabled?
       Maily.enabled || raise('Maily: engine disabled!')
     end
+
+    def http_authorization
+      if auth_hash = Maily.http_authorization
+        authenticate_or_request_with_http_basic do |username, password|
+          username == auth_hash[:username] && password == auth_hash[:password]
+        end
+      end
+    end
   end
 end

data/lib/generators/templates/initializer.rb

@@ -11,6 +11,9 @@ Maily.setup do |config|
   # I18n.available_locales by default
   # config.available_locales = [:en, :es, :pt, :fr]
 
-  # Run maily under different controller. 'ActionController::Base' by default
-  # config.base_controller = 'AdminController'
+  # Run maily under different controller ('ActionController::Base' by default)
+  # config.base_controller = '::AdminController'
+
+  # Http basic authentication (nil by default)
+  # config.http_authorization = { username: 'admin', password: 'secret' }
 end

data/lib/maily.rb

@@ -5,14 +5,16 @@ require 'maily/email'
 
 module Maily
   class << self
-    attr_accessor :enabled, :allow_edition, :allow_delivery, :available_locales, :base_controller
+    attr_accessor :enabled, :allow_edition, :allow_delivery, :available_locales,
+                  :base_controller, :http_authorization
 
     def init!
-      self.enabled           = Rails.env.production? ? false : true
-      self.allow_edition     = Rails.env.production? ? false : true
-      self.allow_delivery    = Rails.env.production? ? false : true
-      self.available_locales = I18n.available_locales
-      self.base_controller   = 'ActionController::Base'
+      self.enabled            = Rails.env.production? ? false : true
+      self.allow_edition      = Rails.env.production? ? false : true
+      self.allow_delivery     = Rails.env.production? ? false : true
+      self.available_locales  = I18n.available_locales
+      self.base_controller    = 'ActionController::Base'
+      self.http_authorization = nil
     end
 
     def load_emails_and_hooks

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

data/spec/controllers_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Maily::EmailsController, type: :controller do
+  routes { Maily::Engine.routes }
+
+  before(:each) do
+    Maily.init!
+  end
+
+  it 'responds ok if enabled' do
+    expect { get :index }.not_to raise_error
+  end
+
+  it 'raise error if disabled' do
+    Maily.enabled = false
+    expect { get :index }.to raise_error('Maily: engine disabled!')
+  end
+
+  it 'responds with 401 if http authorization fails' do
+    Maily.http_authorization = { username: 'admin', password: 'admin' }
+    get :index
+    expect(response.status).to eq(401)
+  end
+
+  it 'responds ok with valid http authorization' do
+    Maily.http_authorization = { username: 'admin', password: 'admin' }
+    request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials('admin', 'admin')
+    get :index
+    expect(response.status).to eq(200)
+  end
+end

data/spec/dummy/README.md

@@ -1,6 +1,6 @@
 # Dummy App
 
-Dummy Rails application for testing `Maily`.
+Dummy Rails application to test `Maily` engine.
 
 Run test suite (from `Maily` root path):
 

data/spec/maily_spec.rb

@@ -9,6 +9,7 @@ describe Maily do
     expect(Maily.allow_delivery).to be true
     expect(Maily.available_locales).to eq(I18n.available_locales)
     expect(Maily.base_controller).to eq('ActionController::Base')
+    expect(Maily.http_authorization).to be nil
   end
 
   it "should not allow edition if edition is disabled" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,6 +84,7 @@ files:
 - lib/maily/version.rb
 - maily.gemspec
 - screenshot.png
+- spec/controllers_spec.rb
 - spec/dummy/README.md
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/.keep
@@ -151,11 +152,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rails Engine to preview emails in the browser.
 test_files:
+- spec/controllers_spec.rb
 - spec/dummy/README.md
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/.keep