titanous-garb 0.8.5

data/lib/garb/report_parameter.rb

@@ -0,0 +1,25 @@
+module Garb
+  class ReportParameter
+
+    attr_reader :elements
+    
+    def initialize(name)
+      @name = name
+      @elements = []
+    end
+    
+    def name
+      @name.to_s
+    end
+    
+    def <<(element)
+      (@elements += [element].flatten).compact!
+      self
+    end
+    
+    def to_params
+      value = self.elements.map{|param| Garb.to_google_analytics(param)}.join(',')
+      value.empty? ? {} : {self.name => value}
+    end
+  end
+end

data/lib/garb/report_response.rb

@@ -0,0 +1,34 @@
+module Garb  
+  class ReportResponse
+    KEYS = ['dxp:metric', 'dxp:dimension']
+
+    def initialize(response_body, instance_klass = OpenStruct)
+      @xml = response_body
+      @instance_klass = instance_klass
+    end
+
+    def results
+      @results ||= parse
+    end
+
+    private
+    def parse
+      entries.map do |entry|
+        hash = values_for(entry).inject({}) do |h, v|
+          h.merge(Garb.from_ga(v['name']) => v['value'])
+        end
+
+        @instance_klass.new(hash)
+      end
+    end
+
+    def entries
+      entry_hash = Crack::XML.parse(@xml)
+      entry_hash ? [entry_hash['feed']['entry']].flatten.compact : []
+    end
+
+    def values_for(entry)
+      KEYS.map {|k| entry[k]}.flatten.compact
+    end
+  end
+end

data/lib/garb/reports.rb

@@ -0,0 +1,5 @@
+require 'garb/reports/exits'
+require 'garb/reports/visits'
+require 'garb/reports/bounces'
+require 'garb/reports/pageviews'
+require 'garb/reports/unique_pageviews'

data/lib/garb/reports/bounces.rb

@@ -0,0 +1,5 @@
+class Bounces
+  extend Garb::Resource
+
+  metrics :bounces
+end

data/lib/garb/reports/exits.rb

@@ -0,0 +1,5 @@
+class Exits
+  extend Garb::Resource
+
+  metrics :exits
+end

data/lib/garb/reports/pageviews.rb

@@ -0,0 +1,5 @@
+class Pageviews
+  extend Garb::Resource
+
+  metrics :pageviews
+end

data/lib/garb/reports/unique_pageviews.rb

@@ -0,0 +1,5 @@
+class UniquePageviews
+  extend Garb::Resource
+
+  metrics :unique_pageviews
+end

data/lib/garb/reports/visits.rb

@@ -0,0 +1,5 @@
+class Visits
+  extend Garb::Resource
+
+  metrics :visits
+end

data/lib/garb/resource.rb

