google_analytics_feeds 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "ox", "< 2"
+gem "faraday"
+gem "addressable"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2"
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Roland Swingler
+
+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,62 @@
+= Google Analytics Feeds
+
+Allows access to google analytics feeds from ruby.
+
+Does not support any of the OAuth-related authentication methods.
+
+== Installation
+
+    gem install google_analytics_feeds
+
+== Usage
+
+    require 'google_analytics_feeds'
+
+    # Define your report. Reports are built up like an ActiveRecord or 
+    # Sequel::Dataset query.
+    report = GoogleAnalyticsFeeds::DataFeed.new.
+      profile(123456).
+      dimensions(:visitor_type).
+      metrics(:visits)
+
+    # Create a session and login. You can optionally pass a
+    # Faraday::Connection to +new+ to use a different adapter, deal 
+    # with proxies etc.
+    session = GoogleAnalyticsFeeds::Session.new
+    session.login("username", "password")
+
+    # Fetch a report. Rows are handled with a 
+    # GoogleAnalyticsFeed::RowHandler - this may just be an anonymous
+    # block as demonstrated here.
+    session.fetch_report(report) do
+      def row(r)
+        puts r.inspect # => outputs the row as a hash.
+      end
+    end
+
+== TODO
+
+* Tests, documentation
+* Filters
+* Access to the management data feed.
+* Auto-follow of paginated result sets.
+
+== Versioning
+
+Patch-level releases will not change the API. Minor releases may make breaking changes to the API until a 1.0 release.
+
+== Contributing to google_analytics_feeds
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Roland Swingler. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "google_analytics_feeds"
+  gem.homepage = "http://github.com/knaveofdiamonds/google_analytics_feeds"
+  gem.license = "MIT"
+  gem.summary = %Q{Google Analytics Feed Access}
+  gem.description = %Q{Fairly low-level client library to access Google Analytics Feeds}
+  gem.email = "roland.swingler@gmail.com"
+  gem.authors = ["Roland Swingler"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google_analytics_feeds #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/google_analytics_feeds.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{google_analytics_feeds}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Roland Swingler}]
+  s.date = %q{2012-08-29}
+  s.description = %q{Fairly low-level client library to access Google Analytics Feeds}
+  s.email = %q{roland.swingler@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "google_analytics_feeds.gemspec",
+    "lib/google_analytics_feeds.rb",
+    "lib/sample.rb",
+    "spec/google_analytics_feeds_spec.rb",
+    "spec/request_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/knaveofdiamonds/google_analytics_feeds}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Google Analytics Feed Access}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ox>, ["< 2"])
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<ox>, ["< 2"])
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ox>, ["< 2"])
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/google_analytics_feeds.rb

