garb 0.9.7 → 0.9.9
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.
- checksums.yaml +5 -5
- data/.github/dependabot.yml +17 -0
- data/.github/workflows/ci.yml +30 -0
- data/.github/workflows/codeql-analysis.yml +46 -0
- data/.gitignore +1 -1
- data/CHANGELOG.md +78 -37
- data/Gemfile +5 -6
- data/LICENSE +22 -0
- data/README.md +125 -92
- data/Rakefile +2 -4
- data/garb.gemspec +4 -3
- data/lib/garb/attributes.rb +2 -1
- data/lib/garb/core_ext/string.rb +6 -6
- data/lib/garb/core_ext/symbol.rb +30 -19
- data/lib/garb/destination.rb +1 -1
- data/lib/garb/errors.rb +5 -3
- data/lib/garb/filter_parameters.rb +10 -5
- data/lib/garb/management/feed.rb +2 -2
- data/lib/garb/management/goal.rb +1 -1
- data/lib/garb/management/segment.rb +1 -1
- data/lib/garb/model.rb +41 -16
- data/lib/garb/profile_reports.rb +9 -1
- data/lib/garb/report_parameter.rb +2 -3
- data/lib/garb/report_response.rb +3 -4
- data/lib/garb/reports/visits.rb +1 -1
- data/lib/garb/request/authentication.rb +1 -1
- data/lib/garb/request/data.rb +13 -10
- data/lib/garb/result_set.rb +9 -7
- data/lib/garb/support.rb +1 -1
- data/lib/garb/version.rb +1 -3
- data/lib/garb.rb +7 -7
- data/test/test_helper.rb +6 -6
- data/test/unit/garb/management/account_test.rb +1 -1
- data/test/unit/garb/management/feed_test.rb +2 -2
- data/test/unit/garb/management/goal_test.rb +1 -1
- data/test/unit/garb/management/profile_test.rb +1 -1
- data/test/unit/garb/management/segment_test.rb +1 -9
- data/test/unit/garb/management/web_property_test.rb +1 -1
- data/test/unit/garb/model_test.rb +121 -6
- data/test/unit/garb/report_response_test.rb +1 -1
- data/test/unit/garb/result_set_test.rb +29 -0
- data/test/unit/symbol_operator_test.rb +21 -19
- metadata +23 -19
- data/.travis.yml +0 -7
|
@@ -11,11 +11,11 @@ module Garb
|
|
|
11
11
|
end
|
|
12
12
|
|
|
13
13
|
should "have a parsed response" do
|
|
14
|
-
|
|
14
|
+
JSON.stubs(:parse)
|
|
15
15
|
@feed.stubs(:response).returns(stub(:body => 'response body'))
|
|
16
16
|
@feed.parsed_response
|
|
17
17
|
|
|
18
|
-
assert_received(
|
|
18
|
+
assert_received(JSON, :parse) { |e| e.with('response body') }
|
|
19
19
|
end
|
|
20
20
|
|
|
21
21
|
should "have entries from the parsed response" do
|
|
@@ -31,7 +31,7 @@ module Garb
|
|
|
31
31
|
|
|
32
32
|
context "A Profile" do
|
|
33
33
|
setup do
|
|
34
|
-
entry =
|
|
34
|
+
entry = JSON.parse(read_fixture('ga_profile_management.json'))['items'].first
|
|
35
35
|
@profile = Profile.new(entry, Session)
|
|
36
36
|
end
|
|
37
37
|
|
|
@@ -19,15 +19,7 @@ module Garb
|
|
|
19
19
|
|
|
20
20
|
context "A Segment" do
|
|
21
21
|
setup do
|
|
22
|
-
entry =
|
|
23
|
-
"link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/segments/12"}],
|
|
24
|
-
"dxp:segment" => {
|
|
25
|
-
"id" => "gaid::-3",
|
|
26
|
-
"name" => "Returning Visitor",
|
|
27
|
-
"dxp:definition" => "ga:visitorType==Returning Visitor"
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
entry = MultiJson.load(read_fixture("ga_segment_management.json"))["items"].first
|
|
22
|
+
entry = JSON.parse(read_fixture('ga_segment_management.json'))['items'].first
|
|
31
23
|
@segment = Segment.new(entry, Session)
|
|
32
24
|
end
|
|
33
25
|
|
|
@@ -28,7 +28,7 @@ module Garb
|
|
|
28
28
|
|
|
29
29
|
context "a WebProperty" do
|
|
30
30
|
setup do
|
|
31
|
-
entry =
|
|
31
|
+
entry = JSON.parse(read_fixture('ga_webproperty_management.json'))['items'].first
|
|
32
32
|
|
|
33
33
|
@web_property = WebProperty.new(entry, Session)
|
|
34
34
|
end
|
|
@@ -41,7 +41,7 @@ module Garb
|
|
|
41
41
|
|
|
42
42
|
context "with a profile" do
|
|
43
43
|
setup do
|
|
44
|
-
entry =
|
|
44
|
+
entry = JSON.parse(read_fixture('ga_profile_management.json'))['items'].first
|
|
45
45
|
|
|
46
46
|
@profile = Garb::Management::Profile.new(entry, Session)
|
|
47
47
|
end
|
|
@@ -59,11 +59,12 @@ module Garb
|
|
|
59
59
|
now = Time.now
|
|
60
60
|
Time.stubs(:now).returns(now)
|
|
61
61
|
@params = {
|
|
62
|
-
'ids'
|
|
63
|
-
'start-date'
|
|
64
|
-
'end-date'
|
|
65
|
-
'metrics'
|
|
66
|
-
'dimensions'
|
|
62
|
+
'ids' => Garb.to_ga(@profile.id),
|
|
63
|
+
'start-date' => (now - Model::MONTH).strftime('%Y-%m-%d'),
|
|
64
|
+
'end-date' => now.strftime('%Y-%m-%d'),
|
|
65
|
+
'metrics' => 'ga:visits',
|
|
66
|
+
'dimensions' => 'ga:pagePath',
|
|
67
|
+
'samplingLevel' => 'default'
|
|
67
68
|
}
|
|
68
69
|
end
|
|
69
70
|
|
|
@@ -124,6 +125,16 @@ module Garb
|
|
|
124
125
|
assert_data_params(@params.merge({'sort' => 'sort value'}))
|
|
125
126
|
end
|
|
126
127
|
|
|
128
|
+
should "be able to specify sampling level" do
|
|
129
|
+
assert_equal @results, @test_model.results(@profile, :sampling_level => 'faster')
|
|
130
|
+
assert_data_params(@params.merge({'samplingLevel' => 'faster'}))
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
should "be able to specify sampling level as symbol" do
|
|
134
|
+
assert_equal @results, @test_model.results(@profile, :sampling_level => :faster)
|
|
135
|
+
assert_data_params(@params.merge({'samplingLevel' => 'faster'}))
|
|
136
|
+
end
|
|
137
|
+
|
|
127
138
|
should "be able to limit" do
|
|
128
139
|
assert_equal @results, @test_model.results(@profile, :limit => 20)
|
|
129
140
|
assert_data_params(@params.merge({'max-results' => 20}))
|
|
@@ -162,11 +173,115 @@ module Garb
|
|
|
162
173
|
assert_equal results.size, @results.total_results
|
|
163
174
|
end
|
|
164
175
|
|
|
176
|
+
should 'not modify the options passed with :all' do
|
|
177
|
+
@results.total_results = 10
|
|
178
|
+
options = { all: true, offset: 1 }
|
|
179
|
+
@test_model.results(@profile, options)
|
|
180
|
+
assert_equal({ all: true, offset: 1 }, options)
|
|
181
|
+
end
|
|
182
|
+
|
|
165
183
|
should "be able to fetch multiple pages of results with a limit" do
|
|
166
184
|
@results.total_results = 25
|
|
167
185
|
results = @test_model.all_results(@profile, :limit => 1)
|
|
168
186
|
assert_equal results.size, 1
|
|
169
187
|
end
|
|
188
|
+
|
|
189
|
+
should 'accept a limit given as a string when fetching all pages' do
|
|
190
|
+
@results.total_results = 25
|
|
191
|
+
results = @test_model.all_results(@profile, limit: '5')
|
|
192
|
+
assert_equal 5, results.size
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
should 'reject a limit lower than 1 when fetching all pages' do
|
|
196
|
+
assert_raises(ArgumentError) do
|
|
197
|
+
@test_model.all_results(@profile, limit: 0)
|
|
198
|
+
end
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
should 'stop at a short page when the total is unknown' do
|
|
202
|
+
@results.total_results = nil
|
|
203
|
+
results = @test_model.all_results(@profile)
|
|
204
|
+
assert_equal @results.to_a, results.to_a
|
|
205
|
+
assert_received(Request::Data, :new) { |e| e.once }
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
context 'when fetching all pages from an offset' do
|
|
209
|
+
setup do
|
|
210
|
+
@rows = (11..25).map { |i| "result ##{i}" }
|
|
211
|
+
pages = [@rows[0...10], @rows[10..-1]].map do |page|
|
|
212
|
+
result_set = ResultSet.new(page)
|
|
213
|
+
result_set.total_results = 25
|
|
214
|
+
stub(results: result_set)
|
|
215
|
+
end
|
|
216
|
+
ReportResponse.stubs(:new).returns(*pages)
|
|
217
|
+
|
|
218
|
+
@start_indexes = []
|
|
219
|
+
@max_results = []
|
|
220
|
+
Request::Data.stubs(:new).with do |_session, _url, params|
|
|
221
|
+
@start_indexes << params['start-index']
|
|
222
|
+
@max_results << params['max-results']
|
|
223
|
+
true
|
|
224
|
+
end.returns(stub(send_request: @response))
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
should 'continue paging from the given offset' do
|
|
228
|
+
results = @test_model.results(@profile, all: true, offset: 11)
|
|
229
|
+
assert_equal @rows, results.to_a
|
|
230
|
+
assert_equal [11, 21], @start_indexes
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
should 'accept an offset given as a string' do
|
|
234
|
+
results = @test_model.results(@profile, all: true, offset: '11')
|
|
235
|
+
assert_equal @rows, results.to_a
|
|
236
|
+
assert_equal [11, 21], @start_indexes
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
should 'apply the limit to rows after the offset' do
|
|
240
|
+
results = @test_model.results(@profile, all: true, offset: 11, limit: 12)
|
|
241
|
+
assert_equal @rows[0...12], results.to_a
|
|
242
|
+
assert_equal [11, 21], @start_indexes
|
|
243
|
+
assert_equal [12, 2], @max_results
|
|
244
|
+
end
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
should 'fetch all pages from the start with a nil offset' do
|
|
248
|
+
rows = (1..15).map { |i| "result ##{i}" }
|
|
249
|
+
pages = [rows[0...10], rows[10..-1]].map do |page|
|
|
250
|
+
result_set = ResultSet.new(page)
|
|
251
|
+
result_set.total_results = 15
|
|
252
|
+
stub(results: result_set)
|
|
253
|
+
end
|
|
254
|
+
ReportResponse.stubs(:new).returns(*pages)
|
|
255
|
+
|
|
256
|
+
results = @test_model.results(@profile, all: true, offset: nil)
|
|
257
|
+
assert_equal rows, results.to_a
|
|
258
|
+
assert_data_params(@params.merge('max-results' => 10_000))
|
|
259
|
+
assert_data_params(
|
|
260
|
+
@params.merge('max-results' => 10_000, 'start-index' => 11)
|
|
261
|
+
)
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
should 'return an empty result set when the offset is past the end' do
|
|
265
|
+
empty = ResultSet.new([])
|
|
266
|
+
empty.total_results = 25
|
|
267
|
+
ReportResponse.stubs(:new).returns(stub(results: empty))
|
|
268
|
+
|
|
269
|
+
results = @test_model.results(@profile, all: true, offset: 26)
|
|
270
|
+
assert_instance_of ResultSet, results
|
|
271
|
+
assert results.empty?
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
should 'reject an offset lower than 1' do
|
|
275
|
+
assert_raises(ArgumentError) do
|
|
276
|
+
@test_model.results(@profile, all: true, offset: 0)
|
|
277
|
+
end
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
should 'reject a non-numeric offset' do
|
|
281
|
+
assert_raises(ArgumentError) do
|
|
282
|
+
@test_model.results(@profile, all: true, offset: 'abc')
|
|
283
|
+
end
|
|
284
|
+
end
|
|
170
285
|
end
|
|
171
286
|
|
|
172
287
|
# should "return results as an array of the class it belongs to, if that class is an ActiveRecord descendant"
|
|
@@ -48,7 +48,7 @@ module Garb
|
|
|
48
48
|
|
|
49
49
|
should "return an empty array if there are no results" do
|
|
50
50
|
response = ReportResponse.new('result json')
|
|
51
|
-
|
|
51
|
+
JSON.stubs(:parse).with('result json').returns('rows' => [])
|
|
52
52
|
|
|
53
53
|
assert_equal [], response.results.to_a
|
|
54
54
|
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
require 'test_helper'
|
|
2
|
+
|
|
3
|
+
module Garb
|
|
4
|
+
class ResultSetTest < MiniTest::Unit::TestCase
|
|
5
|
+
context 'Adding result sets' do
|
|
6
|
+
setup do
|
|
7
|
+
@first = ResultSet.new(%w[a b])
|
|
8
|
+
@second = ResultSet.new(%w[c])
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
should 'concatenate the results' do
|
|
12
|
+
assert_equal %w[a b c], (@first + @second).to_a
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
should 'be sampled if any of the result sets is sampled' do
|
|
16
|
+
@second.sampled = true
|
|
17
|
+
assert((@first + @second).sampled?)
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
should 'not be sampled if none of the result sets is sampled' do
|
|
21
|
+
assert !(@first + @second).sampled?
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
should 'accept an array' do
|
|
25
|
+
assert_equal %w[a b c], (@first + %w[c]).to_a
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -14,24 +14,26 @@ class SymbolOperatorTest < MiniTest::Unit::TestCase
|
|
|
14
14
|
assert_equal "-ga:metric", SymbolOperator.new(:metric, :desc).to_google_analytics
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
17
|
+
should 'know if it is equal to another instance' do
|
|
18
|
+
op1 = SymbolOperator.new(:hello, '==')
|
|
19
|
+
op2 = SymbolOperator.new(:hello, '==')
|
|
20
|
+
assert_equal op1, op2
|
|
21
|
+
assert op1.eql?(op2)
|
|
22
|
+
assert_equal op1.hash, op2.hash
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
should 'not be equal to another instance if different target or operator' do
|
|
26
|
+
op1 = SymbolOperator.new(:hello1, '==')
|
|
27
|
+
op2 = SymbolOperator.new(:hello2, '==')
|
|
28
|
+
refute_equal op1, op2
|
|
29
|
+
refute op1.eql?(op2)
|
|
30
|
+
refute_equal op1.hash, op2.hash
|
|
31
|
+
|
|
32
|
+
op1 = SymbolOperator.new(:hello, '!=')
|
|
33
|
+
op2 = SymbolOperator.new(:hello, '==')
|
|
34
|
+
refute_equal op1, op2
|
|
35
|
+
refute op1.eql?(op2)
|
|
36
|
+
refute_equal op1.hash, op2.hash
|
|
37
|
+
end
|
|
36
38
|
end
|
|
37
39
|
end
|
metadata
CHANGED
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: garb
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.9.
|
|
4
|
+
version: 0.9.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Tony Pitale
|
|
8
8
|
- Sijawusz Pur Rahnama
|
|
9
|
-
autorequire:
|
|
9
|
+
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2026-11-21 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: activesupport
|
|
16
16
|
requirement: !ruby/object:Gem::Requirement
|
|
17
17
|
requirements:
|
|
18
|
-
- -
|
|
18
|
+
- - ">="
|
|
19
19
|
- !ruby/object:Gem::Version
|
|
20
20
|
version: '2.2'
|
|
21
21
|
type: :runtime
|
|
22
22
|
prerelease: false
|
|
23
23
|
version_requirements: !ruby/object:Gem::Requirement
|
|
24
24
|
requirements:
|
|
25
|
-
- -
|
|
25
|
+
- - ">="
|
|
26
26
|
- !ruby/object:Gem::Version
|
|
27
27
|
version: '2.2'
|
|
28
28
|
- !ruby/object:Gem::Dependency
|
|
29
|
-
name:
|
|
29
|
+
name: ostruct
|
|
30
30
|
requirement: !ruby/object:Gem::Requirement
|
|
31
31
|
requirements:
|
|
32
|
-
- -
|
|
32
|
+
- - "~>"
|
|
33
33
|
- !ruby/object:Gem::Version
|
|
34
|
-
version: '
|
|
34
|
+
version: '0.6'
|
|
35
35
|
type: :runtime
|
|
36
36
|
prerelease: false
|
|
37
37
|
version_requirements: !ruby/object:Gem::Requirement
|
|
38
38
|
requirements:
|
|
39
|
-
- -
|
|
39
|
+
- - "~>"
|
|
40
40
|
- !ruby/object:Gem::Version
|
|
41
|
-
version: '
|
|
41
|
+
version: '0.6'
|
|
42
42
|
description: ''
|
|
43
43
|
email:
|
|
44
44
|
- tony.pitale@viget.com
|
|
@@ -47,10 +47,13 @@ executables: []
|
|
|
47
47
|
extensions: []
|
|
48
48
|
extra_rdoc_files: []
|
|
49
49
|
files:
|
|
50
|
-
- .
|
|
51
|
-
- .
|
|
50
|
+
- ".github/dependabot.yml"
|
|
51
|
+
- ".github/workflows/ci.yml"
|
|
52
|
+
- ".github/workflows/codeql-analysis.yml"
|
|
53
|
+
- ".gitignore"
|
|
52
54
|
- CHANGELOG.md
|
|
53
55
|
- Gemfile
|
|
56
|
+
- LICENSE
|
|
54
57
|
- README.md
|
|
55
58
|
- Rakefile
|
|
56
59
|
- garb.gemspec
|
|
@@ -111,6 +114,7 @@ files:
|
|
|
111
114
|
- test/unit/garb/report_response_test.rb
|
|
112
115
|
- test/unit/garb/request/authentication_test.rb
|
|
113
116
|
- test/unit/garb/request/data_test.rb
|
|
117
|
+
- test/unit/garb/result_set_test.rb
|
|
114
118
|
- test/unit/garb/session_test.rb
|
|
115
119
|
- test/unit/garb_test.rb
|
|
116
120
|
- test/unit/symbol_operator_test.rb
|
|
@@ -118,24 +122,23 @@ homepage: http://github.com/Sija/garb
|
|
|
118
122
|
licenses:
|
|
119
123
|
- MIT
|
|
120
124
|
metadata: {}
|
|
121
|
-
post_install_message:
|
|
125
|
+
post_install_message:
|
|
122
126
|
rdoc_options: []
|
|
123
127
|
require_paths:
|
|
124
128
|
- lib
|
|
125
129
|
required_ruby_version: !ruby/object:Gem::Requirement
|
|
126
130
|
requirements:
|
|
127
|
-
- -
|
|
131
|
+
- - ">="
|
|
128
132
|
- !ruby/object:Gem::Version
|
|
129
|
-
version: '
|
|
133
|
+
version: '3.2'
|
|
130
134
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
131
135
|
requirements:
|
|
132
|
-
- -
|
|
136
|
+
- - ">="
|
|
133
137
|
- !ruby/object:Gem::Version
|
|
134
138
|
version: '0'
|
|
135
139
|
requirements: []
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
signing_key:
|
|
140
|
+
rubygems_version: 3.5.18
|
|
141
|
+
signing_key:
|
|
139
142
|
specification_version: 4
|
|
140
143
|
summary: Google Analytics API Ruby Wrapper
|
|
141
144
|
test_files:
|
|
@@ -164,6 +167,7 @@ test_files:
|
|
|
164
167
|
- test/unit/garb/report_response_test.rb
|
|
165
168
|
- test/unit/garb/request/authentication_test.rb
|
|
166
169
|
- test/unit/garb/request/data_test.rb
|
|
170
|
+
- test/unit/garb/result_set_test.rb
|
|
167
171
|
- test/unit/garb/session_test.rb
|
|
168
172
|
- test/unit/garb_test.rb
|
|
169
173
|
- test/unit/symbol_operator_test.rb
|