esilverberg-google_otg 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*~

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 esilverberg
+
+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.rdoc

@@ -0,0 +1,46 @@
+= google_otg
+
+Author::    Eric Silverberg (http://www.ericsilverberg.com)
+Copyright:: Copyright (c) 2009 Eric Silverberg
+License::   MIT (Go Beavers!)
+Git::       http://github.com/esilverberg/google_otg/tree/master
+
+This plugin adds helpers to include Google's pretty over time line graph in your rails application. You will
+recognize this line graph from Google Analytics. 
+
+Many features are missing, including support for multiple lines and colors. Feel free to add.
+
+== Requirements
+You must be able to generate arrays of objects that respond to "count" and "created_at". The X-axis is presumed to be dates. You can control time step of the x-axis. 
+
+== Example Usage
+In your controller:
+
+ @hits_last_week = Hits.find_by_sql(["
+    SELECT 
+        DAYOFYEAR(hits.created_at) as d, 
+        DATE(hits.created_at) as created_at, 
+        count(*) as count
+    FROM hits
+    WHERE hits.created_at > UTC_TIMESTAMP() - INTERVAL 7 DAY
+    GROUP BY d
+    ORDER BY created_at"])
+
+In your view:
+
+  <%= over_time_graph(@hits_last_week) %>
+  or
+  <%= over_time_graph(@hits_last_week, :label => "Hits", :range => 1440, :x_label_format => "%A, %B %d", :src => "/google/OverTimeGraph.swf") %>
+
+== +over_time_graph+
+
+Some of the options available:
+
+<tt>:label</tt>::                The label of quantity being measured
+<tt>:range</tt>::                The time step, in minutes
+<tt>:x_label_format</tt>::       The time format for the x label
+<tt>:src</tt>::                  An optional local source to serve this widget (otherwise will serve from Google)
+
+== Copyright
+
+Copyright (c) 2009 esilverberg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "google_otg"
+    gem.summary = %Q{Google's amazing over-time graph, in your rails app}
+    gem.description = %Q{Include Google's Over Time Graph in your app}
+    gem.email = "eric@ericsilverberg.com"
+    gem.homepage = "http://github.com/esilverberg/google_otg"
+    gem.authors = ["esilverberg"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google_otg #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/google_otg.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{google_otg}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["esilverberg"]
+  s.date = %q{2009-09-03}
+  s.description = %q{Include Google's Over Time Graph in your app}
+  s.email = %q{eric@ericsilverberg.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "google_otg.gemspec",
+     "lib/google_otg.rb",
+     "rails/init.rb",
+     "test/google_otg_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/esilverberg/google_otg}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Google's amazing over-time graph, in your rails app}
+  s.test_files = [
+    "test/google_otg_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/google_otg.rb

@@ -0,0 +1,157 @@
+require 'uri'
+
+module GoogleOtg
+
+    DEFAULT_RANGE = 30 # 30 min
+
+    def over_time_graph(hits, args = {})
+        height = args.has_key?(:height) ? args[:height] : 125
+        src = args.has_key?(:src) ? args[:src] : "http://www.google.com/analytics/static/flash/OverTimeGraph.swf"
+        
+        range = hits_to_range(hits, args)
+        vars = range_to_flashvars(range)
+        
+        html = <<-eos
+<embed width="100%" height="#{height}"
+wmode="opaque" salign="tl" scale="noScale" quality="high" bgcolor="#FFFFFF"
+flashvars="input=#{vars}" 
+pluginspage="http://www.macromedia.com/go/getflashplayer" type="application/x-shockwave-flash" 
+src="#{src}"/>
+eos
+
+    end
+    
+    def flto10(val)
+        return ((val / 10) * 10).to_i
+    end
+    protected :flto10
+    
+    def hits_to_range(hits, args = {})
+
+        return nil unless hits
+        
+        hits.map{|h|
+            if !h.respond_to?("created_at") || !h.respond_to?("count")
+                raise ArgumentError, "Invalid object type. All objects must respond to 'count' and 'created_at'"
+            end
+        }
+      
+        label = args.has_key?(:label) ? args[:label] : "Value"
+        time_fn = args.has_key?(:time_fn) ? args[:time_fn] : lambda {|h| h.created_at }
+        range = args.has_key?(:range) ? args[:range] : DEFAULT_RANGE
+        x_label_format = args.has_key?(:x_label_format) ? args[:x_label_format] : "%A %I:%M%p"
+      
+        max_y = 0
+        tz = args.has_key?(:time_zone) ? args[:time_zone] : ActiveSupport::TimeZone['UTC']
+        hits_dict = {}
+        hits.each { |h|
+            hits_dict[time_fn.call(h)] = h
+        }
+
+        total = 0
+        
+        points = []
+        now_floored = Time.at((Time.now.to_i/(60*range))*(60*range)).gmtime
+        current = hits.length > 0 ? time_fn.call(hits[0]) : now_floored
+
+        while (current <= now_floored && range > 0) do
+            if hits_dict[current]
+                count = hits_dict[current].count.to_i
+                max_y = count if count > max_y
+
+                date = tz.utc_to_local(time_fn.call(hits_dict[current]))
+                date_key = date.to_i
+                date_value = date.strftime(x_label_format)
+                
+                points.push({:Value => [count, count], :Label => [date_key, date_value]})
+                total += count
+            else
+            
+                date = tz.utc_to_local(current)
+                date_key = date.to_i
+                date_value = date.strftime(x_label_format)
+                
+                points.push({:Value => [0, 0], :Label => [date_key, date_value]})
+            end
+            current = current + range.minutes
+            if points.length > 100 
+                break
+            end
+        end
+
+
+        mid_y = self.flto10(max_y / 2)
+        top_y = self.flto10(max_y)
+        if (top_y == 0)
+            mid_y = max_y / 2
+            top_y = max_y
+        end
+        
+        y_labels = [ [mid_y, mid_y], [top_y, top_y] ]
+
+        x_labels = []
+
+        if points.length > 0    
+            for i in 0..3
+                hit = points[i * (points.length / 4)]
+                
+                date_key = hit[:Label][0]
+                date_value = hit[:Label][1]
+                x_labels.push([date_key, date_value])
+            end
+        end
+        return {:x_labels => x_labels, :y_labels => y_labels, :label => label, :points => points, :total => total}    
+        
+    end
+    protected :hits_to_range
+    
+    def range_to_flashvars(args = {})
+        x_labels = args[:x_labels]
+        y_labels = args[:y_labels]
+        label = args[:label]
+        points = args[:points]
+        
+        raise ArgumentError unless x_labels
+        raise ArgumentError unless y_labels
+        raise ArgumentError unless label
+        raise ArgumentError unless points
+        
+            # this is the structure necessary to support the Google Analytics OTG
+
+            options = {:Graph => {
+            :Id => "Graph",
+            :ShowHover => true,
+            :Format => "NORMAL",
+            :XAxisTitle => "Day",
+            :Compare => false, 
+            :XAxisLabels => x_labels,
+            :HoverType => "primary_compare",
+            :SelectedSeries => ["primary", "compare"],
+            :Series => [
+                {
+                    :SelectionStartIndex => 0,
+                    :SelectionEndIndex => points.length,
+                    :Style => 
+                    {
+                        :PointShape => "CIRCLE",
+                        :PointRadius => 9,
+                        :FillColor => 30668,
+                        :FillAlpha => 10,
+                        :LineThickness => 4,
+                        :ActiveColor => 30668,
+                        :InactiveColor => 11654895
+                    },
+                    :Label => label,
+                    :Id => "primary",
+                    :YLabels => y_labels,
+                    :ValueCategory => "visits",
+                    :Points => points
+                        }]        
+                } # end graph
+            } # end options
+
+        return URI::encode(options.to_json)
+    end
+    protected :range_to_flashvars
+
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'google_otg.rb'
+ActionView::Base.send :include, GoogleOtg
+
+
+

data/test/google_otg_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class GoogleOtgTest < ActiveSupport::TestCase
+    include GoogleOtg
+
+    context "GoogleOtg" do
+        context "when passed in bad data" do
+            should "throw ArgumentError" do
+                e = nil
+                begin
+                    over_time_graph([:foo => "bar"])
+                rescue Exception => e
+                end
+                
+                assert_instance_of(ArgumentError, e)
+            end
+        end
+        
+        context "when passed in simple data" do
+            should "print out html" do 
+                hits = Hit.find(:all, :order => "created_at" )
+                output = over_time_graph(hits)
+                md = output.strip!.match(/^\<embed/)
+                assert(md != nil)
+            end
+        end
+        
+        context "actionview is modified" do
+            should "have over_time_graph method" do
+                assert(ActionView::Base.instance_methods.include?("over_time_graph"))
+            end
+        end
+    end    
+    
+end
+
+class ApplicationHelperTest < ActionView::TestCase  
+  def test_helper_method
+    hits = Hit.find(:all, :order => "created_at" )
+    tag = over_time_graph(hits)  
+    assert_tag_in(tag, :embed)#, :attributes => {:href => edit_account_path})  
+  end  
+end  

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_record'
+require 'action_controller'
+require 'active_record/fixtures'
+require 'active_support'
+require 'action_pack'
+require 'action_view'
+require 'rails/init'
+require 'action_view/test_case'
+
+require 'google_otg'
+
+class Test::Unit::TestCase
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :hits do |t|
+    t.integer :count
+    t.datetime :created_at
+  end
+end
+
+class Hit < ActiveRecord::Base
+    validates_presence_of :count
+end
+
+(1..3).each{|idx| 
+    ca = (3 - idx).hours.ago
+    range = GoogleOtg::DEFAULT_RANGE
+    ca = Time.at((ca.to_i/(60*range))*(60*range))
+
+    Hit.create(:count => rand(65535), :created_at => ca)
+}
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: esilverberg-google_otg
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- esilverberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Include Google's Over Time Graph in your app
+email: eric@ericsilverberg.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- google_otg.gemspec
+- lib/google_otg.rb
+- rails/init.rb
+- test/google_otg_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/esilverberg/google_otg
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Google's amazing over-time graph, in your rails app
+test_files: 
+- test/google_otg_test.rb
+- test/test_helper.rb