authtrail 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a8cfabe2cfddb7349c055c13db2b56080409058ba48813310c6218a6b34fba
-  data.tar.gz: 59190df662382f672ad17c753d1eee6c0f8afacb68f7e082ed8766f188487d66
+  metadata.gz: 9481599ae1715a613d794df663c4c6a25f15bb941e0b1043f0fda8bb34841771
+  data.tar.gz: 42cce2b5e242e9120e7ce9699d7da7d30f61d2cefbd7c06add65182174ab8e95
 SHA512:
-  metadata.gz: c9137421c5e8f4c91be7dae62ccc9f12a831da6ae6fb390cfca766274045135c130f3cd9b0b5178d041be1348c527f39cc1aa0c986c798634e68300ee1c5a0a7
-  data.tar.gz: fa139b3a9df804feb52fa3823a67fb88781cefeda509d5719caf3f98c793e1aaaaecec553e8d1b1f08c03da8c4886b8e42400158e04aef12c34d404045b7b799
+  metadata.gz: a2facc0859a8c691b5512e95323b7d970a077fa0f7d9effa3701078344b507105fce23d383952c3f889ef941b869d7c53127da7911e1e5a5d57021c1cf603571
+  data.tar.gz: 49298c5c5094c5106daa8275ddf4298061a298690fef08469192429999e4cfd44b8e81f13c4148706d10795ebdf2cc3ce6642e6d6509ce1622a885b23d6e05d1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.6.0 (2024-11-11)
+
+- Improved generator for Active Record encryption and MySQL
+- Removed support for Rails < 7 and Ruby < 3.1
+
+## 0.5.0 (2023-07-02)
+
+- Made Active Record and Active Job optional
+- Removed support for Rails < 6.1 and Ruby < 3
+
 ## 0.4.3 (2022-06-12)
 
 - Updated install generator for Lockbox 1.0

data/LICENSE.txt

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

data/README.md

@@ -2,11 +2,9 @@
 
 Track Devise login activity
 
