maily 0.3.2 → 0.3.3

data/README.md

@@ -39,14 +39,14 @@ This installator makes some tasks for you:
 * Adds an initializer (into `config/initializers/maily.rb`) to customize some settings
 * Adds a file (into `lib/maily_hooks.rb`) to define hooks
 
-## Initializer
+## Initialization and configuration
 You should configure Maily via this initializer. You can set these options per environment:
 
 ```ruby
   Maily.enabled = ENV['MAILY_ENABLED']
 ```
 
-This is a sample of file with the full list of options:
+This is a sample of the file with the full list of options:
 
 ```ruby
 # config/initializers/maily.rb
@@ -64,10 +64,16 @@ Maily.setup do |config|
   # config.available_locales = [:en, :es, :pt, :fr]
 
   # Define parent controller. Allow to run engine under a custom controller
-  # config.base_controller = 'AdminController'
+  # config.base_controller = '::AdminController'
 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:
 
@@ -95,10 +101,35 @@ 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:
+
+```ruby
+Maily.setup do |config|
+  ...
+  config.base_controller = '::AdminController'
+  ...
+end
+```
+
+And write your own authorization rules in the defined `base_controller`:
+
+```ruby
+class AdminController < ActionController::Base
+  before_action :maily_authorized?
+
+  private
+
+  def maily_authorized?
+    (current_user && current_user.admin?) || raise('You don't have access to this section!')
+  end
+end
+```
+
 ## 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. For example, [ryanb/letter_opener](https://github.com/ryanb/letter_opener) or [MailCatcher](https://github.com/sj26/mailcatcher).
+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), [MailCatcher](https://github.com/sj26/mailcatcher) or [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,5 @@
 module Maily
   class ApplicationController < Maily.base_controller.constantize
-
     before_filter :maily_enabled?
 
     layout 'maily/application'

data/lib/generators/templates/initializer.rb

@@ -1,16 +1,16 @@
 Maily.setup do |config|
-  # On/off engine. True by default
+  # On/off engine
   # config.enabled = Rails.env.production? ? false : true
 
-  # Allow views edition. True by default
+  # Allow templates edition
   # config.allow_edition = Rails.env.production? ? false : true
 
-  # Allow deliveries. True by default
+  # Allow deliveries
   # config.allow_delivery = Rails.env.production? ? false : true
 
   # I18n.available_locales by default
   # config.available_locales = [:en, :es, :pt, :fr]
 
-  # 'ActionController::Base' by default
-  # config.base_controller = 'FooController'
+  # Run maily under different controller. 'ActionController::Base' by default
+  # config.base_controller = 'AdminController'
 end

data/lib/maily.rb

@@ -5,19 +5,18 @@ require 'maily/email'
 
 module Maily
   class << self
-
     attr_accessor :enabled, :allow_edition, :allow_delivery, :available_locales, :base_controller
 
     def init!
-      self.enabled           = true
-      self.allow_edition     = true
-      self.allow_delivery    = true
+      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'
     end
 
     def load_emails_and_hooks
-      # Load emails
+      # Load emails from file system
       Dir[Rails.root + 'app/mailers/*.rb'].each do |mailer|
         klass   = File.basename(mailer, '.rb')
         methods = klass.camelize.constantize.send(:instance_methods, false)
@@ -41,8 +40,10 @@ module Maily
 
     def allowed_action?(action)
       case action.to_sym
-      when :edit, :update
+      when :edit,
         allow_edition
+      when :update
+        allow_edition && !Rails.env.production?
       when :deliver
         allow_delivery
       end

data/lib/maily/email.rb

@@ -1,6 +1,5 @@
 module Maily
   class Email
-
     attr_accessor :name, :mailer, :arguments, :template_path
 
     def initialize(name, mailer)

data/lib/maily/mailer.rb

@@ -1,6 +1,5 @@
 module Maily
   class Mailer
-
     cattr_accessor :collection
     attr_accessor :name, :emails
 

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/maily.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.authors       = ["markets"]
   s.email         = ["srmarc.ai@gmail.com"]
   s.homepage      = "https://github.com/markets/maily"
-  s.summary       = "Rails Engine to preview emails in a browser."
-  s.description   = "Rails Engine to preview emails in a browser."
+  s.summary       = "Rails Engine to preview emails in the browser."
+  s.description   = "Rails Engine to preview, follow up, test and edit the emails of your applications in the browser"
   s.license       = "MIT"
 
   s.files         = `git ls-files`.split($/)

data/spec/dummy/README.md

@@ -1,3 +1,9 @@
 # Dummy App
 
-Dummy application for testing Maily
+Dummy application for testing Maily.
+
+Run test suite:
+
+```
+bundle exec rake
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails Engine to preview emails in a browser.
+description: Rails Engine to preview, follow up, test and edit the emails of your
+  applications in the browser
 email:
 - srmarc.ai@gmail.com
 executables: []
@@ -150,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4181981977769088006
+      hash: 1797094736581911098
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -159,13 +160,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4181981977769088006
+      hash: 1797094736581911098
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Rails Engine to preview emails in a browser.
+summary: Rails Engine to preview emails in the browser.
 test_files:
 - spec/dummy/README.md
 - spec/dummy/Rakefile