devise-activity 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11b74f54908a949e1fd7f77824b911847162465692517b1593127440f0e802ca
-  data.tar.gz: 89582a91b0f7e5070d0f42a83027af79f3134c6c107278103f78af09c79bf173
+  metadata.gz: 7d2df215d3525ec9108eb6ea3ced82541277bc90bab084aa4a2963b64f4ecb8e
+  data.tar.gz: a17d8a0a190f94bd6927141ec5a12522ac501874a36658c5f21164248b586749
 SHA512:
-  metadata.gz: e14f5b7c687c90c2347e805e00e9e8ba42b930f977915fd01ef345474d89afdcd18920cbe1c897b12ec20b8314b817ef457994750043410ef712789462157769
-  data.tar.gz: d699cdb824ce163a8de475b3939138eb6b0d4a97bf911ce3a4a94e9699b8319a4587bccd604bedd123d5dcc1cea7f0f92865093f548231e7fc002bac83800dbf
+  metadata.gz: 99f7eb0ff9f06df3348b87eebf24b5eecce1afadcd9461c272205ccaa7c792e784342ad97174b317d148fd5146b7c06e75ed8dafd0217596b6814030e684f0f7
+  data.tar.gz: fbb2ee8d65a870b82fe5ee4ec75cf295d8c7255ec121a439f477bceacc020332344da759ff57616b161c03573f4205b1630e42a7dae3c9af5d4c397753d6a79c

data/README.rdoc

@@ -1,16 +1,12 @@
-= Trackstamps
+= DeviseActivity
 
-Track which user created or updated record in rails. This gem depends on devise gem and uses devise 'current_user' helper method.
-
-== Dependency
-
-This gem depends on devise gem and uses devise 'current_user' helper method.
+Keep history of user page views and time spent on differnt pages in rails. This gem depends on devise gem and uses devise 'current_user' helper method which can be configured.
 
 == Installation
 
 Simply add trackstamps gem to your Gemfile.
 
-    gem 'trackstamps'
+    gem 'devise-activity'
 
 Install bundler gems
 
@@ -18,20 +14,17 @@ Install bundler gems
 
 Install trackstamps
 
-    rails generate trackstamps:install
+    rails generate devise_activity:install
 
+You can change sessions and navigations table names from generated configuration file (config/initializers/devise_activity.rb) before generating migration.
 Generate migration on required model's table
 
-    rails generate trackstamps:migration table_name
-
-i.e. if you need to track changes on Account model, you need to do this
+    rails generate devise_activity:migration
 
-    rails generate trackstamps:migration accounts
+Include DeviseActivity module to application controller or admin etc for which you want to track user activities
 
-It will automatically include trackstamps module inside your model class
-
-    class Account < ActiveRecord::Base
-        include Trackstamps
+    class ApplicationController
+        include DeviseActivity
 
         .....
 
@@ -46,19 +39,22 @@ And now you are ready to track changes
 
 == Usage
 
-It will automatically track record is created or updated by which user. i.e.
+It will automatically keep of sign in's, sign out's and page views history in sessions and navigations table i.e.
 
-    Account.last.creator
+    Session.all
 
 will return last account was created by which user. Similarily
 
-    Account.find(8).updater
+    Session.last.navigations
+
+    Session.where(user_id: 12).all
+
+    Session.where(user_id: 12).last.navigations
 
 will tells us which user updated account with id 8
 
 == TODO
 
-* Autodiscover devise model class
 * Mongoid ORM support
 
 == Contributing

data/lib/devise_activity/configuration.rb

@@ -2,10 +2,19 @@ module DeviseActivity
   class Configuration
     attr_accessor :sessions_table_name,
                   :navigations_table_name,
-                  :devise_model_name
+                  :devise_model_name,
+                  :sign_in_controller_name,
+                  :sign_in_action_name,
+                  :sign_out_controller_name,
+                  :sign_out_action_name
 
     def initialize
-
+      @sessions_table_name = 'sessions'
+      @navigations_table_name = 'navigations'
+      @sign_in_controller_name = 'sessions'
+      @sign_in_action_name = 'create'
+      @sign_out_controller_name = 'sessions'
+      @sign_out_action_name = 'destroy'
     end
   end
 end

data/lib/devise_activity/extenders/navigation.rb

@@ -0,0 +1,8 @@
+module DeviseActivity
+  module Extenders
+    module Navigation
+      # TODO: attrs tracking
+    end
+  end
+
+end

data/lib/devise_activity/extenders/session.rb

@@ -0,0 +1,7 @@
+module DeviseActivity
+  module Extenders
+    module Session
+      # TODO: attrs tracking
+    end
+  end
+end