@@ -0,0 +1,244 @@
+require 'ox'
+require 'addressable/uri'
+require 'stringio'
+require 'faraday'
+
+module GoogleAnalyticsFeeds
+  class AuthenticationError < StandardError ; end
+  class HttpError < StandardError ; end
+
+  class Session
+    CLIENT_LOGIN_URI = "https://www.google.com/accounts/ClientLogin"
+
+    def initialize(connection=Faraday.default_connection)
+      @connection = connection
+    end
+
+    def login(username, password)
+      return @token if @token
+      response = @connection.post(CLIENT_LOGIN_URI,
+                                  'Email'       => username,
+                                  'Passwd'      => password,
+                                  'accountType' => 'HOSTED_OR_GOOGLE',
+                                  'service'     => 'analytics',
+                                  'source'      => 'ruby-google-analytics-feeds')
+
+      if response.success?
+        @token = response.body.match(/^Auth=(.*)$/)[1]
+      else
+        raise AuthenticationError
+      end
+    end
+
+    def fetch_report(report, handler=nil, &block)
+      handler  = block if handler.nil?
+      response = report.retrieve(@token, @connection)
+
+      if response.success?
+        DataFeedParser.new(handler).parse_rows(StringIO.new(response.body))
+      else
+        raise HttpError.new
+      end
+    end
+  end
+
+  # A SAX-style row handler.
+  #
+  # Extend this class and override the methods you care about to
+  # handle data feed row data.
+  class RowHandler
+    def start_rows
+    end
+
+    def row(row)
+    end
+
+    def end_rows
+    end
+  end
+  
+  module Naming
+    # Returns a ruby-friendly symbol from a google analytics name.
+    #
+    # For example:
+    #
+    #     name_to_symbol("ga:visitorType") # => :visitor_type
+    def name_to_symbol(name)
+      name.sub(/^ga\:/,'').gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+    end
+    
+    # Returns a google analytics name from a ruby symbol.
+    #
+    # For example:
+    #
+    #     symbol_to_name(:visitor_type) # => "ga:visitorType"
+    def symbol_to_name(sym)
+      parts = sym.to_s.split("_").map(&:capitalize)
+      parts[0].downcase!
+      "ga:" + parts.join('')
+    end
+  end
+
+  # Parses rows from the GA feed via SAX. Clients shouldn't have to
+  # use this - use a RowHandler instead.
+  class RowParser < ::Ox::Sax
+    include Naming
+
+    def initialize(handler)
+      @handler = handler
+    end
+
+    def start_element(element)
+      case element
+
+      when :entry
+        @row = {}
+      when :"dxp:dimension", :"dxp:metric"
+        @property = {}
+      end
+    end
+
+    def attr(name, value)
+      if @property
+        @property[name] = value
+      end
+    end
+
+    def end_element(element)
+      case element
+      when :entry
+        handle_complete_row
+        @row = nil
+      when :"dxp:dimension", :"dxp:metric"
+        handle_complete_property
+        @property = nil
+      end
+    end
+    
+    private
+
+    def handle_complete_row
+      @handler.row(@row)
+    end
+
+    def handle_complete_property
+      if @row
+        value = @property[:value]
+        if @property[:type] == "integer"
+          value = Integer(value)
+        end
+        name = name_to_symbol(@property[:name])
+        @row[name] = value
+      end
+    end
+  end
+
+  class DataFeed
+    include Naming
+    
+    BASE_URI = "https://www.googleapis.com/analytics/v2.4/data"
+
+    def initialize
+      @params = {}
+    end
+
+    def profile(id)
+      clone_and_set {|params|
+        params['ids'] = symbol_to_name(id)
+      }
+    end
+
+    def metrics(*vals)
+      clone_and_set {|params|
+        params['metrics'] = vals.map {|v| symbol_to_name(v) }.join(',')
+      }
+    end
+
+    def dimensions(*vals)
+      clone_and_set {|params|
+        params['dimensions'] = vals.map {|v| symbol_to_name(v) }.join(',')
+      }
+    end
+
+    def dates(start_date, end_date)
+      clone_and_set {|params|
+        params['start-date'] = start_date.strftime("%Y-%m-%d")
+        params['end-date'] = end_date.strftime("%Y-%m-%d")
+      }
+    end
+
+    def start_index(i)
+      clone_and_set {|params|
+        params['start-index'] = i.to_s
+      }
+    end
+
+    def max_results(i)
+      clone_and_set {|params|
+        params['max-results'] = i.to_s
+      }
+    end
+
+    # Sorts the result set by a column.
+    #
+    # Direction can be :asc or :desc.
+    def sort(column, direction)
+      clone_and_set {|params|
+        c = symbol_to_name(column)
+        params['sort'] = (direction == :desc ? "-#{c}" : c)
+      }
+    end
+
+    def uri
+      uri = Addressable::URI.parse(BASE_URI)
+      uri.query_values = @params
+      uri.to_s
+    end
+
+    alias :to_s :uri
+
+    def retrieve(session_token, connection)
+      connection.get(uri) do |request|
+        request.headers['Authorization'] = 
+          "GoogleLogin auth=#{session_token}"
+      end
+    end
+
+    def clone
+      obj = super
+      obj.instance_variable_set(:@params, @params.clone)
+      obj
+    end
+
+    protected
+
+    attr_reader :params
+
+    private
+
+    def clone_and_set
+      obj = clone
+      yield obj.params
+      obj
+    end
+  end
+
+  class DataFeedParser
+    def initialize(handler)
+      if handler.kind_of?(Proc)
+        @handler = Class.new(RowHandler, &handler).new
+      elsif handler.kind_of?(Class)
+        @handler = handler.new
+      else
+        @handler = handler
+      end
+    end
+
+    # Parse rows from an IO object.
+    def parse_rows(io)
+      @handler.start_rows
+      Ox.sax_parse(RowParser.new(@handler), io)
+      @handler.end_rows
+    end
+  end
+end

