entity_events 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0b7c68e15961317833572b8d7a89052a333e67f
+  data.tar.gz: fbcaef6d049367c14133c3f32d9e56c1dea2c3d9
+SHA512:
+  metadata.gz: 02e6cad9a181fd97885079a3b77976ab8339ca9ea321ce5696668d770897f94de3a66cf84506a3def7cd1714adba0256f81785ecb5e921c22a441d9e38ab2b45
+  data.tar.gz: 8c8be966b40416101de3042ee95744ab4ef8f57e9db62c8928cc68714004ca7847b5753fe665d57741e53ff91c6cdc0abede19be69276c143ddf0376f9622733

data/README.rdoc

@@ -4,9 +4,9 @@ ABOUT
 
 Entity Events is a meta data collection tool which uses the MIT licence, written by Josh Dean on Chalkle.com time.
 
-In a nut shell, it records whenever one entity interacts with another entity.
+In a nutshell, it records whenever one entity interacts with another entity.
 
-Some have criticized Entity Events as doing the work of a third party metrics service, which to some extent is valid. However I enjoy the flexibility and ownership of recording this myself. 
+Some have criticized Entity Events as doing the work of a third party metrics service, which to some extent is valid. However I enjoy the flexibility, extensibility, and ownership of recording this myself. 
 
 It is my long term goal to make a gem which will provide basic query functions for the data Entity Events records.
 
@@ -14,7 +14,54 @@ The design pattern was inspired by Pundit.
 
 This is the first gem I've written so beware if might be a little gnarly and please do contribute if you like the concept but feel you could do some things better.
 
-IMPLEMENTATION
 
-gemfile
- http://rubygems.org/entity_events
+DESCRIPTION OF FUNCTIONS
+Whenever a request is made an Interaction record is written to the database. An Interaction describes an 'actor' making an 'action' on a 'target'. This is usually the current_user, the controller action which the request is routed to, and the target the object the request is related to. 
+
+i.e. { actor: User, action: Views, target: Post }
+
+Additionally, all the requests params are stored in that interaction, as well as the controller and action names (for querying purposes), and also an option params[:flag] which I added so I could record which href a user used to get there
+
+
+BASIC IMPLEMENTATION
+
+1. Add to gemfile then bundle install
+
+===ruby
+gem 'entity_events'
+===
+
+2. create and run a new migration
+
+===ruby
+  class CreateInteraction < ActiveRecord::Migration
+    def change
+      create_table :interactions do |t|
+        t.string :action
+        t.string :controller
+        t.string :flag
+        t.text   :parameters
+        t.references :actor, polymorphic: true
+        t.references :target, polymorphic: true
+        t.timestamps
+      end
+    end
+  end
+===
+
+3. On application_controller.rbgit
+
+===ruby
+  before_filter :entity_events
+
+  def entity_events
+      auto_log = true
+      EntityEvents.record(params, current_user, auto_log)
+  end
+===
+
+
+CUSTOMIZATION
+
+The bool auto_log in application_controller.entity_events should be set to true
+Under /app/events/ create 

data/lib/entity_events/version.rb

@@ -1,3 +1,3 @@
 module EntityEvents
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entity_events
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Josh Dean
@@ -14,7 +13,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +27,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: In a nut shell, it records whenever one entity interacts with another
@@ -51,19 +46,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/entity_events.rb
 - lib/entity_events/event_finder.rb
 - lib/entity_events/interaction.rb
 - lib/entity_events/version.rb
-- lib/entity_events.rb
 - lib/tasks/entity_events_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -79,7 +77,6 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
 - test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20141124235638_create_interaction.rb
 - test/dummy/db/schema.rb
@@ -88,35 +85,32 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/entity_events_test.rb
 - test/test_helper.rb
 homepage: http://rubygems.org/gems/entity_events
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.3.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Entity Events is a meta data collection tool
 test_files:
 - test/dummy/app/assets/javascripts/application.js