gapi 0.0.1

data/lib/gapi.rb

@@ -0,0 +1,2 @@
+Dir[ File.join( File.dirname( __FILE__ ),'gapi', '*.rb' ) ].each {|f| puts( f); require( f )}
+

data/lib/gapi/em_oauth_middle.rb

@@ -0,0 +1,47 @@
+# Uses simple_oauth gem and em to make requests
+# requires ruby 1.9 as it uses a Fiber to achieve async behaviour without a callback
+
+module Gapi
+  
+  class EmOauthMiddle
+
+    # connection timeout in seconds
+    CONNECT_TIMEOUT_S = 10
+
+    # inactivity timeout in seconds
+    INACTIVITY_TIMEOUT_S = 0
+
+    # these are all strings not the access token object from ruby-oauth
+    def initialize( consumer_key, consumer_secret, access_token, access_secret )
+      @oauth_opts = {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :access_token => access_token,
+        :access_token_secret => access_secret
+      }
+    end
+
+    def get( domain, path, opts )
+      data = opts.collect {|kv| kv.join('=') }.join('&')
+      path = "#{path}?#{data}" if data && data.length > 0
+      http = http_get( "https://#{domain}#{path}" )
+      return http.response_header.status, http.response
+    end
+  
+  private
+
+    def http_get( url )
+      f = Fiber.current
+      f.nil? and raise "http_get called with no current fiber"
+      conn = EM::HttpRequest.new( url, :connect_timeout => CONNECT_TIMEOUT_S, :inactivity_timeout => INACTIVITY_TIMEOUT_S )
+      conn.use( EventMachine::Middleware::OAuth, @oauth_opts )
+      http = conn.get
+      http.callback { f.resume( http ) }
+      http.errback {|r| f.resume( http ) }
+      return Fiber.yield
+    end
+
+  end
+
+end
+

data/lib/gapi/file_cache_middle.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+
+module Gapi
+
+  # wraps another middle, caches using MD5 hexdigest of path as key
+  class FileCacheMiddle
+
+    def initialize( actual_middle, cache_dir, uid )
+      @actual_middle = actual_middle
+      @cache_dir = Pathname.new( cache_dir )
+      @uid = uid
+    end
+
+    def get( domain, path, opts )
+      data = opts.collect {|kv| kv.join('=') }.join('&')
+      uri = path
+      uri = "#{path}?#{data}" if data && data.length > 0
+      cache_fname = cache_filename_for_uri( uri )
+      code = 500
+      body = ""
+      if File.exists?( cache_fname )
+        File.open( cache_fname, 'rb' ) do |f|
+          body = f.read
+          code = 200
+        end
+      else
+        code, body = @actual_middle.get( domain, path, opts )
+        if 200 == code
+          File.open( cache_fname, 'wb' ) do |f|
+            f.write( body )
+          end
+        end
+      end
+      return code, body
+    end
+
+  private
+
+    # TODO consider how we'll clear down cache? Could perhaps just
+    # delete files created before today
+    def cache_filename_for_uri( path )
+      uid = Digest::MD5.hexdigest( "#{@uid}:#{path}" )
+      # NOTE: this path needs to exist with r/w permissions for webserver
+      @cache_dir.join( uid )
+    end
+  
+  end
+
+end
+

data/lib/gapi/fixture_middle.rb

@@ -0,0 +1,18 @@
+module Gapi
+
+  class FixtureMiddle
+
+    def initialize( filename )
+      File.open( filename, 'rb' ) do |f|
+        @data = f.read
+      end
+    end
+
+    def get( domain, path, opts )
+      return 200, @data 
+    end
+
+  end
+
+end
+

data/lib/gapi/login_middle.rb

@@ -0,0 +1,52 @@
+module Gapi
+  
+  class LoginMiddle
+
+    def initialize( email, password, source="gapi-v1" )
+      @auth_token = login( email, password, "source=#{source}" )
+    end
+
+   def get( domain, path, opts )
+      http = Net::HTTP.new( domain, 443 )
+      http.use_ssl = true
+      data = opts.collect {|kv| kv.join('=') }.join('&')
+      path = "#{path}?#{data}" if data && data.length > 0
+      resp, data = http.get( path, auth_headers )
+      code = resp.code.to_i
+      body = resp.body
+      return code, body
+    end
+
+  private
+    
+    def login( email, password, source )
+      params = {"Email" => email, "Passwd" => password, "accountType" => "GOOGLE", "source" => source, "service" => "analytics"}
+      code, body = post( "www.google.com", "/accounts/ClientLogin", params );
+      if code == 200
+        body.split( "\n" ).each do |line|
+          if line.match( /^Auth/ )
+            return line
+          end
+        end
+      else
+        nil
+      end
+    end
+
+    def auth_header
+      {"Authorization" => "AuthSub token=#{@auth_token}"}
+    end
+
+    def post( domain, path, opts )
+      http = Net::HTTP.new( domain, 443 )
+      http.use_ssl = true
+      data = opts.collect {|kv| kv.join('=') }.join('&')
+      headers = {'Content-Type' => 'application/x-www-form-urlencoded'}.merge( auth_headers )
+      resp, data = http.post( path, data, headers )
+      code = resp.code.to_i
+      return code, resp.body
+    end
+ 
+  end
+
+end

