db_session 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a803fca4e763e6665092b29dd9feb4911d605a02
-  data.tar.gz: 87571df508941c0e5d218172d17b7a8b43b97c81
+  metadata.gz: e6714f9b659ebeb71ccf2cf7be8cc5d425eb920c
+  data.tar.gz: 644b8b95f71070950aa4ddf0ae1aa1db7c9c326b
 SHA512:
-  metadata.gz: c7de04bf441a3c02038548342a01a8c456cdc11cca90951746653036497dbab6487832ee3c78efc9fd153c0514178401cfbaf745ba016821acd57cb1b0f167b0
-  data.tar.gz: 1c27a541ff9ac09163abc08dc9a804309c725c39813a32d947ba106386fa1b0c1a3462a39708974a03f00b5d808628e718807be305bbdbf0c47655287384ddca
+  metadata.gz: ca06dc938618110c8111950cd3c53375b0e37dcfb344a4058dfce7fbb98b8917664f1ee3eb5525bca8f3658f7d7dc127cf88baf5edab3a3eb335d80b4d0c40fd
+  data.tar.gz: 77adcc5a12298d167320a13d29fc2a0b8cb32abb895559c74e44ee227222a487560cc92d4ebbbd34c374d0cda26044d4d0a8bbb27789be58aadd03f5fd57747c

data/README.rdoc

@@ -16,6 +16,8 @@ After you install DbSession and add it to your Gemfile, you need to run the gene
 
 The generator will install an initializer which describes DbSession configuration options.
 
+DbSession uses Sidekiq to perform some asynchronous task. Sidekiq uses Redis to manage its job queue, so you’ll need to install Redis.
+
 === Configuration
 
 You can set up the life span of a session in <i>config/initializers/db_session.rb</i>:
@@ -26,24 +28,26 @@ This value represent the time in seconds after which a session expire and can po
 
 === Usage
 
-You can call this methods inside any controller:
+You can call this methods on any controller or view:
 
-<tt>set_db_session(key, value)</tt>
+<tt>set_db_session(key, object)</tt>
 
-This method overwrite the content of the session with the key–value pair.
+This method overwrite the content of the session with the key–object pair.
 
-<tt>add_to_db_session(key, value)</tt>
+<tt>add_to_db_session(key, object)</tt>
 
-This method add the key–value pair to the content of the session.
+This method add the key–object pair to the content of the session.
 
 <tt>get_from_db_session(key)</tt>
 
-This method return the value stored in the session for the specified key. If no key is specified it returns the whole content of the session.
+This method return the object stored in the session for the specified key. If no key is specified it returns the whole content of the session.
 
 <tt>clear_db_session</tt>
 
 This method clear the content of the session.
 
+Objects are sotred in the database as JSON strings, so in order to be stored an object need to support JSON serialization and deserialization.
+
 === <em>That's it folks!</em>
 
 

data/lib/db_session.rb

@@ -1,5 +1,6 @@
 module DbSession
   require 'json'
+  require 'colorize'
   require 'workers/clear_session_stores_worker'
 
   autoload :DbSessionStore, 'models/db_session_store'
@@ -14,50 +15,64 @@ module DbSession
 
   def get_from_db_session(key=nil)
     db_session_id = session[SESSION_KEY]
-    db_session = DbSessionStore.find_by(id: db_session_id) if db_session_id
+    db_session_id ? db_session = DbSessionStore.find_by(id: db_session_id) : db_session = nil
 
     if db_session
       main_data_object = JSON.parse(db_session.serialized_data)
 
       if key
-        return main_data_object[key]
+        return rebuild_object(main_data_object[key.to_s])
       else
+        main_data_object.each do |k, v|
+          main_data_object[k] = rebuild_object(main_data_object[k])
+        end
         return main_data_object
       end
     end
   end
 
-  def set_db_session(key, value)
+  def set_db_session(key, object)
     clear_db_session
 
-    main_data_object = {}
-    main_data_object[key] = value
+    can_be_stored = can_be_stored?(object)
 
-    db_session = DbSessionStore.create(serialized_data: main_data_object.to_json)
-    session[SESSION_KEY] = db_session.id
+    if can_be_stored
+      main_data_object = {}
+      main_data_object[key] = {class: get_class(object), object: object}
+
+      db_session = DbSessionStore.create(serialized_data: main_data_object.to_json)
+
+      session[SESSION_KEY] = db_session.id
+    end
 
     clear_expired_sessions
+
+    can_be_stored
   end
 
-  def add_to_db_session(key, value)
-    main_data_object = {}
+  def add_to_db_session(key, object)
+    can_be_stored = can_be_stored?(object)
 
-    db_session_id = session[SESSION_KEY]
-    db_session = DbSessionStore.find_by(id: db_session_id) if db_session_id
+    if can_be_stored
+      db_session_id = session[SESSION_KEY]
+      db_session_id ? db_session = DbSessionStore.find_by(id: db_session_id) : db_session = nil
 
-    main_data_object = JSON.parse(db_session.serialized_data) if db_session
-    main_data_object[key] = value
+      db_session ? main_data_object = JSON.parse(db_session.serialized_data) : main_data_object = {}
+      main_data_object[key] = {class: get_class(object), object: object}
 
-    if db_session
-      db_session.serialized_data = main_data_object.to_json
-      db_session.save
-    else
-      db_session = DbSessionStore.create(serialized_data: main_data_object.to_json)
-    end
+      if db_session
+        db_session.serialized_data = main_data_object.to_json
+        db_session.save
+      else
+        db_session = DbSessionStore.create(serialized_data: main_data_object.to_json)
+      end
 
-    session[SESSION_KEY] = db_session.id
+      session[SESSION_KEY] = db_session.id
+    end
 
     clear_expired_sessions
+
+    can_be_stored
   end
 
   def clear_db_session
@@ -68,6 +83,41 @@ module DbSession
     end
   end
 
+  private
+
+  def rebuild_object(obj)
+    if obj['class']
+      new = class_from_string(obj['class']).new
+      new.assign_attributes(obj['object'])
+      new
+    else
+      obj['object']
+    end
+  end
+
+  def get_class(obj)
+    if obj
+      if obj.class.ancestors.include?(ActiveRecord::Base) && obj.respond_to?(:assign_attributes)
+        obj.class.name
+      end
+    end
+  end
+
+  def can_be_stored?(obj)
+    begin
+      JSON.parse(obj.to_json)
+      return true
+    rescue
+      return false
+    end
+  end
+
+  def class_from_string(str)
+    str.split('::').inject(Object) do |mod, class_name|
+      mod.const_get(class_name)
+    end
+  end
+
   def clear_expired_sessions
     begin
       ClearSessionStoresWorker.perform_async(session_validity)
@@ -78,4 +128,9 @@ module DbSession
   end
 end
 
-ActionController::Base.send(:include, DbSession)
+ActionController::Base.send(:include, DbSession)
+
+ActionController::Base.send(:helper_method, :get_from_db_session)
+ActionController::Base.send(:helper_method, :set_db_session)
+ActionController::Base.send(:helper_method, :add_to_db_session)
+ActionController::Base.send(:helper_method, :clear_db_session)

data/lib/db_session/version.rb

@@ -1,3 +1,3 @@
 module DbSession
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_session
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrea Salomoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails