google-analytics 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0 Nothing here yet

data/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+LICENSE
+Manifest
+README.textile
+Rakefile
+google-analytics.gemspec
+lib/google_analytics.rb
+lib/google_analytics/account.rb
+lib/google_analytics/client.rb
+lib/google_analytics/report.rb
+lib/google_analytics/user.rb
+test.rb
+test/google_analytics/account_test.rb
+test/google_analytics/client_test.rb
+test/google_analytics/report_test.rb
+test/google_analytics/user_test.rb
+test/test_helper.rb

data/README.textile

@@ -0,0 +1,3 @@
+h1. Google Analytics API for Ruby
+
+Does what it says on the tin.  

data/Rakefile

@@ -0,0 +1,12 @@
+require 'echoe'
+require 'fileutils'
+
+Echoe.new("google-analytics") do |p|
+  p.author = "Dan Webb"
+  p.email = 'dan@danwebb.net'
+  p.summary = "Wrapper around the Google Analytics API"
+  p.runtime_dependencies = ['nokogiri']                        
+  p.development_dependencies = ['shoulda', 'fakeweb']
+  p.retain_gemspec = true
+  p.rcov_options = "--exclude 'gems/*'"
+end

data/google-analytics.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{google-analytics}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Webb"]
+  s.date = %q{2009-10-12}
+  s.description = %q{Wrapper around the Google Analytics API}
+  s.email = %q{dan@danwebb.net}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.textile", "lib/google_analytics.rb", "lib/google_analytics/account.rb", "lib/google_analytics/client.rb", "lib/google_analytics/report.rb", "lib/google_analytics/user.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.textile", "Rakefile", "google-analytics.gemspec", "lib/google_analytics.rb", "lib/google_analytics/account.rb", "lib/google_analytics/client.rb", "lib/google_analytics/report.rb", "lib/google_analytics/user.rb", "test.rb", "test/google_analytics/account_test.rb", "test/google_analytics/client_test.rb", "test/google_analytics/report_test.rb", "test/google_analytics/user_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Google-analytics", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{google-analytics}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Wrapper around the Google Analytics API}
+  s.test_files = ["test/google_analytics/account_test.rb", "test/google_analytics/client_test.rb", "test/google_analytics/report_test.rb", "test/google_analytics/user_test.rb", "test/test_helper.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
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end

data/lib/google_analytics.rb

@@ -0,0 +1,9 @@
+module GoogleAnalytics
+  autoload :Client,  'google_analytics/client'
+  autoload :User,    'google_analytics/user'
+  autoload :Account, 'google_analytics/account'
+  autoload :Profile, 'google_analytics/profile'
+  autoload :Report, 'google_analytics/report'
+  
+  DXP_NAMESPACE = 'http://schemas.google.com/analytics/2009'
+end

data/lib/google_analytics/account.rb

@@ -0,0 +1,25 @@
+module GoogleAnalytics
+  
+  class Account    
+    attr_reader :url, :title, :id, :profile_id, :client
+    
+    def self.from_node(client, node)
+      new client, 
+          node.xpath('.//xmlns:id').first.content, 
+          node.xpath('.//dxp:property[@name="ga:accountName"]', 'dxp' => DXP_NAMESPACE).first.attributes['value'].to_s,
+          node.xpath('.//dxp:property[@name="ga:accountId"]', 'dxp' => DXP_NAMESPACE).first.attributes['value'].to_s,
+          node.xpath('.//dxp:property[@name="ga:profileId"]', 'dxp' => DXP_NAMESPACE).first.attributes['value'].to_s
+    end
+    
+    def initialize(client, url, title, id, profile_id)
+      @client, @url, @title = client, url, title
+      @id, @profile_id = id, profile_id
+    end
+    
+    def report(options={})
+      Report.new(self, options)
+    end
+     
+  end
+
+end

data/lib/google_analytics/client.rb

@@ -0,0 +1,98 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'nokogiri'
+
+module GoogleAnalytics
+  
+  AUTH_URL = 'https://www.google.com/accounts/ClientLogin'
+  BASE_URL = 'https://www.google.com/analytics'
+  
+  class NotAuthorized < StandardError; end
+  class ResponseError < StandardError; end
+  
+  class Client
+    
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+    
+    def login!
+      data = {
+        :accountType => 'GOOGLE_OR_HOSTED',
+        :service     => 'analytics',
+        :Email       => @username,
+        :Passwd      => @password
+      }
+      
+      begin
+        resp = request(URI.parse(AUTH_URL), :post, data)
+  
+        if resp =~ /^Auth\=(.+)$/
+          @auth = $1
+        else
+          raise NotAuthorized, 'you cannot access this google account'
+        end
+      rescue GoogleAnalytics::ResponseError
+        raise NotAuthorized, 'you cannot access this google account'
+      end
+    end
+    
+    def get(path, args=nil)
+      api_request(path, :get, args)
+    end
+
+    def post(path, args=nil)
+      api_request(path, :post, args)
+    end
+    
+    def api_request(path, method, args)
+      login! unless @auth
+      url = URI.parse([BASE_URL, path].join)
+      
+      resp = request(url, method, args)
+      
+      Nokogiri::XML(resp)
+    end
+
+    def request(url, method=:get, data=nil)
+      case method
+      when :get
+        url.query = encode(data) if data
+        req = Net::HTTP::Get.new(url.request_uri)
+      when :post
+        req = Net::HTTP::Post.new(url.request_uri)
+        req.body = encode(data) if data
+        req.content_type = 'application/x-www-form-urlencoded'
+      end
+      
+      req['Authorization'] = "GoogleLogin auth=#{@auth}" if @auth
+
+      puts url.to_s
+      
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = (url.port == 443)
+
+      res = http.start() { |conn| conn.request(req) }
+      
+      raise ResponseError, "#{res.code} #{res.message}: #{res.body}" unless res.code == '200'
+      
+      res.body
+    end
+    
+    protected
+    
+    def encode(data)
+      data.map do |k,v| 
+        value = v.is_a?(Array) ? v.join(',') : v.to_s
+        ("%s=%s" % [uri_encode(k), uri_encode(value)]) unless value.empty?
+      end.compact.join("&")
+    end
+    
+    def uri_encode(item)
+      encoded = URI.encode(item.to_s)
+      encoded.gsub(/\=/, '%3D')
+    end
+  end
+
+end

data/lib/google_analytics/report.rb

@@ -0,0 +1,93 @@
+module GoogleAnalytics
+  class Report
+    
+    def initialize(account, options={})
+      @account = account
+      @options = {
+        :ids => "ga:#{account.profile_id}",
+        :metrics => ga_prefix(options.delete(:metrics)),
+        :dimensions => ga_prefix(options.delete(:dimensions)),
+        :'start-date' => date_format(options.delete(:start) || one_month_ago),
+        :'end-date' => date_format(options.delete(:end) || Time.now)
+      }.merge(options)
+      
+      if filters = options.delete(:filters)
+        @options[:filters] = ga_prefix(filters)
+      end
+      
+      if sort = options.delete(:sort)
+        @options[:sort] = ga_prefix(sort)
+      end
+    end
+    
+    def each
+      page = 1
+      items = rows(page)
+      
+      while !items.empty?
+        yield items.pop
+        
+        items = rows(page+=1) if items.empty?
+      end
+    end
+    
+    def rows(page=1, per_page=10000)
+      parse_rows(get( 
+        :"start-index" => start_index(page, per_page), 
+        :'max-results' => per_page  
+      ))
+    end
+    
+    def get(options={})
+      @account.client.get('/feeds/data', @options.merge(options))
+    end
+    
+    protected
+    
+    def start_index(page, per_page)
+      ((page - 1) * per_page) + 1
+    end
+    
+    def parse_rows(data)
+      rows = []
+      data.xpath('.//xmlns:entry').each do |node|
+        row = {}
+        
+        node.xpath('./dxp:dimension').each do |dim|
+          row[strip_prefix(dim.attributes['name'])] = dim.attributes['value'].to_s
+        end
+        
+        node.xpath('./dxp:metric').each do |dim|
+          row[strip_prefix(dim.attributes['name'])] = dim.attributes['value'].to_s
+        end
+        
+        rows << row
+      end
+      return rows
+    end
+    
+    def strip_prefix(name)
+      name.to_s.gsub(/^ga\:/, '')
+    end
+    
+    def ga_prefix(data)
+      if data.is_a?(Array)
+        data.collect { |d| d.gsub(/(-?)(\w+)/, "\\1ga:\\2") }
+      elsif !data.nil?
+        d.gsub(/(-?)(\w+)/, "\\1ga:\\2")
+      end
+    end
+    
+    def date_format(date)
+      if date.nil?
+        nil
+      else
+        date.strftime('%Y-%m-%d')
+      end
+    end
+    
+    def one_month_ago
+      Time.now - (28 * 24 * 60 * 60)
+    end
+  end
+end

data/lib/google_analytics/user.rb

@@ -0,0 +1,31 @@
+module GoogleAnalytics
+  
+  class User
+    
+    def initialize(username, password)
+      @client = Client.new username, password
+    end
+    
+    def accounts
+      return @accounts if @accounts
+      xml = @client.get('/feeds/accounts/default')
+      @accounts = xml.xpath('//xmlns:entry').collect do |account_node|
+        Account.from_node(@client, account_node)
+      end
+    end
+    
+    def account(id)
+      accounts.find do |account|
+        account if account.id == id
+      end
+    end
+    
+    def valid?
+      @client.login!
+      true
+    rescue NotAuthorized
+      false
+    end
+  end
+
+end

data/test.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'google_analytics'
+
+include GoogleAnalytics
+
+u = User.new 'dan@danwebb.net', 'poortheory'
+
+r = u.accounts[1].report :dimensions => ['keyword'],
+                         :metrics => ['visits', 'bounces', 'newVisits', 'timeOnSite']
+                         
+puts r.rows(1).inspect

data/test/google_analytics/account_test.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+class AccountTest < Test::Unit::TestCase
+end

data/test/google_analytics/client_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+class ClientTest < Test::Unit::TestCase
+  
+  context 'given an instance of Client' do
+    setup do
+      @client = GoogleAnalytics::Client.new('user', 'password')
+    end
+    
+    should 'turn a hash into a url encoded string when encode called' do
+      res = @client.send :encode, { :thing => 12, :thong => 'something with spaces' }
+      assert_match /thing\=12/, res
+      assert_match /thong\=something\%20with\%20spaces/, res
+    end
+    
+    should 'should comma seperate arrays when encode called' do
+      res = @client.send :encode, { :thong => [:blurg, :blargh] }
+      assert_match /thong\=blurg,blargh/, res
+    end
+    
+    should 'send request to correct url with username and password' do
+      @client.expects(:request).with(
+        URI.parse(GoogleAnalytics::AUTH_URL),
+        :post,
+        { 
+          :Email => 'user', :Passwd => 'password', 
+          :accountType => 'GOOGLE_OR_HOSTED', :service => 'analytics' 
+        }
+      ).returns('Auth=thing')
+      
+      @client.login!
+    end
+    
+    should 'raise not authorized if failed to log in' do
+      @client.expects(:request).with(
+        URI.parse(GoogleAnalytics::AUTH_URL),
+        :post,
+        { 
+          :Email => 'user', :Passwd => 'password', 
+          :accountType => 'GOOGLE_OR_HOSTED', :service => 'analytics' 
+        }
+      ).returns('fail')
+      
+      assert_raises GoogleAnalytics::NotAuthorized do
+        @client.login!
+      end
+    end
+    
+    should 'login if auth is not set before api_request' do
+      @client.instance_variable_set(:@auth, nil)
+      @client.expects(:login!)
+      @client.expects(:request).returns('')
+      
+      @client.api_request('/', :get, {})
+    end
+  end
+  
+end

data/test/google_analytics/report_test.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+class ReportTest < Test::Unit::TestCase
+end

data/test/google_analytics/user_test.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), '../test_helper')
+
+class UserTest < Test::Unit::TestCase
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'fakeweb'
+require 'google_analytics'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: google-analytics
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Webb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Wrapper around the Google Analytics API
+email: dan@danwebb.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README.textile
+- lib/google_analytics.rb
+- lib/google_analytics/account.rb
+- lib/google_analytics/client.rb
+- lib/google_analytics/report.rb
+- lib/google_analytics/user.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README.textile
+- Rakefile
+- google-analytics.gemspec
+- lib/google_analytics.rb
+- lib/google_analytics/account.rb
+- lib/google_analytics/client.rb
+- lib/google_analytics/report.rb
+- lib/google_analytics/user.rb
+- test.rb
+- test/google_analytics/account_test.rb
+- test/google_analytics/client_test.rb
+- test/google_analytics/report_test.rb
+- test/google_analytics/user_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Google-analytics
+- --main
+- README.textile
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: google-analytics
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapper around the Google Analytics API
+test_files: 
+- test/google_analytics/account_test.rb
+- test/google_analytics/client_test.rb
+- test/google_analytics/report_test.rb
+- test/google_analytics/user_test.rb
+- test/test_helper.rb