ahoy_email 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc1f584255e88dbcda182347224e0e30cbd43684cf5e9bf1ba71007cd8470d25
-  data.tar.gz: 7143c167fa888441510b1eaa67edd74c0285efa50a1a4e6fa5b0b4770b7afcb7
+  metadata.gz: 1bd419ac1420c0d404b6137e3804545193969ecd8aab0444c919e9f7b5e5fae4
+  data.tar.gz: 3cce5d71d203a287992fc6560910f596f3cf74b0ef24861df8f5ed27ad9bd3b1
 SHA512:
-  metadata.gz: 648078aac8c79119c4caa1ecd42ff624d58e5b898cf6eb2231d14fc0aaece937a2a76020931fbc8c22f730dcdfa27068fc1fc62f9b80ea30ef766c69ea8ddffc
-  data.tar.gz: f529c4de18d3ffbd5b2ef4d4b2122409d521fca920d200eaad337c0bc984de31ef3b6d7c6c0642a7120446cf759055a9f84b0f9bdda44bdafb654708994cef4a
+  metadata.gz: b163a83c5a2f78e7a2576940f1d7d0bb25bb38fec0203571adf387ffa2e380c5ed164fff92ba12c00f81a30d7b43b39e41d7a68a1d94b86f2dfc27c48139eb16
+  data.tar.gz: 816a961760e8fedf55efa9b5b59f38decdf0fdd12531dc5a52f83c09178bddf820e93eb375c47100e10bd4e9f2aba7b4c2efabde952ebfc589cf20d2d0418537

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.2
+
+- Fixed secret token for Rails 5.2
+- Added `heuristic_parse` option
+
 ## 0.5.1
 
 - Fixed deprecation warning in Rails 5.2

data/README.md

@@ -99,13 +99,13 @@ Use `track open: false` to skip this.
 A redirect is added to links to track clicks in HTML emails.
 
 ```
-http://chartkick.com
+https://chartkick.com
 ```
 
 becomes
 
 ```
-http://you.io/ahoy/messages/rAnDoMtOkEn/click?url=http%3A%2F%2Fchartkick.com&signature=...
+https://yoursite.com/ahoy/messages/rAnDoMtOkEn/click?url=https%3A%2F%2Fchartkick.com&signature=...
 ```
 
 A signature is added to prevent [open redirects](https://www.owasp.org/index.php/Open_redirect).
@@ -251,7 +251,7 @@ track unsubscribe_links: true
 Use a different model
 
 ```ruby
-AhoyEmail.message_model = UserMessage
+AhoyEmail.message_model = -> { UserMessage }
 ```
 
 ## Upgrading

data/ahoy_email.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.2.0"
 
   spec.add_runtime_dependency "railties"
   spec.add_runtime_dependency "actionmailer"

data/lib/ahoy_email.rb

@@ -17,14 +17,15 @@ module AhoyEmail
     open: true,
     click: true,
     utm_params: true,
-    utm_source: proc { |message, mailer| mailer.mailer_name },
+    utm_source: ->(message, mailer) { mailer.mailer_name },
     utm_medium: "email",
     utm_term: nil,
     utm_content: nil,
-    utm_campaign: proc { |message, mailer| mailer.action_name },
-    user: proc { |message, mailer| (message.to.size == 1 ? User.where(email: message.to.first).first : nil) rescue nil },
-    mailer: proc { |message, mailer| "#{mailer.class.name}##{mailer.action_name}" },
-    url_options: {}
+    utm_campaign: ->(message, mailer) { mailer.action_name },
+    user: ->(message, mailer) { (message.to.size == 1 ? User.where(email: message.to.first).first : nil) rescue nil },
+    mailer: ->(message, mailer) { "#{mailer.class.name}##{mailer.action_name}" },
+    url_options: {},
+    heuristic_parse: false
   }
 
   self.subscribers = []

data/lib/ahoy_email/engine.rb

@@ -3,10 +3,17 @@ require "rails/engine"
 module AhoyEmail
   class Engine < ::Rails::Engine
     initializer "ahoy_email" do |app|
