woopra_track 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b7223a15d2694d6f1fff24368c65052dd3074bd
+  data.tar.gz: 5d4e05376eb54ff80f73adc72fbdb0438a76771e
+SHA512:
+  metadata.gz: ef3905755fbae9609a907ac9b828ba3706c6006a0e8cb9c2ea20845457691ae926ab43bfcdc8abe2a826bde2e897dfa7e735f0c8e3d6d7573288b1db3870893a
+  data.tar.gz: 7b983f399f2855fb2e68be53b4706d37d291e42faf8f9bf2ad7fc84091cce43c6621a1ee5785bba633f0b026c645acb2b82e3446f8724b80f1b85e5ec3e897f4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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,35 @@
+# WoopraTrack
+
+Tracking library for woopra.com. Woopra analytics client-side and server-side tracking helper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'woopra_track'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install woopra_track
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/woopra-track.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/woopra_track/helper.rb

@@ -0,0 +1,7 @@
+module WoopraTrack
+  module Helper
+    def woopra_javascript_tag
+      @woopra.try :javascript_tag
+    end
+  end
+end

data/lib/woopra_track/tracker.rb

@@ -0,0 +1,170 @@
+require 'uri'
+require 'typhoeus'
+require 'logger'
+
+module WoopraTrack
+  class Tracker
+    @@application_id = 'rails'
+    @@default_config = {
+      domain:            nil,
+      cookie_name:       'wooTracker',
+      cookie_domain:     nil,
+      cookie_path:       '/',
+      ping:              true,
+      ping_interval:     12000,
+      idle_timeout:      300000,
+      download_tracking: true,
+      outgoing_tracking: true,
+      download_pause:    200,
+      outgoing_pause:    400,
+      ignore_query_url:  true,
+      hide_campaign:     false,
+      ip_address:        nil,
+      cookie_value:      nil,
+    }
+
+    def initialize(request)
+      @request         = request
+      @current_config  = @@default_config
+      @custom_config   = { app: @@application_id }
+      @user            = {}
+      @events          = []
+      @user_up_to_date = true
+      @has_pushed      = false
+
+      @current_config[:domain]        = @request.host
+      @current_config[:cookie_domain] = @request.host
+      @current_config[:ip_address]    = get_client_ip
+      @current_config[:cookie_value]  = @request.cookies[@current_config[:cookie_name]] || random_cookie
+    end
+
+    def enable_logging
+      @logger = Logger.new(STDOUT)
+    end
+
+    def config(data)
+      data = Hash(data).select { |k, _v| k.in? @@default_config.keys }
+      data = data.except(:ip_address, :cookie_value)
+
+      @custom_config.merge!(data)
+    end
+
+    def identify(user)
+      @user            = user
+      @user_up_to_date = false
+    end
+
+    def track(*args)
+      event_name = nil
+      event_data = nil
+      back_end   = false
+
+      args.each do |param|
+        case param
+        when String
+          event_name = param
+        when Hash
+          event_data = param
+        when TrueClass
+          back_end = param
+        end
+      end
+
+      if back_end
+        http_request([event_name, event_data])
+      else
+        @events << [event_name, event_data]
+      end
+    end
+
+    def push(back_end=false)
+      if not @user_up_to_date
+        if back_end
+          http_request()
+        else
+          @has_pushed = true
+        end
+      end
+    end
+
+    def javascript_tag
+      code = ['(function(){var t,i,e,n=window,o=document,a=arguments,s="script",r=["config","track","trackForm","trackClick","identify","visit","push","call"],c=function(){var t,i=this;for(i._e=[],t=0;r.length>t;t++)(function(t){i[t]=function(){return i._e.push([t].concat(Array.prototype.slice.call(arguments,0))),i}})(r[t])};for(n._w=n._w||{},t=0;a.length>t;t++)n._w[a[t]]=n[a[t]]=n[a[t]]||new c;i=o.createElement(s),i.async=1,i.src="//static.woopra.com/js/w.js",e=o.getElementsByTagName(s)[0],e.parentNode.insertBefore(i,e)})("woopra");']
+
+      code << "woopra.config(#{@custom_config.to_json});" if @custom_config.length != 0
+      code << "woopra.identify(#{@user.to_json});" if not @user_up_to_date
+
+      @events.each do |event|
+        if event.first.nil?
+          code << "woopra.track();"
+        else
+          code << "woopra.track('#{event.first}', #{event.second.to_json});"
+        end
+      end
+
+      code << "woopra.push();" if @has_pushed
+
+      "<script>\n#{code.join("\n")}\n</script>".html_safe
+    end
+
+    def set_cookie(cookies)
+      cookies[@current_config[:cookie_name]] = @current_config[:cookie_value]
+    end
+
+    private
+
+      def http_request(event=nil)
+        request_url = 'https://www.woopra.com'
+        get_params  = {
+          host:    @current_config[:domain],
+          cookie:  @current_config[:cookie_value],
+          ip:      @current_config[:ip_address],
+          timeout: @current_config[:idle_timeout]
+        }
+
+        user_params = Hash[@user.map { |k, v| [:"cv_#{k}", "#{v}"] }]
+        get_params  = get_params.merge(user_params)
+
+        if event.nil?
+          request_url = URI.join(request_url, 'track/identify')
+        else
+          request_url = URI.join(request_url, 'track/ce')
+
+          if event.first.nil?
+            get_params = get_params.merge(event: 'pv', ce_url: @request.url)
+          else
+            event_data = Hash[Array(event.second).map { |k, v| [:"ce_#{k}", "#{v}"] }]
+            get_params = get_params.merge(event: event.first).merge(event_data)
+          end
+        end
+
+        request_url.query = URI.encode_www_form(get_params.merge(ce_app: @@application_id))
+        request_headers   = { 'User-Agent' => @request.env['HTTP_USER_AGENT'] }
+        request_response  = Typhoeus.get(request_url, headers: request_headers)
+
+        if @logger
+          if request_response.success?
+            @logger.info("Woopra") { "Success: #{request_url}" }
+          elsif request_response.timed_out?
+            @logger.warn("Woopra") { "Timeout: #{request_url}" }
+          elsif request_response.code == 0
+            @logger.error("Woopra") { "#{request_response.return_message}, #{request_url}" }
+          else
+            @logger.error("Woopra") { "WOOPRA Failed: #{request_response.code.to_s}, #{request_url}" }
+          end
+        end
+      end
+
+      def random_cookie
+        o = [('0'..'9'), ('A'..'Z')].map { |i| i.to_a }.flatten
+        (0..12).map { o[rand(o.length)] }.join
+      end
+
+      def get_client_ip
+        if not @request.env['HTTP_X_FORWARDED_FOR'].nil?
+          @request.env['HTTP_X_FORWARDED_FOR'].split(',').first.strip
+        else
+          @request.remote_ip
+        end
+      end
+  end
+end

data/lib/woopra_track/version.rb

@@ -0,0 +1,3 @@
+module WoopraTrack
+  VERSION = '0.1.0'
+end

data/lib/woopra_track.rb

@@ -0,0 +1,23 @@
+require 'woopra_track/version'
+require 'woopra_track/helper'
+
+module WoopraTrack
+  autoload :Tracker, 'woopra_track/tracker'
+
+  class << self
+    def included(model_class)
+      model_class.extend self
+    end
+  end
+
+  def woopra(request, config=nil, cookies=nil)
+    @woopra = Tracker.new request
+
+    @woopra.config(config)      unless config.nil?
+    @woopra.set_cookie(cookies) unless cookies.nil?
+  end
+end
+
+if defined? ActionView::Base
+  ActionView::Base.send :include, WoopraTrack::Helper
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: woopra_track
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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'
+description: Woopra analytics client-side and server-side tracking helper.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/woopra_track.rb
+- lib/woopra_track/helper.rb
+- lib/woopra_track/tracker.rb
+- lib/woopra_track/version.rb
+homepage: https://github.com/hardpixel/woopra-track
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Tracking library for woopra.com
+test_files: []