shrew 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f547aa76f469d4d753a91e5d52bba25ae8bbf5fe
-  data.tar.gz: 604784d086e871a6f3fec1682ae210597ca67c33
+  metadata.gz: 08a92b898b271df0893a9cae07e5da9a9339438f
+  data.tar.gz: b2cb9fafe62a8abd0820a0f67448f6cadfa98914
 SHA512:
-  metadata.gz: cda8105d1e2110e48a8abc07cc2d895c872dfac3e845951bd70bcb91f72fc0648d8a86989001cbd1b60b870f5b3aa22d6c4511393bcaeb894cdb9f31f7eb3887
-  data.tar.gz: 0a5bc8e4efd71f465c55e3e6b3ad05afd223feac8e68a1e1c6ab44315a25b67e0e6ab6238890360a43fac3bd05be2556a0e1d3166a398da22caada5b897190d5
+  metadata.gz: 66dbce425c0109ec66c1a709ae0fe394b42d459cc64cea9a2636a5d7e2fd7da4e85a1fa5b4d7ed558aafcb2b7f56f70178acdc46c91a4657526261984b6823e2
+  data.tar.gz: 3856eaf445d5c010d64eaf7f0f171f86daf13acfce1666c1e008a3a63fe5514d6e003b671f36be5d7f07ce33eeab2702abf25ab08c28633e781056f66faea7e6

data/.gitignore

@@ -0,0 +1,67 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+#https://github.com/github/gitignore/blob/master/Rails.gitignore
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/public/system
+/public/uploads
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# Comment out this rules if you are OK with secrets been uploaded to the repo
+config/initializers/secret_token.rb
+#config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+#ignore idea
+/.idea
+
+#mac
+.DS_Store
+
+#precompiled assets
+public/assets/
+
+solr/**/data
+solr/pids/
+
+#uploaded files
+public/file/
+
+
+#javascript code coverage
+spec/javascripts_coverage/
+
+#node modules
+node_modules

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails', '~> 4.1'

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    shrew (0.0.2)
+      activerecord (>= 4.0.0)
+      activesupport (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.7)
+      actionpack (= 4.1.7)
+      actionview (= 4.1.7)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.7)
+      actionview (= 4.1.7)
+      activesupport (= 4.1.7)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.7)
+      activesupport (= 4.1.7)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.7)
+      activesupport (= 4.1.7)
+      builder (~> 3.1)
+    activerecord (4.1.7)
+      activemodel (= 4.1.7)
+      activesupport (= 4.1.7)
+      arel (~> 5.0.0)
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.7)
+      actionmailer (= 4.1.7)
+      actionpack (= 4.1.7)
+      actionview (= 4.1.7)
+      activemodel (= 4.1.7)
+      activerecord (= 4.1.7)
+      activesupport (= 4.1.7)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.7)
+      sprockets-rails (~> 2.0)
+    railties (4.1.7)
+      actionpack (= 4.1.7)
+      activesupport (= 4.1.7)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  rails (~> 4.1)
+  rspec (~> 3.1.0)
+  rspec-rails (~> 3.1.0)
+  shrew!
+  sqlite3

data/README.md

