entity_events 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b7c68e15961317833572b8d7a89052a333e67f
-  data.tar.gz: fbcaef6d049367c14133c3f32d9e56c1dea2c3d9
+  metadata.gz: 7512e622b41651a0f5112a1db6c5b71d4a573ef7
+  data.tar.gz: 7cae9396d99bbaa6eefef46f3a810cbffa1d45a0
 SHA512:
-  metadata.gz: 02e6cad9a181fd97885079a3b77976ab8339ca9ea321ce5696668d770897f94de3a66cf84506a3def7cd1714adba0256f81785ecb5e921c22a441d9e38ab2b45
-  data.tar.gz: 8c8be966b40416101de3042ee95744ab4ef8f57e9db62c8928cc68714004ca7847b5753fe665d57741e53ff91c6cdc0abede19be69276c143ddf0376f9622733
+  metadata.gz: 237211222c3139b495a64fd89f5805425945aa333137d1e50462657da288575041ea6b14f074dd416e093b6d677465080fa0f5961da05a5e37a74d65dff75caf
+  data.tar.gz: ac365f123d9f2a25a1840eac22cf1085879acf38df16e2e3c26294e9da1d327ffad5079d54d122e8204bb6836d3bca8b8579c7ccc57abde04b43806ef5f8b59a

data/README.rdoc

@@ -25,7 +25,9 @@ Additionally, all the requests params are stored in that interaction, as well as
 
 BASIC IMPLEMENTATION
 
-1. Add to gemfile then bundle install
+Steps 1-3 will have your rails app recording the Controller and Action for every Request. If the request is from an authenticated user, that user will be recorded. If entity_events can determine the target object from the params then that will also be recorded (i.e. On FooController Foo with id of 3 would be identified through params[:foo_id] or params[:id], in that order).
+
+1. Add entity_events to your gemfile then run bundle install
 
 ===ruby
 gem 'entity_events'
@@ -49,7 +51,7 @@ gem 'entity_events'
   end
 ===
 
-3. On application_controller.rbgit
+3. On application_controller.rb
 
 ===ruby
   before_filter :entity_events
@@ -63,5 +65,104 @@ gem 'entity_events'
 
 CUSTOMIZATION
 
-The bool auto_log in application_controller.entity_events should be set to true
-Under /app/events/ create 
+4. Recording events on a specific entity, rather than every entity
+Maybe you don't want to record every single request, and you only want to record events on objects that you explicitly say to record. Revise the above ApplicationController code as follows.
+
+===ruby
+  before_filter :entity_events
+
+  def entity_events
+      auto_log = false
+      EntityEvents.record(params, current_user, auto_log)
+  end
+===
+
+Then, given that you want to record Foo events, you create a file at /app/events/foo_events.rb
+
+===ruby
+
+class FooEvent < EntityEvents::EntityEvent
+  def should_record?
+    true
+  end
+end
+
+===
+
+5. Recording specific events on specific entities, rather than every event
+Let's say you care when a Foo is Created, but not when someone requests the new Foo form. Do the following
+
+===ruby
+
+class FooEvent < EntityEvents::EntityEvent
+  def new?
+    false
+  end
+
+  def create?
+    true
+  end
+end
+
+===
+
+6. Unconventional actors and targets
+entity_events does a very basic job of getting the actor and target; it says the actor is the authenticated_user, and the target is object of type params[:controller] with an id of params[:<object>_id] or params[:id]
+
+In this sample, users belong to a group and a Foo has many Bars. Because we care how many bars a group of users make on any given Foo, we want to record the actor as the Group and the target as the Foo. You can do that!
+
+===ruby
+
+class BarEvent < EntityEvents::EntityEvent
+  def new_actor
+    current_user.group
+  end
+
+  def new_target
+    id = params[:foo_id]
+    Foo.find id
+  end
+end
+
+===
+
+7. Indicator Flags
+Lets say you are analyzing user behavior. There are two buttons to create a new Bar, and you want to see which button people people use more to get to the new Bar form. So long as you are recording the new Bar action, it is as simple as setting the params[:flag] on the button as follows 
+
+===html
+  <a id="new_bar_a" href="<%= new_bar_path({flag: 'a'}) %>" />
+  <a id="new_bar_b" href="<%= new_bar_path({flag: 'b'}) %>" />
+===
+
+Maybe you think params[:flag] is ugly though, or perhaps you are already using it for something else, then you will want to override flag in your EntityEvent file to record params[:xyz]. You could do this on each file, as in overriding it on foo_event.rb and bar_event.rb. But if you want to make it normalized throughout your app it would be far simpler to create a new base EntityEvent which FooEvent and BarEvent would inherit from
+
+===ruby
+  class CustomEntityEvent < EntityEvents::EntityEvent
+    def flag
+      params[:xyz]
+    end
+  end
+
+  class FooEvent < CustomEntityEvent
+    ##
+    #I inherit flag from CustomEntityEvent so I don't need to implement it myself in order to receive params[:xyz]
+    ##
+  end
+===
+
+8. Other overrides
+If you really want you can override controller, action, flag, default_actor, and default_target on your CustomEntityEvent or on a entity by entity basis (i.e. just for Foo entity in the FooEvent class)
+
+===ruby
+class CustomEntityEvent < EntityEvents::EntityEvent
+    def default_actor
+      current_user.group
+    end
+  end
+===
+
+
+
+TESTS
+
+coming soon...

data/lib/entity_events/version.rb

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

data/lib/entity_events.rb

@@ -24,7 +24,6 @@ module EntityEvents
     attr_reader :actor, :action ,:target, :params, :current_user, :target_is_user_defined, :actor_is_user_defined
 
     def initialize(params,current_user)
-      @auto_log = auto_log
       @params = params
       @action = action
       @current_user = current_user
@@ -51,10 +50,10 @@ module EntityEvents
       Interaction.log({
         actor:       actor,
         target:      target,
-        action:      params[:action],
-        controller:  params[:controller],
+        action:      action,
+        controller:  controller,
         parameters:  YAML::dump(params),
-        flag:        params[:flag]
+        flag:        flag
       })
     end
 
@@ -62,24 +61,39 @@ module EntityEvents
       self.class.name
     end
 
-    #OVERRIDE FROM HERE
-
-      def should_record?
+    #if auto_log == false, then should_record? will dictate is the action is recorded
+    def should_record?
+      action_method = (@action.to_s+'?').to_sym
+      if respond_to?(action_method)
+        #if <action>? is defined follow that
+        send action_method
+      else
+        #else if actor or target is defined, assume we are to record
         actor_is_user_defined || target_is_user_defined
       end
-      
-      def action
-        params[:action]
-      end
+    end
 
-      def default_actor
-        current_user
-      end
+    #You can override methods after this line, however it is not nessisary.
+    def controller
+      params[:controller]
+    end
 
-      def default_target
-        id = params["#{params[:controller].to_s.singularize}_id"] || params[:id]
-        params[:controller].classify.constantize.find id if id
-      end
+    def action
+      params[:action]
+    end
+
+    def flag
+      params[:flag]
+    end
+
+    def default_actor
+      current_user
+    end
+
+    def default_target
+      id = params["#{params[:controller].to_s.singularize}_id"] || params[:id]
+      params[:controller].classify.constantize.find id if id
+    end
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entity_events
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Josh Dean
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.19
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.19
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: In a nut shell, it records whenever one entity interacts with another
-  entity
+  entity. It also has more advanced features to allow specific event recording as
+  well as ab testing
 email:
 - josh@chalkle.com
 executables: []