activity-log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: febe0dc7536072f6c6cffa1d0ee12f186a7b3622
+  data.tar.gz: 1ddec33fe7b0868f8f335a1c6731090a02966e4c
+SHA512:
+  metadata.gz: af438b2426cdb738fe24e2e60d3494bce5d501d0ce7bdea9685fe144c4513af7ea5527d5e833d4c9b5b57ff684d269b6506231d7cc631087c094ce3d19ef06d6
+  data.tar.gz: d8f01964e65a4996fd65e6cf5849534d5dc2e473be1fb7fcef6438bf9141a2cc9cd73ec85994577c5072cb61cfc6e56086ebb41f6bf07d0a9acc53ee96dc493a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 James Kropp
+
+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,45 @@
+# Activity-Log
+
+Short description and motivation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activity-log'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install activity-log
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activity-log. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activity::Log project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activity-log/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Activity'
+  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", __dir__)
+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/controllers/activity/application_controller.rb

@@ -0,0 +1,5 @@
+module Activity
+  class ApplicationController < ActionController::API
+    # protect_from_forgery with: :exception
+  end
+end

data/app/controllers/activity/event_logs_controller.rb

@@ -0,0 +1,6 @@
+require_dependency "activity/application_controller"
+
+module Activity
+  class EventLogsController < ApplicationController
+  end
+end

data/app/models/activity/application_record.rb

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

data/app/models/activity/event_log.rb

@@ -0,0 +1,37 @@
+module Activity
+  class EventLog < ApplicationRecord
+    self.table_name = "activity_logs"
+
+    # Supported field names and scopes for each field
+    SUPPORTED_FILTERS = [:user_id, :attached_id, :model, :event, :created_at, :updated_at]
+    scope :user_id, -> (value) { where(user_id: value) }
+    scope :attached_id, -> (value) { where(attached_id: value) }
+    scope :model, -> (value) { where(model: value) }
+    scope :event, -> (value) { where(event: value) }
+
+    # Filter that finds all records that match a given request
+    # Example Request: attributes = {:attached_id: 1, event: "created_user"}
+    # - Will return any records where attached_id = 1 and event = "created_user"
+    # - Allows for simple searching with many unique cases
+    def self.filter(page, per_page, order_by, attributes)
+      logs = attributes.slice(*SUPPORTED_FILTERS).reduce(all) do |scope, (key, value)|
+        value.present? ? scope.send(key, value) : scope
+      end
+
+      {
+        current_page: page,
+        total_pages: logs.page(page).per(per_page).total_pages,
+        logs: logs.order(order_by).page(page).per(per_page),
+      }
+    end
+
+    def self.create_log(log)
+      self.create!(
+        user_id: log[:user_id],
+        attached_id: log[:attached_id],
+        model: log[:model],
+        event: log[:event],
+      )
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Activity::Engine.routes.draw do
+  # Routes here
+end

data/db/migrate/20180625234553_create_activity_logs.rb

@@ -0,0 +1,12 @@
+class CreateActivityLogs < ActiveRecord::Migration[5.2]
+  def change
+    create_table :activity_logs do |t|
+      t.integer :user_id, null: false, index: true
+      t.integer :attached_id, index: true
+      t.string :model, index: true
+      t.string :event, index: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/activity.rb

@@ -0,0 +1,5 @@
+require "activity/engine"
+
+module Activity
+  # Your code goes here...
+end

data/lib/activity/engine.rb

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

data/lib/activity/version.rb

@@ -0,0 +1,3 @@
+module Activity
+  VERSION = "0.1.0"
+end

data/lib/tasks/activity_tasks.rake

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: activity-log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Kropp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: 
+email:
+- james-kropp@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/activity/application_controller.rb
+- app/controllers/activity/event_logs_controller.rb
+- app/models/activity/application_record.rb
+- app/models/activity/event_log.rb
+- config/routes.rb
+- db/migrate/20180625234553_create_activity_logs.rb
+- lib/activity.rb
+- lib/activity/engine.rb
+- lib/activity/version.rb
+- lib/tasks/activity_tasks.rake
+homepage: https://github.com/jameskropp/activity-log
+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.14
+signing_key: 
+specification_version: 4
+summary: Rails Activity Logger
+test_files: []