-**AuthTrail 0.4.0 was recently released** - see [how to upgrade](#upgrading)
-
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://github.com/ankane/authtrail/workflows/build/badge.svg?branch=master)](https://github.com/ankane/authtrail/actions)
+[![Build Status](https://github.com/ankane/authtrail/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/authtrail/actions)
 
 ## Installation
 
@@ -23,7 +21,7 @@ rails generate authtrail:install --encryption=lockbox
 rails db:migrate
 ```
 
-To use Active Record encryption (Rails 7+, experimental), run:
+To use Active Record encryption, run:
 
 ```sh
 rails generate authtrail:install --encryption=activerecord
@@ -135,13 +133,17 @@ AuthTrail.job_queue = :low_priority
 
 ### Local Geocoding
 
-For privacy and performance, we recommend geocoding locally. Add this line to your application’s Gemfile:
+For privacy and performance, we recommend geocoding locally.
+
+For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/).
+
+Add this line to your application’s Gemfile:
 
 ```ruby
 gem "maxminddb"
 ```
 
-For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and create `config/initializers/geocoder.rb` with:
+And create `config/initializers/geocoder.rb` with:
 
 ```ruby
 Geocoder.configure(
@@ -158,6 +160,12 @@ For country-level geocoding, install the `geoip-database` package. It’s preins
 sudo apt-get install geoip-database
 ```
 
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "geoip"
+```
+
 And create `config/initializers/geocoder.rb` with:
 
 ```ruby
@@ -210,29 +218,6 @@ We recommend using this in addition to Devise’s `Lockable` module and [Rack::A
 
 Check out [Hardening Devise](https://ankane.org/hardening-devise) and [Secure Rails](https://github.com/ankane/secure_rails) for more best practices.
 
-## Upgrading
-
-### 0.4.0
-
-There are two notable changes to geocoding:
-
-1. Geocoding is now disabled by default (this was already the case for new installations with 0.3.0+). Check out the instructions for [how to enable it](#geocoding) (you may need to create `config/initializers/authtrail.rb`).
-
-2. The `geocoder` gem is now an optional dependency. To use geocoding, add it to your Gemfile:
-
-  ```ruby
-  gem "geocoder"
-  ```
-
-### 0.2.0
-
-To store latitude and longitude, create a migration with:
-
-```ruby
-add_column :login_activities, :latitude, :float
-add_column :login_activities, :longitude, :float
-```
-
 ## History
 
 View the [changelog](https://github.com/ankane/authtrail/blob/master/CHANGELOG.md)

data/lib/auth_trail/version.rb

@@ -1,3 +1,3 @@
 module AuthTrail
-  VERSION = "0.4.3"
+  VERSION = "0.6.0"
 end

data/lib/authtrail.rb

@@ -2,15 +2,24 @@
 require "warden"
 
 # modules
-require "auth_trail/engine"
-require "auth_trail/manager"
-require "auth_trail/version"
+require_relative "auth_trail/manager"
+require_relative "auth_trail/version"
 
 module AuthTrail
+  autoload :GeocodeJob, "auth_trail/geocode_job"
+
   class << self
     attr_accessor :exclude_method, :geocode, :track_method, :identity_method, :job_queue, :transform_method
   end
   self.geocode = false
+  self.track_method = lambda do |data|
+    login_activity = LoginActivity.new
+    data.each do |k, v|
+      login_activity.try("#{k}=", v)
+    end
+    login_activity.save!
+    AuthTrail::GeocodeJob.perform_later(login_activity) if AuthTrail.geocode
+  end
   self.identity_method = lambda do |request, opts, user|
     if user
       user.try(:email)
@@ -45,16 +54,7 @@ module AuthTrail
     exclude = AuthTrail.exclude_method && AuthTrail.safely(default: false) { AuthTrail.exclude_method.call(data) }
 
     unless exclude
-      if AuthTrail.track_method
-        AuthTrail.track_method.call(data)
-      else
-        login_activity = LoginActivity.new
-        data.each do |k, v|
-          login_activity.try("#{k}=", v)
-        end
-        login_activity.save!
-        AuthTrail::GeocodeJob.perform_later(login_activity) if AuthTrail.geocode
-      end
+      AuthTrail.track_method.call(data)
     end
   end
 

data/lib/generators/authtrail/install_generator.rb

@@ -6,9 +6,7 @@ module Authtrail
       include ActiveRecord::Generators::Migration
       source_root File.join(__dir__, "templates")
 
-      class_option :encryption, type: :string
-      # deprecated
-      class_option :lockbox, type: :boolean
+      class_option :encryption, type: :string, required: true
 
       def copy_migration
         encryption # ensure valid
@@ -39,8 +37,11 @@ module Authtrail
         when "lockbox"
           "t.text :identity_ciphertext\n      t.string :identity_bidx, index: true"
         else
-          # TODO add limit: 510 for Active Record encryption + MySQL?
-          "t.string :identity, index: true"
+          if encryption == "activerecord" && mysql?
+            "t.string :identity, limit: 510, index: true"
+          else
+            "t.string :identity, index: true"
+          end
         end
       end
 
@@ -49,23 +50,14 @@ module Authtrail
         when "lockbox"
           "t.text :ip_ciphertext\n      t.string :ip_bidx, index: true"
         else
-          # TODO add limit: 510 for Active Record encryption + MySQL?
           "t.string :ip, index: true"
         end
       end
 
-      # TODO remove default
       def encryption
         case options[:encryption]
         when "lockbox", "activerecord", "none"
           options[:encryption]
-        when nil
-          if options[:lockbox]
-            # TODO deprecation warning
-            "lockbox"
-          else
-            "none"
-          end
         else
           abort "Error: encryption must be lockbox, activerecord, or none"
         end
@@ -78,6 +70,14 @@ module Authtrail
           "has_encrypted"
         end
       end
+
+      def mysql?
+        adapter =~ /mysql|trilogy/i
+      end
+
+      def adapter
+        ActiveRecord::Base.connection_db_config.adapter.to_s
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authtrail
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-12 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: warden
   requirement: !ruby/object:Gem::Requirement
@@ -61,8 +47,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- app/jobs/auth_trail/geocode_job.rb
-- lib/auth_trail/engine.rb
+- lib/auth_trail/geocode_job.rb
 - lib/auth_trail/manager.rb
 - lib/auth_trail/version.rb
 - lib/authtrail.rb
@@ -84,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Track Devise login activity

data/lib/auth_trail/engine.rb

@@ -1,7 +0,0 @@
-require "active_support"
-require "rails/engine"
-
-module AuthTrail
-  class Engine < Rails::Engine
-  end
-end