rugalytics 0.1.6 → 0.1.7

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.1.7. rugalytics server, rugrat greasemonkey script
+
 v0.1.6. better fix for double quotes in csv causing fastercsv to fail
 
 v0.1.5. fixes for bad quotes in csv causing fastercsv to fail

data/Manifest

@@ -6,6 +6,7 @@ lib/rugalytics/item.rb
 lib/rugalytics/profile.rb
 lib/rugalytics/report.rb
 lib/rugalytics/server.rb
+lib/rugalytics/rugrat.user.js
 lib/rugalytics.rb
 LICENSE
 Manifest

data/README

@@ -88,7 +88,7 @@ In the report, there is a +pageviews_graph+ containing the points:
  => [[Mon, 01 Jan 2007, 8200], [Tue, 02 Jan 2007, 8400]]
 
 
-== What Reports are There?
+== Lots of Reports!
 
 The report name comes from the Google Analytics URL for a CSV report export.
 The report name is the rpt parameter from the URL, e.g. 'Pageviews' or
@@ -234,6 +234,49 @@ automatically, e.g.:
  top_items_over_week = report.items.sort_by{|i| i.unique_pageviews.to_i}.reverse
 
 
+==Rugalytics on Rugrat - a Greasemonkey script for Firefox
+
+TO INSTALL:
+
+Create a rugalytics.yml config file containing:
+
+ ---
+ account: your_account_name
+ profile: your_profile_name
+ username: your_user_name
+ password: your_pass_w
+
+
+Run rugalytics executable on console in same directory as rugalytics.yml:
+
+ > rugalytics
+
+
+Add Greasemonkey to Firefox:
+ https://addons.mozilla.org/firefox/748/
+
+Go to:
+ http://localhost:8888/
+
+Add rugrat user script:
+ http://localhost:8888/rugrat.user.js
+
+Configure website for rugrat to run over:
+
+ Firefox -> Tools -> Greasemonkey -> Manage User Scripts
+ -> select rugrat -> press "Add"
+ -> add your site, e.g. http://your_site.com/*
+ -> press "Close"
+
+Browse your site!
+
+
+==Ruby Manor Presentation Slides - Nov 2008
+
+Rugalytics - making a Ruby API to Google Analytics data - presentation slides from Ruby Manor 2008:
+  http://www.slideshare.net/delineator/rugalytics-ruby-manor-nov-2008-presentation/
+
+
 ==Acknowledgements
 
 Rugalytics started life as a fork of jnunemaker's Statwhore. As the code and

data/README.rdoc

@@ -88,7 +88,7 @@ In the report, there is a +pageviews_graph+ containing the points:
  => [[Mon, 01 Jan 2007, 8200], [Tue, 02 Jan 2007, 8400]]
 
 
-== What Reports are There?
+== Lots of Reports!
 
 The report name comes from the Google Analytics URL for a CSV report export.
 The report name is the rpt parameter from the URL, e.g. 'Pageviews' or
@@ -234,6 +234,49 @@ automatically, e.g.:
  top_items_over_week = report.items.sort_by{|i| i.unique_pageviews.to_i}.reverse
 
 
+==Rugalytics on Rugrat - a Greasemonkey script for Firefox
+
+TO INSTALL:
+
+Create a rugalytics.yml config file containing:
+
+ ---
+ account: your_account_name
+ profile: your_profile_name
+ username: your_user_name
+ password: your_pass_w
+
+
+Run rugalytics executable on console in same directory as rugalytics.yml:
+
+ > rugalytics
+
+
+Add Greasemonkey to Firefox:
+ https://addons.mozilla.org/firefox/748/
+
+Go to:
+ http://localhost:8888/
+
+Add rugrat user script:
+ http://localhost:8888/rugrat.user.js
+
+Configure website for rugrat to run over:
+
+ Firefox -> Tools -> Greasemonkey -> Manage User Scripts
+ -> select rugrat -> press "Add"
+ -> add your site, e.g. http://your_site.com/*
+ -> press "Close"
+
+Browse your site!
+
+
+==Ruby Manor Presentation Slides - Nov 2008
+
+Rugalytics - making a Ruby API to Google Analytics data - presentation slides from Ruby Manor 2008:
+  http://www.slideshare.net/delineator/rugalytics-ruby-manor-nov-2008-presentation/
+
+
 ==Acknowledgements
 
 Rugalytics started life as a fork of jnunemaker's Statwhore. As the code and

