user_activity 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 570aafea45f410b73687c1369cad33444d88050a
-  data.tar.gz: 5b51b03da704c47f3d434ed769cc05b043f696c7
+  metadata.gz: ca0ef675a19edb56bccd4933aeb5a52f5afc778c
+  data.tar.gz: c14aca3b123c5b806626ac68d988f8f73ec49bb1
 SHA512:
-  metadata.gz: 9c8aa9f7a8097d7dd04b717836b1ff8a3dde4072aec9721c5c9f19d358f1843562624e1426c7aef9eccf18d5c5a980519cd4ce8e4b1be4af7058bcaaf22ab807
-  data.tar.gz: 0c584653f8d72004d0fd57b9bb5e4d21c390648a93556f9ec1f65a5ab39a3546902d56a81682c247fff8ed7e59fa431ee3649a017c360d4d1777ac2936d1f2f0
+  metadata.gz: 0172e301b263e2f9f9cd6b467aea8f5d28bc3ba9a7420baf97691e4dbe787431de5636ceffc5fc706a29e80e9f472f7b88809f58c1c0986de0446cbecd12ad64
+  data.tar.gz: 39a697f26056da1c91716ce41ecac37c7d10145e0672f1e0861e382240c8f537996b47a37f5217325b636d1357d881ecb3bc716cedecb379e48692189fbcbd6a

data/README.md

@@ -25,6 +25,10 @@ $ gem install user_activity
 ```bash
 $ rails user_activity:install:migrations
 ```
+And then execute:
+```bash
+$ rake db:migrate
+```
 
 ### Mount route to application:
 ```ruby
@@ -34,6 +38,36 @@ Rails.application.routes.draw do
 ...
 end
 ```
+### Install initializer files by command below: 
+### Generate database table:
+```bash
+$ rails generate installer user_activity
+```
+
+##Configuration
+It is posible to config some data in this gem, to do that you can follow the example below:
+
+### Add before_action to enable recording activities
+In case you want to enable to all controller in your application, you can add code to ApplicationController.
+```ruby
+class ApplicationController < ActionController::Base
+...
+	before_action :log_user_activity
+...
+end
+```
+
+### To provide user name and user id you need to override controller method "user_for_user_activity"
+Example in case using Devise
+```ruby
+class ApplicationController < ActionController::Base
+...
+	def user_for_user_activity
+  	Struct.new(:name, :id).new(current_user.email, current_user.id)
+  end
+...
+end
+```
 
 ## Contributing
 Contribution directions go here.

data/lib/generators/installer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate installer Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/installer/installer_generator.rb

@@ -0,0 +1,11 @@
+class InstallerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file "user_activity.rb", "config/initializers/user_activity.rb"
+  end
+
+  def copy_activity_definition_file
+    copy_file "user_activity.yml", "config/user_activity.yml"
+  end
+end

data/lib/generators/installer/templates/user_activity.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains configurฟะรนื settings for UserActivity
+
+UserActivity.configure do |config|
+	# Load activity define from yml file to configuration
+	# you can change activity define file path ans name here, by default we use the file that generated from gem 
+	config.activity_define = YAML.load_file("#{Rails.root.to_s}/config/user_activity.yml") || {}
+end

data/lib/generators/installer/templates/user_activity.yml

@@ -0,0 +1,8 @@
+#This file was generated by user_activity gem to store activity define by using controller name and action name.
+# below is an format and example 
+# comments:
+#   index: "comment view index activity"
+#   show: "visit comment activity"
+#   edit: "visit edit page comment activity"
+#   update: "update comment activity"
+#   destroy: "delete comment activity"

data/lib/user_activity.rb

@@ -2,19 +2,37 @@ require "active_support"
 require "user_activity/engine"
 
 module UserActivity
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :activity_define
+
+    def initialize
+      @activity_define =  {}
+    end
+  end
+
   def tee_method
   	"Kraiyanat"
   end
 
   def user_for_user_activity
-  	@current_user || Struct.new(:name, :id).new("anonymus", "")
+  	Struct.new(:name, :id).new("anonymus", "")
   end
 
   def activity_for_user_activity(controller, method)
-    activity_hash = {}
-    activity_hash[["aa", "bb"]] = "cc"
-
-    activity_hash[[controller.to_s, method.to_s]].to_s
+    begin 
+      configure.activity_define[controller][method]
+    rescue
+      ""
+    end
   end
 
   def log_user_activity
@@ -23,7 +41,7 @@ module UserActivity
   													user_name: user_for_user_activity.name,
   													action: params[:action],
   													controller: params[:controller],
-  													activity: activity_for_user_activity("aa", "bb"),
+  													activity: activity_for_user_activity(params[:controller], params[:action]),
   													http_request: "#{request.method} #{request.url} #{request.params}"
   												)
   end
@@ -38,5 +56,4 @@ end
 
 ActiveSupport.on_load(:action_controller) do 
   include UserActivity
-  before_action :log_user_activity
 end

data/lib/user_activity/version.rb

@@ -1,3 +1,3 @@
 module UserActivity
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kraiyanat Chomchumpol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rails_admin
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +42,14 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: 'Easy to use gem, tracking all activity that user done and come with
@@ -76,11 +76,15 @@ files:
 - config/initializers/rails_admin.rb
 - config/routes.rb
 - db/migrate/20171107030047_add_user_logs_table.rb
+- lib/generators/installer/USAGE
+- lib/generators/installer/installer_generator.rb
+- lib/generators/installer/templates/user_activity.rb
+- lib/generators/installer/templates/user_activity.yml
 - lib/tasks/user_activity_tasks.rake
 - lib/user_activity.rb
 - lib/user_activity/engine.rb
 - lib/user_activity/version.rb
-homepage: ''
+homepage: https://github.com/kraiyanat/user_activity
 licenses:
 - MIT
 metadata: {}