data/lib/sample.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/google_analytics_feeds" 
+
+class LoggingRowHandler < GoogleAnalyticsFeeds::RowHandler
+  def row(r)
+    puts r.inspect
+  end
+
+  def end_rows
+    puts "Done!"
+  end
+end
+
+File.open("/home/roland/gaout2.xml") do |fh|
+  GoogleAnalyticsFeeds.parse_data_rows(fh, LoggingRowHandler)
+end

data/spec/google_analytics_feeds_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Parsing property names" do
+  it "snake cases, symbolizes and removes ga namespace" do
+    GoogleAnalyticsFeeds::DataFeed.new.name_to_symbol("ga:visitorType").should == :visitor_type
+  end
+
+  it "converts a ruby symbol to a google analytics name" do
+    GoogleAnalyticsFeeds::DataFeed.new.symbol_to_name(:visitor_type).should == "ga:visitorType"
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'addressable/uri'
+
+describe GoogleAnalyticsFeeds::DataFeed do
+  it "builds a URI" do
+    request = described_class.new.
+      profile(123).
+      metrics(:foo, :bar).
+      dimensions(:baz).
+      dates(Date.new(2010, 3, 14), Date.new(2010, 3, 14)).
+      max_results(50).
+      start_index(10)
+
+    uri = Addressable::URI.parse(request.uri)
+    uri.scheme.should == "https"
+    uri.host.should == "www.googleapis.com"
+    uri.path.should == "/analytics/v2.4/data"
+    uri.query_values.should == {
+      "ids" => "ga:123",
+      "metrics" => "ga:foo,ga:bar",
+      "dimensions" => "ga:baz",
+      "start-date" => "2010-03-14",
+      "end-date" => "2010-03-14",
+      "max-results" => "50",
+      "start-index" => "10",
+    }
+  end
+
+  it "doesn't modify the original request" do
+    request = described_class.new.profile(123)
+    request.metrics(:foo) # result thrown away
+
+    uri = Addressable::URI.parse(request.uri)
+    uri.query_values.should == {"ids" => "ga:123"}
+  end
+
+  it "adds the appropriate header and makes the request" do
+    connection = mock(:connection)
+    headers    = {}
+    request    = mock(:request, :headers => headers).as_null_object
+
+    connection.should_receive(:get).and_yield(request)
+    described_class.new.retrieve("123", connection)
+
+    headers["Authorization"].should == "GoogleLogin auth=123"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'google_analytics_feeds'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: google_analytics_feeds
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roland Swingler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  version_requirements: *id001
+  name: ox
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: faraday
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: addressable
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  version_requirements: *id004
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  version_requirements: *id005
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 8
+        version: "1.8"
+  version_requirements: *id006
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: rcov
+  prerelease: false
+  type: :development
+description: Fairly low-level client library to access Google Analytics Feeds
+email: roland.swingler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- google_analytics_feeds.gemspec
+- lib/google_analytics_feeds.rb
+- lib/sample.rb
+- spec/google_analytics_feeds_spec.rb
+- spec/request_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/knaveofdiamonds/google_analytics_feeds
+licenses: 
+- MIT
+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.8.6
+signing_key: 
+specification_version: 3
+summary: Google Analytics Feed Access
+test_files: []
+