cannikin-gattica 0.1.4

data/History.txt

@@ -0,0 +1,14 @@
+== 0.1.4 / 2009-04-22
+  * Another attempt at getting the gem to build on github
+
+== 0.1.3 / 2009-04-22
+  * Getting gem to build on github
+
+== 0.1.2 / 2009-04-22
+  * Updated readme and examples, better documentation throughout
+
+== 0.1.1 / 2009-04-22
+  * When outputting as CSV, surround each piece of data with double quotes (appears pretty common for various properties (like Browser name) to contain commas
+
+== 0.1.0 / 2009-03-26
+  * Basic functionality working good. Can't use filters yet.

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+ 
+Copyright (c) 2009 Rob Cameron
+ 
+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,137 @@
+Gattica is a Ruby library for talking to the Google Analytics API.
+
+= Installation
+Install the gattica gem using github as the source:
+
+  gem install cannikin-gattica -s http://gems.github.com
+
+When you want to require, you just use 'gattica' as the gem name:
+
+  require 'rubygems'
+  require 'gattica'
+
+= Introduction
+There are generally three steps to getting info from the GA API:
+
+1. Authenticate
+2. Get a profile id
+3. Get the data you really want
+
+It's a good idea to familiarize yourself with the Google API docs:
+
+  http://code.google.com/apis/analytics/docs/gdata/gdataDeveloperGuide.html
+  
+In particular there are some very specific combinations of Metrics and Dimensions that
+you are restricted to and those are explained in this document:
+
+  http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html
+
+= Usage
+This library does all three. A typical transaction will look like this:
+
+ gs = Gattica.new('johndoe@google.com','password',123456)
+ results = gs.get({ :start_date => '2008-01-01', 
+                    :end_date => '2008-02-01', 
+                    :dimensions => 'browser', 
+                    :metrics => 'pageviews', 
+                    :sort => '-pageviews'})
+
+So we instantiate a copy of Gattica and pass it a Google Account email address and password.
+The third parameter is the profile_id that we want to access data for.
+
+Then we call +get+ with the parameters we want to shape our data with. In this case we want
+total page views, broken down by browser, from Jan 1 2008 to Feb 1 2008, sorted by descending
+page views.
+
+If you don't know the profile_id you want to get data for, call +accounts+
+
+ gs = Gattica.new('johndoe@google.com','password')
+ accounts = gs.accounts
+
+This returns all of the accounts and profiles that the user has access to. Note that if you
+use this method to get profiles, you need to manually set the profile before you can call +get+
+
+ gs.profile_id = 123456
+ results = gs.get({ :start_date => '2008-01-01', 
+                    :end_date => '2008-02-01', 
+                    :dimensions => 'browser', 
+                    :metrics => 'pageviews', 
+                    :sort => '-pageviews'})
+                    
+When you put in the names for the dimensions and metrics you want, refer to this doc for the 
+available names:
+
+  http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html
+  
+Note that you do *not* use the 'ga:' prefix when you tell Gattica which ones you want. Gattica
+adds that for you automatically.
+
+If you want to search on more than one dimension or metric, pass them in as an array (you can
+also pass in single values as arrays too, if you wish):
+                    
+  results = gs.get({ :start_date => '2008-01-01', 
+                     :end_date => '2008-02-01', 
+                     :dimensions => ['browser','browserVersion'], 
+                     :metrics => ['pageviews','visits'], 
+                     :sort => ['-pageviews']})
+                      
+= Output
+When Gattica was originally created it was intended to take the data returned and put it into
+Excel for someone else to crunch through the numbers. Thus, Gattica has great built-in support
+for CSV output. Once you have your data simply:
+
+  results.to_csv
+  
+A couple example rows of what that looks like:
+
+  "id","updated","title","browser","pageviews"
+  "http://www.google.com/analytics/feeds/data?ids=ga:12345&ga:browser=Internet%20Explorer&start-date=2009-01-01&end-date=2009-01-31","2009-01-30T16:00:00-08:00","ga:browser=Internet Explorer","Internet Explorer","53303"
+  "http://www.google.com/analytics/feeds/data?ids=ga:12345&ga:browser=Firefox&start-date=2009-01-01&end-date=2009-01-31","2009-01-30T16:00:00-08:00","ga:browser=Firefox","Firefox","20323"
+  
+Data is comma-separated and double-quote delimited. In most cases, people don't care
+about the id, updated, or title attributes of this data. They just want the dimensions and
+metrics. In that case, pass the symbol +:short+ to +to_csv+ and receive get back only the
+the good stuff:
+
+  results.to_csv(:short)
+  
+Which returns: 
+
+  "browser","pageviews"
+  "Internet Explorer","53303"
+  "Firefox","20323"
+
+You can also just output the results as a string and you'll get the standard inspect syntax:
+
+  results.to_s
+  
+Gives you:
+
+  { "end_date"=>#<Date: 4909725/2,0,2299161>, 
+    "start_date"=>#<Date: 4909665/2,0,2299161>, 
+    "points"=>[
+      { "title"=>"ga:browser=Internet Explorer", 
+        "dimensions"=>[{:browser=>"Internet Explorer"}],
+        "id"=>"http://www.google.com/analytics/feeds/data?ids=ga:12345&amp;ga:browser=Internet%20Explorer&amp;start-date=2009-01-01&amp;end-date=2009-01-31", 
+        "metrics"=>[{:pageviews=>53303}], 
+        "updated"=>#<DateTime: 212100120000001/86400000,-1/3,2299161>}]}
+        
+= Limitations
+The GA API limits each call to 1000 results per "page." If you want more, you need to tell
+the API what number to begin at and it will return the next 1000. Gattica does not currently
+support this, but it's in the plan for the very next version.
+
+The GA API support filtering, so you can say things like "only show me the pageviews for pages
+whose URL meets the regular expression ^/saf.*?/$". Gattica can pass in filters, but you'll need
+to know how to format them correctly (refer to the GA API), it won't let you do any kind of pretty
+syntax and convert it for you. I plan to add this soon.
+
+= The Future
+A couple of things I have planned:
+
+1. Tests!
+2. The option to use a custom delimiter for output
+3. Automatically handle paging (the API only returns 1000 results at a time). Gattica will request
+   one result set, see how many pages there are, then do several calls until all pages are retrieved
+   or it hits the limit of the number of results you want and return all that data as one big block.
+4. Create a nice syntax for filters

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 4

data/examples/example.rb

@@ -0,0 +1,23 @@
+require '../lib/gattica'
+
+# authenticate with the API
+ga = Gattica.new('username@gmail.com','password')
+
+# get the list of accounts you have access to with that username and password
+accounts = ga.accounts
+
+# for this example we just use the first account's profile_id, but you'll probably want to look
+# at this list and choose the profile_id of the account you want (the web_property_id is the
+# property you're most used to seeing in GA, looks like UA123456-1)
+ga.profile_id = accounts.first.profile_id
+
+# now get the number of page views by browser for Janurary 2009
+# note that as of right now, Gattica does not support filtering
+data = ga.get({ :start_date => '2009-01-01', 
+                :end_date => '2009-01-31',
+                :dimensions => ['browser'],
+                :metrics => ['pageviews'],
+                :sort => ['-pageviews'] })
+
+# write the data out as CSV
+puts data.to_csv

data/lib/gattica.rb

@@ -0,0 +1,236 @@
+$:.unshift File.dirname(__FILE__) # for use/testing when no gem is installed
+
+# external
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'logger'
+require 'rubygems'
+require 'hpricot'
+
+# internal
+require 'gattica/core_extensions'
+require 'gattica/convertible'
+require 'gattica/exceptions'
+require 'gattica/user'
+require 'gattica/auth'
+require 'gattica/account'
+require 'gattica/data_set'
+require 'gattica/data_point'
+
+# Gattica is a Ruby library for talking to the Google Analytics API.
+#
+# = Introduction
+# There are generally three steps to getting info from the GA API:
+# 
+# 1. Authenticate
+# 2. Get a profile id
+# 3. Get the data you really want
+# 
+# = Usage
+# This library does all three. A typical transaction will look like this:
+# 
+#  gs = Gattica.new('johndoe@google.com','password',123456)
+#  results = gs.get({ :start_date => '2008-01-01', 
+#                     :end_date => '2008-02-01', 
+#                     :dimensions => 'browser', 
+#                     :metrics => 'pageviews', 
+#                     :sort => 'pageviews'})
+# 
+# So we instantiate a copy of Gattica and pass it a Google Account email address and password.
+# The third parameter is the profile_id that we want to access data for. (If you don't know what
+# your profile_id is [and you probably don't since GA doesn't tell you except through this API]
+# then check out Gattica::Engine#accounts).
+# 
+# Then we call +get+ with the parameters we want to shape our data with. In this case we want
+# total page views, broken down by browser, from Jan 1 2008 to Feb 1 2008, sorted by page views.
+# 
+# If you don't know the profile_id you want to get data for, call +accounts+
+# 
+#  gs = Gattica.new('johndoe@google.com','password')
+#  accounts = gs.accounts
+# 
+# This returns all of the accounts and profiles that the user has access to. Note that if you
+# use this method to get profiles, you need to manually set the profile before you can call +get+
+# 
+#  gs.profile_id = 123456
+#  results = gs.get({ :start_date => '2008-01-01', 
+#                     :end_date => '2008-02-01', 
+#                     :dimensions => 'browser', 
+#                     :metrics => 'pageviews', 
+#                     :sort => 'pageviews'})
+
+
+module Gattica
+  
+  VERSION = '0.1.4'
+  LOGGER = Logger.new(STDOUT)
+
+  def self.new(*args)
+    Engine.new(*args)
+  end
+  
+  # The real meat of Gattica, deals with talking to GA, returning and parsing results.
+  
+  class Engine
+    
+    SERVER = 'www.google.com'
+    PORT = 443
+    SECURE = true
+    DEFAULT_ARGS = { :start_date => nil, :end_date => nil, :dimensions => [], :metrics => [], :filters => [], :sort => [] }
+    
+    attr_reader :user, :token
+    attr_accessor :profile_id
+    
+    # Create a user, and get them authorized.
+    # If you're making a web app you're going to want to save the token that's returned by this
+    # method so that you can use it later (without having to re-authenticate the user each time)
+    #
+    #   ga = Gattica.new('johndoe@google.com','password',123456)
+    #   ga.token => 'DW9N00wenl23R0...' (really long string)
+    
+    def initialize(email,password,profile_id=0,debug=false)
+      LOGGER.datetime_format = '' if LOGGER.respond_to? 'datetime_format'
+      
+      @profile_id = profile_id
+      @user_accounts = nil
+      
+      # save an http connection for everyone to use
+      @http = Net::HTTP.new(SERVER, PORT)
+      @http.use_ssl = SECURE
+      @http.set_debug_output $stdout if debug
+      
+      # create a user and authenticate them
+      @user = User.new(email, password)
+      @auth = Auth.new(@http, user, { :source => 'active-gattica-0.1' }, { 'User-Agent' => 'ruby 1.8.6 (2008-03-03 patchlevel 114) [universal-darwin9.0] Net::HTTP' })
+      @token = @auth.tokens[:auth]
+      @headers = { 'Authorization' => "GoogleLogin auth=#{@token}" }
+      
+      # TODO: check that the user has access to the specified profile and show an error here rather than wait for Google to respond with a message
+    end
+    
+    
+    # Returns the list of accounts the user has access to. A user may have multiple accounts on Google Analytics
+    # and each account may have multiple profiles. You need the profile_id in order to get info from GA. If you
+    # don't know the profile_id then use this method to get a list of all them. Then set the profile_id of your
+    # instance and you can make regular calls from then on.
+    #
+    #   ga = Gattica.new('johndoe@google.com','password')
+    #   ga.get_accounts
+    #   # you parse through the accounts to find the profile_id you need
+    #   ga.profile_id = 12345678
+    #   # now you can perform a regular search, see Gattica::Engine#get
+    #
+    # If you pass in a profile id when you instantiate Gattica::Search then you won't need to
+    # get the accounts and find a profile_id - you apparently already know it!
+    #
+    # See Gattica::Engine#get to see how to get some data.
+    
+    def accounts
+      # if we haven't retrieved the user's accounts yet, get them now and save them
+      if @accts.nil?
+        response, data = @http.get('/analytics/feeds/accounts/default', @headers)
+        xml = Hpricot(data)
+        @user_accounts = xml.search(:entry).collect { |entry| Account.new(entry) }
+      end
+      return @user_accounts
+    end
+    
+    
+    # This is the method that performs the actual request to get data.
+    #
+    # == Usage
+    #
+    #   gs = Gattica.new('johndoe@google.com','password',123456)
+    #   gs.get({ :start_date => '2008-01-01', 
+    #            :end_date => '2008-02-01', 
+    #            :dimensions => 'browser', 
+    #            :metrics => 'pageviews', 
+    #            :sort => 'pageviews'})
+    #
+    # == Input
+    #
+    # When calling +get+ you'll pass in a hash of options. For a description of what these mean to 
+    # Google Analytics, see http://code.google.com/apis/analytics/docs
+    #
+    # Required values are:
+    #
+    # * +start_date+ => Beginning of the date range to search within
+    # * +end_date+ => End of the date range to search within
+    #
+    # Optional values are:
+    #
+    # * +dimensions+ => an array of GA dimensions (without the ga: prefix)
+    # * +metrics+ => an array of GA metrics (without the ga: prefix)
+    # * +filter+ => an array of GA dimensions/metrics you want to filter by (without the ga: prefix)
+    # * +sort+ => an array of GA dimensions/metrics you want to sort by (without the ga: prefix)
+    #
+    # == Exceptions
+    #
+    # If a user doesn't have access to the +profile_id+ you specified, you'll receive an error.
+    # Likewise, if you attempt to access a dimension or metric that doesn't exist, you'll get an
+    # error back from Google Analytics telling you so.
+    
+    def get(args={})
+      args = validate_and_clean(DEFAULT_ARGS.merge(args))
+      query_string = build_query_string(args,@profile_id)
+        LOGGER.debug(query_string)
+      response, data = @http.get("/analytics/feeds/data?#{query_string}", @headers)
+      begin
+        response.value
+      rescue Net::HTTPServerException => e
+        raise GatticaError::AnalyticsError, data.to_s + " (status code: #{e.message})"
+      end
+      return DataSet.new(Hpricot.XML(data))
+    end
+    
+    
+    private
+    # Creates a valid query string for GA
+    def build_query_string(args,profile)
+      output = "ids=ga:#{profile}&start-date=#{args[:start_date]}&end-date=#{args[:end_date]}"
+      unless args[:dimensions].empty?
+        output += '&dimensions=' + args[:dimensions].collect do |dimension|
+          "ga:#{dimension}"
+        end.join(',')
+      end
+      unless args[:metrics].empty?
+        output += '&metrics=' + args[:metrics].collect do |metric|
+          "ga:#{metric}"
+        end.join(',')
+      end
+      unless args[:sort].empty?
+        output += '&sort=' + args[:sort].collect do |sort|
+          sort[0..0] == '-' ? "-ga:#{sort[1..-1]}" : "ga:#{sort}"  # if the first character is a dash, move it before the ga:
+        end.join(',')
+      end
+      unless args[:filters].empty?    # filters are a little more complicated because they can have all kinds of modifiers
+        
+      end
+      return output
+    end
+    
+    
+    # Validates that the args passed to +get+ are valid
+    def validate_and_clean(args)
+      
+      raise GatticaError::MissingStartDate, ':start_date is required' if args[:start_date].nil? || args[:start_date].empty?
+      raise GatticaError::MissingEndDate, ':end_date is required' if args[:end_date].nil? || args[:end_date].empty?
+      raise GatticaError::TooManyDimensions, 'You can only have a maximum of 7 dimensions' if args[:dimensions] && (args[:dimensions].is_a?(Array) && args[:dimensions].length > 7)
+      raise GatticaError::TooManyMetrics, 'You can only have a maximum of 10 metrics' if args[:metrics] && (args[:metrics].is_a?(Array) && args[:metrics].length > 10)
+      
+      # make sure that the user is only trying to sort fields that they've previously included with dimensions and metrics
+      if args[:sort]
+        possible = args[:dimensions] + args[:metrics]
+        missing = args[:sort].find_all do |arg|
+          !possible.include? arg.gsub(/^-/,'')    # remove possible minuses from any sort params
+        end
+        raise GatticaError::InvalidSort, "You are trying to sort by fields that are not in the available dimensions or metrics: #{missing.join(', ')}" unless missing.empty?
+      end
+      
+      return args
+    end
+    
+    
+  end
+end

data/lib/gattica/account.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'hpricot'
+
+module Gattica
+  
+  # Represents an account that an authenticated user has access to
+  
+  class Account
+    
+    include Convertible
+    
+    attr_reader :id, :updated, :title, :table_id, :account_id, :account_name, :profile_id, :web_property_id
+  
+    def initialize(xml)
+      @id = xml.at(:id).inner_html
+      @updated = DateTime.parse(xml.at(:updated).inner_html)
+      @title = xml.at(:title).inner_html
+      @table_id = xml.at('dxp:tableid').inner_html
+      @account_id = xml.at("dxp:property[@name='ga:accountId']").attributes['value'].to_i
+      @account_name = xml.at("dxp:property[@name='ga:accountName']").attributes['value']
+      @profile_id = xml.at("dxp:property[@name='ga:profileId']").attributes['value'].to_i
+      @web_property_id = xml.at("dxp:property[@name='ga:webPropertyId']").attributes['value']
+    end
+    
+  end
+end

data/lib/gattica/auth.rb

@@ -0,0 +1,39 @@
+require 'net/http'
+require 'net/https'
+
+module Gattica
+  
+  # Authenticates a user against the Google Client Login system
+  
+  class Auth
+    
+    include Convertible
+
+    SCRIPT_NAME = '/accounts/ClientLogin'
+    HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+    OPTIONS = { :source => '', :service => 'analytics' }
+  
+    attr_reader :response, :data, :tokens, :token
+  
+    # Prepare the user info along with options and header
+    def initialize(http, user, options={}, headers={})
+      data = OPTIONS.merge(options)
+      data = data.merge(user.to_h)
+      headers = HEADERS.merge(headers)
+    
+      @response, @data = http.post(SCRIPT_NAME, data.to_query, headers)
+      @tokens = parse_tokens(@data)
+    end
+  
+    private
+    # Parse the authentication tokens out of the response
+    def parse_tokens(data)
+      tokens = {}
+      data.split("\n").each do |t|
+        tokens.merge!({ t.split('=').first.downcase.to_sym => t.split('=').last })
+      end
+      return tokens
+    end
+  
+  end
+end

data/lib/gattica/convertible.rb

@@ -0,0 +1,28 @@
+module Gattica
+  
+  # Common output methods that are sharable
+  
+  module Convertible
+    
+    # output as hash
+    def to_h
+      output = {}
+      instance_variables.each do |var|
+        output.merge!({ var[1..-1] => instance_variable_get(var) }) unless var == '@xml'    # exclude the whole XML dump
+      end
+      output
+    end
+    
+    # output nice inspect syntax
+    def to_s
+      to_h.inspect
+    end
+    
+    alias inspect to_s
+    
+    def to_query
+      to_h.to_query
+    end
+    
+  end
+end

data/lib/gattica/core_extensions.rb

@@ -0,0 +1,18 @@
+class Hash
+  
+  def to_query
+    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+    self.collect do |key, value|
+      "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+    end.sort * '&'
+  end
+  
+  def key
+    self.keys.first if self.length == 1
+  end
+
+  def value
+    self.values.first if self.length == 1
+  end
+
+end

data/lib/gattica/data_point.rb

@@ -0,0 +1,52 @@
+module Gattica
+  
+  # Represents a single "row" of data containing any number of dimensions, metrics
+  
+  class DataPoint
+    
+    include Convertible
+    
+    attr_reader :id, :updated, :title, :dimensions, :metrics, :xml
+    
+    # Parses the XML <entry> element
+    def initialize(xml)
+      @xml = xml.to_s
+      @id = xml.at('id').inner_html
+      @updated = DateTime.parse(xml.at('updated').inner_html)
+      @title = xml.at('title').inner_html
+      @dimensions = xml.search('dxp:dimension').collect do |dimension|
+        { dimension.attributes['name'].split(':').last.to_sym => dimension.attributes['value'].split(':').last }
+      end
+      @metrics = xml.search('dxp:metric').collect do |metric|
+        { metric.attributes['name'].split(':').last.to_sym => metric.attributes['value'].split(':').last.to_i }
+      end
+    end
+    
+    
+    # Outputs in Comma Seperated Values format
+    def to_csv(format = :long)
+      output = ''
+      
+      # only output
+      case format
+      when :long
+        output = "\"#{@id}\",\"#{@updated.to_s}\",\"#{@title}\","
+      end
+      
+      # output all dimensions
+      output += @dimensions.collect do |dimension|
+        "\"#{dimension.value}\""
+      end.join(',')
+      output += ','
+      
+      # output all metrics
+      output += @metrics.collect do |metric|
+        "\"#{metric.value}\""
+      end.join(',')
+      
+      return output
+    end
+    
+  end
+  
+end

data/lib/gattica/data_set.rb

@@ -0,0 +1,54 @@
+module Gattica
+  
+  # Encapsulates the data returned by the GA API
+  
+  class DataSet
+    
+    include Convertible
+    
+    attr_reader :total_results, :start_index, :items_per_page, :start_date, :end_date, :points, :xml
+      
+    def initialize(xml)
+      @xml = xml.to_s
+      @total_results = xml.at('openSearch:totalResults').inner_html.to_i
+      @start_index = xml.at('openSearch:startIndex').inner_html.to_i
+      @items_per_page = xml.at('openSearch:itemsPerPage').inner_html.to_i
+      @start_date = Date.parse(xml.at('dxp:startDate').inner_html)
+      @end_date = Date.parse(xml.at('dxp:endDate').inner_html)
+      @points = xml.search(:entry).collect { |entry| DataPoint.new(entry) }
+    end
+    
+    
+    # output important data to CSV, ignoring all the specific data about this dataset 
+    # (total_results, start_date) and just output the data from the points
+    
+    def to_csv(format = :long)
+      # build the headers
+      output = ''
+      
+      # only show the nitty gritty details of id, updated_at and title if requested
+      case format
+      when :long
+        output = '"id","updated","title",'
+      end
+      
+      output += @points.first.dimensions.collect do |dimension|
+        "\"#{dimension.key.to_s}\""
+      end.join(',')
+      output += ','
+      output += @points.first.metrics.collect do |metric|
+        "\"#{metric.key.to_s}\""
+      end.join(',') 
+      output += "\n"
+      
+      # get the data from each point
+      @points.each do |point|
+        output += point.to_csv(format) + "\n"
+      end
+      
+      return output
+    end
+    
+  end
+  
+end

data/lib/gattica/exceptions.rb

@@ -0,0 +1,18 @@
+module GatticaError
+  # user errors
+  class InvalidEmail < StandardError; end;
+  class InvalidPassword < StandardError; end;
+  # authentication errors
+  class CouldNotAuthenticate < StandardError; end;
+  # profile errors
+  class InvalidProfileId < StandardError; end;
+  # search errors
+  class TooManyDimensions < StandardError; end;
+  class TooManyMetrics < StandardError; end;
+  class InvalidSort < StandardError; end;
+  class InvalidFilter < StandardError; end;
+  class MissingStartDate < StandardError; end;
+  class MissingEndDate < StandardError; end;
+  # errors from Analytics
+  class AnalyticsError < StandardError; end;
+end

data/lib/gattica/user.rb

@@ -0,0 +1,32 @@
+module Gattica
+  
+  # Represents a user to be authenticated by GA
+  
+  class User
+  
+    include Convertible
+  
+    SERVICE = 'analytics'
+    attr_accessor :email, :password
+  
+    def initialize(email,password,source='')
+      @email = email
+      @password = password
+      validate
+    end
+    
+    # User gets a special +to_h+ because Google expects +Email+ and +Passwd+ instead of our nicer internal names
+    def to_h
+      { :Email => @email,
+        :Passwd => @password }
+    end
+    
+    private
+    # Determine whether or not this is a valid user
+    def validate
+      raise GatticaError::InvalidEmail, "The email address '#{@email}' is not valid" if not @email.match(/^(?:[_a-z0-9-]+)(\.[_a-z0-9-]+)*@([a-z0-9-]+)(\.[a-zA-Z0-9\-\.]+)*(\.[a-z]{2,4})$/i)
+      raise GatticaError::InvalidPassword, "The password cannot be blank" if @password.empty? || @password.nil?
+    end
+  
+  end
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib gattica])
+ 
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+ 
+include Gattica
+ 
+def fixture(name)
+  File.read(File.join(File.dirname(__FILE__), 'fixtures', name))
+end
+ 
+def absolute_project_path
+  File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end

data/test/suite.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+ 
+tests = Dir["#{File.dirname(__FILE__)}/test_*.rb"]
+tests.each do |file|
+  require file
+end

data/test/test_sample.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/helper'
+ 
+class TestActor < Test::Unit::TestCase
+  def setup
+    
+  end
+  
+  # from_string
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: cannikin-gattica
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Rob Cameron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+description: Gattica is a Ruby library for extracting data from the Google Analytics API.
+email: cannikinn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.rdoc
+- LICENSE
+- VERSION.yml
+- examples/example.rb
+- lib/gattica
+- lib/gattica.rb
+- lib/gattica/account.rb
+- lib/gattica/auth.rb
+- lib/gattica/convertible.rb
+- lib/gattica/core_extensions.rb
+- lib/gattica/data_point.rb
+- lib/gattica/data_set.rb
+- lib/gattica/exceptions.rb
+- lib/gattica/user.rb
+- test/helper.rb
+- test/suite.rb
+- test/test_sample.rb
+has_rdoc: true
+homepage: http://github.com/cannikin/gattica
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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: 
+- A Google Analytics Account
+- One or more Profiles that are being tracked in your GA account
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Gattica is a Ruby library for extracting data from the Google Analytics API.
+test_files: []
+