shingara-garb 0.7.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. data/README.md +255 -0
  2. data/Rakefile +56 -0
  3. data/lib/garb.rb +42 -0
  4. data/lib/garb/account.rb +29 -0
  5. data/lib/garb/authentication_request.rb +53 -0
  6. data/lib/garb/data_request.rb +42 -0
  7. data/lib/garb/filter_parameters.rb +41 -0
  8. data/lib/garb/profile.rb +37 -0
  9. data/lib/garb/profile_reports.rb +15 -0
  10. data/lib/garb/report.rb +26 -0
  11. data/lib/garb/report_parameter.rb +25 -0
  12. data/lib/garb/report_response.rb +33 -0
  13. data/lib/garb/reports.rb +5 -0
  14. data/lib/garb/reports/bounces.rb +5 -0
  15. data/lib/garb/reports/exits.rb +5 -0
  16. data/lib/garb/reports/pageviews.rb +5 -0
  17. data/lib/garb/reports/unique_pageviews.rb +5 -0
  18. data/lib/garb/reports/visits.rb +5 -0
  19. data/lib/garb/resource.rb +92 -0
  20. data/lib/garb/session.rb +35 -0
  21. data/lib/garb/version.rb +13 -0
  22. data/lib/support.rb +39 -0
  23. data/test/fixtures/cacert.pem +67 -0
  24. data/test/fixtures/profile_feed.xml +38 -0
  25. data/test/fixtures/report_feed.xml +46 -0
  26. data/test/test_helper.rb +18 -0
  27. data/test/unit/garb/account_test.rb +53 -0
  28. data/test/unit/garb/authentication_request_test.rb +121 -0
  29. data/test/unit/garb/data_request_test.rb +119 -0
  30. data/test/unit/garb/filter_parameters_test.rb +59 -0
  31. data/test/unit/garb/oauth_session_test.rb +11 -0
  32. data/test/unit/garb/profile_reports_test.rb +29 -0
  33. data/test/unit/garb/profile_test.rb +75 -0
  34. data/test/unit/garb/report_parameter_test.rb +43 -0
  35. data/test/unit/garb/report_response_test.rb +14 -0
  36. data/test/unit/garb/report_test.rb +91 -0
  37. data/test/unit/garb/resource_test.rb +38 -0
  38. data/test/unit/garb/session_test.rb +91 -0
  39. data/test/unit/garb_test.rb +14 -0
  40. data/test/unit/symbol_operator_test.rb +37 -0
  41. metadata +146 -0
