mailkick 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a36d760e07c5d02d2a0a685c4ced2e9075eb0e272f7814b08fd477fd282a9a0
-  data.tar.gz: 6038e41c31a36c14fd7438fc870531773fb6098d0932e72b4d187dc9c51ef634
+  metadata.gz: 8256980737a3ffda9fce00c4117b05566bf89728f39869e3c5f8afd8a0419728
+  data.tar.gz: dc8887bf9b238bdc3031e7f1b0aa3ba42a36f371494f62583b319b84dab70162
 SHA512:
-  metadata.gz: f1f4229e0f2191437d1cda0ef791683908cbc9d5a98519ba8fd00f9250b6f64f9aa0f9ec0df8be05c62506bf6d7e407bf610643d7f2faf979c066d8e977f7efc
-  data.tar.gz: b2801fbe7e9bb5de9d3eda275e7b162b68ccf5ff3ad352cb5b4462a3e617edb44cae177652d3c7ecda70f7dd35abc2755cc958219e761510270f32605f7eae91
+  metadata.gz: 670b60804614ab81daba07cbc20fdde047386b6ea704f66ce4934737b9211b16e34683ad469f318683195aa7036d19615ba4a0363352c0979ec6a40b2467f009
+  data.tar.gz: b5acb8496859d172360fb59ff06a7406831b79837264758eb9f6ba88c47ff3b731404b7a75bf08c59539553ff8ab44901785485e996c69063bdb086973a70977

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.0
+
+- Fixed error with model methods and `email_key` option
+- Fixed bug with `opted_out` scope
+- Dropped support for Action Mailer 4.2
+
 ## 0.3.1
 
 - Fixed `Secret should not be nil` error in Rails 5.2
@@ -10,7 +16,7 @@
 - Fixed `Subscription not found` for Rails 5.2
 - Use `references` in migration
 - Use `smtp_settings[:domain]` for Mailgun
-- Dropped support for ActionMailer < 4.2
+- Dropped support for Action Mailer < 4.2
 
 ## 0.2.1
 

data/LICENSE.txt

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

data/README.md

@@ -203,6 +203,12 @@ Resubscribe
 user.opt_in
 ```
 
+Access the opt-out model directly
+
+```ruby
+Mailkick::OptOut.all
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/mailkick/blob/master/CHANGELOG.md)

data/app/controllers/mailkick/subscriptions_controller.rb

@@ -31,11 +31,7 @@ module Mailkick
         list: @list
       }
     rescue ActiveSupport::MessageVerifier::InvalidSignature
-      if Rails::VERSION::MAJOR >= 5
-        render plain: "Subscription not found", status: :bad_request
-      else
-        render text: "Subscription not found", status: :bad_request
-      end
+      render plain: "Subscription not found", status: :bad_request
     end
 
     def opted_out?

data/app/models/mailkick/opt_out.rb

@@ -2,6 +2,6 @@ module Mailkick
   class OptOut < ActiveRecord::Base
     self.table_name = "mailkick_opt_outs"
 
-    belongs_to :user, ActiveRecord::VERSION::MAJOR >= 5 ? {polymorphic: true, optional: true} : {polymorphic: true}
+    belongs_to :user, polymorphic: true, optional: true
   end
 end

data/lib/generators/mailkick/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 Mailkick
   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/install_mailkick.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

data/lib/mailkick.rb

@@ -1,7 +1,8 @@
+# dependencies
 require "set"
 require "active_support"
 
-require "mailkick/engine" if defined?(Rails)
+# modules
 require "mailkick/model"
 require "mailkick/service"
 require "mailkick/service/mailchimp"
@@ -10,6 +11,9 @@ require "mailkick/service/mandrill"
 require "mailkick/service/sendgrid"
 require "mailkick/version"
 
+# integrations
+require "mailkick/engine" if defined?(Rails)
+
 module Mailkick
   mattr_accessor :services, :user_method, :secret_token, :mount
   self.services = []

data/lib/mailkick/model.rb

@@ -3,8 +3,8 @@ module Mailkick
     def mailkick_user(opts = {})
       email_key = opts[:email_key] || :email
       class_eval do
