framed_rails 0.1.7 → 0.2.0

data/.rubocop.yml

@@ -0,0 +1,61 @@
+AllCops:
+  Exclude:
+    - 'lib/framed/okjson.rb'
+    - 'vendor/**/*'
+
+Documentation:
+  Enabled: False
+
+Lint/HandleExceptions:
+  Enabled: False
+
+Metrics/AbcSize:
+  Enabled: False
+
+Metrics/LineLength:
+  Enabled: False
+
+Metrics/MethodLength:
+  Enabled: False
+
+Style/BracesAroundHashParameters:
+  Enabled: False
+
+Style/EachWithObject:
+  Enabled: False
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: False
+
+Style/GuardClause:
+  Enabled: False
+
+Style/HashSyntax:
+  Enabled: False
+
+Style/IfUnlessModifier:
+  Enabled: False
+
+Style/IndentHash:
+  Enabled: False
+
+Style/ModuleFunction:
+  Enabled: False
+
+Style/RaiseArgs:
+  Enabled: False
+
+Style/RedundantBegin:
+  Enabled: False
+
+Style/RedundantSelf:
+  Enabled: False
+
+Style/SignalException:
+  Enabled: False
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: False
+
+Style/WhileUntilModifier:
+  Enabled: False

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -2,11 +2,11 @@
 ------------
 
 `framed_rails` is a gem to add Framed instrumentation to your Rails 4
-app. For each request, it sends an event to Framed.
+app. For each request that occurs in your app, it sends an event to Framed for analysis.
 
 To use this in your Rails project:
 
- * Add `gem 'framed_rails', '~> 0.1.4'` to your Gemfile.
+ * Add `gem 'framed_rails', '~> 0.1.7'` to your Gemfile.
  * Add the following to `config/initializers/framed_rails.rb`:
 
 ```ruby
@@ -17,7 +17,8 @@ Framed.configure do |config|
 end
 ```
 
-If reporting fails, the exception will be logged to `Rails.logger` by default.
+If request reporting fails, an exception will be logged to `Rails.logger` by default.
+The logger used can be customized in config.
 
 Configuration
 -------------
@@ -30,47 +31,40 @@ Configuration
   </tr>
 
   <tr>
-    <td>:consumer</td>
-    <td>The emitter to be used for reporting.  See the Emitters
+    <td><code>:emitter</code></td>
+    <td>The emitter to be used for reporting. See the Emitters
     section below.</td>
-    <td>`Framed::Emitters::Blocking`</td>
+    <td><code>Framed::Emitters::Blocking</code></td>
   </tr>
 
   <tr>
-    <td>:user_id_controller_method</td>
-    <td>The name of a controller method which returns the user ID, if
+    <td><code>:user_id_controller_method</code></td>
+    <td>The name of a controller method which returns id of the current user, if
     any</td>
-    <td>`framed_current_user_id`</td>
+    <td><code>'framed_current_user_id'</code> (tries <code>current_user.id</code>)</td>
   </tr>
 
 	<tr>
-    <td>:logger</td>
+    <td><code>:logger</code></td>
     <td>A Logger for reporting errors.</td>
-    <td>`Rails.logger`</td>
+    <td><code>Rails.logger</code></td>
   </tr>
 
 	<tr>
-    <td>:anonymous_cookie</td>
-    <td>The name of the in signed cookie for anonymous user IDs.
-    Long-lived anonymous user IDs are issued anonymous users.</td>
-    <td>`Framed::COOKIE_NAME`</td>
-  </tr>
-
-	<tr>
-    <td>:user_id_controller_method</td>
-    <td>The name of a controller method which can provide the current
-    User ID. (Also works with Devise).</td>
-    <td>'framed_current_user_id'</td>
+    <td><code>:anonymous_cookie</code></td>
+    <td>The name of the signed cookie for anonymous user IDs.
+    Long-lived anonymous user IDs are issued anonymous IDs by default.</td>
+    <td><code>Framed::COOKIE_NAME</code></td>
   </tr>
 
   <tr>
-    <td>:include_xhr</td>
+    <td><code>:include_xhr</code></td>
     <td>Whether to include requests sent via AJAX. (Turbolinks are always included.)</td>
     <td>false</td>
   </tr>
 
   <tr>
-    <td>:excluded_params</td>
+    <td><code>:excluded_params</code></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.
@@ -80,6 +74,15 @@ Configuration
 
 </table>
 
