activerecord-session_store 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0920d7a8356d636009b0ab31c27a96cbaad5f1b
-  data.tar.gz: f395a9a6b74ed0c90120e971f91ea1bc5087b62f
+  metadata.gz: 199bab6eabd1c53a61809255dd6fafd4ecfeffd1
+  data.tar.gz: fd10f4a954606f18f6d1d706d8f71d510eaa855b
 SHA512:
-  metadata.gz: e5c6788589a3c53391308c31718e1c8bf181b2bf7180ad70a1720cd9129815e5f77043ad4b51efec0b3ebbc404c4132fab404bb8a76880570c89d1948e76958d
-  data.tar.gz: b7f0155f5446dbadf8a5c9dca98a42f24615015035991402810908b28d7fce21257eb7264c046c7596902b8a5f55f2501820541d269358c8f62d7da97067affc
+  metadata.gz: 02175400f0fd3cb44160b71d440241ad97224dc48d20e9fbbbbffb28ba9364b7880446b71a62c34297b5ddb16cd75e6bc04d0940549e74f72ebc0f3672871695
+  data.tar.gz: f5e2b9522e09858fbeafe2dff0298ca80fef72c822282141a11c01eb147164afa86cbc5cdeb1a20ba4f790109eacfce3359ce2920932d04903cede2270fade96

data/README.md

@@ -18,12 +18,23 @@ Run the migration generator:
 
     rails generate active_record:session_migration
 
+Run the migration:
+
+    rake db:migrate
+
 Then, set your session store in `config/initializers/session_store.rb`:
 
 ```ruby
 Rails.application.config.session_store :active_record_store, :key => '_my_app_session'
 ```
 
+To avoid your sessions table expanding without limit as it will store expired and
+potentially sensitive session data, it is strongly recommended in production
+environments to schedule the `db:sessions:trim` rake task to run daily.
+Running `bin/rake db:sessions:trim` will delete all sessions that have not
+been updated in the last 30 days. The 30 days cutoff can be changed using the
+`SESSION_DAYS_TRIM_THRESHOLD` environment variable.
+
 Configuration
 --------------
 
@@ -31,7 +42,8 @@ The default assumes a `sessions` tables with columns:
 
 *  `id` (numeric primary key),
 *  `session_id` (string, usually varchar; maximum length is 255), and
-*  `data` (text or longtext; careful if your session data exceeds 65KB).
+*  `data` (text, longtext, json or jsonb); careful if your session data exceeds
+65KB).
 
 The `session_id` column should always be indexed for speedy lookups.
 Session data is marshaled to the `data` column in Base64 format.
@@ -53,11 +65,14 @@ having a separate `id` column if you don't want it. However, you must
 set `session.model.id = session.session_id` by hand!  A before filter
 on ApplicationController is a good place.
 
-The serializer may be one of `marshal`, `json`, or `hybrid`.  `marshal` is
-the default and uses the built-in Marshal methods coupled with Base64
-encoding.  `json` does what it says on the tin, using the `parse()` and
-`generate()` methods of the JSON module.  `hybrid` will read either type
-but write as JSON.
+The serializer may be class responding to `#load(value)` and `#dump(value)`, or
+a symbol of `marshal`, `json`, `hybrid` or `null`. `marshal` is the default and
+uses the built-in Marshal methods coupled with Base64 encoding. `json` does
+what it says on the tin, using the `parse()` and `generate()` methods of the
+JSON module. `hybrid` will read either type but write as JSON. `null` will
+not perform serialization, leaving that up to the ActiveRecord database
+adapter. This allows you to take advantage of the native JSON capabilities of
+your database.
 
 Since the default class is a simple Active Record, you get timestamps
 for free if you add `created_at` and `updated_at` datetime columns to

data/lib/active_record/session_store.rb

@@ -47,6 +47,8 @@ module ActiveRecord
             JsonSerializer
           when :hybrid then
             HybridSerializer
+          when :null then
+            NullSerializer
           else
             self.serializer
         end
@@ -91,6 +93,17 @@ module ActiveRecord
           value.start_with?(MARSHAL_SIGNATURE)
         end
       end
+
+      # Defer serialization to the ActiveRecord database adapter
+      class NullSerializer
+        def self.load(value)
+          value
+        end
+
+        def self.dump(value)
+          value
+        end
+      end
     end
   end
 end

data/lib/active_record/session_store/session.rb

@@ -80,7 +80,10 @@ module ActiveRecord
 
       private
         def serialize_data!
-          return false unless loaded?
+          unless loaded?
+            return false if Rails::VERSION::MAJOR < 5
+            throw :abort
+          end
           write_attribute(@@data_column_name, self.class.serialize(data))
         end
 
@@ -88,7 +91,10 @@ module ActiveRecord
         # larger than the data storage column. Raises
         # ActionController::SessionOverflowError.
         def raise_on_session_data_overflow!
-          return false unless loaded?
+          unless loaded?
+            return false if Rails::VERSION::MAJOR < 5
+            throw :abort
+          end
           limit = self.class.data_column_size_limit
           if limit and read_attribute(@@data_column_name).size > limit
             raise ActionController::SessionOverflowError

data/lib/active_record/session_store/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module SessionStore
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/tasks/database.rake

@@ -3,13 +3,13 @@ namespace 'db:sessions' do
   task :create => [:environment, 'db:load_config'] do
     raise 'Task unavailable to this database (no migration support)' unless ActiveRecord::Base.connection.supports_migrations?
     Rails.application.load_generators
-    require 'rails/generators/rails/session_migration/session_migration_generator'
-    Rails::Generators::SessionMigrationGenerator.start [ ENV['MIGRATION'] || 'add_sessions_table' ]
+    require 'generators/active_record/session_migration_generator'
+    ActiveRecord::Generators::SessionMigrationGenerator.start [ ENV['MIGRATION'] || 'add_sessions_table' ]
   end
 
   desc "Clear the sessions table"
   task :clear => [:environment, 'db:load_config'] do
-    ActiveRecord::Base.connection.execute "DELETE FROM #{ActiveRecord::SessionStore::Session.table_name}"
+    ActiveRecord::Base.connection.execute "TRUNCATE TABLE #{ActiveRecord::SessionStore::Session.table_name}"
   end
 
   desc "Trim old sessions from the table (default: > 30 days)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-session_store
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: An Action Dispatch session store backed by an Active Record class.