statwhore 0.0.3

data/History.txt

@@ -0,0 +1,3 @@
+* 0.0.3	- updated to new google api and switched to rspec
+* 0.0.2 - switched to googlebase for google auth and requests
+* 0.0.1 - initial relase

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 John Nunemaker
+
+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/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/statwhore.rb
+lib/statwhore/connection.rb
+lib/statwhore/google.rb
+lib/statwhore/google/analytics.rb
+lib/statwhore/google/analytics/account.rb
+lib/statwhore/google/analytics/profile.rb
+lib/statwhore/google/feedburner.rb
+lib/statwhore/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/fixtures/analytics_account_find_all.html
+spec/fixtures/analytics_profile_find_all.html
+spec/fixtures/dashboard_report_webgroup.xml
+spec/spec.opts
+spec/spec_helper.rb
+spec/statwhore_google_analytics_account_spec.rb
+spec/statwhore_google_analytics_profile_spec.rb
+spec/statwhore_google_analytics_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,4 @@
+= WARNING!!!!!!!!!!!
+This is completely unstable and will remain so for a bit. Do not use it right now unless you are hoping for things to go boom. :)
+
+Feel free however to hack at it and send me patches. 

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'statwhore/version'
+
+AUTHOR = 'FIXME full name'  # can also be an array of Authors
+EMAIL = "FIXME email"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'statwhore' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'statwhore' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Statwhore::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'statwhore documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  p.extra_deps = [ ['googlebase', '>= 0.2.0'], ['activesupport', '>= 2.0.2'], ['hpricot', '>= 0.6'] ]
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'statwhore'

data/lib/statwhore/connection.rb

@@ -0,0 +1,38 @@
+require 'net/https'
+module Statwhore
+  class Connection
+		def initialize(base_url, args = {})
+			@base_url = base_url
+			@username = args[:username]
+			@password = args[:password]
+		end
+
+		def get(resource, args = nil)
+			request(resource, "get", args)
+		end
+
+		def post(resource, args = nil)
+			request(resource, "post", args)
+		end
+
+		def request(resource, method = "get", args = nil)
+			url = URI.join(@base_url, resource)
+			url.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(v.to_s)] }.join("&") if args
+      
+			case method
+			when "get"
+				req = Net::HTTP::Get.new(url.request_uri)
+			when "post"
+				req = Net::HTTP::Post.new(url.request_uri)
+			end
+      
+			req.basic_auth(@username, @password) if @username && @password
+      
+			http = Net::HTTP.new(url.host, url.port)
+			http.use_ssl = (url.port == 443)
+      
+			res = http.start() { |conn| conn.request(req) }
+			res.body
+		end
+	end
+end

data/lib/statwhore/google/analytics/account.rb

@@ -0,0 +1,34 @@
+module Statwhore
+  module Google
+    module Analytics      
+      class Account < ::Google::Base
+        def self.find_all
+          doc = Hpricot::XML(get('https://www.google.com:443/analytics/home/'))
+          (doc/'select[@name=account_list] option').inject([]) do |accounts, option|
+            account_id = option['value'].to_i
+            accounts << new(:account_id => account_id, :name => option.inner_html) if account_id > 0
+            accounts
+          end
+        end
+        
+        attr_accessor :name, :account_id
+        
+        def initialize(attrs)
+          @name = attrs[:name]
+          @account_id = attrs[:account_id]
+        end
+        
+        def profiles(force=false)
+          if force || @profiles.nil?
+            @profiles = Profile.find_all(account_id)
+          end
+          @profiles
+        end
+
+        def to_s
+          "#{name} (#{account_id})"
+        end
+      end
+    end
+  end
+end

data/lib/statwhore/google/analytics/profile.rb