+
+user_id_controller_method
+--------
+This function is used to get the ID of the current user (if any) for properly attributing
+events to the users who performed them. The default implementation effectively tries to read
+`current_user.id`, but will not fail if `current_user` is not defined. You can change this
+to a to a controller function of your choosing by specifying its name as a string (invoked via `send`).
+
+
 Emitters
 --------
 
@@ -89,7 +92,7 @@ your configure block:
 
 
 ```ruby
-config[:consumer] = Framed::Emitters::Buffered
+config[:emitter] = Framed::Emitters::Buffered
 ```
 
 Emitters included in this gem:
@@ -97,7 +100,7 @@ Emitters included in this gem:
  * `Framed::Emitters::Blocking` - Logs each request to Framed using a single blocking request (default)
  * `Framed::Emitters::Buffered` - Logs to Framed 1) if no request is in progress, immediately 2) otherwise in batches of up to 100 as soon as the previous request completes.  All requests are sent on a background thread.
  * `Framed::Emitters::InMemory` - stores reported events in memory,
-   rather than transmitting them.  Events are later available as `Framed.consumer.reported`.
+   rather than transmitting them.  Events are later available as `Framed.emitter.reported`.
  * `Framed::Emitters::Logger` - Logs an info message to `config[:logger]`.
 
 Both `InMemory` and `Logger` should be considered for debugging/diagnostic purposes only.

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  override:
+    - bundle exec rubocop

data/framed_rails.gemspec

@@ -5,33 +5,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'framed/version'
 
 Gem::Specification.new do |s|
-  s.name = "framed_rails"
+  s.name = 'framed_rails'
   s.version = Framed::VERSION
   s.required_ruby_version = '>= 1.8.7'
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = [ "Jeremy Dunck" ]
+  s.required_rubygems_version = Gem::Requirement.new('> 1.3.1') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Jeremy Dunck']
   s.date = Time.now.strftime('%Y-%m-%d')
   s.licenses    = ['MIT']
   s.description = <<-EOS
 TK
 EOS
-  s.email = "support@framed.io"
-  s.executables = [ ]
+  s.email = 'support@framed.io'
+  s.executables = []
   s.extra_rdoc_files = [
-    "CHANGELOG",
-    "LICENSE",
-    "README.md"
+    'CHANGELOG',
+    'LICENSE',
+    'README.md'
   ]
 
   file_list = `git ls-files`.split
   s.files = file_list
 
-  s.homepage = "http://www.github.com/framed-data/framed_rails"
-  s.require_paths = ["lib", 'vendor/gems/excon-0.45.3/lib']
+  s.homepage = 'http://www.github.com/framed-data/framed_rails'
+  s.require_paths = ['lib', 'vendor/gems/excon-0.45.3/lib']
   s.rubygems_version = Gem::VERSION
-  s.summary = "Framed.io data collector"
+  s.summary = 'Framed.io data collector'
 
-  # s.add_development_dependency 'rake', '10.1.0'
-
-  # FIXME: RUBY_VERSION, RUBY_PLATFORM, RUBY_ENGINE
+  s.add_development_dependency 'rubocop', '~> 0.35.1'
 end

data/lib/framed/client.rb

@@ -20,7 +20,8 @@ module Framed
 
       creds = Base64.strict_encode64(@config[:api_key] + ':')
       payload = JSON.generate(data)