data/Rakefile

@@ -10,7 +10,7 @@ begin
     m.rubyforge_name = "rugalytics"
     m.rdoc_options << '--inline-source'
     m.rdoc_pattern = ["README", "CHANGELOG", "LICENSE"]
-    m.dependencies = ["hpricot >=0.6", "activesupport >=2.0.2", "googlebase >=0.2.0", "morph >=0.2.0", "fastercsv >=1.4.0"]
+    m.dependencies = ["hpricot >=0.6", "activesupport >=2.0.2", "googlebase >=0.2.0", "morph >=0.2.0", "fastercsv >=1.4.0", "rack >=0.4.0"]
     m.executable_pattern = 'bin/rugalytics'
   end
 

data/lib/rugalytics/item.rb

@@ -1,14 +1,11 @@
 module Rugalytics
-
   class Item
     include Morph
 
-    def initialize attributes, values, base_url
-      attributes.each_with_index do |attribute, index|
-        attribute.sub!('$','dollar')
-        attribute.sub!('/',' per ')
-        attribute.sub!('.',' ')
-        attribute.sub!(/page views/i,'pageviews')
+    def initialize labels, values, base_url
+      labels.each_with_index do
+          |label, index|
+        attribute = normalize(label)
         value = values[index]
         morph(attribute, value)
       end
@@ -19,6 +16,15 @@ module Rugalytics
         self.url = "http://#{base_url}#{page}"
       end
     end
+
+    private
+    def normalize label
+      label.sub!('$','dollar')
+      label.sub!('/',' per ')
+      label.sub!('.',' ')
+      label.sub!(/page views/i,'pageviews')
+      label
+    end
   end
 
 end

data/lib/rugalytics/profile.rb

@@ -89,6 +89,14 @@ module Rugalytics
       }
       params[:d1] = options[:url] if options[:url]
       params[:d1] = options[:page_title] if options[:page_title]
+      if options[:keywords]
+        params[:d1] = options[:keywords].gsub(' ','+')
+        params[:seg] = '1'
+        params[:segkey] = options[:segment] ? options[:segment] : 'organization'
+      end
+      if options[:value]
+        params[:gval] = options[:value]
+      end
       params
     end
 

data/lib/rugalytics/report.rb

@@ -14,8 +14,12 @@ module Rugalytics
       handle_tables lines
     end
 
+    def attributes
+      morph_attributes.delete_if {|k,v| v.nil?}.stringify_keys
+    end
+
     def attribute_names
-      Report.morph_methods.select {|m| m[/[a-z]$/]}.select {|m| send(m.to_sym)}
+      attributes.keys
     end
 
     def method_missing symbol, *args
@@ -98,9 +102,9 @@ module Rugalytics
           begin
             values = FasterCSV.parse_line(values_line)
           rescue Exception => e
-            values_line.gsub!(/""/,'$$')
+            values_line.gsub!(/""/,'^$$^')
             values = FasterCSV.parse_line(values_line)
-            values.each {|v| v.gsub!('$$','"')}
+            values.each {|v| v.gsub!('^$$^','"')}
           end
           items << Item.new(attributes, values, base_url)
           index = index.next

data/lib/rugalytics/rugrat.user.js

