user_activity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 570aafea45f410b73687c1369cad33444d88050a
+  data.tar.gz: 5b51b03da704c47f3d434ed769cc05b043f696c7
+SHA512:
+  metadata.gz: 9c8aa9f7a8097d7dd04b717836b1ff8a3dde4072aec9721c5c9f19d358f1843562624e1426c7aef9eccf18d5c5a980519cd4ce8e4b1be4af7058bcaaf22ab807
+  data.tar.gz: 0c584653f8d72004d0fd57b9bb5e4d21c390648a93556f9ec1f65a5ab39a3546902d56a81682c247fff8ed7e59fa431ee3649a017c360d4d1777ac2936d1f2f0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Kraiyanat Tee
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# UserActivity
+The GDPR is forcing to use in mid of year 2017, I wanna have the tool out of the box to record the personal data accessing that can have some activity configuration.  
+
+## Usage
+User activity gem is a rails engine mountable gem working with "rails" and "rails admin". It's record all controller and action that user use into the database table itself.   
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'user_activity'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install user_activity
+```
+
+### Generate database table:
+```bash
+$ rails user_activity:install:migrations
+```
+
+### Mount route to application:
+```ruby
+Rails.application.routes.draw do
+...
+	mount RailsAdmin::Engine => '/user_activity', as: 'user_activity'
+...
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UserActivity'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/user_activity_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/user_activity .js
+//= link_directory ../stylesheets/user_activity .css

data/app/assets/javascripts/user_activity/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/user_activity/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/user_activity/application_controller.rb

@@ -0,0 +1,5 @@
+module UserActivity
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/user_activity/application_helper.rb

@@ -0,0 +1,4 @@
+module UserActivity
+  module ApplicationHelper
+  end
+end

data/app/jobs/user_activity/application_job.rb

@@ -0,0 +1,4 @@
+module UserActivity
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/user_activity/application_mailer.rb

@@ -0,0 +1,6 @@
+module UserActivity
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/user_activity/application_record.rb

@@ -0,0 +1,5 @@
+module UserActivity
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/user_activity/user_activity_log.rb

@@ -0,0 +1,5 @@
+module UserActivity
+  class UserActivityLog < ApplicationRecord
+  	self.table_name = "user_activity_logs"
+  end
+end

data/app/views/layouts/user_activity/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>User activity</title>
+  <%= stylesheet_link_tag    "user_activity/application", media: "all" %>
+  <%= javascript_include_tag "user_activity/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/rails_admin.rb

@@ -0,0 +1,57 @@
+RailsAdmin.config do |config|
+
+  ### Popular gems integration
+
+  ## == Devise ==
+  # config.authenticate_with do
+  #   warden.authenticate! scope: :user
+  # end
+  # config.current_user_method(&:current_user)
+
+  ## == Cancan ==
+  # config.authorize_with :cancan
+
+  ## == Pundit ==
+  # config.authorize_with :pundit
+
+  ## == PaperTrail ==
+  # config.audit_with :paper_trail, 'User', 'PaperTrail::Version' # PaperTrail >= 3.0.0
+
+  ### More at https://github.com/sferik/rails_admin/wiki/Base-configuration
+
+  ## == Gravatar integration ==
+  ## To disable Gravatar integration in Navigation Bar set to false
+  # config.show_gravatar = true
+
+  config.actions do
+    dashboard do
+      only  UserActivity::UserActivityLog
+    end
+
+    index do
+      only  UserActivity::UserActivityLog
+    end
+
+    export do
+      only  UserActivity::UserActivityLog
+    end
+
+    # new 
+    # bulk_delete
+    
+    show do
+      only  UserActivity::UserActivityLog
+    end
+    
+    # edit
+    # delete
+    
+    show_in_app do
+      only  UserActivity::UserActivityLog
+    end
+
+    ## With an audit adapter, you can add:
+    # history_index
+    # history_show
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+UserActivity::Engine.routes.draw do
+  mount RailsAdmin::Engine => '/', as: 'rails_admin'
+end

data/db/migrate/20171107030047_add_user_logs_table.rb

@@ -0,0 +1,15 @@
+class AddUserLogsTable < ActiveRecord::Migration[5.1]
+  def change
+  	create_table :user_activity_logs do |t|
+      t.integer :user_id
+      t.string :user_name
+      t.string :object_id
+      t.string :controller
+      t.string :action
+      t.string :activity
+      t.string :http_request
+ 
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/user_activity_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :user_activity do
+#   # Task goes here
+# end

data/lib/user_activity.rb

@@ -0,0 +1,42 @@
+require "active_support"
+require "user_activity/engine"
+
+module UserActivity
+  def tee_method
+  	"Kraiyanat"
+  end
+
+  def user_for_user_activity
+  	@current_user || 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
+  end
+
+  def log_user_activity
+  	UserActivityLog.create(
+  													user_id: user_for_user_activity.id,
+  													user_name: user_for_user_activity.name,
+  													action: params[:action],
+  													controller: params[:controller],
+  													activity: activity_for_user_activity("aa", "bb"),
+  													http_request: "#{request.method} #{request.url} #{request.params}"
+  												)
+  end
+
+  def self.included(klass)
+  	klass.extend ClassMethods
+  end
+
+  module ClassMethods
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do 
+  include UserActivity
+  before_action :log_user_activity
+end

data/lib/user_activity/engine.rb

@@ -0,0 +1,5 @@
+module UserActivity
+  class Engine < ::Rails::Engine
+    isolate_namespace UserActivity
+  end
+end

data/lib/user_activity/version.rb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: user_activity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kraiyanat Chomchumpol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  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
+  the modern user interface ''rails admin'' '
+email:
+- kraiyanat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/user_activity_manifest.js
+- app/assets/javascripts/user_activity/application.js
+- app/assets/stylesheets/user_activity/application.css
+- app/controllers/user_activity/application_controller.rb
+- app/helpers/user_activity/application_helper.rb
+- app/jobs/user_activity/application_job.rb
+- app/mailers/user_activity/application_mailer.rb
+- app/models/user_activity/application_record.rb
+- app/models/user_activity/user_activity_log.rb
+- app/views/layouts/user_activity/application.html.erb
+- config/initializers/rails_admin.rb
+- config/routes.rb
+- db/migrate/20171107030047_add_user_logs_table.rb
+- lib/tasks/user_activity_tasks.rake
+- lib/user_activity.rb
+- lib/user_activity/engine.rb
+- lib/user_activity/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Rails engine mountable gem to tracking user activities
+test_files: []
+has_rdoc: