betapond-gattica 0.5.1

data/lib/gattica/exceptions.rb

@@ -0,0 +1,21 @@
+module GatticaError
+  # user errors
+  class InvalidEmail < StandardError; end;
+  class InvalidPassword < StandardError; end;
+  # authentication errors
+  class CouldNotAuthenticate < StandardError; end;
+  class NoLoginOrToken < StandardError; end;
+  class InvalidToken < 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;
+  class UnknownAnalyticsError < StandardError; end;
+end

data/lib/gattica/hash_extensions.rb

@@ -0,0 +1,20 @@
+module Gattica
+  module HashExtensions
+
+    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
+end

data/lib/gattica/segment.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'hpricot'
+
+module Gattica
+  class Segment
+    include Convertible
+    
+    attr_reader :id, :name, :definition
+  
+    def initialize(xml)
+      @id = xml.attributes['id']
+      @name = xml.attributes['name']
+      @definition = xml.at("dxp:definition").inner_html
+    end
+    
+  end
+end

data/lib/gattica/settings.rb

@@ -0,0 +1,51 @@
+module Gattica
+  module Settings
+
+    # Google server to connect to
+    #
+    # You may need to change this if you use a proxy server.  However, I have not
+    # tested using a proxy.... YMMV
+    SERVER = 'www.google.com'
+
+    # Use a secure connection?
+    #
+    # If set to true, Gattica will use SSL_PORT or else it will use NON_SSL_PORT.
+    #
+    # === Example:
+    # +USE_SSL = true+::  # Always use a secure connection
+    USE_SSL = true
+    SSL_PORT = 443
+    NON_SSL_PORT = 80
+
+    # Net::HTTP timeout in seconds
+    #
+    # Increase the timeout setting if you have over 100 profiles.
+    #
+    # === Example:
+    # +TIMEOUT = 300+::   # Increase timeout to 5 minutes.
+    TIMEOUT = 100
+
+    DEFAULT_ARGS = {
+        :start_date => nil,
+        :end_date => nil,
+        :dimensions => [],
+        :metrics => [],
+        :filters => [],
+        :sort => []
+    }
+
+    DEFAULT_OPTIONS = {
+        :email => nil,        # eg: 'email@gmail.com'
+        :password => nil,     # eg: '$up3r_$ekret'
+        :token => nil,
+        :profile_id => nil,
+        :debug => false,
+        :headers => {},
+        :logger => Logger.new(STDOUT)
+    }
+
+    FILTER_METRIC_OPERATORS = %w{ == != > < >= <= }
+    FILTER_DIMENSION_OPERATORS = %w{ == != =~ !~ =@ ~@ }
+    
+  end
+end

data/lib/gattica/user.rb

@@ -0,0 +1,31 @@
+module Gattica
+  
+  # Represents a user to be authenticated by GA
+  
+  class User
+  
+    include Convertible
+  
+    attr_accessor :email, :password
+  
+    def initialize(email,password)
+      @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,14 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib gattica])
+
+require 'rubygems'
+require 'test/unit'
+ 
+# 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/settings.rb