data/lib/devise_activity/navigation.rb

@@ -1,5 +1,8 @@
 module DeviseActivity
   class Navigation < ApplicationRecord
-    #self.table_name = DeviseActivity.configuration.session_navigations_table_name
+    self.table_name = DeviseActivity.configuration.navigations_table_name
+
+    belongs_to :session, class_name: 'DeviseActivity::Session'
+
   end
 end

data/lib/devise_activity/session.rb

@@ -1,6 +1,10 @@
 module DeviseActivity
   class Session < ApplicationRecord
-    #self.table_name = DeviseActivity.configuration.session_activities_table_name
+    self.table_name = DeviseActivity.configuration.sessions_table_name
+
+    scope :current, ->(current_user){ where(user_id: current_user.id)}
+
+    has_many :navigations, class_name: 'DeviseActivity::Navigation'
 
   end
 end

data/lib/devise_activity/version.rb

@@ -1,3 +1,3 @@
 module DeviseActivity
-  VERSION = "0.1.4"
+  VERSION = "0.1.7"
 end

data/lib/devise_activity.rb

@@ -1,22 +1,53 @@
 require 'devise_activity/configuration'
 require 'active_record'
 
-
 module DeviseActivity
-  require 'devise_activity/session'
-  require 'devise_activity/navigation'
 
   extend ActiveSupport::Concern
 
   included do
 
-    before_action :track_user_activity
+    before_action :track_navigation_activity, if: Proc.new{ da_current_user.present? }
+
+    prepend_before_action :track_sign_out_activity, if: Proc.new{ controller_name == DeviseActivity.configuration.sign_out_controller_name and action_name == DeviseActivity.configuration.sign_out_action_name and da_current_user.present? }
+    after_action :track_sign_in_activity, if: Proc.new{ controller_name == DeviseActivity.configuration.sign_in_controller_name and action_name == DeviseActivity.configuration.sign_in_action_name and da_current_user.present? }
 
     protected
 
-    def track_user_activity
-      DeviseActivity::Session.create
-      DeviseActivity::Navigation.create
+    def track_sign_out_activity
+      current_session = Session.current(current_user).last
+      current_session.signed_out_at = Time.now
+      current_session.save
+    end
+
+    def track_sign_in_activity
+      current_session = Session.current(da_current_user).new
+      current_session.signed_in_at = Time.now
+      current_session.user_id = da_current_user.id
+      current_session.ip_address = request.remote_ip
+      current_session.save
+    end
+
+    def track_navigation_activity
+      current_session = find_or_create_current_session
+      navigation = Navigation.create session_id:current_session.id,
+                                     page_url: request.original_url,
+                                     controller_name: controller_name,
+                                     action_name: action_name
+    end
+
+    def find_or_create_current_session
+      session = Session.current(da_current_user).last
+      unless session.present? and session.signed_out_at.nil?
+        session = Session.create ip_address: request.remote_ip,
+                                 user_id: da_current_user.id,
+                                 signed_in_at: Time.now
+      end
+      session
+    end
+
+    def da_current_user
+      self.send("current_#{DeviseActivity.configuration.devise_model_name}")
     end
 
   end
@@ -28,5 +59,16 @@ module DeviseActivity
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
+    # Load models after configurations
+    if defined?(ActiveRecord::Base)
+      require "devise_activity/extenders/session"
+      require "devise_activity/extenders/navigation"
+      require "devise_activity/session"
+      require "devise_activity/navigation"
+      ActiveRecord::Base.extend DeviseActivity::Extenders::Session
+      ActiveRecord::Base.extend DeviseActivity::Extenders::Navigation
+    end
+
+
   end
 end

data/lib/generators/devise_activity/templates/devise_activity_initializer.rb

@@ -5,4 +5,10 @@ DeviseActivity.configure do |config|
   config.sessions_table_name = 'sessions'
   config.navigations_table_name = 'navigations'
   config.devise_model_name = 'user'
+
+  config.sign_in_controller_name = 'sessions'
+  config.sign_in_action_name = 'create'
+  config.sign_out_controller_name = 'sessions'
+  config.sign_out_action_name = 'destroy'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-activity
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - M Shahzad Tariq
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,6 +37,8 @@ files:
 - Rakefile
 - lib/devise_activity.rb
 - lib/devise_activity/configuration.rb
+- lib/devise_activity/extenders/navigation.rb
+- lib/devise_activity/extenders/session.rb
 - lib/devise_activity/navigation.rb
 - lib/devise_activity/session.rb
 - lib/devise_activity/version.rb