action_mailer_auto_url_options 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f9116fa35c026254314d6e822815ee50e8261be
+  data.tar.gz: ffd7a963374190575c2b59c8f63370ce0d9d4bd9
+SHA512:
+  metadata.gz: d5832f4c3b2c3188750d4d63c919bed90818f7a801f25ab60ac4c10f473d61bb6c01bd3bc910536afcd1862d8edc4d19be91b2c43cde17fd99210b0a6f52c62a
+  data.tar.gz: d6828c9fa57980a2340d3d7ef907ad72282a2b755143118a5883da217c2359f43efff6f07f171ba6445cb30b01e2c739cb39a368e5a5803efef84ecc80dc48d9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Sunny Ripert
+
+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,57 @@
+ActionMailer automatic URL options
+==================================
+
+Make ActionMailer use the current request host, port and protocol for URL
+generation.
+
+
+Why?
+----
+
+In Rails apps, if you create links in your emails, you need to set the
+host, port and protocol in every environment configuration file you use.
+
+This plugin removes that need by using the current request's host, port and
+protocol instead.
+
+This is also helpful when you use different domain names, based on the language
+for example.
+
+
+Install
+-------
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'action_mailer_auto_url_options'
+```
+
+Run `bundle install`, restart your server and that's it!
+
+
+Usage with Sidekiq
+------------------
+
+If you delay your emails with Sidekiq, include this middleware in your
+`sidekiq.rb` initializer:
+
+```ruby
+require "action_mailer_auto_url_options/middleware/sidekiq"
+```
+
+
+Security considerations
+-----------------------
+
+This does not protect you from host-injection exploits, so please whitelist
+requests to the allowed domain name in production.
+
+Read more about [this vulnerability](http://seclists.org/fulldisclosure/2008/Jun/169)
+because your app may already be vulnerable if it does any kind of cache.
+
+
+License
+-------
+
+MIT

data/Rakefile

@@ -0,0 +1,22 @@
+# bundler
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler::GemHelper.install_tasks
+
+# rdoc
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LayoutValues'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# rspec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/action_mailer_auto_url_options.rb

@@ -0,0 +1,2 @@
+require "action_mailer_auto_url_options/controller"
+require "action_mailer_auto_url_options/engine"

data/lib/action_mailer_auto_url_options/controller.rb

@@ -0,0 +1,20 @@
+module ActionMailerAutoUrlOptions
+
+  # Included in the app's Application Controller
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :make_action_mailer_use_request_host_and_protocol
+    end
+
+    private
+
+    # Via http://makandracards.com/makandra/1353
+    def make_action_mailer_use_request_host_and_protocol
+      ActionMailer::Base.default_url_options[:protocol] = request.protocol
+      ActionMailer::Base.default_url_options[:host] = request.host_with_port
+    end
+  end
+
+end

data/lib/action_mailer_auto_url_options/engine.rb

@@ -0,0 +1,9 @@
+module ActionMailerAutoUrlOptions
+
+  class Engine < Rails::Engine
+    initializer "action_mailer_auto_url_options.controller" do |app|
+      ActionController::Base.send :include, ActionMailerAutoUrlOptions::Controller
+    end
+  end
+
+end

data/lib/action_mailer_auto_url_options/middleware/sidekiq.rb

@@ -0,0 +1,36 @@
+module Sidekiq::Middleware::ActionMailerDefaultUrlOption
+  # Get the current Action Mailer default URL options and store them in the
+  # message to be sent to Sidekiq.
+  class Client
+    def call(worker_class, msg, queue, redis_pool)
+      options = ActionMailer::Base.default_url_options
+      msg['action_mailer_default_url_options'] ||= options
+      yield
+    end
+  end
+
+  # Pull the message's Action Mailer default URL options out and set the
+  # current thread to use them.
+  class Server
+    def call(worker, msg, queue)
+      options = msg['action_mailer_default_url_options'].symbolize_keys
+      ActionMailer::Base.default_url_options = options if options
+      yield
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::ActionMailerDefaultUrlOption::Client
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::ActionMailerDefaultUrlOption::Client
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::ActionMailerDefaultUrlOption::Server
+  end
+end

data/lib/action_mailer_auto_url_options/version.rb

@@ -0,0 +1,3 @@
+module ActionMailerAutoUrlOptions
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer_auto_url_options
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make ActionMailer use the current request host and protocol for URL generation
+email:
+- sunny@sunfox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_mailer_auto_url_options/controller.rb
+- lib/action_mailer_auto_url_options/engine.rb
+- lib/action_mailer_auto_url_options/middleware/sidekiq.rb
+- lib/action_mailer_auto_url_options/version.rb
+- lib/action_mailer_auto_url_options.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/sunny/action_mailer_auto_url_options
+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.1.11
+signing_key: 
+specification_version: 4
+summary: ActionMailer automatic URL options
+test_files: []