-        scope :opted_out, proc {|options = {}|
-          binds = [self.class.name, true]
+        scope :opted_out, lambda { |options = {}|
+          binds = [name, true]
           if options[:list]
             query = "(mailkick_opt_outs.list IS NULL OR mailkick_opt_outs.list = ?)"
             binds << options[:list]
@@ -13,20 +13,21 @@ module Mailkick
           end
           where("#{options[:not] ? 'NOT ' : ''}EXISTS(SELECT * FROM mailkick_opt_outs WHERE (#{table_name}.#{email_key} = mailkick_opt_outs.email OR (#{table_name}.#{primary_key} = mailkick_opt_outs.user_id AND mailkick_opt_outs.user_type = ?)) AND mailkick_opt_outs.active = ? AND #{query})", *binds)
         }
-        scope :not_opted_out, proc {|options = {}|
+
+        scope :not_opted_out, lambda { |options = {}|
           opted_out(options.merge(not: true))
         }
 
-        def opted_out?(options = {})
-          Mailkick.opted_out?({email: email, user: self}.merge(options))
+        define_method :opted_out? do |options = {}|
+          Mailkick.opted_out?({email: send(email_key), user: self}.merge(options))
         end
 
-        def opt_out(options = {})
-          Mailkick.opt_out({email: email, user: self}.merge(options))
+        define_method :opt_out do |options = {}|
+          Mailkick.opt_out({email: send(email_key), user: self}.merge(options))
         end
 
-        def opt_in(options = {})
-          Mailkick.opt_in({email: email, user: self}.merge(options))
+        define_method :opt_in do |options = {}|
+          Mailkick.opt_in({email: send(email_key), user: self}.merge(options))
         end
       end
     end

data/lib/mailkick/version.rb

@@ -1,3 +1,3 @@
 module Mailkick
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkick
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,26 +165,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/controllers/mailkick/subscriptions_controller.rb
 - app/helpers/mailkick/url_helper.rb
 - app/models/mailkick/opt_out.rb
 - app/views/mailkick/subscriptions/show.html.erb
 - config/routes.rb
 - lib/generators/mailkick/install_generator.rb
-- lib/generators/mailkick/templates/install.rb
+- lib/generators/mailkick/templates/install.rb.tt
 - lib/generators/mailkick/views_generator.rb
 - lib/mailkick.rb
 - lib/mailkick/engine.rb
@@ -195,18 +190,6 @@ files:
 - lib/mailkick/service/mandrill.rb
 - lib/mailkick/service/sendgrid.rb
 - lib/mailkick/version.rb
-- mailkick.gemspec
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/app/mailers/user_mailer.rb
-- test/internal/app/models/user.rb
-- test/internal/app/views/user_mailer/welcome.html.erb
-- test/internal/app/views/user_mailer/welcome.text.erb
-- test/internal/config/database.yml
-- test/internal/db/schema.rb
-- test/mailkick_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/mailkick
 licenses:
 - MIT
@@ -219,27 +202,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      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 subscriptions made easy
-test_files:
-- test/gemfiles/actionmailer42.gemfile
-- test/gemfiles/actionmailer50.gemfile
-- test/gemfiles/actionmailer51.gemfile
-- test/internal/app/mailers/user_mailer.rb
-- test/internal/app/models/user.rb
-- test/internal/app/views/user_mailer/welcome.html.erb
-- test/internal/app/views/user_mailer/welcome.text.erb
-- test/internal/config/database.yml
-- test/internal/db/schema.rb
-- test/mailkick_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,25 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.log
-*.sqlite
-*.lock

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.2
-sudo: false
-script: bundle exec rake test
-before_script:
-  - gem install bundler
-notifications:
-  email:
-    on_success: never
-    on_failure: change
-gemfile:
-  - Gemfile
-  - test/gemfiles/actionmailer51.gemfile
-  - test/gemfiles/actionmailer50.gemfile
-  - test/gemfiles/actionmailer42.gemfile

data/Gemfile

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

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.warning = false
-end

data/mailkick.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mailkick/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "mailkick"
-  spec.version       = Mailkick::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Email subscriptions made easy"
-  spec.homepage      = "https://github.com/ankane/mailkick"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", ">= 4.2"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "gibbon", ">= 2"
-  spec.add_development_dependency "mailgun-ruby"
-  spec.add_development_dependency "mandrill-api"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "sendgrid_toolkit"
-  spec.add_development_dependency "combustion"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "sqlite3"
-end

data/test/gemfiles/actionmailer42.gemfile

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

data/test/gemfiles/actionmailer50.gemfile

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

data/test/gemfiles/actionmailer51.gemfile

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

data/test/internal/app/mailers/user_mailer.rb

@@ -1,7 +0,0 @@
-class UserMailer < ActionMailer::Base
-  default from: "from@example.com"
-
-  def welcome
-    mail to: "test@example.org", subject: "Hello"
-  end
-end

data/test/internal/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-  mailkick_user
-end

data/test/internal/app/views/user_mailer/welcome.html.erb

@@ -1 +0,0 @@
-<p><%= mailkick_unsubscribe_url %></p>

data/test/internal/app/views/user_mailer/welcome.text.erb

@@ -1 +0,0 @@
-Unsubscribe: <%= mailkick_unsubscribe_url %>

data/test/internal/config/database.yml

@@ -1,3 +0,0 @@
-test:
-  adapter:  sqlite3
-  database: db/combustion_test.sqlite

data/test/internal/db/schema.rb

@@ -1,16 +0,0 @@
-ActiveRecord::Schema.define do
-  create_table :mailkick_opt_outs do |t|
-    t.string :email
-    t.references :user, polymorphic: true
-    t.boolean :active, null: false, default: true
-    t.string :reason
-    t.string :list
-    t.timestamps
-  end
-
-  add_index :mailkick_opt_outs, :email
-
-  create_table :users do |t|
-    t.string :email
-  end
-end

data/test/mailkick_test.rb

@@ -1,29 +0,0 @@
-require_relative "test_helper"
-
-class MailkickTest < Minitest::Test
-  def test_unsubscribe_url
-    message = UserMailer.welcome.deliver_now
-    html_body = message.html_part.body.to_s
-    assert_includes html_body, "unsubscribe"
-    text_body = message.text_part.body.to_s
-    assert_includes text_body, "unsubscribe"
-  end
-
-  def test_opt_out
-    email = "test2@example.org"
-    user = User.create!(email: email)
-
-    Mailkick.opt_out(email: email, user: user)
-
-    opt_outs = Mailkick::OptOut.all.to_a
-    assert_equal 1, opt_outs.size
-
-    opt_out = opt_outs.first
-    assert_equal email, opt_out.email
-    assert_equal user, opt_out.user
-
-    assert user.opted_out?
-    assert_equal 1, User.opted_out.count
-    assert_equal 0, User.not_opted_out.count
-  end
-end

data/test/test_helper.rb

@@ -1,18 +0,0 @@
-require "bundler/setup"
-require "combustion"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-require "logger"
-
-Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
-
-Combustion.path = "test/internal"
-Combustion.initialize! :all do
-  if config.active_record.sqlite3.respond_to?(:represent_boolean_as_integer)
-    config.active_record.sqlite3.represent_boolean_as_integer = false
-  end
-end
-
-ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT) if ENV["VERBOSE"]
-ActionMailer::Base.delivery_method = :test