tryterra-client 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +93 -0
- data/examples/example.rb +58 -0
- data/lib/API/Athelete.rb +42 -0
- data/lib/API/Data.rb +53 -0
- data/lib/API/GenerateWidgetSession.rb +63 -0
- data/lib/API/Helpers.rb +19 -0
- data/lib/API/Providers.rb +40 -0
- data/lib/API/Subscribers.rb +40 -0
- data/lib/API/TerraError.rb +20 -0
- data/lib/API/TerraResponse.rb +25 -0
- data/lib/API/TerraWebhook.rb +21 -0
- data/lib/API/Users.rb +59 -0
- data/lib/Terra.rb +119 -0
- data/spec/tests.rb +46 -0
- metadata +58 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 22e3432c218c7f596453a33a5633964fcc145204592ea6e5044d90aa09b9abae
|
4
|
+
data.tar.gz: 9739770e8d343aa11ae76f0df4dab774a7c9c7de8d7c6e219f31f7a2769a3048
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 411fae0a57e0bcc938cb6f5721e7dace1d6e688a0544d08772b611891a7f287fe747a99cee6a1173b5be69632214c1c7398ffdbf34be56615f8188dbb4201b86
|
7
|
+
data.tar.gz: 1d4107d19edeb76b799b8327a084d27b2e6ae21f294f34461ba1f1810f9fca6c2d9ee41c02f49adf204b95b64c7e6cf179fc8a547cf247c303aaf2f62e799ffd
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
# Terra Ruby Package
|
2
|
+
|
3
|
+
A wrapper in ruby for the Terra endpoints and models.
|
4
|
+
|
5
|
+
|
6
|
+
Install using
|
7
|
+
|
8
|
+
```sh
|
9
|
+
gem install tryterra-client
|
10
|
+
```
|
11
|
+
|
12
|
+
Then import the `TerraAPI` class from Terra
|
13
|
+
|
14
|
+
Initialise a new TerraAPI instance with:
|
15
|
+
|
16
|
+
```rb
|
17
|
+
begin
|
18
|
+
terra = TerraAPI::Terra.new(YOUR_DEV_ID, YOUR_API_KEY)
|
19
|
+
rescue TerraError => e
|
20
|
+
# Handle errors here
|
21
|
+
end
|
22
|
+
```
|
23
|
+
|
24
|
+
Now you can call the following functions from the instance:
|
25
|
+
|
26
|
+
- `get_atheletes(user_id:string, to_webhook:boolean_optional)`
|
27
|
+
- `generate_widget_session(
|
28
|
+
reference_id:string,
|
29
|
+
providers:array_of_string,
|
30
|
+
language:string,
|
31
|
+
auth_success_redirect_url:string,
|
32
|
+
auth_failure_redirect_url:string
|
33
|
+
)`
|
34
|
+
- `get_providers`
|
35
|
+
- `get_subscribers`
|
36
|
+
- `get_user(user_id:string)`
|
37
|
+
- `deauthUser(user_id:string)`
|
38
|
+
- `get_activity(
|
39
|
+
user_id:string,
|
40
|
+
start_date:date,
|
41
|
+
end_date:date_optional,
|
42
|
+
to_webhook:boolean_optional
|
43
|
+
)`
|
44
|
+
- `get_daily(
|
45
|
+
user_id:string,
|
46
|
+
start_date:date,
|
47
|
+
end_date:date_optional,
|
48
|
+
to_webhook:boolean_optional
|
49
|
+
)`
|
50
|
+
- `get_body(
|
51
|
+
user_id:string,
|
52
|
+
start_date:date,
|
53
|
+
end_date:date_optional,
|
54
|
+
to_webhook:boolean_optional
|
55
|
+
)`
|
56
|
+
- `get_sleep(
|
57
|
+
user_id:string,
|
58
|
+
start_date:date,
|
59
|
+
end_date:date_optional,
|
60
|
+
to_webhook:boolean_optional
|
61
|
+
)`
|
62
|
+
- `get_menstruation(
|
63
|
+
user_id:string,
|
64
|
+
start_date:date,
|
65
|
+
end_date:date_optional,
|
66
|
+
to_webhook:boolean_optional
|
67
|
+
)`
|
68
|
+
- `parse_webhook(payload:object, type:string, user_id:string_optional)`
|
69
|
+
|
70
|
+
In addition, all the data models documented on https://docs.tryterra.co/data-models are available to import and use.
|
71
|
+
|
72
|
+
## Example
|
73
|
+
|
74
|
+
```rb
|
75
|
+
require 'Terra'
|
76
|
+
|
77
|
+
begin
|
78
|
+
terra = TerraAPI::Terra.new(YOUR_DEV_ID, YOUR_API_KEY)
|
79
|
+
rescue TerraError => e
|
80
|
+
# Handle errors here
|
81
|
+
end
|
82
|
+
|
83
|
+
begin
|
84
|
+
puts terra.getProviders # will display a list of available providers
|
85
|
+
rescue TerraError => e
|
86
|
+
# Handle errors here
|
87
|
+
end
|
88
|
+
```
|
89
|
+
|
90
|
+
The result will be
|
91
|
+
```
|
92
|
+
{"status"=>"success", "providers"=>["FITBIT", "OURA", "TRAININGPEAKS", "WITHINGS", "SUUNTO", "PELOTON", "ZWIFT", "GARMIN", "EIGHT", "WAHOO", "GOOGLE", "POLAR", "WEAROS", "FREESTYLELIBRE", "TEMPO", "IFIT", "CONCEPT2", "FATSECRET", "CRONOMETER", "MYFITNESSPAL", "NUTRACHECK", "UNDERARMOUR", "OMRON", "RENPHO", "DEXCOM"]}
|
93
|
+
```
|
data/examples/example.rb
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
require 'Terra'
|
2
|
+
|
3
|
+
#initialize the api here
|
4
|
+
begin
|
5
|
+
terra = TerraAPI::Terra.new("testingAnis2", "O571xuiDDS9aGXlqro9youav9YOwD3r57YqC7bj0")
|
6
|
+
rescue TerraError => e
|
7
|
+
puts e
|
8
|
+
end
|
9
|
+
|
10
|
+
begin
|
11
|
+
test = terra.get_providers
|
12
|
+
rescue TerraError => e
|
13
|
+
puts e
|
14
|
+
else
|
15
|
+
puts test
|
16
|
+
end
|
17
|
+
|
18
|
+
begin
|
19
|
+
puts terra.get_subscribers
|
20
|
+
rescue TerraError => e
|
21
|
+
puts e
|
22
|
+
end
|
23
|
+
|
24
|
+
#begin
|
25
|
+
# puts terra.generate_widget_session(
|
26
|
+
# "",
|
27
|
+
# ["GARMIN", "FITBIT", "OURA"],
|
28
|
+
# "EN",
|
29
|
+
# "https://tryterra.co",
|
30
|
+
# "https://google.com"
|
31
|
+
# )
|
32
|
+
#rescue TerraError => e
|
33
|
+
# puts e
|
34
|
+
#end
|
35
|
+
|
36
|
+
#begin
|
37
|
+
# puts terra.get_user(YOUR_USER_ID)
|
38
|
+
#rescue TerraError => e
|
39
|
+
# puts e
|
40
|
+
#end
|
41
|
+
|
42
|
+
#begin
|
43
|
+
# puts terra.deauth_user(YOUR_USER_ID)
|
44
|
+
#rescue TerraError => e
|
45
|
+
# puts e
|
46
|
+
#end
|
47
|
+
|
48
|
+
#begin
|
49
|
+
# puts terra.get_athelete(YOUR_USER_ID)
|
50
|
+
#rescue TerraError => e
|
51
|
+
# puts e
|
52
|
+
#end
|
53
|
+
|
54
|
+
#begin
|
55
|
+
# puts terra.get_activity(YOUR_USER_ID, Time.new)
|
56
|
+
#rescue TerraError => e
|
57
|
+
# puts e
|
58
|
+
#end
|
data/lib/API/Athelete.rb
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'httparty'
|
16
|
+
require 'json'
|
17
|
+
require 'API/TerraError'
|
18
|
+
require 'API/TerraResponse'
|
19
|
+
module Athelete
|
20
|
+
def self.get(dev_id, api_key, api_path, user_id, to_webhook)
|
21
|
+
|
22
|
+
options = {
|
23
|
+
"headers" => {
|
24
|
+
"X-API-Key"=> api_key,
|
25
|
+
"dev-id"=> dev_id,
|
26
|
+
"Content-Type"=> "application/json",
|
27
|
+
}
|
28
|
+
}
|
29
|
+
|
30
|
+
res = HTTParty.get(
|
31
|
+
"#{api_path}/athlete?user_id=#{user_id}&to_webhook=#{to_webhook}",
|
32
|
+
:headers=>options["headers"]
|
33
|
+
)
|
34
|
+
|
35
|
+
case res.code
|
36
|
+
when 200
|
37
|
+
return TerraResponse::parseBody(res)
|
38
|
+
when 400...600
|
39
|
+
raise TerraError.new(res)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
data/lib/API/Data.rb
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "API/Helpers"
|
16
|
+
require 'API/TerraResponse'
|
17
|
+
|
18
|
+
module Data
|
19
|
+
def self.get_data(
|
20
|
+
type,
|
21
|
+
dev_id,
|
22
|
+
api_key,
|
23
|
+
api_path,
|
24
|
+
user_id,
|
25
|
+
startDate,
|
26
|
+
endDate,
|
27
|
+
to_webhook
|
28
|
+
)
|
29
|
+
options = {
|
30
|
+
"headers" => {
|
31
|
+
"X-API-Key" => api_key,
|
32
|
+
"dev-id" => dev_id,
|
33
|
+
"Content-Type" => "application/json",
|
34
|
+
},
|
35
|
+
}
|
36
|
+
|
37
|
+
url = "#{api_path}/#{type}?user_id=#{user_id}&start_date=#{Helpers::GetTerraDate(startDate)}"
|
38
|
+
if(endDate)
|
39
|
+
url += "&end_date=#{Helpers::GetTerraDate(endDate)}"
|
40
|
+
end
|
41
|
+
|
42
|
+
url += "&to_webhook=#{to_webhook}"
|
43
|
+
|
44
|
+
res = HTTParty.get("#{url}", :headers=>options["headers"])
|
45
|
+
|
46
|
+
case res.code
|
47
|
+
when 200
|
48
|
+
return TerraResponse::parseBody(res)
|
49
|
+
when 400...600
|
50
|
+
raise TerraError.new(res)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'httparty'
|
16
|
+
require 'json'
|
17
|
+
require 'API/TerraError'
|
18
|
+
require 'API/TerraResponse'
|
19
|
+
|
20
|
+
module GWS
|
21
|
+
def self.generate_widget_session(
|
22
|
+
dev_id,
|
23
|
+
api_key,
|
24
|
+
api_path,
|
25
|
+
referenceId,
|
26
|
+
providers,
|
27
|
+
language,
|
28
|
+
auth_success_redirect_url,
|
29
|
+
auth_failure_redirect_url
|
30
|
+
)
|
31
|
+
data = {
|
32
|
+
"reference_id" => referenceId,
|
33
|
+
"providers" => providers.join(','),
|
34
|
+
"auth_failure_redirect_url" => auth_failure_redirect_url,
|
35
|
+
"auth_success_redirect_url" => auth_success_redirect_url,
|
36
|
+
"language" => language
|
37
|
+
}
|
38
|
+
|
39
|
+
data = data.to_json
|
40
|
+
|
41
|
+
options = {
|
42
|
+
"headers" => {
|
43
|
+
"X-API-Key" => api_key,
|
44
|
+
"dev-id" => dev_id,
|
45
|
+
"Content-Type" => "application/json",
|
46
|
+
}
|
47
|
+
}
|
48
|
+
|
49
|
+
res = HTTParty.post(
|
50
|
+
"#{api_path}/auth/generate_widget_session",
|
51
|
+
:headers=>options["headers"],
|
52
|
+
:body=>data
|
53
|
+
)
|
54
|
+
|
55
|
+
body = JSON.parse(res.body)
|
56
|
+
case body["status"]
|
57
|
+
when "success"
|
58
|
+
return TerraResponse::parseBody(res)
|
59
|
+
else
|
60
|
+
raise TerraError.new(res)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
data/lib/API/Helpers.rb
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
module Helpers
|
16
|
+
def self.GetTerraDate(d)
|
17
|
+
return "#{d.year}-#{d.month}-#{d.day}"
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'httparty'
|
16
|
+
require 'API/TerraError'
|
17
|
+
require 'API/TerraResponse'
|
18
|
+
|
19
|
+
module Provider
|
20
|
+
def self.get_providers(dev_id, api_key, api_path)
|
21
|
+
options = {
|
22
|
+
"headers" => {
|
23
|
+
"X-API-Key" => api_key,
|
24
|
+
"dev-id" => dev_id,
|
25
|
+
"Content-Type" => "application/json",
|
26
|
+
},
|
27
|
+
}
|
28
|
+
|
29
|
+
res = HTTParty.get(
|
30
|
+
"#{api_path}/integrations",
|
31
|
+
:headers=>options["headers"]
|
32
|
+
)
|
33
|
+
case res.code
|
34
|
+
when 200
|
35
|
+
return TerraResponse::parseBody(res)
|
36
|
+
when 400...600
|
37
|
+
raise TerraError.new(res)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'httparty'
|
16
|
+
require 'API/TerraError'
|
17
|
+
require 'API/TerraResponse'
|
18
|
+
|
19
|
+
module Subscribers
|
20
|
+
def self.get_subscribers(dev_id, api_key, api_path)
|
21
|
+
options = {
|
22
|
+
"headers" => {
|
23
|
+
"X-API-Key" => api_key,
|
24
|
+
"dev-id" => dev_id,
|
25
|
+
"Content-Type" => "application/json",
|
26
|
+
},
|
27
|
+
}
|
28
|
+
|
29
|
+
res = HTTParty.get(
|
30
|
+
"#{api_path}/subscriptions",
|
31
|
+
:headers=>options["headers"]
|
32
|
+
)
|
33
|
+
case res.code
|
34
|
+
when 200
|
35
|
+
return TerraResponse::parseBody(res)
|
36
|
+
when 400...600
|
37
|
+
raise TerraError.new(res)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
class TerraError < StandardError
|
16
|
+
def initialize(error)
|
17
|
+
@error = error
|
18
|
+
super(error)
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'json'
|
16
|
+
module TerraResponse
|
17
|
+
def self.parseBody(response)
|
18
|
+
return JSON.parse(response.body)
|
19
|
+
end
|
20
|
+
|
21
|
+
def self.parseResponse(response)
|
22
|
+
return JSON.parse(response)
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "API/TerraResponse"
|
16
|
+
class TerraWebhook
|
17
|
+
def initialize(res, type, user)
|
18
|
+
@json = TerraResponse::parse(res)
|
19
|
+
@type = type
|
20
|
+
end
|
21
|
+
end
|
data/lib/API/Users.rb
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'httparty'
|
16
|
+
require 'API/TerraError'
|
17
|
+
require 'API/TerraResponse'
|
18
|
+
|
19
|
+
module Users
|
20
|
+
def self.get_user(dev_id, api_key, api_path, user_id)
|
21
|
+
options = {
|
22
|
+
"headers" => {
|
23
|
+
"X-API-Key" => api_key,
|
24
|
+
"dev-id" => dev_id,
|
25
|
+
"Content-Type" => "application/json",
|
26
|
+
},
|
27
|
+
}
|
28
|
+
|
29
|
+
res = HTTParty.get(
|
30
|
+
"#{api_path}/userInfo?user_id=#{user_id}",
|
31
|
+
:headers=>options["headers"]
|
32
|
+
)
|
33
|
+
|
34
|
+
case res.code
|
35
|
+
when 200
|
36
|
+
return TerraResponse::parseBody(res)
|
37
|
+
when 400...600
|
38
|
+
raise TerraError.new(res)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
def self.deauth_user(dev_id, api_key, api_path, user_id)
|
43
|
+
options = {
|
44
|
+
"headers" => {
|
45
|
+
"X-API-Key" => api_key,
|
46
|
+
"dev-id" => dev_id,
|
47
|
+
"Content-Type" => "application/json",
|
48
|
+
},
|
49
|
+
}
|
50
|
+
|
51
|
+
begin
|
52
|
+
res = HTTParty.delete("#{api_path}/auth/deauthenticateUser?user_id=#{user_id}", :headers=>options["headers"])
|
53
|
+
rescue HTTParty::Error => e
|
54
|
+
raise TerraError.new(e)
|
55
|
+
else
|
56
|
+
return TerraResponse::parseBody(res)
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
data/lib/Terra.rb
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
# Copyright 2022 Terra Enabling Developers Limited
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "httparty"
|
16
|
+
require "API/Athelete"
|
17
|
+
require "API/GenerateWidgetSession"
|
18
|
+
require "API/Providers"
|
19
|
+
require "API/Subscribers"
|
20
|
+
require "API/Users"
|
21
|
+
require "API/Data"
|
22
|
+
require "API/Helpers"
|
23
|
+
require "API/TerraWebhook"
|
24
|
+
|
25
|
+
|
26
|
+
module TerraAPI
|
27
|
+
class Terra
|
28
|
+
def initialize(dev_id, api_key)
|
29
|
+
|
30
|
+
@api_path = "https://api.tryterra.co/v2"
|
31
|
+
|
32
|
+
options = {
|
33
|
+
"headers" => {
|
34
|
+
"X-API-Key" => api_key,
|
35
|
+
"dev-id" => dev_id,
|
36
|
+
"Content-Type" => "application/json",
|
37
|
+
},
|
38
|
+
}
|
39
|
+
|
40
|
+
res = HTTParty.get("#{@api_path}/subscriptions", :headers=>options["headers"])
|
41
|
+
case res.code
|
42
|
+
when 200
|
43
|
+
@api_key = api_key
|
44
|
+
@dev_id = dev_id
|
45
|
+
puts "Successfuly connected to the API"
|
46
|
+
when 400...600
|
47
|
+
raise TerraError.new(res)
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def get_athelete(user_id, to_webhook=false)
|
52
|
+
return Athelete::get(@dev_id, @api_key, @api_path, user_id, to_webhook,)
|
53
|
+
end
|
54
|
+
|
55
|
+
def generate_widget_session(
|
56
|
+
reference_id,
|
57
|
+
providers,
|
58
|
+
language,
|
59
|
+
auth_success_redirect_url,
|
60
|
+
auth_failure_redirect_url
|
61
|
+
)
|
62
|
+
return GWS::generate_widget_session(
|
63
|
+
@dev_id,
|
64
|
+
@api_key,
|
65
|
+
@api_path,
|
66
|
+
reference_id,
|
67
|
+
providers,
|
68
|
+
language,
|
69
|
+
auth_success_redirect_url,
|
70
|
+
auth_failure_redirect_url
|
71
|
+
)
|
72
|
+
end
|
73
|
+
|
74
|
+
def get_providers()
|
75
|
+
return Provider::get_providers(@dev_id, @api_key, @api_path)
|
76
|
+
end
|
77
|
+
|
78
|
+
def get_subscribers()
|
79
|
+
return Subscribers::get_subscribers(@dev_id, @api_key, @api_path)
|
80
|
+
end
|
81
|
+
|
82
|
+
def get_user(user_id)
|
83
|
+
return Users::get_user(@dev_id, @api_key, @api_path, user_id)
|
84
|
+
end
|
85
|
+
|
86
|
+
def deauth_user(user_id)
|
87
|
+
return Users::deauth_user(@dev_id, @api_key, @api_path, user_id)
|
88
|
+
end
|
89
|
+
|
90
|
+
private def get_data(type, user_id, start_date, end_date, to_webhook=false)
|
91
|
+
return Data::get_data(type, @dev_id, @api_key, @api_path, user_id, start_date, end_date, to_webhook)
|
92
|
+
end
|
93
|
+
|
94
|
+
def get_activity(user_id, start_date, end_date=nil, to_webhook=false)
|
95
|
+
return get_data("activity", user_id, start_date, end_date, to_webhook)
|
96
|
+
end
|
97
|
+
|
98
|
+
def get_daily(user_id, start_date, end_date=nil, to_webhook=false)
|
99
|
+
return get_data("daily", user_id, start_date, end_date, to_webhook)
|
100
|
+
end
|
101
|
+
|
102
|
+
def get_body(user_id, start_date, end_date=nil, to_webhook=false)
|
103
|
+
return get_data("body", start_date, end_date, to_webhook)
|
104
|
+
end
|
105
|
+
|
106
|
+
def get_sleep(user_id, start_date, end_date=nil, to_webhook=false)
|
107
|
+
return get_data("sleep", user_id, start_date, end_date, to_webhook)
|
108
|
+
end
|
109
|
+
|
110
|
+
def get_menstruation(user_id, start_date, end_date=nil, to_webhook=false)
|
111
|
+
return get_data("menstruation", user_id, start_date, end_date, to_webhook)
|
112
|
+
end
|
113
|
+
|
114
|
+
def parse_webhook(payload, type, user_id=nil)
|
115
|
+
return TerraWebhook.new(playload, type, user_id)
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
data/spec/tests.rb
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'Terra'
|
2
|
+
require 'rspec/autorun'
|
3
|
+
require 'API/Providers'
|
4
|
+
|
5
|
+
describe TerraAPI::Terra do
|
6
|
+
describe "#getProviders" do
|
7
|
+
it "returns the providers list" do
|
8
|
+
providers = double("Provider", get_providers: "provider_list")
|
9
|
+
terra = double("TerraAPI::Terra")
|
10
|
+
|
11
|
+
begin
|
12
|
+
terra = TerraAPI::Terra.new("testingAnis", "O571xuiDDS9aGXlqro9youav9YOwD3r57YqC7bj0")
|
13
|
+
rescue TerraError => e
|
14
|
+
puts e
|
15
|
+
end
|
16
|
+
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
describe "#getSubscribers" do
|
21
|
+
it "returns the subscribers list" do
|
22
|
+
subs = double("Subscribers", get_subscribers: "subscribers_list")
|
23
|
+
terra = double("TerraAPI::Terra")
|
24
|
+
|
25
|
+
allow(terra).to receive(:getSubscribers).and_return(subs.get_subscribers)
|
26
|
+
|
27
|
+
expect(terra.getSubscribers).to eq("subscribers_list")
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
describe "#getUser" do
|
32
|
+
it "returns User informations" do
|
33
|
+
user = double("Users")
|
34
|
+
terra = double("TerraAPI::Terra")
|
35
|
+
|
36
|
+
allow(user).to receive(:get_user).with("test_user1").and_return("test_user1 data")
|
37
|
+
allow(terra).to receive(:getUser).with("test_user1").and_return(user.get_user("test_user1"))
|
38
|
+
expect(terra.getUser("test_user1")).to eq("test_user1 data")
|
39
|
+
|
40
|
+
|
41
|
+
allow(user).to receive(:get_user).with("test_user2").and_return("test_user2 data")
|
42
|
+
allow(terra).to receive(:getUser).with("test_user2").and_return(user.get_user("test_user2"))
|
43
|
+
expect(terra.getUser("test_user2")).to eq("test_user2 data")
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
metadata
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: tryterra-client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Anis
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-10-07 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: Ruby client for tryterra api
|
14
|
+
email: dev@tryterra.co
|
15
|
+
executables: []
|
16
|
+
extensions: []
|
17
|
+
extra_rdoc_files: []
|
18
|
+
files:
|
19
|
+
- LICENSE
|
20
|
+
- README.md
|
21
|
+
- examples/example.rb
|
22
|
+
- lib/API/Athelete.rb
|
23
|
+
- lib/API/Data.rb
|
24
|
+
- lib/API/GenerateWidgetSession.rb
|
25
|
+
- lib/API/Helpers.rb
|
26
|
+
- lib/API/Providers.rb
|
27
|
+
- lib/API/Subscribers.rb
|
28
|
+
- lib/API/TerraError.rb
|
29
|
+
- lib/API/TerraResponse.rb
|
30
|
+
- lib/API/TerraWebhook.rb
|
31
|
+
- lib/API/Users.rb
|
32
|
+
- lib/Terra.rb
|
33
|
+
- spec/tests.rb
|
34
|
+
homepage: https://docs.tryterra.co/docs/ruby-project
|
35
|
+
licenses:
|
36
|
+
- MIT
|
37
|
+
metadata:
|
38
|
+
source_code_uri: https://github.com/tryterra/terra-client-ruby
|
39
|
+
post_install_message:
|
40
|
+
rdoc_options: []
|
41
|
+
require_paths:
|
42
|
+
- lib
|
43
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
49
|
+
requirements:
|
50
|
+
- - ">="
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: '0'
|
53
|
+
requirements: []
|
54
|
+
rubygems_version: 3.0.3.1
|
55
|
+
signing_key:
|
56
|
+
specification_version: 4
|
57
|
+
summary: Ruby client for tryterra api
|
58
|
+
test_files: []
|