@@ -0,0 +1,28 @@
+module GatticaTest
+  
+  DEFAULT_AUTH = {
+      :email => 'name@email.com',
+      :password => 'password',
+      :debug => true
+  }
+  DEFAULT_QUERY = {
+      :start_date => '2010-01-01',
+      :end_date => '2011-01-01',
+      :dimensions => ['date'],
+      :metrics => ['visits']
+  }
+  PROFILE_ID = 23987717
+
+  def self.ga(options={}, profile_id=PROFILE_ID)
+    unless defined? @ga
+      @ga = Gattica.new(DEFAULT_AUTH)
+      @ga.profile_id = profile_id
+    end
+    @ga
+  end
+
+  def self.get(options={}, profile_id=PROFILE_ID)
+    ga.get(DEFAULT_QUERY.merge(options))
+  end
+  
+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_engine.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../helper', __FILE__)
+require File.expand_path('../settings', __FILE__)
+
+class TestEngine < Test::Unit::TestCase
+
+  def test_login_with_good_password
+    assert Gattica.new(GatticaTest::DEFAULT_AUTH),
+           "should have been able to login"
+  end
+
+  def test_login_with_bad_user_password
+    assert_raise GatticaError::CouldNotAuthenticate do
+      Gattica.new({ :email => 'bad-email@gmail.com',
+                    :password => 'bad-password' })
+    end
+  end
+
+  def test_accounts
+    ga = Gattica.new(GatticaTest::DEFAULT_AUTH)
+    accounts = ga.accounts
+    assert accounts.count > 900, "should have gotten at least 900 accounts"
+  end
+
+#  def test_timeout_too_short
+#    ga = Gattica.new(GatticaTest::DEFAULT_AUTH.merge!(:timeout => 0))
+#    assert_raise Timeout::Error do
+#      ga.accounts
+#    end
+#  end
+
+  def test_setting_timeout
+    ga = Gattica.new((GatticaTest::DEFAULT_AUTH).merge!(:timeout => 300))
+    http = ga.instance_variable_get('@http')
+    assert http.read_timeout == 300, "http timeout should be 300"
+  end
+
+#  def test_raise_error_when_no_user_pass_or_token_specified
+#    assert_raise GatticaError::NoLoginOrToken do
+#      Gattica.new
+#    end
+#  end
+#
+#  def test_use_an_existing_token
+#    token = Gattica.new(@auth).token
+#    assert Gattica.new({ :token => token })
+#  end
+
+end

data/test/test_results.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../helper', __FILE__)
+require File.expand_path('../settings', __FILE__)
+
+class TestResults < Test::Unit::TestCase
+
+  def setup
+    @response = GatticaTest::get({ :start_index => 5, :max_results => 5 })
+  end
+
+  def test_max_results
+    assert @response.points.count == 5, "should only return 5 results"
+  end
+
+  def test_start_index
+    assert @response.points.first.title == "ga:date=20100105", "should start on the 5th"
+  end
+
+  def test_conversions
+    assert @response.class.inspect == 'Gattica::DataSet', "should be a Gattica:DataSet"
+    assert @response.to_h.class.inspect == 'Hash', "Should be a hash"
+  end
+
+end

data/test/test_user.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestUser < Test::Unit::TestCase
+  def setup
+    
+  end
+  
+  def test_can_create_user
+    assert Gattica::User.new('anonymous@anon.com','none')
+  end
+  
+  def test_invalid_email
+    assert_raise GatticaError::InvalidEmail do Gattica::User.new('','') end
+    assert_raise ArgumentError do Gattica::User.new('') end
+    assert_raise GatticaError::InvalidEmail do Gattica::User.new('anonymous','none') end
+    assert_raise GatticaError::InvalidEmail do Gattica::User.new('anonymous@asdfcom','none') end
+  end
+    
+  def test_invalid_password
+    assert_raise GatticaError::InvalidPassword do Gattica::User.new('anonymous@anon.com','') end
+    assert_raise ArgumentError do Gattica::User.new('anonymous@anon.com') end
+  end
+  
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: betapond-gattica
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Christopher Le, et all
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gattica
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Gattica is a easy to use Ruby Gem for getting data from the Google Analytics API.  It supports metrics, dimensions, sort, filters, goals, and segments.  It can handle accounts with 1000+ profiles, and can return data in CSV, Hash, or JSON
+email: chrisl@seerinteractive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
+- gattica.gemspec
+- lib/gattica.rb
+- lib/gattica/account.rb
+- lib/gattica/auth.rb
+- lib/gattica/convertible.rb
+- lib/gattica/data_point.rb
+- lib/gattica/data_set.rb
+- lib/gattica/engine.rb
+- lib/gattica/exceptions.rb
+- lib/gattica/hash_extensions.rb
+- lib/gattica/segment.rb
+- lib/gattica/settings.rb
+- lib/gattica/user.rb
+- test/helper.rb
+- test/settings.rb
+- test/suite.rb
+- test/test_engine.rb
+- test/test_results.rb
+- test/test_user.rb
+has_rdoc: true
+homepage: http://github.com/chrisle/gattica
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Gattica is a easy to use Ruby Gem for getting data from the Google Analytics API.
+test_files: []
+