ahoy_email 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 527a708aff3145893b72f1ca737ba23c89e101fd4619d24469f941e909dd6c9b
-  data.tar.gz: ac041969c7872230cca421cb08981b23a4a070db1b24050f80b7924c5c6c1a04
+  metadata.gz: c056fb39ad0a8774c23582f8a37fbea9f460d903f4f05565e31b5670b0ce615d
+  data.tar.gz: 5b489942efd5cb224f068d06d06fdd9e9e68f65d256ded15be359ccdfc4190ec
 SHA512:
-  metadata.gz: a7e5203d5932c1d47d47c58c56abce98ce528ecfeb4f775f434e2555a1e241697eb5a9df4fcd2c031dbee98cb6b767edb3bb65af206baa62e9da533bd5c90add
-  data.tar.gz: dbfbf3057ce14095875a15be2c80654ff5561c8b7f83d95a91fcc1ec663ab668083cdcc236b0a4afa1d0417e0885ca58f89950e21b593370949c9dec5ea5bffb
+  metadata.gz: 55a1a58246738297be5e07198ef58014a13596fa372cf8127a4b4670ddfb7465c09371250ff269306cfc03ef7704ec28bc716669857eb6bc40fbe3132c94564a
+  data.tar.gz: b58a064519fb0ef57a255db8a57c4b0101f0fbf029e3110f1ece205e927bb13a8e4c3d5f95888e36be41f25eed6f0dc73ee995ff546d27771604c6b4058fd392

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.0
+
+- Made `opened_at` optional with click tracking
+- Fixed secret token for environment variables
+- Removed support for Rails 4.2
+
 ## 1.0.3
 
 - Fixed custom message model

data/README.md

@@ -53,7 +53,7 @@ AhoyEmail.default_options[:message] = false
 
 Ahoy records the user a message is sent to - not just the email address. This gives you a full history of messages for each user, even if he or she changes addresses.
 
-By default, Ahoy tries `@user` then `params[:user]` then `User.find_by(email: message.to.first)` to find the user.
+By default, Ahoy tries `@user` then `params[:user]` then `User.find_by(email: message.to)` to find the user.
 
 You can pass a specific user with:
 
@@ -243,6 +243,22 @@ end
 AhoyEmail.subscribers << EmailSubscriber.new
 ```
 
+## Data Protection
+
+Protect the privacy of your users by encrypting the `to` field. [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted) is great for this. Use [blind_index](https://github.com/ankane/blind_index) if you need to query by the `to` field.
+
+Create `app/models/ahoy/message.rb` with:
+
+```ruby
+class Ahoy::Message < ApplicationRecord
+  self.table_name = "ahoy_messages"
+  belongs_to :user, polymorphic: true, optional: true
+
+  attr_encrypted :to, key: ...
+  blind_index :to, key: ...
+end
+```
+
 ## Reference
 
 Set global options
@@ -303,10 +319,10 @@ Breaking changes
 
   ```ruby
   # old
-  user: ->(mailer, message) { User.find_by(email: message.to.first) }
+  user: ->(mailer, message) { User.find_by(email: message.to) }
 
   # new
-  user: -> { User.find_by(email: message.to.first) }
+  user: -> { User.find_by(email: message.to) }
   ```
 
 - Invalid options now throw an `ArgumentError`

data/app/controllers/ahoy/messages_controller.rb

@@ -1,13 +1,9 @@
 module Ahoy
   class MessagesController < ApplicationController
     filters = _process_action_callbacks.map(&:filter) - AhoyEmail.preserve_callbacks
-    if Rails::VERSION::MAJOR >= 5
-      skip_before_action(*filters, raise: false)
-      skip_after_action(*filters, raise: false)
-      skip_around_action(*filters, raise: false)
-    else
-      skip_action_callback *filters
-    end
+    skip_before_action(*filters, raise: false)
+    skip_after_action(*filters, raise: false)
+    skip_around_action(*filters, raise: false)
 
     before_action :set_message
 
@@ -25,7 +21,7 @@ module Ahoy
     def click
       if @message && !@message.clicked_at
         @message.clicked_at = Time.now
-        @message.opened_at ||= @message.clicked_at
+        @message.opened_at ||= @message.clicked_at if @message.respond_to?(:opened_at=)
         @message.save!
       end
 

data/app/models/ahoy/message.rb

@@ -2,6 +2,6 @@ module Ahoy
   class Message < ActiveRecord::Base
     self.table_name = "ahoy_messages"
 
-    belongs_to :user, (ActiveRecord::VERSION::MAJOR >= 5 ? {optional: true} : {}).merge(polymorphic: true)
+    belongs_to :user, polymorphic: true, optional: true
   end
 end

data/lib/ahoy_email/engine.rb

@@ -13,7 +13,9 @@ module AhoyEmail
             app.config
           end
 
-        creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
+        token = creds.respond_to?(:secret_key_base) ? creds.secret_key_base : creds.secret_token
+        token ||= app.secret_key_base # should come first, but need to maintain backward compatibility
+        token
       end
     end
   end

data/lib/ahoy_email/processor.rb

@@ -58,7 +58,9 @@ module AhoyEmail
 
     def track_open
       if html_part?
-        raw_source = (message.html_part || message).body.raw_source
+        part = message.html_part || message
+        raw_source = part.body.raw_source
+
         regex = /<\/body>/i
         url =
           url_for(
@@ -71,18 +73,18 @@ module AhoyEmail
 
         # try to add before body tag
         if raw_source.match(regex)
-          raw_source.gsub!(regex, "#{pixel}\\0")
+          part.body = raw_source.gsub(regex, "#{pixel}\\0")
         else
-          raw_source << pixel
+          part.body = raw_source + pixel
         end
       end
     end
 
     def track_links
       if html_part?
-        body = (message.html_part || message).body
+        part = message.html_part || message
 
-        doc = Nokogiri::HTML(body.raw_source)
+        doc = Nokogiri::HTML(part.body.raw_source)
         doc.css("a[href]").each do |link|
           uri = parse_uri(link["href"])
           next unless trackable?(uri)
@@ -98,6 +100,8 @@ module AhoyEmail
           end
 
           if options[:click] && !skip_attribute?(link, "click")
+            raise "Secret token is empty" unless AhoyEmail.secret_token
+
             # TODO sign more than just url and transition to HMAC-SHA256
             signature = OpenSSL::HMAC.hexdigest("SHA1", AhoyEmail.secret_token, link["href"])
             link["href"] =
@@ -111,8 +115,7 @@ module AhoyEmail
           end
         end
 
-        # hacky
-        body.raw_source.sub!(body.raw_source, doc.to_s)
+        part.body = doc.to_s
       end
     end
 

data/lib/ahoy_email/version.rb

@@ -1,3 +1,3 @@
 module AhoyEmail
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/generators/ahoy_email/install_generator.rb

@@ -1,34 +1,17 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module AhoyEmail
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "install.rb", "db/migrate/create_ahoy_messages.rb", migration_version: migration_version
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ahoy_email
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 description: 
 email: andrew@chartkick.com
 executables: []
@@ -198,15 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Email analytics for Rails