@@ -0,0 +1,115 @@
+module Garb
+  module Resource
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def self.extended(base)
+      # define a method on a module that gets included into profile
+      # Exits would make:
+      # to enable profile.exits(options_hash, &block)
+      # returns Exits.results(self, options_hash, &block)
+      # every class defined which extends Resource will add to the module
+
+      # ActiveSupport::Deprecation.warn
+      ProfileReports.add_report_method(base)
+    end
+
+    %w(metrics dimensions sort).each do |parameter|
+      class_eval <<-CODE
+        def #{parameter}(*fields)
+          @#{parameter} ||= ReportParameter.new(:#{parameter})
+          @#{parameter} << fields
+        end
+
+        def clear_#{parameter}
+          @#{parameter} = ReportParameter.new(:#{parameter})
+        end
+      CODE
+    end
+
+    def filters(*hashes, &block)
+      @filter_parameters ||= FilterParameters.new
+
+      hashes.each do |hash|
+        @filter_parameters.parameters << hash
+      end
+
+      @filter_parameters.filters(&block) if block_given?
+      @filter_parameters
+    end
+
+    def clear_filters
+      @filter_parameters = FilterParameters.new
+    end
+
+    def set_segment_id(id)
+      @segment = "gaid::#{id.to_i}"
+    end
+
+    def segment
+      @segment
+    end
+
+    def set_instance_klass(klass)
+      @instance_klass = klass
+    end
+
+    def instance_klass
+      @instance_klass || OpenStruct
+    end
+
+    def results(profile, opts = {}, &block)
+      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
+
+      if @profile
+        @start_date = opts.fetch(:start_date, Time.now - MONTH)
+        @end_date = opts.fetch(:end_date, Time.now)
+        @limit = opts.fetch(:limit, nil)
+        @offset = opts.fetch(:offset, nil)
+
+        instance_eval(&block) if block_given?
+
+        ReportResponse.new(send_request_for_body, instance_klass).results
+      else
+        []
+      end
+    end
+
+    def page_params
+      {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
+    end
+
+    def default_params
+      {'ids' => @profile.table_id,
+        'start-date' => format_time(@start_date),
+        'end-date' => format_time(@end_date)}
+    end
+
+    def segment_params
+      segment.nil? ? {} : {'segment' => segment}
+    end
+
+    def params
+      [
+        metrics.to_params,
+        dimensions.to_params,
+        sort.to_params,
+        filters.to_params,
+        page_params,
+        segment_params
+      ].inject(default_params) do |p, i|
+        p.merge(i)
+      end
+    end
+
+    def format_time(t)
+      t.strftime('%Y-%m-%d')
+    end
+
+    def send_request_for_body
+      request = DataRequest.new(@profile.session, URL, params)
+      response = request.send_request
+      response.body
+    end
+  end
+end

data/lib/garb/session.rb

@@ -0,0 +1,35 @@
+module Garb
+  class Session
+    module Methods
+      attr_accessor :auth_token, :access_token, :email
+
+      # use only for single user authentication
+      def login(email, password, opts={})
+        self.email = email
+        auth_request = AuthenticationRequest.new(email, password, opts)
+        self.auth_token = auth_request.auth_token(opts)
+      end
+
+      def single_user?
+        auth_token && auth_token.is_a?(String)
+      end
+
+      def oauth_user?
+        !access_token.nil?
+      end
+
+      def auth_sub(token)
+        self.auth_token = token
+        @auth_sub = true
+      end
+
+      def auth_sub?
+        @auth_sub
+      end
+
+    end
+
+    include Methods
+    extend Methods
+  end
+end

data/lib/garb/step.rb

@@ -0,0 +1,13 @@
+module Garb
+  class Step
+    attr_reader :name, :number, :path
+
+    def initialize(attributes)
+      return unless attributes.is_a?(Hash)
+
+      @name = attributes['name']
+      @number = attributes['number'].to_i
+      @path = attributes['path']
+    end
+  end
+end

data/lib/garb/version.rb

@@ -0,0 +1,13 @@
+module Garb
+  module Version
+
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 5
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

data/lib/support.rb

@@ -0,0 +1,40 @@
+class SymbolOperator
+  def initialize(field, operator)
+    @field, @operator = field, operator
+  end unless method_defined?(:initialize)
+
+  def to_google_analytics
+    operators = {
+      :eql => '==',
+      :not_eql => '!=',
+      :gt => '>',
+      :gte => '>=',
+      :lt => '<',
+      :lte => '<=',
+      :matches => '==',
+      :does_not_match => '!=',
+      :contains => '=~',
+      :does_not_contain => '!~',
+      :substring => '=@',
+      :not_substring => '!@',
+      :desc => '-',
+      :descending => '-'
+    }
+
+    target = Garb.to_google_analytics(@field)
+    operator = operators[@operator]
+
+    [:desc, :descending].include?(@operator) ? "#{operator}#{target}" : "#{target}#{operator}"
+  end
+end
+
+class Symbol
+  [:eql, :not_eql, :gt, :gte, :lt, :lte, :desc, :descending,
+    :matches, :does_not_match, :contains, :does_not_contain,
+    :substring, :not_substring].each do |operator|
+
+    define_method(operator) do
+      SymbolOperator.new(self, operator)
+    end unless method_defined?(operator)
+  end
+end

data/test/fixtures/cacert.pem

@@ -0,0 +1,67 @@
+##
+## cacert.pem-foo -- Bundle of CA Root Certificates
+##
+## Converted at: Thu Mar 26 21:23:06 2009 UTC
+##
+## This is a bundle of X.509 certificates of public Certificate Authorities
+## (CA). These were automatically extracted from Mozilla's root certificates
+## file (certdata.txt).  This file can be found in the mozilla source tree:
+## '/mozilla/security/nss/lib/ckfw/builtins/certdata.txt'
+##
+## It contains the certificates in PEM format and therefore
+## can be directly used with curl / libcurl / php_curl, or with
+## an Apache+mod_ssl webserver for SSL client authentication.
+## Just configure this file as the SSLCACertificateFile.
+##
+
+# ***** BEGIN LICENSE BLOCK *****
+# Version: MPL 1.1/GPL 2.0/LGPL 2.1
+#
+# The contents of this file are subject to the Mozilla Public License Version
+# 1.1 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+# http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+# for the specific language governing rights and limitations under the
+# License.
+#
+# The Original Code is the Netscape security libraries.
+#
+# The Initial Developer of the Original Code is
+# Netscape Communications Corporation.
+# Portions created by the Initial Developer are Copyright (C) 1994-2000
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s):
+#
+# Alternatively, the contents of this file may be used under the terms of
+# either the GNU General Public License Version 2 or later (the "GPL"), or
+# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+# in which case the provisions of the GPL or the LGPL are applicable instead
+# of those above. If you wish to allow use of your version of this file only
+# under the terms of either the GPL or the LGPL, and not to allow others to
+# use your version of this file under the terms of the MPL, indicate your
+# decision by deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL or the LGPL. If you do not delete
+# the provisions above, a recipient may use your version of this file under
+# the terms of any one of the MPL, the GPL or the LGPL.
+#
+# ***** END LICENSE BLOCK *****
+# @(#) $RCSfile: certdata.txt,v $ $Revision: 1.51 $ $Date: 2009/01/15 22:35:15 $
+
+Verisign/RSA Secure Server CA
+=============================
+-----BEGIN CERTIFICATE-----
+MIICNDCCAaECEAKtZn5ORf5eV288mBle3cAwDQYJKoZIhvcNAQECBQAwXzELMAkGA1UEBhMCVVMx
+IDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQLEyVTZWN1cmUgU2VydmVy
+IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk0MTEwOTAwMDAwMFoXDTEwMDEwNzIzNTk1OVow
+XzELMAkGA1UEBhMCVVMxIDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQL
+EyVTZWN1cmUgU2VydmVyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGbMA0GCSqGSIb3DQEBAQUA
+A4GJADCBhQJ+AJLOesGugz5aqomDV6wlAXYMra6OLDfO6zV4ZFQD5YRAUcm/jwjiioII0haGN1Xp
+sSECrXZogZoFokvJSyVmIlZsiAeP94FZbYQHZXATcXY+m3dM41CJVphIuR2nKRoTLkoRWZweFdVJ
+VCxzOmmCsZc5nG1wZ0jl3S3WyB57AgMBAAEwDQYJKoZIhvcNAQECBQADfgBl3X7hsuyw4jrg7HFG
+mhkRuNPHoLQDQCYCPgmc4RKz0Vr2N6W3YQO2WxZpO8ZECAyIUwxrl0nHPjXcbLm7qt9cuzovk2C2
+qUtN8iD3zV9/ZHuO3ABc1/p3yjkWWW8O6tO1g39NTUJWdrTJXwT4OPjr0l91X817/OWOgHz8UA==
+-----END CERTIFICATE-----