-      response = Excon.post(@config[:endpoint],
+      response = Excon.post(
+        @config[:endpoint],
         :headers => {
           'Authorization' => "Basic #{creds}",
           'Content-Type' => 'application/json'

data/lib/framed/emitters.rb

@@ -8,14 +8,13 @@ module Framed
         @client = client
       end
 
-      def stop(drain = false)
-
+      def stop(_drain = false)
       end
-      def start
 
+      def start
       end
 
-      def enqueue(event)
+      def enqueue(_event)
         raise NotImplementedError
       end
 
@@ -26,7 +25,7 @@ module Framed
 
         begin
           @client.track(events)
-        rescue Exception => exc
+        rescue StandardError => exc
           Framed.log_error("#transmit failed: #{exc}")
         end
       end
@@ -54,8 +53,10 @@ module Framed
     class Blocking < Base
       def start
       end
-      def stop(drain = false)
+
+      def stop(_drain = false)
       end
+
       def enqueue(event)
         transmit([event])
       end
@@ -77,12 +78,12 @@ module Framed
       end
 
       def start
-        if @request_thread and !@request_thread.alive?
-          Framed.log_info("Starting request thread due to dead thread")
+        if @request_thread && !@request_thread.alive?
+          Framed.log_info('Starting request thread due to dead thread')
         end
 
         @request_thread = Thread.new do
-          while true
+          loop do
             pending = @request_queue.pop
 
             @request_pending.synchronize do
@@ -126,7 +127,7 @@ module Framed
           #  we remember if the queue is full and log outside the lock.
           queue_full = @event_queue.length >= MAX_QUEUE_SIZE
 
-          if !queue_full
+          unless queue_full
             @event_queue << event
           end
 
@@ -166,7 +167,7 @@ module Framed
 
           pending = []
           while pending.length < MAX_REQUEST_BATCH_SIZE && @event_queue.length > 0
-             pending << @event_queue.pop
+            pending << @event_queue.pop
           end
 
           @request_queue << pending
@@ -178,7 +179,7 @@ module Framed
 
         begin
           @client.track(events)
-        rescue Exception => exc
+        rescue StandardError => exc
           Framed.log_error("#transmit failed: #{exc}")
         end
       end

data/lib/framed/rails.rb

@@ -24,7 +24,7 @@ ActionController::Base.class_eval do
       cookies.signed.permanent[Framed.anonymous_cookie] = cookie
     end
 
-    return anonymous_id
+    anonymous_id
   end
 
   def framed_current_user_id
@@ -60,7 +60,7 @@ ActionController::Base.class_eval do
       }
 
       Framed.report(event)
-    rescue Exception => exc
+    rescue StandardError => exc
       Framed.log_error("Failed to report request #{exc}")
     end
   end

data/lib/framed/utils.rb

@@ -39,8 +39,8 @@ module Framed
       dt.utc.iso8601
     end
 
-    def flattened_hash(h, namespace = '', memo = {})
-      h.reduce(memo) { |memo, (key, value)|
+    def flattened_hash(h, namespace = '', init = {})
+      h.reduce(init) do |memo, (key, value)|
         value = value.to_h if value.respond_to?(:to_h)
         if value.instance_of?(Hash)
           memo.merge!(flattened_hash(value, "#{namespace}#{key}_", memo))
@@ -48,7 +48,7 @@ module Framed
           memo["#{namespace}#{key}"] = value
         end
         memo
-      }
+      end
     end
   end
 end

data/lib/framed/version.rb

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

data/lib/framed_rails.rb

@@ -23,11 +23,11 @@ module Framed
      :password]
 
   class << self
-    attr_accessor :client, :consumer
+    attr_accessor :client, :emitter
 
     def configuration
       @configuration ||= {
-        :consumer => Framed::Emitters::Blocking,
+        :emitter => Framed::Emitters::Blocking,
         :user_id_controller_method => 'framed_current_user_id',
         :endpoint => Framed::FRAMED_API_ENDPOINT,
         :logger => Logger.new(STDERR),
@@ -41,28 +41,28 @@ module Framed
       (configuration[:excluded_params] + DEFAULT_EXCLUDED_PARAMS).uniq
     end
 
-    def configure(silent = false)
+    def configure
       yield configuration
       self.client = Client.new(configuration)
 
-      @consumer.stop(true) if @consumer
-      @consumer = configuration[:consumer].new(self.client)
+      @emitter.stop(true) if @emitter
+      @emitter = configuration[:emitter].new(self.client)
     end
 
     def report(event)
-      event[:lib] =  "framed_ruby"
+      event[:lib] = 'framed_ruby'
       event[:lib_version] = Framed::VERSION
       event[:type] ||= :track
       event[:context] ||= {}
       event[:context].merge!({
-        :channel => 'server',
+        :channel => 'server'
       })
 
       event[:properties] ||= {}
 
       # fill in if needed, in case it sits in queue for a while.
       event[:timestamp] ||= Framed::Utils.serialize_date(Time.now)
-      @consumer.enqueue(event)
+      @emitter.enqueue(event)
     end
 
     def logger
@@ -78,7 +78,7 @@ module Framed
     end
 
     def drain
-      @consumer.stop(true) if @consumer
+      @emitter.stop(true) if @emitter
     end
 
     def user_id_controller_method

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framed_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
-dependencies: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.35.1
 description: ! 'TK
 
 '
@@ -23,11 +39,13 @@ extra_rdoc_files:
 - README.md
 files:
 - .gitignore
+- .rubocop.yml
 - .ruby-version
 - CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
+- circle.yml
 - framed_rails.gemspec
 - lib/framed/client.rb
 - lib/framed/emitters.rb