mailkick 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84a6786c23946b6e27a67a14d75c01da5cde231928d19c65edd2b591de9a153
-  data.tar.gz: 1a944d065c7bf4c164db038aabe0073b3759e96a232ec22b29e86cf746ffc02f
+  metadata.gz: 2d27cea2a7290b64e0b7d59322124923e5c84069040d43df800269bd17069aec
+  data.tar.gz: 4a40900192322ef6e5f04940277713ce43d0c64c3a672ec29ec3a5dbd2269e80
 SHA512:
-  metadata.gz: 3ed9f0315dc5c60ed5b2cc524fd13763566b6126bafceb665dbddcdc2a182f4408a370e267fdcc8ab97cbe616684c7ff5ab91b0fe717d39a65deac854cd3b958
-  data.tar.gz: 82c2c1d7a1d0077eb60df59a9d672039b17750462a435afdef19125e26f3c122600a2a8f394c06a3119a64c773d4a6ef7a1f61dc5081dca587735eda80c4a9c3
+  metadata.gz: 39fc8af0c0b60f613834f05e9b02b8bbe795cb483ce62e4a99016d257ae0345ff7a97d024d5e4c9791b04f5074e51679b92175470e987e613152034aa8ee5128
+  data.tar.gz: b1f1ed3b224be6bfb74d87851e029a797783b7bf25d4d19c09a2b1867b3ce6a1803e19cabf7942ec9eedd1575c3aff6f6279386373fe8a6af807f659bb395817

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.1.1 (2023-01-30)
+
+- Switched to JSON for serialization with non-default `secret_token`
+
+## 1.1.0 (2023-01-29)
+
+- Improved secret token generation
+- Switched to JSON for serialization with default `secret_token`
+
 ## 1.0.1 (2021-06-20)
 
 - Fixed error message when process out-opts not configured

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2021 Andrew Kane
+Copyright (c) 2014-2023 Andrew Kane
 
 MIT License
 

data/README.md

@@ -5,8 +5,6 @@ Email subscriptions for Rails
 - Add one-click unsubscribe links to your emails
 - Fetch bounces and spam reports from your email service
 
-**Mailkick 1.0 was recently released** - see [how to upgrade](#upgrading)
-
 :postbox: Check out [Ahoy Email](https://github.com/ankane/ahoy_email) for analytics
 
 [![Build Status](https://github.com/ankane/mailkick/workflows/build/badge.svg?branch=master)](https://github.com/ankane/mailkick/actions)
@@ -16,7 +14,7 @@ Email subscriptions for Rails
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'mailkick'
+gem "mailkick"
 ```
 
 And run the generator. This creates a table to store subscriptions.
@@ -125,7 +123,7 @@ Will gladly accept pull requests for others.
 Add the gem
 
 ```ruby
-gem 'aws-sdk-sesv2'
+gem "aws-sdk-sesv2"
 ```
 
 And [configure your AWS credentials](https://github.com/aws/aws-sdk-ruby#configuration). Requires `ses:ListSuppressedDestinations` permission.
@@ -137,7 +135,7 @@ If you started using Amazon SES [before November 25, 2019](https://docs.aws.amaz
 Add the gem
 
 ```ruby
-gem 'gibbon', '>= 2'
+gem "gibbon", ">= 2"
 ```
 
 And set `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]`.
@@ -147,7 +145,7 @@ And set `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]`.
 Add the gem
 
 ```ruby
-gem 'mailgun-ruby'
+gem "mailgun-ruby"
 ```
 
 And set `ENV["MAILGUN_API_KEY"]`.
@@ -157,7 +155,7 @@ And set `ENV["MAILGUN_API_KEY"]`.
 Add the gem
 
 ```ruby
-gem 'mandrill-api'
+gem "mandrill-api"
 ```
 
 And set `ENV["MANDRILL_APIKEY"]`.
@@ -167,7 +165,7 @@ And set `ENV["MANDRILL_APIKEY"]`.
 Add the gem
 
 ```ruby
-gem 'postmark'
+gem "postmark"
 ```
 
 And set `ENV["POSTMARK_API_KEY"]`.
@@ -177,7 +175,7 @@ And set `ENV["POSTMARK_API_KEY"]`.
 Add the gem
 
 ```ruby
-gem 'sendgrid-ruby'
+gem "sendgrid-ruby"
 ```
 
 And set `ENV["SENDGRID_API_KEY"]`. The API key requires only the `Suppressions` permission.

data/lib/mailkick/engine.rb

@@ -5,7 +5,11 @@ module Mailkick
     initializer "mailkick" do |app|
       Mailkick.discover_services unless Mailkick.services.any?
 
-      Mailkick.secret_token ||= begin
+      unless Mailkick.secret_token
+        Mailkick.secret_token = app.key_generator.generate_key("mailkick")
+        Mailkick.message_verifier = ActiveSupport::MessageVerifier.new(Mailkick.secret_token, serializer: JSON)
+
+        # TODO remove in 2.0
         creds =
           if app.respond_to?(:credentials) && app.credentials.secret_key_base
             app.credentials
@@ -15,7 +19,8 @@ module Mailkick
             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
+        Mailkick.message_verifier.rotate(token, serializer: Marshal)
       end
     end
   end

data/lib/mailkick/serializer.rb

@@ -0,0 +1,15 @@
+# need custom class due to
+# https://github.com/rails/rails/issues/47185
+module Mailkick
+  class Serializer
+    def self.dump(value)
+      JSON.dump(value)
+    end
+
+    def self.load(value)
+      JSON.load(value)
+    rescue JSON::ParserError
+      Marshal.load(value)
+    end
+  end
+end

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/lib/mailkick.rb

@@ -2,11 +2,13 @@
 require "active_support"
 
 # stdlib
+require "json"
 require "set"
 
 # modules
 require "mailkick/legacy"
 require "mailkick/model"
+require "mailkick/serializer"
 require "mailkick/service"
 require "mailkick/service/aws_ses"
 require "mailkick/service/mailchimp"
@@ -22,7 +24,9 @@ require "mailkick/version"
 require "mailkick/engine" if defined?(Rails)
 
 module Mailkick
-  mattr_accessor :services, :secret_token, :mount, :process_opt_outs_method
+  mattr_accessor :services, :mount, :process_opt_outs_method
+  mattr_reader :secret_token
+  mattr_writer :message_verifier
   self.services = []
   self.mount = true
   self.process_opt_outs_method = ->(_) { raise "process_opt_outs_method not defined" }
@@ -37,8 +41,13 @@ module Mailkick
     end
   end
 
+  def self.secret_token=(token)
+    @@secret_token = token
+    @@message_verifier = nil
+  end
+
   def self.message_verifier
-    @message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token)
+    @@message_verifier ||= ActiveSupport::MessageVerifier.new(Mailkick.secret_token, serializer: Serializer)
   end
 
   def self.generate_token(subscriber, list)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,6 +45,7 @@ files:
 - lib/mailkick/engine.rb
 - lib/mailkick/legacy.rb
 - lib/mailkick/model.rb
+- lib/mailkick/serializer.rb
 - lib/mailkick/service.rb
 - lib/mailkick/service/aws_ses.rb
 - lib/mailkick/service/mailchimp.rb
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Email subscriptions for Rails