ahoy_email 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a367225c4c07c790df8fe4267f5bf7d230921b0e
-  data.tar.gz: 9360b86e5075df7bf02e427a689c035db77faaf7
+SHA256:
+  metadata.gz: bc1f584255e88dbcda182347224e0e30cbd43684cf5e9bf1ba71007cd8470d25
+  data.tar.gz: 7143c167fa888441510b1eaa67edd74c0285efa50a1a4e6fa5b0b4770b7afcb7
 SHA512:
-  metadata.gz: e4c94a2e17739b8400c1cfccf870f3774c131f23c46ffc062e94140156565e9b002b83ebf3fbd440f857353038274bca4139365267756dfcb7b75bdde2d4eb66
-  data.tar.gz: da84e8725823073ae8aa5d7b636fac645786cff90484bd381b5ce8d894d0556764a9bbd2df9649265ff3d4b00ba310a3ad6dd1090fe88d86bccd7e82ea7231bd
+  metadata.gz: 648078aac8c79119c4caa1ecd42ff624d58e5b898cf6eb2231d14fc0aaece937a2a76020931fbc8c22f730dcdfa27068fc1fc62f9b80ea30ef766c69ea8ddffc
+  data.tar.gz: f529c4de18d3ffbd5b2ef4d4b2122409d521fca920d200eaad337c0bc984de31ef3b6d7c6c0642a7120446cf759055a9f84b0f9bdda44bdafb654708994cef4a

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.4.2
 sudo: false
 script: bundle exec rake test
 before_script:
@@ -11,5 +11,6 @@ notifications:
     on_failure: change
 gemfile:
   - Gemfile
+  - test/gemfiles/actionmailer51.gemfile
   - test/gemfiles/actionmailer50.gemfile
   - test/gemfiles/actionmailer42.gemfile

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.5.1
+
+- Fixed deprecation warning in Rails 5.2
+- Added `unsubscribe_links` option
+- Allow `message_model` to accept a proc
+- Use `references` in migration
+
 ## 0.5.0
 
 - Added support for Rails 5.1

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in ahoy_email.gemspec
 gemspec
 
-gem "actionmailer", "~> 5.1.0"
+gem "actionmailer", "~> 5.2.0"

data/README.md

@@ -5,8 +5,8 @@
 You get:
 
 - A history of emails sent to each user
-- Open and click tracking
 - Easy UTM tagging
+- Open and click tracking
 
 Works with any email service.
 
@@ -28,7 +28,7 @@ And run the generator. This creates a model to store messages.
 
 ```sh
 rails generate ahoy_email:install
-rake db:migrate
+rails db:migrate
 ```
 
 ## How It Works
@@ -44,7 +44,7 @@ By default, Ahoy tries `User.where(email: message.to.first).first` to find the u
 You can pass a specific user with:
 
 ```ruby
-class UserMailer < ActionMailer::Base
+class UserMailer < ApplicationMailer
   def welcome_email(user)
     # ...
     track user: user
@@ -58,8 +58,8 @@ The user association is [polymorphic](http://railscasts.com/episodes/154-polymor
 To get all messages sent to a user, add an association:
 
 ```ruby
-class User < ActiveRecord::Base
-  has_many :messages, class_name: "Ahoy::Message"
+class User < ApplicationRecord
+  has_many :messages, class_name: "Ahoy::Message", as: :user
 end
 ```
 
@@ -69,6 +69,23 @@ And run:
 user.messages
 ```
 
+### UTM Parameters
+
+UTM parameters are added to links if they don’t already exist.
+
+The defaults are:
+
+- utm_medium - `email`
+- utm_source - the mailer name like `user_mailer`
+- utm_campaign - the mailer action like `welcome_email`
+
+Use `track utm_params: false` to skip tagging, or skip specific links with:
+
+
+```html
+<a data-skip-utm-params="true" href="...">Break it down</a>
+```
+
 ### Opens
 
 An invisible pixel is added right before the `</body>` tag in HTML emails.
@@ -99,23 +116,6 @@ Use `track click: false` to skip tracking, or skip specific links with:
 <a data-skip-click="true" href="...">Can't touch this</a>
 ```
 
-### UTM Parameters
-
-UTM parameters are added to links if they don’t already exist.
-
-The defaults are:
-
-- utm_medium - `email`
-- utm_source - the mailer name like `user_mailer`
-- utm_campaign - the mailer action like `welcome_email`
-
-Use `track utm_params: false` to skip tagging, or skip specific links with:
-
-
-```html
-<a data-skip-utm-params="true" href="...">Break it down</a>
-```
-
 ### Extra Attributes
 
 Create a migration to add extra attributes to the `ahoy_messages` table, for example:
@@ -152,7 +152,7 @@ There are 3 places to set options. Here’s the order of precedence.
 #### Action
 
 ``` ruby
-class UserMailer < ActionMailer::Base
+class UserMailer < ApplicationMailer
   def welcome_email(user)
     # ...
     track user: user
@@ -164,7 +164,7 @@ end
 #### Mailer
 
 ```ruby
-class UserMailer < ActionMailer::Base
+class UserMailer < ApplicationMailer
   track utm_campaign: "boom"
 end
 ```