@@ -0,0 +1,38 @@
+# Shrew
+
+
+Simple analytics engine for rails
+
+### Installation
+
+Run the generator to install the migration and routes.
+
+```
+rails g analytics:install
+rake db:migrate
+```
+
+Add page tracking to your application controller (or any other controller)
+
+```
+class ApplicationController < ActionController::Base
+  include Analytics::TracksPageViews
+end
+```
+
+*For tracking javascript run time*
+
+Include analytics.js in your application.js
+
+```
+//= require analytics
+```
+
+Include the partial at the end of your layout to automatically track javascript run time
+
+```
+...
+<%= render "analytics/automatically_track_page_views" %>
+</body>
+</html>
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs'
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'

data/app/assets/javascripts/shrew.js

@@ -0,0 +1,69 @@
+/* jshint: asi:false */
+(function(config) {
+  var _validConfig = function(){
+    if(typeof config.pageViewUrl !== 'string'){
+      return false
+    }
+    if(typeof config.jTI !== 'string'){
+      return false
+    }
+    return true
+  }
+
+  /* http://stackoverflow.com/questions/8790099/detect-if-any-javascript-function-is-running */
+  var automaticallyTrackPageView = function() {
+    if (window.addEventListener) {
+      window.addEventListener("load", loadHandler, false)
+    }
+    else if (window.attachEvent) {
+      window.attachEvent("onload", loadHandler)
+    }
+    else {
+      window.onload = loadHandler
+    }
+
+    function loadHandler() {
+      setTimeout(trackPageView, 0)
+    }
+  }
+
+  var trackPageView = function() {
+    if(!_validConfig()){
+      if(typeof console !== 'undefined' && typeof console.error !== 'undefined'){
+        console.error('invalid shrew configuration')
+      }
+      return false
+    }
+    var xmlhttp = new XMLHttpRequest()
+    var params = 'url=' + encodeURIComponent(window.location.href) +
+                 '&title=' + encodeURIComponent(document.title) +
+                 '&jTI=' + encodeURIComponent(config.jTI) + 
+                 '&jRT=' + encodeURIComponent(new Date().getTime())
+    params.replace(/%20/g, '+')
+    xmlhttp.open('POST', config.pageViewUrl, true)
+    xmlhttp.setRequestHeader('Content-type', 'application/x-www-form-urlencoded')
+    xmlhttp.send(params)
+  }
+
+  var setJTI = function(jTI){
+    config.jTI = jTI
+  }
+
+  var publicAccess = {
+    automaticallyTrackPageView: automaticallyTrackPageView,
+    trackPageView: trackPageView,
+    setJTI: setJTI,
+    config: config
+  }
+
+  if ( typeof define === "function" && define.amd ) {
+    define([], function(){
+      return publicAccess
+    })
+  } else {
+    window.shrew = publicAccess
+  }
+})(typeof shrewConfig !== 'undefined' ? shrewConfig : {
+  pageViewUrl: '/shrew/page_views',
+  jTI: null
+})

data/app/controllers/shrew/application_controller.rb

@@ -0,0 +1,4 @@
+module Shrew
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/shrew/page_views_controller.rb

@@ -0,0 +1,22 @@
+module Shrew
+  class PageViewsController < ApplicationController
+    def create
+      empty_response && return unless params[:jTI].present? && params[:jRT].present?
+
+      page_view = Shrew::PageView.find_by js_tracking_id: params[:jTI]
+      empty_response && return unless page_view
+
+      page_view.js_return_time = params[:jRT]
+      page_view.time_between_sent_and_return = page_view.js_return_time - page_view.sent_time if page_view.js_return_time && page_view.sent_time
+      page_view.save
+
+      empty_response
+    end
+
+    private
+
+    def empty_response
+      render json: []
+    end
+  end
+end

data/app/models/shrew/page_view.rb

@@ -0,0 +1,19 @@
+module Shrew
+  class PageView < ActiveRecord::Base
+    self.table_name = 'shrew_page_views'
+    belongs_to :user, class_name: Shrew.user_class
+
+    def self.create_from_payload(payload)
+      attributes = payload.slice(:user_id, :controller, :status, :view_runtime,
+                                 :db_runtime, :sent_time, :js_return_time,
+                                 :js_tracking_id)
+                          .merge(sent_time: milliseconds_since_epoch)
+      create(attributes)
+    end
+
+    private
+    def self.milliseconds_since_epoch
+      (Time.now.to_f * 1000).to_i
+    end
+  end
+end

data/app/views/shrew/_automatically_track_page_views.html.erb

@@ -0,0 +1,11 @@
+<script defer async>
+if (typeof define === "function" && define.amd) {
+  require(['shrew'], function(shrew){
+    shrew.setJTI('<%= @_js_tracking_id %>')
+    shrew.automaticallyTrackPageView()
+  })
+} else {
+  shrew.setJTI('<%= @_js_tracking_id %>') 
+  shrew.automaticallyTrackPageView()
+}
+</script>

data/config/routes.rb

@@ -0,0 +1,9 @@
+# Rails.application.routes.draw do
+#   mount Shrew::Engine => Rails.configuration.shrew[:route_scope]
+# end
+
+Shrew::Engine.routes.draw do
+  scope module: Shrew.route_scope do
+    resources :page_views, only: [:create], defaults: { format: :json }
+  end
+end

data/db/migrate/1_add_shrew_page_view_table.rb

@@ -0,0 +1,17 @@
+class AddShrewPageViewTable < ActiveRecord::Migration
+  def change
+    create_table :shrew_page_views do |t|
+      t.integer         :user_id
+      t.string          :controller
+      t.integer         :status
+      t.float           :view_runtime
+      t.float           :db_runtime
+      t.integer         :sent_time
+      t.integer         :js_return_time
+      t.integer         :time_between_sent_and_return
+      t.binary          :js_tracking_id, limit: 16
+    end
+
+    add_index :shrew_page_views, :user_id
+  end
+end

data/lib/generators/shrew/install_generator.rb

@@ -0,0 +1,31 @@
+module Shrew
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Create a shrew initializer'
+
+      def copy_initializer
+        template 'shrew.rb', 'config/initializers/shrew.rb'
+      end
+
+      def copy_migration
+        migration_template 'page_view_migration.rb', 'db/migrate/add_shrew_page_view_table.rb'
+      end
+
+      def add_routes
+        route "mount Shrew::Engine => '/shrew', as: 'shrew'"
+      end
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+    end
+  end
+end

data/lib/generators/templates/page_view_migration.rb

@@ -0,0 +1,17 @@
+class AddShrewPageViewTable < ActiveRecord::Migration
+  def change
+    create_table :shrew_page_views do |t|
+      t.integer         :user_id
+      t.string          :controller
+      t.integer         :status
+      t.float           :view_runtime
+      t.float           :db_runtime
+      t.integer         :sent_time
+      t.integer         :js_return_time
+      t.integer         :time_between_sent_and_return
+      t.binary          :js_tracking_id, limit: 16
+    end
+
+    add_index :shrew_page_views, :user_id
+  end
+end

data/lib/generators/templates/shrew.rb

@@ -0,0 +1,4 @@
+Shrew.setup do |config|
+  # config.route_scope = 'shrew'
+  # config.user_class = 'User'
+end

data/lib/shrew/engine.rb

@@ -0,0 +1,14 @@
+module Shrew
+  class Engine < Rails::Engine
+    initializer 'shrew.configure_rails_initialization' do |_|
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do
+        |_, start, finish, _, payload|
+
+        duration = (finish - start) * 1000
+        payload[:duration] = duration
+        next if payload[:controller] == 'Shrew::PageViewsController'
+        Shrew::PageView.create_from_payload(payload)
+      end
+    end
+  end
+end

data/lib/shrew/tracks_page_views.rb

@@ -0,0 +1,21 @@
+module Shrew
+  module TracksPageViews
+    extend ActiveSupport::Concern
+
+    def append_info_to_payload(payload)
+      super
+      return unless @_tracking_page_views
+      payload[:user_id] = try(:current_user).try(:id)
+      payload[:js_tracking_id] = @_js_tracking_id
+    end
+
+    included do
+      before_action :tracks_page_views
+    end
+
+    def tracks_page_views
+      @_tracking_page_views = true
+      @_js_tracking_id = SecureRandom.uuid
+    end
+  end
+end

data/lib/shrew/version.rb

@@ -0,0 +1,3 @@
+module Shrew
+  VERSION = '0.0.4'
+end

data/shrew.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'shrew/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'shrew'
+  s.version       = Shrew::VERSION
+  s.date          = '2014-11-05'
+  s.summary       = 'Shrew'
+  s.description   = 'A simple shrew gem'
+  s.authors       = ['Adam Gross']
+  s.email         = 'agross@synergydatasystems.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.license       = 'MIT'
+
+  s.add_dependency 'activesupport', '>=4.0.0'
+  s.add_dependency 'activerecord', '>=4.0.0'
+
+  s.add_development_dependency 'rspec', '~>3.1.0'
+  s.add_development_dependency 'rspec-rails', '~>3.1.0'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'database_cleaner'
+end

data/spec/controllers/page_views_controller_spec.rb

@@ -0,0 +1,56 @@
+require 'rails_helper'
+
+RSpec.describe Shrew::PageViewsController, type: :controller do
+  routes { Shrew::Engine.routes }
+
+  required_params = { jTI: '1', jRT: '100' }
+
+  context 'when missing parameter' do
+    required_params.each do |required_param|
+      it "#{required_param} does not attempt to find a page view" do
+        expect(Shrew::PageView).not_to receive(:find_by)
+
+        post :create, required_params.slice(required_param)
+      end
+
+      it 'returns a 200 empty response anyways' do
+        post :create, required_params.slice(required_param)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq '[]'
+      end
+    end
+  end
+
+  context 'when the javascript tracking id matches no existing page view' do
+    it 'returns a 200 empty response anyways' do
+      expect(Shrew::PageView).to receive(:find_by).and_return(nil)
+
+      post :create, required_params
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq '[]'
+    end
+  end
+
+  context 'when successful' do
+    let(:page_view) { Shrew::PageView.new }
+    before(:each) do
+      expect(Shrew::PageView).to receive(:find_by).and_return(page_view)
+      expect(page_view).to receive(:save).and_return(true)
+    end
+
+    it 'updates the page view with the js return time' do
+      post :create, required_params
+
+      expect(page_view.js_return_time).to eq 100
+    end
+
+    it 'returns a 200 empty response' do
+      post :create, required_params
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq '[]'
+    end
+  end
+end

data/spec/controllers/tracks_page_views_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+class ApplicationController < ActionController::Base
+  include Shrew::TracksPageViews
+end
+
+RSpec.describe ApplicationController do
+  controller do
+    def current_user
+      {}
+    end
+    def index
+      render json: 'ok'
+    end
+  end
+
+  describe Shrew::TracksPageViews do
+    it 'adds the js tracking id to be used in the layout' do
+      get :index
+      expect(assigns(:_js_tracking_id)).not_to eq nil
+    end
+
+    it 'sets that we are going to track page views to append to payload' do
+      get :index
+      expect(assigns(:_tracking_page_views)).to eq true
+    end
+
+    it 'creates the initial page view' do
+      expect {
+        get :index
+      }.to change{Shrew::PageView.count}.by(1)
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,50 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../../test/dummy/config/environment", __FILE__)
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end