@@ -0,0 +1,165 @@
+// ==UserScript==
+// @name           rugrat
+// @namespace      github.com/robmckinnon/rugalytics
+// @description    a mousehole to google analytics data
+// @include        http://your_website/*
+// ==/UserScript==
+
+window.Rugrat = function() {;}
+
+window.Rugrat.prototype = {
+
+  replace_all: function(text, old, replace) {
+    while(text.indexOf(old) > 0) { text = text.replace(old,replace); }
+    return text;
+  },
+
+  keyword_grab: function(keywords, keyword_id, segment) {
+    var the_url = "http://localhost:8888/keyword_detail?keywords="+keywords+"&segment="+segment;
+    GM_log(the_url);
+    var base = this;
+    GM_xmlhttpRequest({
+       method:"GET",
+       url: the_url,
+       headers:{
+         "User-Agent":"Mozilla/5.0",
+         "Accept":"application/json"
+       },
+       onload:function(response) {
+         var status = base.replace_all(response.statusText,' ','');
+         if (status == 'OK') {
+           var json = response.responseText;
+           var data = eval('(' + json + ')');
+           base.display_keywords(data, keyword_id, segment);
+         }
+       }
+     });
+  },
+
+  display_keywords: function(data, keyword_id, segment) {
+    var items = data.items;
+    var comma = '';
+    for (var i in items) {
+      var item = items[i];
+      var name = 'red';
+
+      if (segment == 'city') {
+        name = item.city;
+      } else {
+        name = item.network_location;
+      }
+      if (segment == 'city' || (name.indexOf('mini') >= 0 || name.indexOf('trea') >= 0) ) {
+        var element = document.getElementById(keyword_id);
+        var html = element.innerHTML;
+        element.innerHTML = html + comma + ' <small>'+ name +'</small>';
+        comma = ',';
+      }
+    }
+  },
+
+  data_grab: function() {
+    var pathname = window.location.pathname;
+    var the_url = "http://localhost:8888/top_content_detail_keywords?url="+pathname;
+    GM_log(the_url);
+    var base = this;
+    GM_xmlhttpRequest({
+       method:"GET",
+       url: the_url,
+       headers:{
+         "User-Agent":"Mozilla/5.0",
+         "Accept":"application/json"
+       },
+       onload:function(response) {
+         var status = base.replace_all(response.statusText,' ','');
+         if (status == 'OK') {
+           var json = response.responseText;
+           var data = eval('(' + json + ')');
+           base.display_data(data);
+         }
+       }
+     });
+  },
+
+  grab_unique_page_views: function() {
+    var pathname = window.location.pathname;
+    var the_url = "http://localhost:8888/top_content_detail?value=unique_pageviews&url="+pathname;
+    GM_log(the_url);
+    var base = this;
+    GM_xmlhttpRequest({
+       method:"GET",
+       url: the_url,
+       headers:{
+         "User-Agent":"Mozilla/5.0",
+         "Accept":"application/json"
+       },
+       onload:function(response) {
+         var status = base.replace_all(response.statusText,' ','');
+         if (status == 'OK') {
+           var json = response.responseText;
+           var data = eval('(' + json + ')');
+           base.display_unique_page_views(data);
+         }
+       }
+     });
+  },
+
+  display_unique_page_views: function(data) {
+    var visits = data.unique_pageviews_graph.points;
+    var max = Math.max.apply( Math, visits) * 1.2;
+    var points = visits.join(',');
+    var sparkline = 'http://chart.apis.google.com/chart?chs=200x40&cht=ls&chds=0,' + max + '&chco=0077CC&chm=B,E6F2FA,0,0,0&chls=1,0,0&chd=t:'+points;
+    var img = '<img style="vertical-align: middle;border: none;width:200px; height:40px;" src="' + sparkline + '"></img>';
+
+    var element = document.getElementById("r_unique_page_views");
+    element.innerHTML = img + ' ' + data.unique_pageviews_total;
+  },
+
+  display_data: function(data) {
+    var lines = '';
+
+    lines += '<h3 style="margin-top: 0.5em;">Unique Page Views</h3>';
+    lines += '<span id="r_unique_page_views" style="width:200px; height:40px;"></span>';
+    lines += '<h3 style="margin-top: 0.5em;">Entrance keywords</h3>';
+
+    for (var i in data.items) {
+      var item = data.items[i];
+      var url = '';
+      var keywords = item.keyword;
+      lines += '<p id="x' + i + '" style="margin : 0.5em; font-size: 0.75em"><a href="'+url+'" style="text-decoration: none;">' + keywords + '</a> (' + item.unique_pageviews + ')</p>';
+    }
+
+    var menudiv = document.createElement('div');
+    menudiv.style.position = 'fixed';
+    menudiv.style.top = '5px';
+    menudiv.style.left = '55%';
+    menudiv.style.padding = '10px';
+    menudiv.style.backgroundColor = '#fff';
+    menudiv.style.border="2px solid";
+    menudiv.zIndex = '3';
+    // menudiv.style.display='none';
+
+    var menuobj = document.createElement('div');
+    menuobj.innerHTML = lines;
+    menudiv.appendChild(menuobj);
+
+    var content = document.getElementById('content');
+    content.appendChild(menudiv);
+
+    this.grab_unique_page_views();
+    for (var i in data.items) {
+      var keywords = data.items[i].keyword;
+      this.keyword_grab(keywords, 'x'+i, 'city');
+      this.keyword_grab(keywords, 'x'+i, 'organization');
+    }
+  },
+
+  init: function() {
+    this.data_grab();
+  }
+};
+
+window.addEventListener("load", function () {
+  var ahole = new window.Rugrat();
+  ahole.init();
+}, false);
+

