mandrill_mailer 0.0.2 → 0.0.3

data/README.md

@@ -22,6 +22,11 @@ MandrillMailer.api_key = ENV['MANDRILL_API_KEY']
 
 Don't forget to setup your ENV variables on your server
 
+You will also need to set default_url_options for the mailer, similar to action mailer
+in your environment config files:
+
+`MandrillMailer::TransactionalMailer.default_url_options = { :host => 'localhost' }`
+
 ## Creating a new mailer
 Creating a new Mandrill Mailer is similar to a normal Rails mailer:
 
@@ -94,7 +99,7 @@ The test for this particular Mailer is setup like so:
 
 ```
 test_setup_for :invite do |mailer, options|
-    invitation = OpenStruct.new({
+    invitation = MandrillMailer::Mock.new({
       email: options[:email],
       owner_name: 'foobar',
       secret: rand(9000000..1000000).to_s
@@ -103,9 +108,22 @@ test_setup_for :invite do |mailer, options|
 end
 ```
 
-The mailer and options passed to the `.test` method are yielded to the block.
+Use MandrillMailer::Mock to mock out objects.
 
-The `:email` option is the only required option, make sure to add at least this to your test object.
+If in order to represent a url within a mock, make sure there is a `url` or `path` attribute,
+for example, if I had a course mock and I was using the `course_url` route helper within the mailer
+I would create the mock like so:
+
+```
+course = MandrillMailer::Mock.new({
+  title: 'zombies',
+  type: 'Ruby',
+  url: 'http://funzone.com/zombies'
+})
+```
+
+This would ensure that `course_url(course)` works as expected.
+
+The mailer and options passed to the `.test` method are yielded to the block.
 
-## Helper Methods
-* `.test_friendly_url`(object, route helper as a symbol) - This helper is used for using route helpers, but still staying compatible with using OpenStructs for stubing out the mailing test objects (there is probably a much better way of doing this)
+The `:email` option is the only required option, make sure to add at least this to your test object.

data/lib/mandrill_mailer.rb

@@ -1,4 +1,5 @@
 require 'action_view'
+require 'mandrill_mailer/mock'
 require 'mandrill_mailer/transactional_mailer'
 require 'mandrill_mailer/version'
 

data/lib/mandrill_mailer/mock.rb

@@ -0,0 +1,4 @@
+module MandrillMailer
+  class Mock < OpenStruct
+  end
+end

data/lib/mandrill_mailer/transactional_mailer.rb

@@ -229,28 +229,6 @@ module MandrillMailer
 
     protected
 
-    # Public: Url helper for creating OpenStruct compatible urls
-    #         This is used for making sure urls will still work with
-    #         OpenStructs used in the email testing code
-    #
-    #         OpenStruct should have a .url property to work with this
-    #
-    # object - Object that would normally be passed into the route helper
-    # route_helper - The route helper as a symbol needed for the url
-    #
-    # Examples
-    #
-    # 'VIDEO_URL' => open_struct_url(video, :code_tv_video_url)
-    #
-    # Returns the url as a string
-    def test_friendly_url(object, route_helper)
-      if object.kind_of? OpenStruct
-        object.url
-      else
-        method(route_helper).call(object)
-      end
-    end
-
     # Makes this class act as a singleton without it actually being a singleton
     # This keeps the syntax the same as the orginal mailers so we can swap quickly if something
     # goes wrong.
@@ -263,10 +241,22 @@ module MandrillMailer
       super || instance_methods.include?(method)
     end
 
-    # Proxy route helpers to rails if Rails exists
+    # Proxy route helpers to rails if Rails exists. Doing routes this way
+    # makes it so this gem doesn't need to be a rails engine
     def method_missing(method, *args)
       return super unless defined?(Rails) && Rails.application.routes.url_helpers.respond_to?(method)
-      Rails.application.routes.url_helpers.method(method).call(*args, host: @@url_host)
+      # Check to see if one of the args is an open struct. If it is, we'll assume it's the
+      # test stub and try to call a path or url attribute.
+      if args.any? {|arg| arg.kind_of?(MandrillMailer::Mock)}
+        # take the first OpenStruct found in args and look for .url or.path
+        args.each do |arg|
+          if arg.kind_of?(MandrillMailer::Mock)
+            break arg.url || arg.path
+          end
+        end
+      else
+        Rails.application.routes.url_helpers.method(method).call(*args, host: @@url_host)
+      end
     end
 
     def image_path(image)

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -87,8 +87,10 @@ files:
 - Gemfile.lock
 - README.md
 - lib/mandrill_mailer.rb
+- lib/mandrill_mailer/mock.rb
 - lib/mandrill_mailer/transactional_mailer.rb
 - lib/mandrill_mailer/version.rb
+- mandrill_mailer-0.0.2.gem
 - mandrill_mailer.gemspec
 - spec/mandrill_mailer_spec.rb
 - spec/spec_helper.rb