@@ -0,0 +1,41 @@
1
+ module Garb
2
+ class FilterParameters
3
+ def self.define_operators(*methods)
4
+ methods.each do |method|
5
+ class_eval <<-CODE
6
+ def #{method}(field, value)
7
+ @filter_hash.merge!({SymbolOperator.new(field, :#{method}) => value})
8
+ end
9
+ CODE
10
+ end
11
+ end
12
+
13
+ define_operators :eql, :not_eql, :gt, :gte, :lt, :lte, :matches,
14
+ :does_not_match, :contains, :does_not_contain, :substring, :not_substring
15
+
16
+ attr_accessor :parameters
17
+
18
+ def initialize
19
+ self.parameters = []
20
+ end
21
+
22
+ def filters(&block)
23
+ @filter_hash = {}
24
+
25
+ instance_eval &block
26
+
27
+ self.parameters << @filter_hash
28
+ end
29
+
30
+ def to_params
31
+ value = self.parameters.map do |param|
32
+ param.map do |k,v|
33
+ next unless k.is_a?(SymbolOperator)
34
+ "#{URI.encode(k.to_google_analytics, /[=<>]/)}#{CGI::escape(v.to_s)}"
35
+ end.join(';') # Hash AND (no duplicate keys)
36
+ end.join(',') # Array OR
37
+
38
+ value.empty? ? {} : {'filters' => value}
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,37 @@
1
+ module Garb
2
+ class Profile
3
+
4
+ include ProfileReports
5
+
6
+ attr_reader :session, :table_id, :title, :account_name, :account_id, :web_property_id
7
+
8
+ def initialize(entry, session)
9
+ @session = session
10
+ @title = entry['title']
11
+ @table_id = entry['dxp:tableId']
12
+
13
+ entry['dxp:property'].each do |p|
14
+ instance_variable_set :"@#{Garb.from_ga(p['name'])}", p['value']
15
+ end
16
+ end
17
+
18
+ def id
19
+ Garb.from_ga(@table_id)
20
+ end
21
+
22
+ def self.all(session = Session)
23
+ url = "https://www.google.com/analytics/feeds/accounts/default"
24
+ response = DataRequest.new(session, url).send_request
25
+ parse(response.body).map {|entry| new(entry, session)}
26
+ end
27
+
28
+ def self.first(id, session = Session)
29
+ all(session).detect {|profile| profile.id == id || profile.web_property_id == id }
30
+ end
31
+
32
+ def self.parse(response_body)
33
+ entry_hash = Crack::XML.parse(response_body)
34
+ entry_hash ? [entry_hash['feed']['entry']].flatten : []
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,15 @@
1
+ module Garb
2
+ module ProfileReports
3
+ def self.add_report_method(klass)
4
+ # demodulize leaves potential to redefine
5
+ # these methods given different namespaces
6
+ method_name = klass.to_s.demodulize.underscore
7
+
8
+ class_eval <<-CODE
9
+ def #{method_name}(opts = {}, &block)
10
+ #{klass}.results(self, opts, &block)
11
+ end
12
+ CODE
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,26 @@
1
+ module Garb
2
+ class Report
3
+ include Resource
4
+
5
+ MONTH = 2592000
6
+ URL = "https://www.google.com/analytics/feeds/data"
7
+
8
+ def initialize(profile, opts={})
9
+ @profile = profile
10
+
11
+ @start_date = opts.fetch(:start_date, Time.now - MONTH)
12
+ @end_date = opts.fetch(:end_date, Time.now)
13
+ @limit = opts.fetch(:limit, nil)
14
+ @offset = opts.fetch(:offset, nil)
15
+
16
+ metrics opts.fetch(:metrics, [])
17
+ dimensions opts.fetch(:dimensions, [])
18
+ sort opts.fetch(:sort, [])
19
+ end
20
+
21
+ def results
22
+ ReportResponse.new(send_request_for_body).results
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,25 @@
1
+ module Garb
2
+ class ReportParameter
3
+
4
+ attr_reader :elements
5
+
6
+ def initialize(name)
7
+ @name = name
8
+ @elements = []
9
+ end
10
+
11
+ def name
12
+ @name.to_s
13
+ end
14
+
15
+ def <<(element)
16
+ (@elements += [element].flatten).compact!
17
+ self
18
+ end
19
+
20
+ def to_params
21
+ value = self.elements.map{|param| Garb.to_google_analytics(param)}.join(',')
22
+ value.empty? ? {} : {self.name => value}
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,33 @@
1
+ module Garb
2
+ class ReportResponse
3
+ KEYS = ['dxp:metric', 'dxp:dimension']
4
+
5
+ def initialize(response_body)
6
+ @xml = response_body
7
+ end
8
+
9
+ def results
10
+ @results ||= parse
11
+ end
12
+
13
+ private
14
+ def parse
15
+ entries.map do |entry|
16
+ hash = values_for(entry).inject({}) do |h, v|
17
+ h.merge(Garb.from_ga(v['name']) => v['value'])
18
+ end
19
+
20
+ OpenStruct.new(hash)
21
+ end
22
+ end
23
+
24
+ def entries
25
+ entry_hash = Crack::XML.parse(@xml)
26
+ entry_hash ? [entry_hash['feed']['entry']].flatten : []
27
+ end
28
+
29
+ def values_for(entry)
30
+ KEYS.map {|k| entry[k]}.flatten.compact
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,5 @@
1
+ require 'garb/reports/exits'
2
+ require 'garb/reports/visits'
3
+ require 'garb/reports/bounces'
4
+ require 'garb/reports/pageviews'
5
+ require 'garb/reports/unique_pageviews'
@@ -0,0 +1,5 @@
1
+ class Bounces
2
+ extend Garb::Resource
3
+
4
+ metrics :bounces
5
+ end
@@ -0,0 +1,5 @@
1
+ class Exits
2
+ extend Garb::Resource
3
+
4
+ metrics :exits
5
+ end
@@ -0,0 +1,5 @@
1
+ class Pageviews
2
+ extend Garb::Resource
3
+
4
+ metrics :pageviews
5
+ end
@@ -0,0 +1,5 @@
1
+ class UniquePageviews
2
+ extend Garb::Resource
3
+
4
+ metrics :unique_pageviews
5
+ end
@@ -0,0 +1,5 @@
1
+ class Visits
2
+ extend Garb::Resource
3
+
4
+ metrics :visits
5
+ end
@@ -0,0 +1,92 @@
1
+ module Garb
2
+ module Resource
3
+ MONTH = 2592000
4
+ URL = "https://www.google.com/analytics/feeds/data"
5
+
6
+ def self.extended(base)
7
+ # define a method on a module that gets included into profile
8
+ # Exits would make:
9
+ # to enable profile.exits(options_hash, &block)
10
+ # returns Exits.results(self, options_hash, &block)
11
+ # every class defined which extends Resource will add to the module
12
+ ProfileReports.add_report_method(base)
13
+ end
14
+
15
+ %w(metrics dimensions sort).each do |parameter|
16
+ class_eval <<-CODE
17
+ def #{parameter}(*fields)
18
+ @#{parameter} ||= ReportParameter.new(:#{parameter})
19
+ @#{parameter} << fields
20
+ end
21
+
22
+ def clear_#{parameter}
23
+ @#{parameter} = ReportParameter.new(:#{parameter})
24
+ end
25
+ CODE
26
+ end
27
+
28
+ def filters(*hashes, &block)
29
+ @filter_parameters ||= FilterParameters.new
30
+
31
+ hashes.each do |hash|
32
+ @filter_parameters.parameters << hash
33
+ end
34
+
35
+ @filter_parameters.filters(&block) if block_given?
36
+ @filter_parameters
37
+ end
38
+
39
+ def clear_filters
40
+ @filter_parameters = FilterParameters.new
41
+ end
42
+
43
+ def results(profile, opts = {}, &block)
44
+ @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
45
+
46
+ if @profile
47
+ @start_date = opts.fetch(:start_date, Time.now - MONTH)
48
+ @end_date = opts.fetch(:end_date, Time.now)
49
+ @limit = opts.fetch(:limit, nil)
50
+ @offset = opts.fetch(:offset, nil)
51
+
52
+ instance_eval(&block) if block_given?
53
+
54
+ ReportResponse.new(send_request_for_body).results
55
+ else
56
+ []
57
+ end
58
+ end
59
+
60
+ def page_params
61
+ {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
62
+ end
63
+
64
+ def default_params
65
+ {'ids' => @profile.table_id,
66
+ 'start-date' => format_time(@start_date),
67
+ 'end-date' => format_time(@end_date)}
68
+ end
69
+
70
+ def params
71
+ [
72
+ metrics.to_params,
73
+ dimensions.to_params,
74
+ sort.to_params,
75
+ filters.to_params,
76
+ page_params
77
+ ].inject(default_params) do |p, i|
78
+ p.merge(i)
79
+ end
80
+ end
81
+
82
+ def format_time(t)
83
+ t.strftime('%Y-%m-%d')
84
+ end
85
+
86
+ def send_request_for_body
87
+ request = DataRequest.new(@profile.session, URL, params)
88
+ response = request.send_request
89
+ response.body
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,35 @@
1
+ module Garb
2
+ class Session
3
+ module Methods
4
+ attr_accessor :auth_token, :access_token, :email
5
+
6
+ # use only for single user authentication
7
+ def login(email, password, opts={})
8
+ self.email = email
9
+ auth_request = AuthenticationRequest.new(email, password, opts)
10
+ self.auth_token = auth_request.auth_token(opts)
11
+ end
12
+
13
+ def single_user?
14
+ auth_token && auth_token.is_a?(String)
15
+ end
16
+
17
+ def oauth_user?
18
+ !access_token.nil?
19
+ end
20
+
21
+ def auth_sub(token)
22
+ self.auth_token = token
23
+ @auth_sub = true
24
+ end
25
+
26
+ def auth_sub?
27
+ @auth_sub
28
+ end
29
+
30
+ end
31
+
32
+ include Methods
33
+ extend Methods
34
+ end
35
+ end
@@ -0,0 +1,13 @@
1
+ module Garb
2
+ module Version
3
+
4
+ MAJOR = 0
5
+ MINOR = 7
6
+ TINY = 4
7
+
8
+ def self.to_s # :nodoc:
9
+ [MAJOR, MINOR, TINY].join('.')
10
+ end
11
+
12
+ end
13
+ end
@@ -0,0 +1,39 @@
1
+ class SymbolOperator
2
+ def initialize(field, operator)
3
+ @field, @operator = field, operator
4
+ end unless method_defined?(:initialize)
5
+
6
+ def to_google_analytics
7
+ operators = {
8
+ :eql => '==',
9
+ :not_eql => '!=',
10
+ :gt => '>',
11
+ :gte => '>=',
12
+ :lt => '<',
13
+ :lte => '<=',
14
+ :matches => '==',
15
+ :does_not_match => '!=',
16
+ :contains => '=~',
17
+ :does_not_contain => '!~',
18
+ :substring => '=@',
19
+ :not_substring => '!@',
20
+ :desc => '-'
21
+ }
22
+
23
+ target = Garb.to_google_analytics(@field)
24
+ operator = operators[@operator]
25
+
26
+ @operator == :desc ? "#{operator}#{target}" : "#{target}#{operator}"
27
+ end
28
+ end
29
+
30
+ class Symbol
31
+ [:eql, :not_eql, :gt, :gte, :lt, :lte, :desc,
32
+ :matches, :does_not_match, :contains, :does_not_contain,
33
+ :substring, :not_substring].each do |operator|
34
+
35
+ define_method(operator) do
36
+ SymbolOperator.new(self, operator)
37
+ end unless method_defined?(operator)
38
+ end
39
+ end
@@ -0,0 +1,67 @@
1
+ ##
2
+ ## cacert.pem-foo -- Bundle of CA Root Certificates
3
+ ##
4
+ ## Converted at: Thu Mar 26 21:23:06 2009 UTC
5
+ ##
6
+ ## This is a bundle of X.509 certificates of public Certificate Authorities
7
+ ## (CA). These were automatically extracted from Mozilla's root certificates
8
+ ## file (certdata.txt). This file can be found in the mozilla source tree:
9
+ ## '/mozilla/security/nss/lib/ckfw/builtins/certdata.txt'
10
+ ##
11
+ ## It contains the certificates in PEM format and therefore
12
+ ## can be directly used with curl / libcurl / php_curl, or with
13
+ ## an Apache+mod_ssl webserver for SSL client authentication.
14
+ ## Just configure this file as the SSLCACertificateFile.
15
+ ##
16
+
17
+ # ***** BEGIN LICENSE BLOCK *****
18
+ # Version: MPL 1.1/GPL 2.0/LGPL 2.1
19
+ #
20
+ # The contents of this file are subject to the Mozilla Public License Version
21
+ # 1.1 (the "License"); you may not use this file except in compliance with
22
+ # the License. You may obtain a copy of the License at
23
+ # http://www.mozilla.org/MPL/
24
+ #
25
+ # Software distributed under the License is distributed on an "AS IS" basis,
26
+ # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
27
+ # for the specific language governing rights and limitations under the
28
+ # License.
29
+ #
30
+ # The Original Code is the Netscape security libraries.
31
+ #
32
+ # The Initial Developer of the Original Code is
33
+ # Netscape Communications Corporation.
34
+ # Portions created by the Initial Developer are Copyright (C) 1994-2000
35
+ # the Initial Developer. All Rights Reserved.
36
+ #
37
+ # Contributor(s):
38
+ #
39
+ # Alternatively, the contents of this file may be used under the terms of
40
+ # either the GNU General Public License Version 2 or later (the "GPL"), or
41
+ # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
42
+ # in which case the provisions of the GPL or the LGPL are applicable instead
43
+ # of those above. If you wish to allow use of your version of this file only
44
+ # under the terms of either the GPL or the LGPL, and not to allow others to
45
+ # use your version of this file under the terms of the MPL, indicate your
46
+ # decision by deleting the provisions above and replace them with the notice
47
+ # and other provisions required by the GPL or the LGPL. If you do not delete
48
+ # the provisions above, a recipient may use your version of this file under
49
+ # the terms of any one of the MPL, the GPL or the LGPL.
50
+ #
51
+ # ***** END LICENSE BLOCK *****
52
+ # @(#) $RCSfile: certdata.txt,v $ $Revision: 1.51 $ $Date: 2009/01/15 22:35:15 $
53
+
54
+ Verisign/RSA Secure Server CA
55
+ =============================
56
+ -----BEGIN CERTIFICATE-----
57
+ MIICNDCCAaECEAKtZn5ORf5eV288mBle3cAwDQYJKoZIhvcNAQECBQAwXzELMAkGA1UEBhMCVVMx
58
+ IDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQLEyVTZWN1cmUgU2VydmVy
59
+ IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk0MTEwOTAwMDAwMFoXDTEwMDEwNzIzNTk1OVow
60
+ XzELMAkGA1UEBhMCVVMxIDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQL
61
+ EyVTZWN1cmUgU2VydmVyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGbMA0GCSqGSIb3DQEBAQUA
62
+ A4GJADCBhQJ+AJLOesGugz5aqomDV6wlAXYMra6OLDfO6zV4ZFQD5YRAUcm/jwjiioII0haGN1Xp
63
+ sSECrXZogZoFokvJSyVmIlZsiAeP94FZbYQHZXATcXY+m3dM41CJVphIuR2nKRoTLkoRWZweFdVJ
64
+ VCxzOmmCsZc5nG1wZ0jl3S3WyB57AgMBAAEwDQYJKoZIhvcNAQECBQADfgBl3X7hsuyw4jrg7HFG
65
+ mhkRuNPHoLQDQCYCPgmc4RKz0Vr2N6W3YQO2WxZpO8ZECAyIUwxrl0nHPjXcbLm7qt9cuzovk2C2
66
+ qUtN8iD3zV9/ZHuO3ABc1/p3yjkWWW8O6tO1g39NTUJWdrTJXwT4OPjr0l91X817/OWOgHz8UA==
67
+ -----END CERTIFICATE-----