rack_clicky 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,21 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+
21
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2010 Mark Turner
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,17 @@
1
+ = rack_clicky
2
+
3
+ Description goes here.
4
+
5
+ == Note on Patches/Pull Requests
6
+
7
+ * Fork the project.
8
+ * Make your feature addition or bug fix.
9
+ * Add tests for it. This is important so I don't break it in a
10
+ future version unintentionally.
11
+ * Commit, do not mess with rakefile, version, or history.
12
+ (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)
13
+ * Send me a pull request. Bonus points for topic branches.
14
+
15
+ == Copyright
16
+
17
+ Copyright (c) 2010 Mark Turner. See LICENSE for details.
data/Rakefile ADDED
@@ -0,0 +1,52 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "rack_clicky"
8
+ gem.summary = "Clicky Analytics for your Rack Apps"
9
+ gem.description = "Embeds the Clicky tracking code at the end of your HTML"
10
+ gem.email = "mark@amerine.net"
11
+ gem.homepage = "http://github.com/amerine/rack_clicky"
12
+ gem.authors = ["Mark Turner"]
13
+ gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
14
+ end
15
+ Jeweler::GemcutterTasks.new
16
+ rescue LoadError
17
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
18
+ end
19
+
20
+ require 'rake/testtask'
21
+ Rake::TestTask.new(:test) do |test|
22
+ test.libs << 'lib' << 'test'
23
+ test.pattern = 'test/**/test_*.rb'
24
+ test.verbose = true
25
+ end
26
+
27
+ begin
28
+ require 'rcov/rcovtask'
29
+ Rcov::RcovTask.new do |test|
30
+ test.libs << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+ rescue LoadError
35
+ task :rcov do
36
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
37
+ end
38
+ end
39
+
40
+ task :test => :check_dependencies
41
+
42
+ task :default => :test
43
+
44
+ require 'rake/rdoctask'
45
+ Rake::RDocTask.new do |rdoc|
46
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
47
+
48
+ rdoc.rdoc_dir = 'rdoc'
49
+ rdoc.title = "rack_clicky #{version}"
50
+ rdoc.rdoc_files.include('README*')
51
+ rdoc.rdoc_files.include('lib/**/*.rb')
52
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.0.0
@@ -0,0 +1,43 @@
1
+ module Rack
2
+ class Clicky
3
+
4
+ TRACKING_CODE = <<-EOTC
5
+ <script src="http://static.getclicky.com/js" type="text/javascript"></script>
6
+ <script type="text/javascript">clicky.init({{CODE}});</script>
7
+ <noscript><p><img alt="Clicky" width="1" height="1" src="http://in.getclicky.com/{{CODE}}ns.gif" /></p></noscript>
8
+ EOTC
9
+
10
+ def initialize(app, site_id, options = {})
11
+ @app = app
12
+ @site_id = site_id
13
+ end
14
+
15
+ def call(env)
16
+ dup._call(env)
17
+ end
18
+
19
+ def _call(env)
20
+
21
+ @status, @headers, @response = @app.call(env)
22
+ return [@status, @headers, @response] unless @headers['Content-Type'] =~ /html/
23
+
24
+ @headers.delete('Content-Length')
25
+ response = Rack::Response.new([], @status, @headers)
26
+ @response.each do |fragment|
27
+ response.write(inject_tracking(fragment))
28
+ end
29
+ response.finish
30
+ end
31
+
32
+ def inject_tracking(response)
33
+ response.sub!(/<\/body>/, "#{track_code}\n</body>")
34
+ end
35
+
36
+ private
37
+
38
+ def track_code
39
+ TRACKING_CODE.sub(/\{\{CODE\}\}/, @site_id)
40
+ end
41
+
42
+ end
43
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+ require 'shoulda'
4
+
5
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
6
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
7
+ require 'rack_clicky'
8
+
9
+ class Test::Unit::TestCase
10
+ end
@@ -0,0 +1,66 @@
1
+ require 'helper'
2
+ require 'rack/mock'
3
+
4
+ class TestRackClicky < Test::Unit::TestCase
5
+ context "Embedding clicky" do
6
+ should "place the tracking code at the end of an HTML request" do
7
+ assert_match EXPECTED_CODE, request.body
8
+ end
9
+
10
+ should "place the tracking code at the end of an XHTML request" do
11
+ assert_match EXPECTED_CODE, request(:content_type => 'application/xhtml+xml').body
12
+ end
13
+
14
+ should "not place the tracking code in a non HTML request" do
15
+ assert_no_match EXPECTED_CODE, request(:content_type => 'application/xml', :body => [XML]).body
16
+ end
17
+
18
+ should "insert the site id" do
19
+ assert_match /clicky\.init\(000000\)/, request.body
20
+ end
21
+
22
+ end
23
+
24
+
25
+ private
26
+
27
+ EXPECTED_CODE = /<script.*clicky\.init.*<\/script>.*<\/body>/m
28
+
29
+ SITE_ID = "000000"
30
+
31
+ HTML = <<-EOHTML
32
+ <html>
33
+ <head>
34
+ <title>Sample Page</title>
35
+ </head>
36
+ <body>
37
+ <h2>Rack::Clicky Test</h2>
38
+ <p>This is more test html</p>
39
+ </body>
40
+ </html>
41
+ EOHTML
42
+
43
+ XML = <<-EOXML
44
+ <?xml version="1.0" encoding="ISO-8859-1"?>
45
+ <user>
46
+ <name>Mark Turner</name>
47
+ <age>Unknown</age>
48
+ </user>
49
+ EOXML
50
+
51
+ def request(options={})
52
+ @app = app(options)
53
+ request = Rack::MockRequest.new(@app).get('/')
54
+ yield(@app, request) if block_given?
55
+ request
56
+ end
57
+
58
+ def app(options={})
59
+ options = options.clone
60
+ options[:content_type] ||= "text/html"
61
+ options[:body] ||= [HTML]
62
+ rack_app = lambda { |env| [200, { 'Content-Type' => options.delete(:content_type) }, options.delete(:body)] }
63
+ Rack::Clicky.new(rack_app, SITE_ID)
64
+ end
65
+
66
+ end
metadata ADDED
@@ -0,0 +1,90 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rack_clicky
3
+ version: !ruby/object:Gem::Version
4
+ hash: 23
5
+ prerelease: false
6
+ segments:
7
+ - 1
8
+ - 0
9
+ - 0
10
+ version: 1.0.0
11
+ platform: ruby
12
+ authors:
13
+ - Mark Turner
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2010-06-29 00:00:00 -07:00
19
+ default_executable:
20
+ dependencies:
21
+ - !ruby/object:Gem::Dependency
22
+ name: thoughtbot-shoulda
23
+ prerelease: false
24
+ requirement: &id001 !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ hash: 3
30
+ segments:
31
+ - 0
32
+ version: "0"
33
+ type: :development
34
+ version_requirements: *id001
35
+ description: Embeds the Clicky tracking code at the end of your HTML
36
+ email: mark@amerine.net
37
+ executables: []
38
+
39
+ extensions: []
40
+
41
+ extra_rdoc_files:
42
+ - LICENSE
43
+ - README.rdoc
44
+ files:
45
+ - .document
46
+ - .gitignore
47
+ - LICENSE
48
+ - README.rdoc
49
+ - Rakefile
50
+ - VERSION
51
+ - lib/rack_clicky.rb
52
+ - test/helper.rb
53
+ - test/test_rack_clicky.rb
54
+ has_rdoc: true
55
+ homepage: http://github.com/amerine/rack_clicky
56
+ licenses: []
57
+
58
+ post_install_message:
59
+ rdoc_options:
60
+ - --charset=UTF-8
61
+ require_paths:
62
+ - lib
63
+ required_ruby_version: !ruby/object:Gem::Requirement
64
+ none: false
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ hash: 3
69
+ segments:
70
+ - 0
71
+ version: "0"
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ hash: 3
78
+ segments:
79
+ - 0
80
+ version: "0"
81
+ requirements: []
82
+
83
+ rubyforge_project:
84
+ rubygems_version: 1.3.7
85
+ signing_key:
86
+ specification_version: 3
87
+ summary: Clicky Analytics for your Rack Apps
88
+ test_files:
89
+ - test/helper.rb
90
+ - test/test_rack_clicky.rb