webtrends 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88af47c8840f1c9a5152ad58bdddbb2348829270
+  data.tar.gz: 9d990d0d6a755bab23ba73f8389cd80b3797d521
+SHA512:
+  metadata.gz: 10c05f208024257f0bd6e4d7ef7bd2afe1fd244132afb03c5e02536c0bd7748c1c4a7516c3b0c62128451c89e9e9803fc9d7331c3292bfab677dd592ef39cdfe
+  data.tar.gz: 2d6d60b1e49d77cc7a54b4e75330e889c7cca86802251b4a0c78c802b6e6c3b122d6b4251cee582f2e4e01c67821bf6974ef539d810dea86a2243ebd5a46b22c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--require rspec/instafail
+--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.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webtrends.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,58 @@
+# Webtrends
+[![Gem Version](https://badge.fury.io/rb/webtrends.png)](http://badge.fury.io/rb/webtrends)
+[![Code Climate](https://codeclimate.com/github/amaabca/webtrends.png)](https://codeclimate.com/github/amaabca/webtrends)
+[![Build Status](https://travis-ci.org/amaabca/webtrends.png?branch=master)](https://travis-ci.org/amaabca/webtrends)
+[![Coverage Status](https://coveralls.io/repos/amaabca/webtrends/badge.png)](https://coveralls.io/r/amaabca/webtrends)
+[![Dependency Status](https://gemnasium.com/amaabca/webtrends.png)](https://gemnasium.com/amaabca/webtrends)
+
+Make use of the Webtrends api to post event data for analytics purposes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webtrends'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install webtrends
+
+## Usage
+
+Create config/initializers/webtrends.rb
+
+Add the following configuration block
+
+    Webtrends.configure do |c|
+      c.protocol = 'https'
+      c.domain = 'dc.webtrends.com'
+      c.version = 'v1'
+      c.customer_id = YOUR_CUSTOMER_ID
+      c.verbose = true (setting verbose false is recommended in production)
+      c.format = 'xml' (plain or xml)
+    end
+
+Additional documentation can be found on: http://help.webtrends.com/en/dcapi/
+
+Example:
+
+     wt = Webtrends::Event.new(tags: { dcsuri: '/your_path_to_track', 'WT.ti' => 'a_tag'} )
+     response = wt.track
+
+Note: You will either get a RestClient::Response back or an exception will be raised.
+
+Note: dcsuri is required for the constructor.
+
+## 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.rb

@@ -0,0 +1,6 @@
+require "rest_client"
+
+require "webtrends/version"
+require "webtrends/service"
+require "webtrends/event"
+require "webtrends/configuration"

data/lib/webtrends/configuration.rb

@@ -0,0 +1,25 @@
+module Webtrends
+
+  attr_accessor :configuration
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :verbose, :format, :protocol, :domain, :version, :customer_id, :event_service
+
+    def initialize
+      self.verbose = false
+      self.format = 'xml'
+      self.protocol = 'https'
+      self.domain = 'dc.webtrends.com'
+      self.version = 'v1'
+      self.event_service = 'events.svc'
+    end
+  end
+end

data/lib/webtrends/event.rb

@@ -0,0 +1,18 @@
+module Webtrends
+  class Event < Service
+
+    attr_accessor :tags
+
+    def initialize(args = {})
+      super
+      self.tags = args.fetch(:tags, {})
+      self.service = args.fetch(:service, Webtrends.configuration.event_service)
+    end
+
+    def track
+      if !tags.empty?
+        RestClient.post endpoint, options.merge(tags)
+      end
+    end
+  end
+end

data/lib/webtrends/service.rb

@@ -0,0 +1,24 @@
+module Webtrends
+  class Service
+
+    attr_accessor :verbose, :format, :protocol, :domain, :version, :customer_id, :service
+
+    def initialize(args = {})
+      self.verbose = args.fetch(:verbose, Webtrends.configuration.verbose)
+      self.format = args.fetch(:format, Webtrends.configuration.format)
+      self.protocol = args.fetch(:protocol, Webtrends.configuration.protocol)
+      self.domain = args.fetch(:protocol, Webtrends.configuration.domain)
+      self.version = args.fetch(:version, Webtrends.configuration.version)
+      self.customer_id = args.fetch(:customer_id, Webtrends.configuration.customer_id)
+    end
+
+  private
+    def options
+      {dcsverbose: verbose, dcsformat: format}
+    end
+
+    def endpoint
+      "#{protocol}://#{domain}/#{version}/#{customer_id}/#{service}"
+    end
+  end
+end

data/lib/webtrends/version.rb

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

data/spec/event_spec.rb

@@ -0,0 +1,80 @@
+describe Webtrends::Event do
+
+  let(:successful_response) do
+     OpenStruct.new({response: File.read(File.join('spec', 'fixtures', 'success.xml')), code: 200})
+  end
+  let(:default_configuration) do
+    OpenStruct.new(
+      customer_id: 'whereevermd',
+      verbose: false,
+      format: 'xml')
+  end
+
+  before(:each) do
+    Webtrends.configure do |c|
+      c.customer_id = default_configuration.customer_id
+    end
+  end
+
+  describe '#track' do
+    context 'successful response' do
+      it 'returns success code' do
+        RestClient.stub(:post).and_return(successful_response)
+        subject.tags = {'dcsuri' => '/waffles'}
+        response = subject.track
+        expect(response.code).to eq(200)
+      end
+
+      it 'should merge tags and options' do
+        RestClient.stub(:post).and_return(successful_response)
+        subject.tags = {'dcsuri' => '/waffles'}
+        expect(RestClient).to receive(:post).with(subject.send(:endpoint), subject.tags.merge(subject.send(:options)))
+        response = subject.track
+      end
+    end
+
+    context 'unsuccessful response' do
+      it 'should trigger an exception' do
+        RestClient.stub(:post).and_raise(RestClient::BadRequest.new '400 Bad Request')
+        subject.tags = {'WT.ti' => 'waffles'}
+        begin
+          response = subject.track
+        rescue Exception => e
+          expect(e).to be_kind_of(RestClient::BadRequest)
+        end
+        expect(response).to be_nil
+      end
+
+      it 'should not call webtrends if tags is empty' do
+        expect(RestClient).to_not receive(:post)
+        response = subject.track
+      end
+    end
+  end
+
+  describe '#initialize' do
+    context 'not passing default configuraiton' do
+      it 'uses default config attributes' do
+        expect(subject.customer_id).to eq(default_configuration.customer_id)
+        expect(subject.verbose).to eq(default_configuration.verbose)
+        expect(subject.format).to eq(default_configuration.format)
+      end
+    end
+
+    context 'passing default configuraiton' do
+      let(:custom_configuration) do
+        OpenStruct.new(
+        customer_id: 'somedifferent',
+        verbose: true,
+        format: 'plain')
+      end
+
+      let(:subject) { Webtrends::Event.new(custom_configuration.to_h) }
+      it 'does not uses default config attributes' do
+        expect(subject.customer_id).to_not eq(default_configuration.customer_id)
+        expect(subject.verbose).to_not eq(default_configuration.verbose)
+        expect(subject.format).to_not eq(default_configuration.format)
+      end
+    end
+  end
+end

data/spec/fixtures/success.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<fields>
+  <date>2014-02-12</date>
+  <time>20:25:52</time>
+  <c-ip>96.53.112.182</c-ip>
+  <cs-useame>-</cs-useame>
+  <cs-host>-</cs-host>
+  <cs-method>POST</cs-method>
+  <cs-uri-stem>/dsgffhn</cs-uri-stem>
+  <cs-uri-query>WT.ti=ACCR</cs-uri-query>
+  <sc-status>200</sc-status>
+  <sc-bytes>-</sc-bytes>
+  <cs-version>-</cs-version>
+  <cs-user-agent>Ruby</cs-user-agent>
+  <cs-cookie>-</cs-cookie>
+  <cs-referer>-</cs-referer>
+  <dcs-id>dcsc1928yuz5bdaag0hu1lr25_6d2y</dcs-id>
+</fields>

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'rspec'
+require 'webtrends'
+require 'coveralls'
+require 'ostruct'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]

data/webtrends.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webtrends/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webtrends"
+  spec.version       = Webtrends::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   = %q{Make use of the Webtrends api to post event data for analytics purposes.}
+  spec.summary       = %q{Make use of the Webtrends api to post event data for analytics purposes.}
+  spec.homepage      = "https://github.com/amaabca/webtrends"
+  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"
+  spec.add_development_dependency "rspec-instafail"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_dependency "rest-client"
+
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: webtrends
+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-19 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
+  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: rest-client
+  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 the Webtrends api to post event data for analytics purposes.
+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.rb
+- lib/webtrends/configuration.rb
+- lib/webtrends/event.rb
+- lib/webtrends/service.rb
+- lib/webtrends/version.rb
+- spec/event_spec.rb
+- spec/fixtures/success.xml
+- spec/spec_helper.rb
+- webtrends.gemspec
+homepage: https://github.com/amaabca/webtrends
+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 the Webtrends api to post event data for analytics purposes.
+test_files:
+- spec/event_spec.rb
+- spec/fixtures/success.xml
+- spec/spec_helper.rb