tremolo-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f607880f67a6363f812625bf502991d85aaee20f
+  data.tar.gz: 131a8f8817bc10aacc99860b17529a342ecbfbac
+SHA512:
+  metadata.gz: 273aeb95d37e15dc13592b63c0a9489b941dbed6b3d38124cc99c2ffc65c14c935070ce24859a97ef80d173e27a09702c0d7354b2b88755303bb19ac8e3797fb
+  data.tar.gz: 2f723624bed6b59984792201cfb267e9c8c00143d40adc651804b2251818d7a120fc794a4bc39daf6e1325382884f073b4d3ecbc485bc96dfe299f0e3c045b7e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tremolo-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tony Pitale
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Tremolo::Rails
+
+Provides seamless integration with basic tracking of rails (timing and pageviews) into the Google Analytics Measurement API.
+
+[![Build Status](https://travis-ci.org/tpitale/tremolo-rails.png?branch=master)](https://travis-ci.org/tpitale/tremolo-rails)
+[![Code Climate](https://codeclimate.com/github/tpitale/tremolo-rails.png)](https://codeclimate.com/github/tpitale/tremolo-rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tremolo-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tremolo-rails
+
+## Provides
+
+* Timing from instrumentation (total duration, db_runtime, view_runtime)
+* Pageview tracking on GETs
+* Tracker hook in controllers that can use a generated UUID request session `client_id`
+* Exception tracking (tracks only the exception name; not recommended for anything but stat-keeping)
+
+Session UUID for the `client_id` is handled for you. Can be overridden easily, see [Overriding the client_id](#overriding_the_client_id).
+
+## Usage
+
+In environments/production.rb (leave blank in development/test to not track):
+
+```ruby
+config.tremolo.trackers << ['0.0.0.0', 4444]
+```
+
+In controllers, `tracker` is made available to you:
+
+```ruby
+tracker.increment('count.series-name')
+```
+
+## Named trackers ##
+
+In the example above, the tracker is named `default`. If you wish, you can make multiple trackers, each with a name.
+
+```ruby
+config.tremolo.trackers << ['0.0.0.0', 4444] # default
+config.tremolo.trackers << [:secondary, '0.0.0.0', 8191]
+```
+
+This named tracker can be retrieved by passing the name to `tracker` in a controller.
+
+```ruby
+tracker(:secondary)
+```
+
+Further options can be passed to the tracker as a hash in the last element of an array (more details on the namespace below):
+
+```ruby
+config.tremolo.trackers << ['0.0.0.0', 4444, {namespace: 'website'}]
+```
+
+## Overriding the client_id ##
+
+A method is added to your controller called `tremolo_client_id`. By default, it's implementation looks like:
+
+```ruby
+session['tremolo.client_id'] ||= Tremolo::Rails.build_client_id
+```
+
+If you wish to not store the `client_id` in session, or you wish to use another UUID value, you may override the method `tremolo_client_id` as you see fit.
+
+## Setting a namespace ##
+
+To set a namespace to be used to prefix all stats for all trackers:
+
+```ruby
+config.tremolo.namespace = 'tremolo' # default is nil
+```
+
+This will cause pageviews and exceptions to be tracked under the stat `tremolo.pageview` and `tremolo.exception`, for example.
+
+The namespace can also be set per-tracker by passing it as the last argument to the configuration:
+
+```ruby
+config.tremolo.trackers << ['0.0.0.0', 4444, {namespace: 'tremolo'}]
+```
+
+## Tracking exceptions ##
+
+```ruby
+config.tremolo.exceptions = true
+```
+
+Tracking exceptions happens by adding to `ActionController::Base` a `rescue_from` for `Exception`. Because of this, it will only rescue exceptions that have not already been rescued from in your own code. If you wish to track those exceptions, as well, you can call `track_exception_with_tremolo(exception)` to your own `rescue_from` methods.
+
+## Disable some, or all, tracking
+
+Inside of your `environment` files, as appropriate
+
+```ruby
+config.tremolo.timing = false # stats: runtime.total, runtime.db, runtime.view
+config.tremolo.pageviews = false # stats: pageview
+config.tremolo.exceptions = false # default, stats: exception
+```
+
+## TODO ##
+
+* Add controller and action to payload
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tremolo/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tremolo/exception_tracking.rb

@@ -0,0 +1,42 @@
+module Tremolo
+  module ExceptionTracking
+
+    def self.included(controller)
+      controller.rescue_from ::Exception,
+        with: :track_exception_with_tremolo_and_raise
+    end
+
+    def track_exception_with_tremolo(exception)
+      tracker.increment('exception', backtrace_tags(exception))
+    end
+
+    def backtrace_tags(exception)
+      {
+        name: exception.class.name
+      }.merge!(backtrace_location(exception))
+    end
+
+    def backtrace_location(exception)
+      if exception.respond_to?(:backtrace_locations)
+        if location = (exception.backtrace_locations || []).first
+
+          {
+            path: location.path,
+            line: location.lineno
+          }
+        else
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def track_exception_with_tremolo_and_raise(exception)
+      track_exception_with_tremolo(exception)
+
+      # re-raise the exception as normal
+      raise exception
+    end
+  end
+end

data/lib/tremolo/railtie.rb

@@ -0,0 +1,49 @@
+module Tremolo
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do |app|
+      app.config.tremolo = ActiveSupport::OrderedOptions.new
+
+      # set defaults
+      app.config.tremolo.trackers = []
+      app.config.tremolo.namespace = nil
+      app.config.tremolo.timing = true
+      app.config.tremolo.pageviews = true
+      app.config.tremolo.exceptions = false
+
+      # optional, for page subscribers
+      app.config.tremolo.hostname = nil
+      app.config.tremolo.path_prefix = nil
+    end
+
+    initializer "tremolo.build_trackers" do
+      config.tremolo.trackers.each do |args|
+        # cheap way to detect a named tracker
+        args.unshift(:default) unless args.first.is_a? Symbol
+
+        args << {namespace: config.tremolo.namespace}
+
+        Tremolo.supervised_tracker(*args)
+      end
+    end
+
+    initializer "tremolo.controller_extension" do
+      track_exceptions = config.tremolo.exceptions
+
+      ActiveSupport.on_load(:action_controller) do
+        include Tremolo::SessionTracking
+
+        include Tremolo::ExceptionTracking if track_exceptions
+      end
+    end
+
+    initializer "tremolo.configure_subscribers" do
+      if config.tremolo.timing
+        ActiveSupport::Notifications.subscribe('process_action.action_controller', Tremolo::Subscribers::Timing)
+      end
+
+      if config.tremolo.pageviews
+        ActiveSupport::Notifications.subscribe('process_action.action_controller', Tremolo::Subscribers::Page)
+      end
+    end
+  end
+end

data/lib/tremolo/session_tracking.rb

@@ -0,0 +1,19 @@
+module Tremolo
+  module SessionTracking
+    def tracker(key=:default)
+      @tracker ||= Tremolo.fetch(key)
+    end
+
+    # load or set new uuid in session
+    def tremolo_client_id
+      session['tremolo.client_id'] ||= Tremolo::Rails.build_client_id
+    end
+
+    def append_info_to_payload(payload)
+      super
+
+      payload["tremolo.tracker"] = tracker
+      payload["tremolo.client_id"] = tremolo_client_id
+    end
+  end
+end

data/lib/tremolo/subscribers/base.rb

@@ -0,0 +1,60 @@
+module Tremolo
+  module Subscribers
+    class Base
+      def self.call(*args)
+        new(args).track!
+      end
+
+      def initialize(args)
+        @args = args
+      end
+
+      def track!
+        # noop, done by page/timing
+      end
+
+      protected
+
+      def tags
+        {
+          path: path,
+          hostname: hostname,
+          method: method,
+          client_id: client_id
+        }
+      end
+
+      def method
+        payload[:method]
+      end
+
+      def path_prefix
+        ::Rails.application.config.tremolo.path_prefix.to_s
+      end
+
+      def path
+        path_prefix.to_s + payload[:path]
+      end
+
+      def hostname
+        ::Rails.configuration.tremolo.hostname
+      end
+
+      def client_id
+        payload['tremolo.client_id']
+      end
+
+      def tracker
+        @tracker ||= payload['tremolo.tracker']
+      end
+
+      def payload
+        @payload ||= event.payload
+      end
+
+      def event
+        @event ||= ActiveSupport::Notifications::Event.new(*@args)
+      end
+    end
+  end
+end

data/lib/tremolo/subscribers/page.rb

@@ -0,0 +1,9 @@
+module Tremolo
+  module Subscribers
+    class Page < Base
+      def track!
+        tracker.increment('pageview', tags)
+      end
+    end
+  end
+end

data/lib/tremolo/subscribers/timing.rb

@@ -0,0 +1,23 @@
+module Tremolo
+  module Subscribers
+    class Timing < Base
+      def total_runtime
+        @total_runtime ||= event.duration
+      end
+
+      def db_runtime
+        @db_runtime ||= payload[:db_runtime]
+      end
+
+      def view_runtime
+        @view_runtime ||= payload[:view_runtime]
+      end
+
+      def track!
+        tracker.timing('runtime.total', total_runtime, tags)
+        tracker.timing('runtime.db', db_runtime, tags)
+        tracker.timing('runtime.view', view_runtime, tags)
+      end
+    end
+  end
+end

data/lib/tremolo-rails/version.rb

@@ -0,0 +1,5 @@
+module Tremolo
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/tremolo-rails.rb

@@ -0,0 +1,18 @@
+require 'securerandom'
+require 'tremolo'
+
+require 'tremolo/session_tracking'
+require 'tremolo/exception_tracking'
+require 'tremolo/subscribers/base'
+require 'tremolo/subscribers/page'
+require 'tremolo/subscribers/timing'
+
+module Tremolo
+  module Rails
+    module_function def build_client_id
+      SecureRandom.uuid
+    end
+  end
+end
+
+require 'tremolo/railtie' if defined?(::Rails)

data/tremolo-rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tremolo-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tremolo-rails"
+  spec.version       = Tremolo::Rails::VERSION
+  spec.authors       = ["Tony Pitale"]
+  spec.email         = ["tpitale@gmail.com"]
+
+  spec.summary       = %q{Rails integration with Tremolo for seamless Influxdb measurement.}
+  spec.description   = %q{Rails integration with Tremolo for seamless Influxdb measurement.}
+  spec.homepage      = "https://github.com/tpitale/tremolo-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bourne"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rails", ">= 3.0"
+
+  spec.add_dependency "tremolo", ">= 0.2.2"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: tremolo-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Pitale
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tremolo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+description: Rails integration with Tremolo for seamless Influxdb measurement.
+email:
+- tpitale@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tremolo-rails.rb
+- lib/tremolo-rails/version.rb
+- lib/tremolo/exception_tracking.rb
+- lib/tremolo/railtie.rb
+- lib/tremolo/session_tracking.rb
+- lib/tremolo/subscribers/base.rb
+- lib/tremolo/subscribers/page.rb
+- lib/tremolo/subscribers/timing.rb
+- tremolo-rails.gemspec
+homepage: https://github.com/tpitale/tremolo-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rails integration with Tremolo for seamless Influxdb measurement.
+test_files: []