-      # default to secrets to keep backward compatible
-      ActiveSupport::Deprecation.silence do
-        secrets = app.respond_to?(:secrets) ? app.secrets : app.config
-        AhoyEmail.secret_token ||= secrets.respond_to?(:secret_key_base) ? secrets.secret_key_base : secrets.secret_token
+      AhoyEmail.secret_token ||= begin
+        creds =
+          if app.respond_to?(:credentials) && app.credentials.secret_key_base
+            app.credentials
+          elsif app.respond_to?(:secrets)
+            app.secrets
+          else
+            app.config
+          end
+
+        creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
       end
 
       AhoyEmail.belongs_to = {optional: true} if Rails::VERSION::MAJOR >= 5

data/lib/ahoy_email/mailer.rb

@@ -2,7 +2,7 @@ module AhoyEmail
   module Mailer
     def self.included(base)
       base.extend ClassMethods
-      base.send(:prepend, InstanceMethods)
+      base.prepend InstanceMethods
       base.class_eval do
         attr_accessor :ahoy_options
         class_attribute :ahoy_options

data/lib/ahoy_email/processor.rb

@@ -157,7 +157,11 @@ module AhoyEmail
     # Return uri if valid, nil otherwise
     def parse_uri(href)
       # to_s prevent to return nil from this method
-      Addressable::URI.parse(href.to_s) rescue nil
+      if options[:heuristic_parse]
+        Addressable::URI.heuristic_parse(href.to_s) rescue nil
+      else
+        Addressable::URI.parse(href.to_s) rescue nil
+      end
     end
 
     def url_for(opt)

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/test/mailer_test.rb

@@ -25,6 +25,31 @@ class UserMailer < ActionMailer::Base
     html_message('<a href="http://example.org?baz[]=1&amp;baz[]=2">Hi<a>')
   end
 
+  def heuristic_parse
+    track heuristic_parse: true
+    html_message('<a href="example.org">Hi<a>')
+  end
+
+  def mailto
+    track heuristic_parse: true
+    html_message('<a href="mailto:someone@yoursite.com">Email Us</a>')
+  end
+
+  def app_link
+    track heuristic_parse: true
+    html_message('<a href="fb://profile/33138223345">Email Us</a>')
+  end
+
+  def welcome4_heuristic
+    track heuristic_parse: true
+    html_message('<a href="http://example.org">Hi<a>')
+  end
+
+  def welcome5_heuristic
+    track heuristic_parse: true
+    html_message('<a href="http://example.org?baz[]=1&amp;baz[]=2">Hi<a>')
+  end
+
   private
 
     def prevent_delivery_to_guests
@@ -74,6 +99,43 @@ class MailerTest < Minitest::Test
     assert_match "baz%5B%5D=1&amp;baz%5B%5D=2", body
   end
 
+  def test_heuristic_parse
+    # Should convert the URI fragment into a URI
+    message = UserMailer.heuristic_parse
+    body = message.body.to_s
+    assert_match "http://example.org", body
+  end
+
+  def test_mailto
+    # heuristic parse should ignore the mailto link
+    message = UserMailer.mailto
+    body = message.body.to_s
+    assert_match "<a href=\"mailto:someone@yoursite.com\">", body
+  end
+
+  def test_app_link
+    # heuristic parse should ignore the app link
+    message = UserMailer.app_link
+    body = message.body.to_s
+    assert_match "<a href=\"fb://profile/33138223345\">", body
+  end
+
+  def test_utm_params_heuristic_parse
+    # heuristic parse should not have unexpected side effects
+    message = UserMailer.welcome4_heuristic
+    body = message.body.to_s
+    assert_match "utm_campaign=welcome4", body
+    assert_match "utm_medium=email", body
+    assert_match "utm_source=user_mailer", body
+  end
+
+  def test_array_params_heuristic_parse
+    # heuristic parse should not have unexpected side effects
+    message = UserMailer.welcome5_heuristic
+    body = message.body.to_s
+    assert_match "baz%5B%5D=1&amp;baz%5B%5D=2", body
+  end
+
   private
 
     def assert_message(method)

data/test/test_helper.rb

@@ -14,5 +14,3 @@ Combustion.initialize! :all do
 end
 
 ActionMailer::Base.delivery_method = :test
-
-ActiveRecord::Base.belongs_to_required_by_default = true if ActiveRecord::VERSION::MAJOR >= 5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -224,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="