gosquared 0.0.1
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.
- data/Gemfile +14 -0
- data/README.md +3 -0
- data/Rakefile +14 -0
- data/gosquared.gemspec +28 -0
- data/lib/client.rb +58 -0
- data/lib/gosquared.rb +47 -0
- data/test/api.rb +17 -0
- data/test/event.rb +19 -0
- metadata +119 -0
data/Gemfile
ADDED
data/README.md
ADDED
data/Rakefile
ADDED
data/gosquared.gemspec
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
#!/usr/bin/env gem build
|
2
|
+
# -*- encoding: utf-8 -*-
|
3
|
+
lib = File.expand_path('../lib/', __FILE__)
|
4
|
+
$:.unshift lib unless $:.include?(lib)
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "gosquared"
|
8
|
+
spec.version = "0.0.1"
|
9
|
+
spec.authors = ["Geoff Wagstaff"]
|
10
|
+
spec.email = ["geoff@gosquared.com"]
|
11
|
+
spec.homepage = "https://www.gosquared.com/"
|
12
|
+
spec.summary = %q{Official GoSquared Ruby Client}
|
13
|
+
spec.description = %q{For use with the API and for tracking metrics}
|
14
|
+
|
15
|
+
# Packaged like a gem so that we can easily share it between projects
|
16
|
+
# spec.rubyforge_project = "infrastructure"
|
17
|
+
|
18
|
+
spec.files = Dir['lib/**/*', 'examples/**/*', 'benchmarks/**/*', 'Gemfile', 'gosquared.gemspec', 'Rakefile', 'README.md', 'LICENSE']
|
19
|
+
spec.executables = Dir['bin/*']
|
20
|
+
spec.test_files = Dir['test/**/*']
|
21
|
+
spec.require_paths = ['lib']
|
22
|
+
|
23
|
+
spec.add_development_dependency 'minitest', '~> 3.2.0'
|
24
|
+
spec.add_development_dependency 'rake', '~> 0.9.2'
|
25
|
+
|
26
|
+
spec.add_runtime_dependency 'faraday', '~> 0.8.5'
|
27
|
+
spec.add_runtime_dependency 'json', '~> 1.7.6'
|
28
|
+
end
|
data/lib/client.rb
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'faraday'
|
3
|
+
require 'uri'
|
4
|
+
require './config/default'
|
5
|
+
|
6
|
+
module GoSquared
|
7
|
+
class Client
|
8
|
+
@@opts = {}
|
9
|
+
Error = Class.new(StandardError)
|
10
|
+
|
11
|
+
def initialize(opts={})
|
12
|
+
@opts = @@opts.merge(opts)
|
13
|
+
debug 1, GoSquared::DEBUG_WARNING if opts[:site_token].nil?
|
14
|
+
@opts[:debugLevel] ||= GoSquared::DEBUG_DEFAULT_LEVEL
|
15
|
+
|
16
|
+
@req_opts = {
|
17
|
+
:site_token => opts[:site_token]
|
18
|
+
}
|
19
|
+
end
|
20
|
+
|
21
|
+
def RESTClient
|
22
|
+
@RESTClient ||= Faraday.new(:url => @url)
|
23
|
+
end
|
24
|
+
|
25
|
+
def get(path, query_params={})
|
26
|
+
response = RESTClient().get do | req |
|
27
|
+
req.url url + path
|
28
|
+
req.params = @req_opts.merge(query_params)
|
29
|
+
end
|
30
|
+
return false unless response.status.to_s.start_with?("20")
|
31
|
+
parse(response.body)
|
32
|
+
end
|
33
|
+
|
34
|
+
def post(path, query_params, post_body="")
|
35
|
+
response = RESTClient().post do | req |
|
36
|
+
req.url url + path
|
37
|
+
req.headers['Content-Type'] = 'application/json'
|
38
|
+
req.params = @req_opts.merge(query_params)
|
39
|
+
req.body = post_body
|
40
|
+
end
|
41
|
+
return false unless response.status.to_s.start_with?("20")
|
42
|
+
parse(response.body)
|
43
|
+
end
|
44
|
+
|
45
|
+
def parse(content)
|
46
|
+
JSON.parse(content)
|
47
|
+
end
|
48
|
+
|
49
|
+
def debug(code, level, extra)
|
50
|
+
return true if (@opts[:debugLevel] & level).zero?
|
51
|
+
|
52
|
+
stream = level > GoSquared::DEBUG_LEVELS[:NOTICE] ? $stdout : $stderr
|
53
|
+
|
54
|
+
# Errors are machine-parseable
|
55
|
+
stream.printf "[GoSquared][%s]:%s\n", level, JSON.generate({message: GoSquared::DEBUG_CODES[code], code: code, extra: extra})
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
data/lib/gosquared.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
require './lib/client'
|
2
|
+
module GoSquared
|
3
|
+
class API < Client
|
4
|
+
API_VERSION = ENV.fetch('GOSQUARED_API_VERSION') { "latest" }
|
5
|
+
|
6
|
+
def initialize(opts={})
|
7
|
+
super
|
8
|
+
debug 2, GoSquared::DEBUG_LEVELS[:WARNING] if @opts[:api_key].nil?
|
9
|
+
debug 3, GoSquared::DEBUG_LEVELS[:NOTICE], {:api_version => API_VERSION} if @opts[:api_version].nil?
|
10
|
+
|
11
|
+
@req_opts[:api_key] = @opts[:api_key]
|
12
|
+
@opts[:api_version] ||= API_VERSION
|
13
|
+
end
|
14
|
+
|
15
|
+
def url
|
16
|
+
@url ||= GoSquared::API_ENDPOINT + '/' + @opts[:api_version]
|
17
|
+
end
|
18
|
+
|
19
|
+
GoSquared::API_FUNCTIONS.each do | func_name |
|
20
|
+
define_method(func_name) { | func_params={} |
|
21
|
+
get("/#{func_name}", func_params)
|
22
|
+
}
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
class Event < Client
|
27
|
+
|
28
|
+
def initialize(opts={})
|
29
|
+
super
|
30
|
+
end
|
31
|
+
|
32
|
+
def url
|
33
|
+
@url ||= GoSquared::EVENT_ENDPOINT
|
34
|
+
end
|
35
|
+
|
36
|
+
def store_event(name, params={})
|
37
|
+
debug 4, GoSquared::DEBUG_LEVELS[:WARNING] if name.nil?
|
38
|
+
|
39
|
+
params = JSON.generate(params)
|
40
|
+
query_params = {
|
41
|
+
:_name => name
|
42
|
+
}
|
43
|
+
post('/event', query_params, params)
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
data/test/api.rb
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
require 'minitest/autorun'
|
2
|
+
|
3
|
+
require 'gosquared'
|
4
|
+
|
5
|
+
describe GoSquared do
|
6
|
+
before do
|
7
|
+
@gosquared = GoSquared::API.new(:site_token => "GSN-106863-S", :api_key => "demo")
|
8
|
+
end
|
9
|
+
|
10
|
+
describe "getting functions" do
|
11
|
+
GoSquared::API_FUNCTIONS.each do | func_name |
|
12
|
+
it "gets #{func_name}" do
|
13
|
+
response = @gosquared.send(func_name)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
data/test/event.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'minitest/autorun'
|
2
|
+
|
3
|
+
require 'gosquared'
|
4
|
+
|
5
|
+
describe GoSquared do
|
6
|
+
before do
|
7
|
+
@gosquared = GoSquared::Event.new(:site_token => "GSN-106863-S")
|
8
|
+
end
|
9
|
+
|
10
|
+
describe "storing events" do
|
11
|
+
it "stores an event with name and parameters" do
|
12
|
+
response = @gosquared.store_event "Test Event", {:random => "params", :cause => "I can"}
|
13
|
+
end
|
14
|
+
|
15
|
+
it "stores an event with name and without parameters" do
|
16
|
+
response = @gosquared.store_event "Test Event"
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: gosquared
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Geoff Wagstaff
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-02-12 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: minitest
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: 3.2.0
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 3.2.0
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: 0.9.2
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: 0.9.2
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: faraday
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ~>
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 0.8.5
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.8.5
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: json
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ~>
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: 1.7.6
|
70
|
+
type: :runtime
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ~>
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: 1.7.6
|
78
|
+
description: For use with the API and for tracking metrics
|
79
|
+
email:
|
80
|
+
- geoff@gosquared.com
|
81
|
+
executables: []
|
82
|
+
extensions: []
|
83
|
+
extra_rdoc_files: []
|
84
|
+
files:
|
85
|
+
- lib/client.rb
|
86
|
+
- lib/gosquared.rb
|
87
|
+
- Gemfile
|
88
|
+
- gosquared.gemspec
|
89
|
+
- Rakefile
|
90
|
+
- README.md
|
91
|
+
- test/api.rb
|
92
|
+
- test/event.rb
|
93
|
+
homepage: https://www.gosquared.com/
|
94
|
+
licenses: []
|
95
|
+
post_install_message:
|
96
|
+
rdoc_options: []
|
97
|
+
require_paths:
|
98
|
+
- lib
|
99
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
100
|
+
none: false
|
101
|
+
requirements:
|
102
|
+
- - ! '>='
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
none: false
|
107
|
+
requirements:
|
108
|
+
- - ! '>='
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
requirements: []
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 1.8.23
|
114
|
+
signing_key:
|
115
|
+
specification_version: 3
|
116
|
+
summary: Official GoSquared Ruby Client
|
117
|
+
test_files:
|
118
|
+
- test/api.rb
|
119
|
+
- test/event.rb
|