webtrends-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30aafe7308b243a4b8a9ba6a0cf75dd92c6a64e9
+  data.tar.gz: e863191af8ce72c3e77beebb9677ff15b88a29dd
+SHA512:
+  metadata.gz: ed16e48d1a6d69d09ff3b9c1e49ba2c3abeac3c3c4b531a7455b7e1f31802fc8e89f470c9d0d3d0cbfced86ac39e7ede0394adb203bd2d3a1b9ac02b8f5daeb6
+  data.tar.gz: 2df8785c367bd1ef694a708792ca5425014a8340e014a977201d0d3c19dd2e0e0ad6db85429a940932c745cc27553cfd20814749c664aeade9d980ab3a148392

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--require spec_helper
+--require rspec/instafail
+--require rspec/rails
+--format documentation

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  SimpleCov.minimum_coverage 100.0
+  add_filter "/vendor"
+  add_filter "/spec"
+end

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ruben Estevez
+
+MIT License
+
+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,80 @@
+# Webtrends::Rails
+
+[![Gem Version](https://badge.fury.io/rb/webtrends-rails.png)](http://badge.fury.io/rb/webtrends-rails)
+[![Code Climate](https://codeclimate.com/github/amaabca/webtrends-rails.png)](https://codeclimate.com/github/amaabca/webtrends-rails)
+[![Build Status](https://travis-ci.org/amaabca/webtrends-rails.png?branch=master)](https://travis-ci.org/amaabca/webtrends-rails)
+[![Coverage Status](https://coveralls.io/repos/amaabca/webtrends-rails/badge.png)](https://coveralls.io/r/amaabca/webtrends-rails)
+[![Dependency Status](https://gemnasium.com/amaabca/webtrends-rails.png)](https://gemnasium.com/amaabca/webtrends-rails)
+
+Make use of Webtrends gem to allow server-side tracking in a Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webtrends-rails'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install webtrends-rails
+
+## Usage
+
+### Controller configuration
+
+Track hook
+
+track :object_to_track, options, optional_block
+
+NOTE: Any options that can be passed to before_action can be used as options.
+
+By default the track hook will use the following tags:
+
+- dcsuri: request path (ex. /path/to/service)
+- dcsdat: milliseconds since epoch
+- dcssip: hostname
+- WT.es: hostname + dcsuri
+- WT.co_f: webtrends visitor id
+
+NOTE: dcsuri is the only mandatory tag for event tracking. If dcsuri is not passed you will get
+a 400 Bad Request response
+
+#### Tracking with custom tags
+
+    track :object_to_track, only: :create do |tags|
+      tags.store('your_custom_tag', 'custom_tag_value')
+    end
+
+#### Tracking with default tags
+
+    track :object_to_track, only: [:create, :update]
+
+
+### Model configuration
+
+#### ActiveRecord
+
+Make use of an after_save hook to call track_event
+
+    after_save :track_event
+
+#### ActiveModel
+
+Make use of an after_validation hook to call track_event
+
+    after_validation :track_event, if: 'errors.blank?'
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create tests for your feature
+4. Make sure coverage meets minimum requirements
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/webtrends/rails/controller.rb

@@ -0,0 +1,34 @@
+module Webtrends
+  module Rails
+    module Controller
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+    private
+
+      def analytics_visitor_id
+        visitor_id = ''
+        /id=([\w\-]*)/.match(cookies['WT_FPC']).tap do |match|
+          visitor_id = match.captures.first if match
+        end
+        visitor_id
+      end
+
+      def analytics_tags
+        { dcsuri: request.path, dcsdat: (Time.now.to_f * 1000).to_i, dcssip: request.domain,
+          'WT.es' => "#{request.domain}#{request.path}", 'WT.co_f' => analytics_visitor_id }
+      end
+
+      module ClassMethods
+        def track(object_to_track, options)
+          before_action(options) do |controller|
+            tags = analytics_tags
+            yield(tags) if block_given?
+            controller.public_send(object_to_track).webtrends_tags = tags
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webtrends/rails/model.rb

@@ -0,0 +1,11 @@
+module Webtrends
+  module Rails
+    module Model
+      attr_accessor :webtrends_tags
+
+      def track_event
+        Webtrends::Event.new(tags: webtrends_tags).track
+      end
+    end
+  end
+end

data/lib/webtrends/rails/version.rb

@@ -0,0 +1,5 @@
+module Webtrends
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/webtrends/rails.rb

@@ -0,0 +1,11 @@
+require "webtrends"
+require "webtrends/rails/version"
+require "webtrends/rails/model"
+require "webtrends/rails/controller"
+
+module Webtrends
+  module Rails
+    ActiveRecord::Callbacks.send(:include, Webtrends::Rails::Model) if defined? ActiveRecord
+    ActionController::Base.send(:include, Webtrends::Rails::Controller) if defined? ActionController
+  end
+end

data/spec/controllers/controller_spec.rb

@@ -0,0 +1,36 @@
+describe TestsController do
+  before(:each) do
+    Webtrends::Event.stub(:track)
+  end
+
+  context 'successfull load' do
+    context '#analytics visitor id' do
+      it 'should respond to method' do
+        expect(subject).to receive(:analytics_visitor_id)
+        get :index
+      end
+
+      context 'cookie is present' do
+        it 'should return the id' do
+          request.cookies['WT_FPC'] = 'id=some_id-9ew8r09t7:vlkhrpe-ryg8u4387'
+          get :index
+          expect(subject.model.webtrends_tags['WT.co_f']).to eq('some_id-9ew8r09t7')
+        end
+      end
+
+      context 'cookies is not present' do
+        it 'should return empty string' do
+          get :index
+          expect(subject.model.webtrends_tags['WT.co_f']).to eq('')
+        end
+      end
+    end
+
+    context '#analytics_tags' do
+      it 'should return tags' do
+        get :index
+        expect(subject.model.webtrends_tags).to_not be_empty
+      end
+    end
+  end
+end

data/spec/factories/application.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+
+module Rails
+  class App
+    def env_config; {} end
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        resources :tests # Replace with your own needs
+      end
+      @routes
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end

data/spec/factories/controller.rb

@@ -0,0 +1,13 @@
+class TestsController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  include Webtrends::Rails::Controller
+
+  def render(*attributes); end
+
+  expose(:model)
+
+  track :model, only: :index
+
+  def index
+  end
+end

data/spec/factories/model.rb

@@ -0,0 +1,23 @@
+class Model
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  include ActiveRecord::Callbacks
+  extend ActiveModel::Naming
+  include Webtrends::Rails::Model
+
+  attr_accessor :some_attribute
+
+  validates :some_attribute, presence: true
+
+  after_validation :track_event, if: 'errors.blank?'
+
+  def attributes=(attributes = {})
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+
+  def save
+    errors.add(:base, 'Error') unless valid?
+  end
+end

data/spec/models/model_spec.rb

@@ -0,0 +1,20 @@
+describe Model do
+  context 'successfull load' do
+    context 'after validation' do
+      it 'should respond to track event' do
+        subject.some_attribute = 'cupcake'
+        expect_any_instance_of(Webtrends::Event).to receive(:track)
+        subject.save
+      end
+    end
+  end
+
+  context 'usuccessfull load' do
+    context 'after validation' do
+      it 'should not respond to track event' do
+        expect_any_instance_of(Webtrends::Event).to_not receive(:track)
+        subject.save
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'rails/all'
+require 'rspec/rails'
+require 'webtrends/rails'
+require 'coveralls'
+require 'decent_exposure'
+require 'factories/application'
+require 'factories/controller'
+require 'factories/model'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]

data/webtrends-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 'webtrends/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webtrends-rails"
+  spec.version       = Webtrends::Rails::VERSION
+  spec.authors       = ["Michael van den Beuken", "Ruben Estevez", "Jordan Babe", "Mathieu Gilbert", "Ryan Jones", "Darko Dosenovic"]
+  spec.email         = ["michael.beuken@gmail.com", "ruben.a.estevez@gmail.com", "jorbabe@gmail.com", "mathieu.gilbert@ama.ab.ca", "ryan.michael.jones@gmail.com", "darko.dosenovic@ama.ab.ca"]
+  spec.description   = "Make use of Webtrends gem to allow server-side tracking in a Rails application."
+  spec.summary       = "Make use of Webtrends gem to allow server-side tracking in a Rails application."
+  spec.homepage      = "https://github.com/amaabca/webtrends-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-instafail"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "decent_exposure"
+  spec.add_dependency "rails", ">= 3.1"
+  spec.add_dependency "webtrends"
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: webtrends-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael van den Beuken
+- Ruben Estevez
+- Jordan Babe
+- Mathieu Gilbert
+- Ryan Jones
+- Darko Dosenovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: rspec-rails
+  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: rspec-instafail
+  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: coveralls
+  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: decent_exposure
+  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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webtrends
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make use of Webtrends gem to allow server-side tracking in a Rails application.
+email:
+- michael.beuken@gmail.com
+- ruben.a.estevez@gmail.com
+- jorbabe@gmail.com
+- mathieu.gilbert@ama.ab.ca
+- ryan.michael.jones@gmail.com
+- darko.dosenovic@ama.ab.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webtrends/rails.rb
+- lib/webtrends/rails/controller.rb
+- lib/webtrends/rails/model.rb
+- lib/webtrends/rails/version.rb
+- spec/controllers/controller_spec.rb
+- spec/factories/application.rb
+- spec/factories/controller.rb
+- spec/factories/model.rb
+- spec/models/model_spec.rb
+- spec/spec_helper.rb
+- webtrends-rails.gemspec
+homepage: https://github.com/amaabca/webtrends-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.0.0
+signing_key: 
+specification_version: 4
+summary: Make use of Webtrends gem to allow server-side tracking in a Rails application.
+test_files:
+- spec/controllers/controller_spec.rb
+- spec/factories/application.rb
+- spec/factories/controller.rb
+- spec/factories/model.rb
+- spec/models/model_spec.rb
+- spec/spec_helper.rb