framed_rails 0.1.5 → 0.1.7

data/README.md

@@ -69,6 +69,15 @@ Configuration
     <td>false</td>
   </tr>
 
+  <tr>
+    <td>:excluded_params</td>
+    <td>An array of request parameter keys to never send to Framed. <code>:controller</code>, <code>:action</code>,
+    <code>:utf8</code>, <code>:authenticity_token</code>, <code>:commit</code>, and <code>:password</code> are never
+    sent, and anything added here is in addition to default values.
+    </td>
+    <td>[]</td>
+  </tr>
+
 </table>
 
 Emitters

data/lib/framed/client.rb

@@ -16,7 +16,7 @@ module Framed
     end
 
     def track(data)
-      Framed.logger.info("Client#track #{data.length}")
+      Framed.log_info("Client#track #{data.length} events")
 
       creds = Base64.strict_encode64(@config[:api_key] + ':')
       payload = JSON.generate(data)

data/lib/framed/emitters.rb

@@ -27,7 +27,7 @@ module Framed
         begin
           @client.track(events)
         rescue Exception => exc
-          Framed.logger.error("framed_rails: transmit failed: #{exc}")
+          Framed.log_error("#transmit failed: #{exc}")
         end
       end
     end
@@ -47,7 +47,7 @@ module Framed
 
     class Logger < Base
       def enqueue(event)
-        Framed.logger.info(JSON.generate(event))
+        Framed.log_info(JSON.generate(event))
       end
     end
 
@@ -78,7 +78,7 @@ module Framed
 
       def start
         if @request_thread and !@request_thread.alive?
-          Framed.logger.error("Starting request thread due to dead thread")
+          Framed.log_info("Starting request thread due to dead thread")
         end
 
         @request_thread = Thread.new do
@@ -116,7 +116,7 @@ module Framed
       end
 
       def warn_full(event)
-        Framed.logger.error("Queued #{event} to framed, but queue is full.  Dropping event.")
+        Framed.log_error("Queued #{event} to Framed, but queue is full. Dropping event.")
       end
 
       def enqueue(event)
@@ -179,7 +179,7 @@ module Framed
         begin
           @client.track(events)
         rescue Exception => exc
-          Framed.logger.error("framed_rails: transmit failed: #{exc}")
+          Framed.log_error("#transmit failed: #{exc}")
         end
       end
     end

data/lib/framed/rails.rb

@@ -6,28 +6,43 @@ ActionController::Base.class_eval do
     "#{request.method}_#{params[:controller]}\##{params[:action]}"
   end
 
+  # XHR requests are not sent unless explictly enabled or Turbolinks, which
+  # is a special kind of XHR
   def framed_included?(request)
     return true if Framed.configuration[:include_xhr]
-    # include Turbolinks requests (which are a special kind of XHR)
     return true if request.headers.include?('X-XHR-Referer')
 
     !request.xhr?
   end
 
+  def framed_get_or_make_anonymous_id
+    anonymous_id = cookies.signed[Framed.anonymous_cookie]
+
+    if anonymous_id.nil?
+      anonymous_id = Framed.new_anonymous_id
+      cookie = {:value => anonymous_id, :httponly => true}
+      cookies.signed.permanent[Framed.anonymous_cookie] = cookie
+    end
+
+    return anonymous_id
+  end
+
+  def framed_current_user_id
+    begin
+      current_user.try(:id)
+    rescue
+      nil
+    end
+  end
+
   def framed_report_request
     return unless framed_included?(request)
 
     begin
-      anonymous_id = cookies.signed[Framed.anonymous_cookie]
+      anonymous_id = framed_get_or_make_anonymous_id
       user_id = send(Framed.user_id_controller_method)
+      cleaned_params = params.except(*Framed.excluded_params).to_h
 
-      if anonymous_id.nil?
-        anonymous_id = Framed.new_anonymous_id
-        cookie = {:value => anonymous_id, :httponly => true}
-        cookies.signed.permanent[Framed.anonymous_cookie] = cookie
-      end
-
-      cleaned_params = params.except(:controller, :action).to_h
       event = {
         :type => :track,
         :anonymous_id => anonymous_id,
@@ -46,15 +61,8 @@ ActionController::Base.class_eval do
 
       Framed.report(event)
     rescue Exception => exc
-      Framed.logger.error("Failed to report request #{exc}")
+      Framed.log_error("Failed to report request #{exc}")
     end
   end
 
-  def framed_current_user_id
-    begin
-      current_user.try(:id)
-    rescue
-      nil
-    end
-  end
 end

data/lib/framed/version.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 module Framed
-  VERSION = "0.1.5"
+  VERSION = '0.1.7'
 end

data/lib/framed_rails.rb

@@ -12,6 +12,15 @@ module Framed
   SEGMENT_API_ENDPOINT = 'https://api.segment.io/v1/track'
   FRAMED_API_ENDPOINT = 'https://intake.framed.io/events'
   COOKIE_NAME = 'framed_id'
+  LOG_PREFIX = '[framed_rails] '
+
+  DEFAULT_EXCLUDED_PARAMS =
+    [:controller,
+     :action,
+     :utf8,
+     :authenticity_token,
+     :commit,
+     :password]
 
   class << self
     attr_accessor :client, :consumer
@@ -23,10 +32,15 @@ module Framed
         :endpoint => Framed::FRAMED_API_ENDPOINT,
         :logger => Logger.new(STDERR),
         :anonymous_cookie => Framed::COOKIE_NAME,
-        :include_xhr => false
+        :include_xhr => false,
+        :excluded_params => []
       }
     end
 
+    def excluded_params
+      (configuration[:excluded_params] + DEFAULT_EXCLUDED_PARAMS).uniq
+    end
+
     def configure(silent = false)
       yield configuration
       self.client = Client.new(configuration)
@@ -55,6 +69,14 @@ module Framed
       configuration[:logger]
     end
 
+    def log_info(msg)
+      logger.info(LOG_PREFIX + msg)
+    end
+
+    def log_error(msg)
+      logger.error(LOG_PREFIX + msg)
+    end
+
     def drain
       @consumer.stop(true) if @consumer
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framed_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies: []
 description: ! 'TK