@@ -214,7 +214,7 @@ AhoyEmail.subscribers << EmailSubscriber.new
 You can use a `Proc` for any option.
 
 ```ruby
-track utm_campaign: proc { |message, mailer| mailer.action_name + Time.now.year }
+track utm_campaign: ->(message, mailer) { mailer.action_name + Time.now.year }
 ```
 
 Disable tracking for an email
@@ -242,6 +242,12 @@ Customize domain
 track url_options: {host: "mydomain.com"}
 ```
 
+By default, unsubscribe links are excluded from tracking. To change this, use:
+
+```ruby
+track unsubscribe_links: true
+```
+
 Use a different model
 
 ```ruby

data/ahoy_email.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
   spec.summary       = "Simple, powerful email tracking for Rails"
-  spec.description   = "Simple, powerful email tracking for Rails"
   spec.homepage      = "https://github.com/ankane/ahoy_email"
   spec.license       = "MIT"
 
@@ -20,14 +19,17 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_runtime_dependency "rails"
-  spec.add_runtime_dependency "addressable"
+  spec.add_runtime_dependency "railties"
+  spec.add_runtime_dependency "actionmailer"
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "addressable", ">= 2.3.2"
   spec.add_runtime_dependency "nokogiri"
   spec.add_runtime_dependency "safely_block", ">= 0.1.1"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "combustion"
+  spec.add_development_dependency "rails"
   spec.add_development_dependency "sqlite3"
 end

data/lib/ahoy_email.rb

@@ -1,6 +1,4 @@
-require "ahoy_email/version"
-require "action_mailer"
-require "rails"
+require "active_support"
 require "nokogiri"
 require "addressable/uri"
 require "openssl"
@@ -9,6 +7,7 @@ require "ahoy_email/processor"
 require "ahoy_email/interceptor"
 require "ahoy_email/mailer"
 require "ahoy_email/engine"
+require "ahoy_email/version"
 
 module AhoyEmail
   mattr_accessor :secret_token, :options, :subscribers, :belongs_to, :invalid_redirect_url
@@ -41,9 +40,13 @@ module AhoyEmail
   end
 
   def self.message_model
-    (defined?(@message_model) && @message_model) || ::Ahoy::Message
+    model = (defined?(@message_model) && @message_model) || ::Ahoy::Message
+    model = model.call if model.respond_to?(:call)
+    model
   end
 end
 
-ActionMailer::Base.send :include, AhoyEmail::Mailer
-ActionMailer::Base.register_interceptor AhoyEmail::Interceptor
+ActiveSupport.on_load(:action_mailer) do
+  include AhoyEmail::Mailer
+  register_interceptor AhoyEmail::Interceptor
+end

data/lib/ahoy_email/engine.rb

@@ -1,8 +1,14 @@
+require "rails/engine"
+
 module AhoyEmail
   class Engine < ::Rails::Engine
     initializer "ahoy_email" do |app|
-      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
+      # 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
+      end
+
       AhoyEmail.belongs_to = {optional: true} if Rails::VERSION::MAJOR >= 5
     end
   end

data/lib/ahoy_email/processor.rb

@@ -140,7 +140,7 @@ module AhoyEmail
         # remove it
         link.remove_attribute(attribute)
         true
-      elsif link["href"].to_s =~ /unsubscribe/i
+      elsif link["href"].to_s =~ /unsubscribe/i && !options[:unsubscribe_links]
         # try to avoid unsubscribe links
         true
       else

data/lib/ahoy_email/version.rb

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

data/lib/generators/ahoy_email/templates/install.rb

@@ -5,8 +5,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 
       # user
       t.text :to
-      t.integer :user_id
-      t.string :user_type
+      t.references :user, polymorphic: true
 
       # optional - feel free to remove
       t.string :mailer
@@ -27,6 +26,5 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     end
 
     add_index :ahoy_messages, [:token]
-    add_index :ahoy_messages, [:user_id, :user_type]
   end
 end

data/test/gemfiles/actionmailer51.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ahoy_email.gemspec
+gemspec path: "../../"
+
+gem "actionmailer", "~> 5.1.0"

data/test/test_helper.rb

@@ -7,7 +7,11 @@ require "combustion"
 Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
 
 Combustion.path = "test/internal"
-Combustion.initialize! :all
+Combustion.initialize! :all do
+  if config.active_record.sqlite3.respond_to?(:represent_boolean_as_integer)
+    config.active_record.sqlite3.represent_boolean_as_integer = true
+  end
+end
 
 ActionMailer::Base.delivery_method = :test
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +98,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple, powerful email tracking for Rails
+description: 
 email:
 - andrew@chartkick.com
 executables: []
@@ -164,6 +206,7 @@ files:
 - lib/generators/ahoy_email/templates/install.rb
 - test/gemfiles/actionmailer42.gemfile
 - test/gemfiles/actionmailer50.gemfile
+- test/gemfiles/actionmailer51.gemfile
 - test/internal/config/database.yml
 - test/internal/config/routes.rb
 - test/internal/db/schema.rb
@@ -189,13 +232,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple, powerful email tracking for Rails
 test_files:
 - test/gemfiles/actionmailer42.gemfile
 - test/gemfiles/actionmailer50.gemfile
+- test/gemfiles/actionmailer51.gemfile
 - test/internal/config/database.yml
 - test/internal/config/routes.rb
 - test/internal/db/schema.rb