data/lib/rugalytics/server.rb

@@ -1,42 +1,67 @@
-require 'webrick'
-include WEBrick
+require 'rack'
 
 module Rugalytics
-
-  class Servlet < HTTPServlet::AbstractServlet
-    def do_GET(req, res)
-      res.body = "<HTML>hello, world.</HTML>"
-      res['Content-Type'] = "text/html"
-    end
-  end
-
   class Server
     def initialize
-      begin
-        require 'webrick'
-        self.class.send(:include, WEBrick)
-      rescue LoadError
-        puts "You need to have webrick installed to run a rugalytics server"
-      end
-
       @profile = Rugalytics.default_profile
       @reports = {}
+      Rack::Handler::WEBrick.run(self, :Port=>8888)
+    end
 
-      server = HTTPServer.new :Port => 8888
+    def call(env)
+      path = env['PATH_INFO'].tr('/','')
 
-      server.mount("/", Rugalytics::Servlet)
+      if path.empty?
+        html = %Q|
+        <h1>Rugalytics on Rugrat</h1>
+        <p>TO INSTALL:</p>
+        <p>Add Greasemonkey to Firefox: <a href="https://addons.mozilla.org/firefox/748/">https://addons.mozilla.org/firefox/748/</a></p>
+        <p>Add rugrat user script: <a href="http://localhost:8888/rugrat.user.js">rugrat.user.js</a></p>
+        <p>Configure site for rugrat to run on:</p>
+        <p><code>Tools -&gt; Greasemonkey -&gt; Manage User Scripts</code><br/>
+        <code>-&gt; select rugrat -&gt; press "Add" -&gt; add your site, e.g. http://your_site.com/* -&gt; press "Close"</code></p>
+        <p>Create a rugalytics.yml config file containing:</p><pre>
+---
+account: your_account_name
+profile: your_profile_name
+username: your_user_name
+password: your_pass_w
 
-      server.mount_proc("/top_content_detail_keywords") {|request, response|
-        url = request.query['url']
-        @reports[url] ||= @profile.top_content_detail_keywords_report(:url => url)
-        items = @reports[url].items
-        data = {:url =>url, :report_name=>@reports[url].name, :items=>items}
-        response.body = data.to_json
-        response['Content-Type'] = "application/json"
-      }
+</pre>
+        <p>Run rugalytics on console in same directory as rugalytics.yml:</p>
+        <p><code>&gt; rugalytics</code></p>
+        <p>Browse your site!</p>|
+        [200, {'Content-Type' => "text/html"}, html]
+      elsif path == 'rugrat.user.js'
+        [200, {'Content-Type' => "application/json"}, File.new(File.dirname(__FILE__)+'/rugrat.user.js').readlines ]
+      else
+        request = Rack::Request.new(env)
+        report_name = (path + '_report').to_sym
+        send_data(report_name, request.GET.symbolize_keys)
+      end
+    end
 
-      trap("INT"){ server.shutdown }
-      server.start
+    def send_data report_name, params
+      key = (params.values << report_name).join('')
+      @reports[key] ||= @profile.send(report_name, params)
+      report = @reports[key]
+
+      json = report.attributes.to_json
+      add_in_front params, json
+      report.attribute_names.each do |name|
+        if name[/(.*)pageviews_graph/]
+          total = "#{$1}pageviews_total".to_sym
+          add_in_front({total => report.send(total)}, json)
+        end
+      end
+      add_in_front({:report_name => report.name}, json)
+
+      [200, {'Content-Type' => "application/json"}, json ]
     end
+
+    private
+      def add_in_front hash, json
+        json.sub!('{', hash.to_json.chomp("}") + ', ' ) unless hash.empty?
+      end
   end
 end

data/lib/rugalytics.rb

