jeremyf-gattica 0.3.4 → 0.3.6

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+github-test.rb
+examples/active_example.rb
+examples/.DS_Store

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.6
+  * Updated gem to pass tests under 1.9.1
+  
+== 0.3.5
+  * Added ability to parse addition query strings
+  * Added test to verify behavior
+
 == 0.3.4
   * Removed Hash#to_query as this directly conflicts with Rails Hash#to_query method.
   * Removed Hash#stringify_keys as it was not used in the code base.

data/VERSION.yml

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

data/gattica.gemspec

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gattica}
+  s.version = "0.3.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Cameron"]
+  s.date = %q{2009-08-07}
+  s.description = %q{Gattica is a Ruby library for extracting data from the Google Analytics API.}
+  s.email = %q{cannikinn@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "examples/example.rb",
+     "gattica.gemspec",
+     "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_auth.rb",
+     "test/test_engine.rb",
+     "test/test_gattica.rb",
+     "test/test_user.rb"
+  ]
+  s.homepage = %q{http://github.com/cannikin/gattica}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Gattica is a Ruby library for extracting data from the Google Analytics API.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/suite.rb",
+     "test/test_auth.rb",
+     "test/test_engine.rb",
+     "test/test_gattica.rb",
+     "test/test_user.rb",
+     "examples/example.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
+    else
+    end
+  else
+  end
+end

data/lib/gattica/auth.rb

@@ -11,7 +11,7 @@ module Gattica
 
     SCRIPT_NAME = '/accounts/ClientLogin'
     HEADERS = { 'Content-Type' => 'application/x-www-form-urlencoded', 'User-Agent' => 'Ruby Net::HTTP' }   # Google asks that you be nice and provide a user-agent string
-    OPTIONS = { :source => 'gattica-'+VERSION, :service => 'analytics' }                                    # Google asks that you provide the name of your app as a 'source' parameter in your POST
+    OPTIONS = { :source => "gattica-#{Gattica::VERSION}", :service => 'analytics' }                                    # Google asks that you provide the name of your app as a 'source' parameter in your POST
 
     attr_reader :tokens
   

data/lib/gattica.rb

@@ -1,5 +1,10 @@
 $:.unshift File.dirname(__FILE__) # for use/testing when no gem is installed
 
+
+module Gattica
+  VERSION = '0.3.6'
+end
+
 # external
 require 'net/http'
 require 'net/https'
@@ -26,8 +31,6 @@ require 'gattica/data_point'
 
 module Gattica
   
-  VERSION = '0.3.1'
-  
   # Creates a new instance of Gattica::Engine and gets us going. Please see the README for usage docs.
   #
   #   ga = Gattica.new({:email => 'anonymous@anon.com', :password => 'password, :profile_id => 123456 })
@@ -206,26 +209,34 @@ module Gattica
     
     # 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|
+      query_params  = args.clone
+      ga_start_date = query_params.delete(:start_date)
+      ga_end_date   = query_params.delete(:end_date)
+      ga_dimensions = query_params.delete(:dimensions)
+      ga_metrics    = query_params.delete(:metrics)
+      ga_sort       = query_params.delete(:sort)
+      ga_filters    = query_params.delete(:filters)
+      
+      output = "ids=ga:#{profile}&start-date=#{ga_start_date}&end-date=#{ga_end_date}"
+      unless ga_dimensions.nil? || ga_dimensions.empty?
+        output += '&dimensions=' + ga_dimensions.collect do |dimension|
           "ga:#{dimension}"
         end.join(',')
       end
-      unless args[:metrics].empty?
-        output += '&metrics=' + args[:metrics].collect do |metric|
+      unless ga_metrics.nil? || ga_metrics.empty?
+        output += '&metrics=' + ga_metrics.collect do |metric|
           "ga:#{metric}"
         end.join(',')
       end
-      unless args[:sort].empty?
-        output += '&sort=' + args[:sort].collect do |sort|
+      unless ga_sort.nil? || ga_sort.empty?
+        output += '&sort=' + Array(ga_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
       
       # TODO: update so that in regular expression filters (=~ and !~), any initial special characters in the regular expression aren't also picked up as part of the operator (doesn't cause a problem, but just feels dirty)
-      unless args[:filters].empty?    # filters are a little more complicated because they can have all kinds of modifiers
-        output += '&filters=' + args[:filters].collect do |filter|
+      unless ga_filters.nil? || ga_filters.empty?    # filters are a little more complicated because they can have all kinds of modifiers
+        output += '&filters=' + ga_filters.collect do |filter|
           match, name, operator, expression = *filter.match(/^(\w*)(\W*)(.*)$/)           # splat the resulting Match object to pull out the parts automatically
           unless name.empty? || operator.empty? || expression.empty?                      # make sure they all contain something
             "ga:#{name}#{CGI::escape(operator.gsub(/ /,''))}#{CGI::escape(expression)}"   # remove any whitespace from the operator before output
@@ -234,8 +245,12 @@ module Gattica
           end
         end.join(';')
       end
+
+      query_params.inject(output) {|m,(key,value)| m << "&#{key}=#{value}"}
+
       return output
     end
+
     
     
     # Validates that the args passed to +get+ are valid

data/test/test_gattica.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/helper'
+ 
+class TestUser < Test::Unit::TestCase
+  def test_build_query_string
+    @gattica = Gattica.new(:token => 'ga-token', :profile_id => 'ga-profile_id')
+    expected = "ids=ga:ga-profile_id&start-date=2008-01-02&end-date=2008-01-03&dimensions=ga:pageTitle,ga:pagePath&metrics=ga:pageviews&sort=-ga:pageviews&max-results=3"
+    result = @gattica.send(:build_query_string, {
+      :start_date => Date.civil(2008,1,2), 
+      :end_date => Date.civil(2008,1,3),
+      :dimensions => ['pageTitle','pagePath'], 
+      :metrics => ['pageviews'], 
+      :sort => '-pageviews',
+      'max-results' => '3'}, 'ga-profile_id')
+    assert_equal expected, result
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeremyf-gattica
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors: 
 - Rob Cameron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -07:00
+date: 2009-08-07 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,12 +23,14 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - History.txt
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION.yml
 - examples/example.rb
+- gattica.gemspec
 - lib/gattica.rb
 - lib/gattica/account.rb
 - lib/gattica/auth.rb
@@ -42,9 +44,11 @@ files:
 - test/suite.rb
 - test/test_auth.rb
 - test/test_engine.rb
+- test/test_gattica.rb
 - test/test_user.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/cannikin/gattica
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -65,14 +69,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Gattica is a Ruby library for extracting data from the Google Analytics API.
 test_files: 
 - test/helper.rb
 - test/suite.rb
 - test/test_auth.rb
 - test/test_engine.rb
+- test/test_gattica.rb
 - test/test_user.rb
 - examples/example.rb