data/lib/gapi/oauth_middle.rb

@@ -0,0 +1,21 @@
+module Gapi
+  
+  class OauthMiddle
+    
+    # the ruby-oauth gem access_token
+    def initialize( access_token )
+      @access_token = access_token
+    end
+
+    def get( domain, path, opts )
+      data = opts.collect {|kv| kv.join('=') }.join('&')
+      path = "#{path}?#{data}" if data && data.length > 0
+      resp, data = @access_token.get( path, {} )
+      code = resp.code.to_i
+      body = resp.body
+      return code, body
+    end
+
+  end
+
+end

data/lib/gapi/service.rb

@@ -0,0 +1,108 @@
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'nokogiri'
+require 'ostruct'
+require 'cgi'
+
+module Gapi
+
+  class Service
+    
+    # middle is used to fetch using net:http, oauth, em etc
+    def initialize( middle )
+      @profile_id = nil
+      @middle = middle
+    end
+   
+    # dimensions and metrics are arrays e.g. ['ga:date', 'ga:sources'] - see Google Analytics Data Export API
+    # filters and sort follow Google Analytics Data Export API documentation e.g. to sort most recent date first: -ga:date
+    # Must be called from a fiber if EmOauthMiddle used
+    def fetch( start_date, end_date, dimensions, metrics, filters=nil, max_results=nil, sort=nil )
+      opts = query_opts( start_date, end_date, dimensions, metrics, filters, max_results, sort )
+      code, body = @middle.get( "www.google.com", "/analytics/feeds/data", opts )
+      if code == 200
+        return code, parse( body )
+      else
+        return code, nil
+      end
+    end
+
+    # Must be called from a fiber if EmOauthMiddle used
+    def accounts
+      code, body = @middle.get( "www.google.com", "/analytics/feeds/accounts/default", {:date => Time.now.strftime("%Y-%m-%d")} )
+      if code == 200
+        return code, parse_accounts( body )
+      else
+        return code, nil
+      end
+    end
+    
+    def use_account_with_table_id( table_id )
+      @profile_id = table_id.split(':').last
+    end
+    
+    def use_account_with_title( title )
+      code, accs = accounts
+      account = accs.find {|acc| acc.title == title}
+      if account
+        @profile_id = use_account_with_table_id( account.table_id )
+      else
+        nil
+      end
+    end
+
+    def self.to_underlined( str )
+      str.gsub( /[a-z]([A-Z])/ ) {|m| m.insert( 1, "_" )}.downcase
+    end
+    
+  private
+
+    def parse( body )
+      doc = Nokogiri::XML(body)
+      results = (doc/:entry).collect do |entry|
+        hash = {}        
+        # as (entry/'dxp:metric') with namespace doesn't work, instead iterate over all sub-elements   
+        (entry/'*').each do |element|
+          if element.name == "dimension" or element.name == "metric"
+            name = Gapi::Service.to_underlined( element[:name].sub(/^ga\:/,'') )
+            hash[name] = element[:value]
+          end
+        end
+        OpenStruct.new(hash)
+      end
+      results
+    end
+
+    def parse_accounts( body )
+      doc = Nokogiri::XML(body)
+      results = (doc/:entry).collect do |entry|
+        hash = {}        
+        # as (entry/'dxp:metric') with namespace doesn't work, instead iterate over all sub-elements   
+        (entry/'*').each do |element|
+          if element.name == "title"
+            hash['title'] = element.content
+          elsif element.name == "tableId"
+            hash['table_id'] = element.content
+          end
+        end
+        OpenStruct.new(hash)
+      end
+    end
+
+    def query_opts( start_date, end_date, dimensions, metrics, filters=nil, max_results=nil, sort=nil )
+      opts = {'ids' => "ga:#{@profile_id}",
+              'start-date' => start_date,
+              'end-date' => end_date,
+              'dimensions' => dimensions.join(','),
+              'metrics' => metrics.join(',')}
+      opts['max-results'] = max_results if max_results
+      opts['filters'] = filters unless filters.nil?
+      opts['sort'] = sort unless sort.nil?
+      opts
+    end
+   
+  end
+
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gapi
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Grayson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Google Analytics Data Export API wrapper which supports rack style middleware for e.g. testing, caching, oauth requests, event-machine based http etc
+email: paul.grayson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ./lib/gapi/em_oauth_middle.rb
+- ./lib/gapi/file_cache_middle.rb
+- ./lib/gapi/fixture_middle.rb
+- ./lib/gapi/login_middle.rb
+- ./lib/gapi/oauth_middle.rb
+- ./lib/gapi/service.rb
+- ./lib/gapi.rb
+has_rdoc: true
+homepage: http://github.com/paulgrayson/GAPI
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: GAPI
+test_files: []
+