data/test/fixtures/profile_feed.xml

@@ -0,0 +1,72 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:dxp='http://schemas.google.com/analytics/2009' xmlns:ga='http://schemas.google.com/ga/2009' xmlns:openSearch='http://a9.com/-/spec/opensearch/1.1/' xmlns:gd='http://schemas.google.com/g/2005' gd:etag='W/&quot;A0UASX45cCp7I2A9WxFQEUQ.&quot;' gd:kind='analytics#accounts'>
+  <id>http://www.google.com/analytics/feeds/accounts/tpitale@gmail.com</id>
+  <updated>2010-05-06T19:27:28.028-07:00</updated>
+  <title>Profile list for tpitale@gmail.com</title>
+  <link rel='self' type='application/atom+xml' href='https://www.google.com/analytics/feeds/accounts/default'/>
+  <author><name>Google Analytics</name></author>
+  <generator version='1.0'>Google Analytics</generator>
+  <openSearch:totalResults>2</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>2</openSearch:itemsPerPage>
+  <dxp:segment id='gaid::-1' name='All Visits'>
+    <dxp:definition> </dxp:definition>
+  </dxp:segment>
+  <dxp:segment id='gaid::-2' name='New Visitors'>
+    <dxp:definition>ga:visitorType==New Visitor</dxp:definition>
+  </dxp:segment>
+  <dxp:segment id='gaid::-3' name='Paid Search Traffic'>
+    <dxp:definition>ga:medium==cpa,ga:medium==cpc,ga:medium==cpm,ga:medium==cpp,ga:medium==cpv,ga:medium==ppc</dxp:definition>
+  </dxp:segment>
+  <dxp:segment id='gaid::0' name='Not New York'>
+    <dxp:definition>ga:city!=New York</dxp:definition>
+  </dxp:segment>
+  <entry gd:etag='W/&quot;CUcHSXs8fip7I2A9WxBUFUg.&quot;' gd:kind='analytics#account'>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:12345</id>
+    <updated>2008-07-21T14:05:57.000-07:00</updated>
+    <title>Historical</title>
+    <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+    <ga:goal active='true' name='Read Blog' number='1' value='10.0'>
+      <ga:destination caseSensitive='false' expression='/blog.html' matchType='head' step1Required='false'/>
+    </ga:goal>
+    <ga:goal active='true' name='Go for Support' number='2' value='5.0'>
+      <ga:destination caseSensitive='false' expression='/support.html' matchType='head' step1Required='false'/>
+    </ga:goal>
+    <ga:goal active='true' name='Contact Form Submission' number='3' value='100.0'>
+      <ga:destination caseSensitive='false' expression='/contact-submit' matchType='exact' step1Required='true'>
+        <ga:step name='Contact Form Page' number='1' path='/contact.html'/>
+      </ga:destination>
+    </ga:goal>
+    <ga:goal active='true' name='Newsletter Form Submission' number='4' value='25.0'>
+      <ga:destination caseSensitive='false' expression='/newsletter-submit' matchType='exact' step1Required='false'/>
+    </ga:goal>
+    <dxp:property name="ga:accountId" value="1111"/>
+    <dxp:property name="ga:accountName" value="Blog Beta"/>
+    <dxp:property name="ga:profileId" value="1212"/>
+    <dxp:property name="ga:webPropertyId" value="UA-1111-1"/>
+    <dxp:property name="ga:currency" value="USD"/>
+    <dxp:property name="ga:timezone" value="America/New_York"/>
+    <dxp:tableId>ga:12345</dxp:tableId>
+  </entry>
+  <entry gd:etag='W/&quot;A0UASX45cCp7I2A9WxFQEUQ.&quot;' gd:kind='analytics#account'>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:12346</id>
+    <updated>2008-11-24T11:51:07.000-08:00</updated>
+    <title>Presently</title>
+    <link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+    <ga:goal active='true' name='Contact Form Submission' number='1' value='100.0'>
+      <ga:destination caseSensitive='false' expression='/contact-submit' matchType='exact' step1Required='true'>
+        <ga:step name='Contact Form Page' number='1' path='/contact.html'/>
+      </ga:destination>
+    </ga:goal>
+    <ga:goal active='true' name='Newsletter Form Submission' number='2' value='25.0'>
+      <ga:destination caseSensitive='false' expression='/newsletter-submit' matchType='exact' step1Required='false'/>
+    </ga:goal>
+    <dxp:property name="ga:accountId" value="1111"/>
+    <dxp:property name="ga:accountName" value="Blog Beta"/>
+    <dxp:property name="ga:profileId" value="1213"/>
+    <dxp:property name="ga:webPropertyId" value="UA-1111-2"/>
+    <dxp:property name="ga:currency" value="USD"/>
+    <dxp:property name="ga:timezone" value="America/New_York"/>
+    <dxp:tableId>ga:12346</dxp:tableId>
+  </entry>
+</feed>