@@ -12,7 +12,7 @@ require 'fastercsv'
 
 # See README for usage documentation.
 module Rugalytics
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 
   FORMAT_PDF = '0' unless defined? FORMAT_PDF
   FORMAT_XML = '1' unless defined? FORMAT_XML
@@ -104,3 +104,5 @@ require File.dirname(__FILE__) + '/rugalytics/graph'
 require File.dirname(__FILE__) + '/rugalytics/server'
 
 # Rugalytics.config_setup(RAILS_ROOT) if defined?(RAILS_ROOT) && RAILS_ROOT
+
+# Rugalytics::Server.new

data/rugalytics.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rugalytics}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob McKinnon"]
-  s.date = %q{2008-11-21}
+  s.date = %q{2008-12-02}
   s.default_executable = %q{rugalytics}
   s.description = %q{Rugalytics is a Ruby API for Google Analytics.}
   s.email = ["rob ~@nospam@~ rubyforge.org"]
   s.executables = ["rugalytics"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README"]
-  s.files = ["CHANGELOG", "lib/rugalytics/account.rb", "lib/rugalytics/connection.rb", "lib/rugalytics/graph.rb", "lib/rugalytics/item.rb", "lib/rugalytics/profile.rb", "lib/rugalytics/report.rb", "lib/rugalytics/server.rb", "lib/rugalytics.rb", "LICENSE", "Manifest", "README", "README.rdoc", "bin/rugalytics", "rugalytics.yml.example", "spec/fixtures/analytics_account_find_all.html", "spec/fixtures/analytics_profile_find_all.html", "spec/fixtures/dashboard_report_webgroup.xml", "spec/lib/rugalytics/account_spec.rb", "spec/lib/rugalytics/graph_spec.rb", "spec/lib/rugalytics/item_spec.rb", "spec/lib/rugalytics/profile_spec.rb", "spec/lib/rugalytics/report_spec.rb", "spec/lib/rugalytics_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "rugalytics.gemspec", "Rakefile"]
+  s.files = ["CHANGELOG", "lib/rugalytics/account.rb", "lib/rugalytics/connection.rb", "lib/rugalytics/graph.rb", "lib/rugalytics/item.rb", "lib/rugalytics/profile.rb", "lib/rugalytics/report.rb", "lib/rugalytics/server.rb", "lib/rugalytics/rugrat.user.js", "lib/rugalytics.rb", "LICENSE", "Manifest", "README", "README.rdoc", "bin/rugalytics", "rugalytics.yml.example", "spec/fixtures/analytics_account_find_all.html", "spec/fixtures/analytics_profile_find_all.html", "spec/fixtures/dashboard_report_webgroup.xml", "spec/lib/rugalytics/account_spec.rb", "spec/lib/rugalytics/graph_spec.rb", "spec/lib/rugalytics/item_spec.rb", "spec/lib/rugalytics/profile_spec.rb", "spec/lib/rugalytics/report_spec.rb", "spec/lib/rugalytics_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "rugalytics.gemspec", "Rakefile"]
   s.has_rdoc = true
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rugalytics", "--main", "README", "--inline-source"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<googlebase>, [">= 0.2.0"])
       s.add_runtime_dependency(%q<morph>, [">= 0.2.0"])
       s.add_runtime_dependency(%q<fastercsv>, [">= 1.4.0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0.4.0"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
     else
       s.add_dependency(%q<hpricot>, [">= 0.6"])
@@ -38,6 +39,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<googlebase>, [">= 0.2.0"])
       s.add_dependency(%q<morph>, [">= 0.2.0"])
       s.add_dependency(%q<fastercsv>, [">= 1.4.0"])
+      s.add_dependency(%q<rack>, [">= 0.4.0"])
       s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<googlebase>, [">= 0.2.0"])
     s.add_dependency(%q<morph>, [">= 0.2.0"])
     s.add_dependency(%q<fastercsv>, [">= 1.4.0"])
+    s.add_dependency(%q<rack>, [">= 0.4.0"])
     s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rugalytics
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-21 00:00:00 +00:00
+date: 2008-12-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.4.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
   type: :development
@@ -92,6 +102,7 @@ files:
 - lib/rugalytics/profile.rb
 - lib/rugalytics/report.rb
 - lib/rugalytics/server.rb
+- lib/rugalytics/rugrat.user.js
 - lib/rugalytics.rb
 - LICENSE
 - Manifest