rack-yandex-metrika 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Ilya Konyukhov
+
+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,65 @@
+# Rack Yandex Metrika
+
+Simple Rack middleware to help injecting the Yandex Metrika tracking code in your website.
+
+This middleware injects tracking code into the correct place of any request only when the response's `Content-Type` header contains `html` (therefore `text/html` and similar).
+
+The project code is based on Rack Google Analytics project.
+
+## Usage
+
+#### Gemfile
+
+```ruby
+gem 'rack-yandex-metrika'
+```
+
+#### Sinatra
+
+```ruby
+## app.rb
+use Rack::YandexMetrika, :counter_id => 00000000
+```
+
+#### Padrino
+
+```ruby
+## app/app.rb
+use Rack::YandexMetrika, :counter_id => 00000000
+```
+
+#### Rails
+
+```ruby
+## environment.rb:
+config.middleware.use Rack::YandexMetrika, :counter_id => 00000000
+```
+
+### Options
+
+* `:async`                  -  sets to use asynchronous tracker (default: true)
+* `:webvisor`               -  sets to use webvisor, ie tool for visitors behavior analysis (default: false)
+* `:clickmap`               -  sets to collect statistics for ClickMap tool (default: false)
+* `:trackLinks`             -  sets to collect statistics on using external links (default: false)
+* `:accurateTrackBounce`    -  sets non-bounce visit time to 15 sec (default: false)
+* `:trackHash`              -  sets to track hashes in URLs for AJAX sites (default: false)
+
+If you are not sure what's best, go with the defaults, and read here if you should opt-out.
+
+## Thread Safety
+
+This middleware *should* be thread safe. Although my experience in such areas is limited, having taken the advice of those with more experience; I defer the call to a shallow copy of the environment, if this is of consequence to you please review the implementation.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2013 Ilya Konyukhov. See LICENSE for details.
+With thanks to [Lee Hambley](https://github.com/leehambley) for Rack Google Analytics gem.

data/lib/rack-yandex-metrika.rb

@@ -0,0 +1 @@
+require 'rack/yandex-metrika'

data/lib/rack/templates/async.erb

@@ -0,0 +1,24 @@
+<script type="text/javascript">
+(function (d, w, c) {
+(w[c] = w[c] || []).push(function() {
+try {
+w.yaCounter<%= @options[:counter_id].to_i %> = new Ya.Metrika({id:<%= @options[:counter_id].to_i %><% if @options[:webvisor] %>,
+webvisor:true<% end %><% if @options[:clickmap] %>,
+clickmap:true<% end %><% if @options[:trackLinks] %>,
+trackLinks:true<% end %><% if @options[:accurateTrackBounce] %>,
+accurateTrackBounce:true<% end %><% if @options[:trackHash] %>,
+trackHash:true<% end %>});
+} catch(e) { }
+});
+var n = d.getElementsByTagName("script")[0],
+s = d.createElement("script"),
+f = function () { n.parentNode.insertBefore(s, n); };
+s.type = "text/javascript";
+s.async = true;
+s.src = (d.location.protocol == "https:" ? "https:" : "http:") + "//mc.yandex.ru/metrika/watch.js";
+if (w.opera == "[object Opera]") {
+d.addEventListener("DOMContentLoaded", f, false);
+} else { f(); }
+})(document, window, "yandex_metrika_callbacks");
+</script>
+<noscript><div><img src="//mc.yandex.ru/watch/<%= @options[:counter_id].to_i %>" style="position:absolute; left:-9999px;" alt="" /></div></noscript>

data/lib/rack/templates/sync.erb

@@ -0,0 +1,11 @@
+<script src="//mc.yandex.ru/metrika/watch.js" type="text/javascript"></script>
+<script type="text/javascript">
+try { var yaCounter<%= @options[:counter_id].to_i %> = new Ya.Metrika({id:<%= @options[:counter_id].to_i %><% if @options[:webvisor] %>,
+webvisor:true<% end %><% if @options[:clickmap] %>,
+clickmap:true<% end %><% if @options[:trackLinks] %>,
+trackLinks:true<% end %><% if @options[:accurateTrackBounce] %>,
+accurateTrackBounce:true<% end %><% if @options[:trackHash] %>,
+trackHash:true<% end %>});
+} catch(e) { }
+</script>
+<noscript><div><img src="//mc.yandex.ru/watch/<%= @options[:counter_id].to_i %>" style="position:absolute; left:-9999px;" alt="" /></div></noscript>

data/lib/rack/yandex-metrika.rb

@@ -0,0 +1,34 @@
+require 'rack'
+require 'erb'
+
+module Rack
+  class YandexMetrika
+    DEFAULT = { :async => true }
+
+    def initialize(app, options = {})
+      raise ArgumentError, "Counter_id must be set!" unless options[:counter_id] and options[:counter_id] != 0
+      @app, @options = app, DEFAULT.merge(options)
+    end
+
+    def call(env); dup._call(env); end
+
+    def _call(env)
+      @status, @headers, @body = @app.call(env)
+      return [@status, @headers, @body] unless html?
+      response = Rack::Response.new([], @status, @headers)
+      @body.each { |fragment| response.write inject(fragment) }
+      @body.close if @body.respond_to?(:close)
+      response.finish
+    end
+
+  private
+
+    def html?; @headers['Content-Type'] =~ /html/; end
+
+    def inject(response)
+      file = @options[:async] ? 'async' : 'sync'
+      @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/#{file}.erb", __FILE__)
+      response.gsub(%r{</body>}, @template.result(binding) + "</body>")
+    end
+  end
+end

data/lib/rack/yandex-metrika/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class YandexMetrika
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rack-yandex-metrika
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ilya Konyukhov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Rack middleware for implementing Yandex Metrika tracking in your
+  Ruby-Rack based project. Supports synchronous and asynchronous insertion and configurable
+  load options.
+email:
+- ilya@konyukhov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/yandex-metrika.rb
+- lib/rack/templates/async.erb
+- lib/rack/templates/sync.erb
+- lib/rack/yandex-metrika/version.rb
+- lib/rack-yandex-metrika.rb
+- README.md
+- LICENSE
+homepage: https://github.com/ilkon/rack-yandex-metrika
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware to inject Yandex Metrika tracking code into outgoing responses.
+test_files: []