@@ -0,0 +1,77 @@
+module Statwhore
+  module Google
+    module Analytics      
+      class Profile < ::Google::Base
+        def self.find_all(account_id)
+          doc = Hpricot::XML(get("https://www.google.com:443/analytics/home/admin?scid=#{account_id}"))
+          (doc/'select[@name=profile_list] option').inject([]) do |profiles, option|
+            profile_id = option['value'].to_i
+            profiles << Profile.new(:account_id => account_id, :profile_id => profile_id, :name => option.inner_html) if profile_id > 0
+            profiles
+          end
+        end
+        
+        def self.find(account_id, profile_id)
+          find_all(account_id).detect { |p| p.profile_id.to_s == profile_id.to_s }
+        end
+        
+        attr_accessor :account_id, :name, :profile_id
+        
+        def initialize(attrs)
+          raise ArgumentError, ":profile_id is required" unless attrs.has_key?(:profile_id)
+          @account_id = attrs[:account_id]  if attrs.has_key?(:account_id)
+          @name       = attrs[:name]        if attrs.has_key?(:name)
+          @profile_id = attrs[:profile_id]  if attrs.has_key?(:profile_id)
+        end
+        
+        def report(options={})
+          options.reverse_merge!({
+            :report  => 'Dashboard',
+            :from    => Time.now.utc - 7.days,
+            :to      => Time.now.utc,
+            :tab     => 0,
+            :format  => FORMAT_XML,
+            :compute => 'average',
+            :view    => 0
+          })
+          options[:from] = ensure_datetime_in_google_format(options[:from])
+          options[:to]   = ensure_datetime_in_google_format(options[:to])
+          
+          params = {
+            :pdr  => "#{options[:from]}-#{options[:to]}",
+            :rpt  => "#{options[:report]}Report",
+            :cmp  => options[:compute],
+            :fmt  => options[:format],
+            :view => options[:view],
+            :tab  => options[:tab],
+            :id   => profile_id,
+          }
+          self.class.get("https://google.com/analytics/reporting/export", :query_hash => params)
+        end
+        
+        def pageviews(options={})
+          response = report(options.merge({:report => 'Dashboard'}))
+          doc = Hpricot::XML(response)
+          pageviews = (doc/:ItemSummary).detect { |summary| summary.at('Message').inner_html == 'Pageviews' }
+          pageviews && pageviews.at('SummaryValue') ? pageviews.at('SummaryValue').inner_html.gsub(/\D/, '').to_i : 0
+        end
+        
+        def visits(options={})
+          response = report(options.merge({:report => 'Dashboard'}))
+          doc = Hpricot::XML(response)
+          pageviews = (doc/:ItemSummary).detect { |summary| summary.at('Message').inner_html == 'Visits' }
+          pageviews && pageviews.at('SummaryValue') ? pageviews.at('SummaryValue').inner_html.gsub(/\D/, '').to_i : 0
+        end
+        
+        # takes a Date, Time or String
+        def ensure_datetime_in_google_format(time)
+          time.is_a?(Time) || time.is_a?(Date) ? time.strftime('%Y%m%d') : time
+        end
+        
+        def to_s
+          "#{name} (#{profile_id})"
+        end
+      end
+    end
+  end
+end

data/lib/statwhore/google/analytics.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/analytics/account'
+require File.dirname(__FILE__) + '/analytics/profile'
+
+module Statwhore
+  module Google
+    module Analytics
+      FORMAT_PDF = '0'
+      FORMAT_XML = '1'
+      FORMAT_CSV = '2'
+      FORMAT_TAB = '3'
+            
+      VALID_REPORTS = %w[ Dashboard ]
+         
+      class InvalidCredentials < Exception; end
+    end
+  end
+end

data/lib/statwhore/google/feedburner.rb

@@ -0,0 +1,27 @@
+module Statwhore
+  module Google
+    module Feedburner
+      API_URL = 'http://api.feedburner.com/management/1.0'
+      
+      class Base
+        def self.establish_connection(u, p)
+          @@connection = Connection.new(API_URL, u, p)
+        end
+        
+        def self.connection
+          @@connection
+        end
+      end
+      
+      class Feed < Base
+        
+      end
+      
+    end
+  end
+end
+# 
+# include Statwhore::Google
+# Feedburner::Feed.find(:all)
+# Feedburner::Feed.find('johnnunemaker')
+# Feedburner::Feed.find(1234)

data/lib/statwhore/google.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/google/analytics'
+require File.dirname(__FILE__) + '/google/feedburner'

data/lib/statwhore/version.rb

@@ -0,0 +1,9 @@
+module Statwhore #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 3
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/statwhore.rb

@@ -0,0 +1,16 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'ostruct'
+require 'rubygems'
+gem 'hpricot', '>= 0.6'
+require 'hpricot'
+gem 'activesupport', '>= 2.0.2'
+require 'activesupport'
+gem 'googlebase', '>= 0.2.0'
+require 'google/base'
+
+require File.dirname(__FILE__) + '/statwhore/google'
+require File.dirname(__FILE__) + '/statwhore/connection'

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/statwhore/version.rb'
+
+version  = Statwhore::VERSION::STRING
+download = 'http://rubyforge.org/projects/statwhore'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)