clicktale 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Railsware LLC
+
+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

@@ -0,0 +1,12 @@
+Clicktale
+=========
+You should specify Clicktale.project_id and Clicktale.ratio in your environment.
+
+1. Put your settings into initializer
+	Example: config/initializers/clicktale.rb
+		Clicktale.project_id = '1212'
+		Clicktale.ratio = '0.5'
+		
+2. Call <%= clicktale_tracker %> from view.
+
+Copyright (c) 2009 Railsware LLC, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc 'Generate documentation for the clicktale plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Clicktale'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/*.rb']
+end
+
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "clicktale"
+    gemspec.summary = "Use ClickTale analytics service with rails sites that require sessions"
+    gemspec.description = "Use ClickTale (http://www.clicktale.com/) analytics service with rails sites that require sessions (user authentication for example)"
+    gemspec.email = "al@railsware.com"
+    gemspec.homepage = "http://github.com/railsware/clicktale"
+    gemspec.description = IO.read "README"
+    gemspec.authors = ["Railsware LLC"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/clicktale.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clicktale}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Railsware LLC"]
+  s.date = %q{2010-03-31}
+  s.description = %q{Clicktale
+=========
+You should specify Clicktale.project_id and Clicktale.ratio in your environment.
+
+1. Put your settings into initializer
+	Example: config/initializers/clicktale.rb
+		Clicktale.project_id = '1212'
+		Clicktale.ratio = '0.5'
+		
+2. Call <%= clicktale_tracker %> from view.
+
+Copyright (c) 2009 Railsware LLC, released under the MIT license}
+  s.email = %q{al@railsware.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "clicktale.gemspec",
+     "init.rb",
+     "lib/clicktale.rb",
+     "lib/clicktale_helper.rb",
+     "spec/clicktale_helper_spec.rb",
+     "spec/clicktale_spec.rb",
+     "spec/lib/attribute_accessors.rb"
+  ]
+  s.homepage = %q{http://github.com/railsware/clicktale}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Use ClickTale analytics service with rails sites that require sessions}
+  s.test_files = [
+    "spec/clicktale_helper_spec.rb",
+     "spec/clicktale_spec.rb",
+     "spec/lib/attribute_accessors.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,5 @@
+require 'clicktale'
+require 'clicktale_helper'
+
+ActionController::Base.session_options[:expire_after] = 1.year
+ActionView::Base.send(:include, ClicktaleHelper)

data/lib/clicktale.rb

@@ -0,0 +1,8 @@
+class Clicktale
+  @@project_id = '0'
+  cattr_accessor :project_id
+
+  
+  @@ratio = '0'
+  cattr_accessor :ratio  
+end

data/lib/clicktale_helper.rb

@@ -0,0 +1,26 @@
+module ClicktaleHelper
+  def clicktale_tracker
+    <<-EOS
+      <!-- ClickTale Bottom part -->
+      <div id="ClickTaleDiv" style="display: none;"></div>
+      <script src="http://s.clicktale.net/WRb.js" type="text/javascript"></script>
+      <script type="text/javascript">
+      if(typeof ClickTale=='function'){
+      	#{clicktale_fetch_from}
+      	ClickTale(#{Clicktale.project_id}, #{Clicktale.ratio});
+      }
+      </script>
+      <!-- ClickTale end of Bottom part -->
+    EOS
+  end
+  
+  def clicktale_fetch_from
+  	url = if request.request_uri.index Regexp.new("^(.*)(\\?|\\&)#{controller.request.session_options[:session_key]}=(.*)(\\&|\\z)")
+      "#{request.protocol}#{request.host}#{request.request_uri}".
+        gsub(Regexp.new("#{controller.request.session_options[:session_key]}=(.*)(\\&|\\z)"), "#{controller.request.session_options[:session_key]}=#{session.session_id}")
+  	else
+  	  "#{request.protocol}#{request.host}#{request.request_uri}#{request.request_uri.index(/\?/) ? '&' : '?'}#{controller.request.session_options[:session_key]}=#{session.session_id}"
+  	end
+  	"ClickTaleFetchFrom = '#{url}'"
+  end
+end

data/spec/clicktale_helper_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + "/lib/attribute_accessors"
+require File.dirname(__FILE__) + '/../lib/clicktale'
+require File.dirname(__FILE__) + '/../lib/clicktale_helper'
+
+context "ClicktaleHelper instance" do  
+  include ClicktaleHelper
+  
+  before(:each) do
+    Clicktale.project_id  = '8001'
+    Clicktale.ratio       = '0.25'
+  end
+  
+  it "should build fetch url" do
+    lambda {
+      result = clicktale_fetch_from
+      result.should match(/param1=value1/)
+      result.should match(/param2=value2/)
+      result.should match(/_session=1234567890/)
+    }.should_not raise_error
+  end
+  
+  it "should build tracker code" do
+    lambda {
+      result = clicktale_tracker
+      result.should match(/ClickTaleFetchFrom = 'http:\/\/test.uri\/some_controller\/some_action\?param1=value1&param2=value2&_session=1234567890/)
+      result.should match(/ClickTale\(8001, 0\.25\)/)
+    }.should_not raise_error
+  end
+  
+  protected
+    def request
+      methods = {
+        :request_uri => "/some_controller/some_action?param1=value1&param2=value2&_session=111000111",
+        :protocol => "http://",
+        :host => "test.uri",
+        :session_options => { :session_key => '_session' }
+      }
+      mock('Request', methods)
+    end
+  
+    def session
+      mock('Session', { :session_id => '1234567890' })      
+    end
+    
+    def controller
+      mock('Controller', { :request => request })
+    end
+end

data/spec/clicktale_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + "/lib/attribute_accessors"
+require File.dirname(__FILE__) + '/../lib/clicktale'
+
+context "Clicktale class" do
+  ["project_id", "ratio"].each do |attr|
+    it "should have #{attr} class attribute" do
+      Clicktale.singleton_methods.should include("#{attr}=")
+      Clicktale.singleton_methods.should include(attr)
+    end
+  end
+end

data/spec/lib/attribute_accessors.rb

@@ -0,0 +1,61 @@
+# Extends the class object with class and instance accessors for class attributes,
+# just like the native attr* accessors for instance attributes.
+#
+# class Person
+# cattr_accessor :hair_colors
+# end
+#
+# Person.hair_colors = [:brown, :black, :blonde, :red]
+
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+end
+
+class Class
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}  # unless defined? @@hair_colors
+          @@#{sym} = nil          # @@hair_colors = nil
+        end # end
+                                  #
+        def self.#{sym}           # def self.hair_colors
+          @@#{sym}                # @@hair_colors
+        end                       # end
+                                  #
+        def #{sym}                # def hair_colors
+          @@#{sym}                # @@hair_colors
+        end                       # end
+      EOS
+    end
+  end
+ 
+  def cattr_writer(*syms)
+    options = syms.extract_options!
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}                      # unless defined? @@hair_colors
+          @@#{sym} = nil                              # @@hair_colors = nil
+        end                                           # end
+                                                      #
+        def self.#{sym}=(obj)                         # def self.hair_colors=(obj)
+          @@#{sym} = obj                              # @@hair_colors = obj
+        end                                           # end
+                                                      #
+        #{"                                           #
+        def #{sym}=(obj)                              # def hair_colors=(obj)
+          @@#{sym} = obj                              # @@hair_colors = obj
+        end                                           # end
+        " unless options[:instance_writer] == false } # # instance writer above is generated unless options[:instance_writer] == false
+      EOS
+    end
+  end
+ 
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: clicktale
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Railsware LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-31 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Clicktale
+  =========
+  You should specify Clicktale.project_id and Clicktale.ratio in your environment.
+  
+  1. Put your settings into initializer
+  	Example: config/initializers/clicktale.rb
+  		Clicktale.project_id = '1212'
+  		Clicktale.ratio = '0.5'
+  		
+  2. Call <%= clicktale_tracker %> from view.
+  
+  Copyright (c) 2009 Railsware LLC, released under the MIT license
+email: al@railsware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- clicktale.gemspec
+- init.rb
+- lib/clicktale.rb
+- lib/clicktale_helper.rb
+- spec/clicktale_helper_spec.rb
+- spec/clicktale_spec.rb
+- spec/lib/attribute_accessors.rb
+has_rdoc: true
+homepage: http://github.com/railsware/clicktale
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Use ClickTale analytics service with rails sites that require sessions
+test_files: 
+- spec/clicktale_helper_spec.rb
+- spec/clicktale_spec.rb
+- spec/lib/attribute_accessors.rb