Skip to content

Commit 662800f

Browse files
stoufa06stoufa06
authored
Version 1.9
update oauth1-client to 1.10 fix php compatibility issue add docker-composer.yml to enable test the package with docker
1 parent c2a70b3 commit 662800f

File tree

5 files changed

+43
-39
lines changed

5 files changed

+43
-39
lines changed

‎composer.json‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
"name": "stoufa06/php-garmin-connect-api",
33
"description": "PHP library to connect and use garmin wellness api",
44
"type": "library",
5-
"version": "1.8.1",
6-
75
"require": {
8-
"league/oauth1-client": "1.8"
6+
"league/oauth1-client": "^1.10",
7+
"php": ">=7.1"
98
},
109
"license": "MIT",
1110
"authors": [
@@ -24,11 +23,6 @@
2423
"garmin-connect",
2524
"php"
2625
],
27-
"config": {
28-
"platform": {
29-
"php": "7.1"
30-
}
31-
},
3226
"require-dev": {
3327
"vlucas/phpdotenv": "^4.2"
3428
}

‎docker-compose.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: garmin-example
2+
services:
3+
garmin-example:
4+
image: php:8.2-cli
5+
volumes:
6+
- ./:/app
7+
ports:
8+
- 8080:8080
9+
working_dir: /app/examples
10+
command: php -S 0.0.0.0:8080

‎examples/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Requirements
2-
- php 7.1 or more
2+
- php version >= 7.1
33
- php package [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv) for .env variables
44
# Usage
55
- Create .env file in examples folder
6-
- Set env variable `GARMIN_KEY` and `GARMIN_SECRET` and `GARMIN_CALLBACK_URI=http://localhost:8000/example.php`
6+
- Set env variable `GARMIN_KEY` and `GARMIN_SECRET` and `GARMIN_CALLBACK_URI=http://localhost:8000/`
77
- Open terminal and go to example folder
88
- run `php -S localhost:8000`
9-
- open http://localhost:8000/example.php
9+
- open http://localhost:8000/

examples/example.php renamed to examples/index.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
'summaryStartTimeInSeconds' => $uploadStartTimeInSeconds, // time in seconds utc
5656
'summaryEndTimeInSeconds' => $uploadEndTimeInSeconds // time in seconds utc
5757
];
58-
$server->backfillActivitySummary($tokenCredentials, $params);
58+
//$server->backfillActivitySummary($tokenCredentials, $params);
5959

6060
// User id
6161
$userId = $server->getUserUid($tokenCredentials);

‎src/GarminApi.php‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class GarminApi extends Server
3030
*
3131
* @return string
3232
*/
33-
public function urlTemporaryCredentials(): string
33+
public function urlTemporaryCredentials()
3434
{
3535
return self::API_URL . 'oauth-service/oauth/request_token';
3636
}
@@ -40,7 +40,7 @@ public function urlTemporaryCredentials(): string
4040
*
4141
* @return string
4242
*/
43-
public function urlAuthorization(): string
43+
public function urlAuthorization()
4444
{
4545
return 'http://connect.garmin.com/oauthConfirm';
4646
}
@@ -50,7 +50,7 @@ public function urlAuthorization(): string
5050
*
5151
* @return string
5252
*/
53-
public function urlTokenCredentials(): string
53+
public function urlTokenCredentials()
5454
{
5555
return self::API_URL . 'oauth-service/oauth/access_token';
5656
}
@@ -62,7 +62,7 @@ public function urlTokenCredentials(): string
6262
* @param TemporaryCredentials|string $temporaryIdentifier
6363
* @return string
6464
*/
65-
public function getAuthorizationUrl($temporaryIdentifier): string
65+
public function getAuthorizationUrl($temporaryIdentifier, array $options = [])
6666
{
6767
// Somebody can pass through an instance of temporary
6868
// credentials and we'll extract the identifier from there.
@@ -91,7 +91,7 @@ public function getAuthorizationUrl($temporaryIdentifier): string
9191
* @throws GuzzleException
9292
* @throws InvalidArgumentException
9393
*/
94-
public function getTokenCredentials(TemporaryCredentials $temporaryCredentials, string $temporaryIdentifier, string $verifier): TokenCredentials
94+
public function getTokenCredentials(TemporaryCredentials $temporaryCredentials, $temporaryIdentifier, $verifier)
9595
{
9696
if ($temporaryIdentifier !== $temporaryCredentials->getIdentifier()) {
9797
throw new \InvalidArgumentException(
@@ -112,7 +112,7 @@ public function getTokenCredentials(TemporaryCredentials $temporaryCredentials,
112112
'form_params' => $bodyParameters
113113
]);
114114
} catch (BadResponseException $e) {
115-
throw $this->getCredentialsExceptionForBadResponse($e, 'token credentials');
115+
throw $this->handleTokenCredentialsBadResponse($e);
116116
}
117117

118118
return $this->createTokenCredentials((string)$response->getBody());
@@ -129,7 +129,7 @@ public function getTokenCredentials(TemporaryCredentials $temporaryCredentials,
129129
* @param array $bodyParameters
130130
* @return string
131131
*/
132-
protected function protocolHeader(string $method, string $uri, CredentialsInterface $credentials, array $bodyParameters = array()): string
132+
protected function protocolHeader($method, $uri, CredentialsInterface $credentials, array $bodyParameters = [])
133133
{
134134
$parameters = array_merge(
135135
$this->baseProtocolParameters(),
@@ -157,7 +157,7 @@ protected function protocolHeader(string $method, string $uri, CredentialsInterf
157157
*
158158
* @see OAuth 1.0 RFC 5849 Section 3.1
159159
*/
160-
protected function baseProtocolParameters(): array
160+
protected function baseProtocolParameters()
161161
{
162162
$dateTime = new DateTime('now', new DateTimeZone('UTC'));
163163

@@ -178,7 +178,7 @@ protected function baseProtocolParameters(): array
178178
* @return string json response
179179
* @throws Exception
180180
*/
181-
public function getActivitySummary(TokenCredentials $tokenCredentials, array $params): string
181+
public function getActivitySummary(TokenCredentials $tokenCredentials, array $params)
182182
{
183183
$client = $this->createHttpClient();
184184
$query = http_build_query($params);
@@ -209,7 +209,7 @@ public function getActivitySummary(TokenCredentials $tokenCredentials, array $pa
209209
* @return string json response
210210
* @throws Exception
211211
*/
212-
public function getManuallyActivitySummary(TokenCredentials $tokenCredentials, array $params): string
212+
public function getManuallyActivitySummary(TokenCredentials $tokenCredentials, array $params)
213213
{
214214
$client = $this->createHttpClient();
215215
$query = http_build_query($params);
@@ -239,7 +239,7 @@ public function getManuallyActivitySummary(TokenCredentials $tokenCredentials, a
239239
* @return string json response
240240
* @throws Exception
241241
*/
242-
public function getActivityDetailsSummary(TokenCredentials $tokenCredentials, array $params): string
242+
public function getActivityDetailsSummary(TokenCredentials $tokenCredentials, array $params)
243243
{
244244
$client = $this->createHttpClient();
245245
$query = http_build_query($params);
@@ -270,7 +270,7 @@ public function getActivityDetailsSummary(TokenCredentials $tokenCredentials, ar
270270
* @return void
271271
* @throws Exception
272272
*/
273-
public function backfill(TokenCredentials $tokenCredentials, string $uri, array $params): void
273+
public function backfill(TokenCredentials $tokenCredentials, string $uri, array $params)
274274
{
275275
$client = $this->createHttpClient();
276276
$query = http_build_query($params);
@@ -300,7 +300,7 @@ public function backfill(TokenCredentials $tokenCredentials, string $uri, array
300300
* @return void
301301
* @throws Exception
302302
*/
303-
public function backfillActivitySummary(TokenCredentials $tokenCredentials, array $params): void
303+
public function backfillActivitySummary(TokenCredentials $tokenCredentials, array $params)
304304
{
305305
$this->backfill($tokenCredentials, 'activities', $params);
306306
}
@@ -313,7 +313,7 @@ public function backfillActivitySummary(TokenCredentials $tokenCredentials, arra
313313
* @return void
314314
* @throws Exception
315315
*/
316-
public function backfillDailySummary(TokenCredentials $tokenCredentials, array $params): void
316+
public function backfillDailySummary(TokenCredentials $tokenCredentials, array $params)
317317
{
318318
$this->backfill($tokenCredentials, 'dailies', $params);
319319
}
@@ -326,7 +326,7 @@ public function backfillDailySummary(TokenCredentials $tokenCredentials, array $
326326
* @return void
327327
* @throws Exception
328328
*/
329-
public function backfillEpochSummary(TokenCredentials $tokenCredentials, array $params): void
329+
public function backfillEpochSummary(TokenCredentials $tokenCredentials, array $params)
330330
{
331331
$this->backfill($tokenCredentials, 'epochs', $params);
332332
}
@@ -339,7 +339,7 @@ public function backfillEpochSummary(TokenCredentials $tokenCredentials, array $
339339
* @return void
340340
* @throws Exception
341341
*/
342-
public function backfillActivityDetailsSummary(TokenCredentials $tokenCredentials, array $params): void
342+
public function backfillActivityDetailsSummary(TokenCredentials $tokenCredentials, array $params)
343343
{
344344
$this->backfill($tokenCredentials, 'activityDetails', $params);
345345
}
@@ -352,7 +352,7 @@ public function backfillActivityDetailsSummary(TokenCredentials $tokenCredential
352352
* @return void
353353
* @throws Exception
354354
*/
355-
public function backfillSleepSummary(TokenCredentials $tokenCredentials, array $params): void
355+
public function backfillSleepSummary(TokenCredentials $tokenCredentials, array $params)
356356
{
357357
$this->backfill($tokenCredentials, 'sleep', $params);
358358
}
@@ -365,7 +365,7 @@ public function backfillSleepSummary(TokenCredentials $tokenCredentials, array $
365365
* @return void
366366
* @throws Exception
367367
*/
368-
public function backfillBodyCompositionSummary(TokenCredentials $tokenCredentials, array $params): void
368+
public function backfillBodyCompositionSummary(TokenCredentials $tokenCredentials, array $params)
369369
{
370370
$this->backfill($tokenCredentials, 'bodyComps', $params);
371371
}
@@ -379,7 +379,7 @@ public function backfillBodyCompositionSummary(TokenCredentials $tokenCredential
379379
* @return void
380380
* @throws Exception
381381
*/
382-
public function backfillStressDetailsSummary(TokenCredentials $tokenCredentials, array $params): void
382+
public function backfillStressDetailsSummary(TokenCredentials $tokenCredentials, array $params)
383383
{
384384
$this->backfill($tokenCredentials, 'stressDetails', $params);
385385
}
@@ -393,7 +393,7 @@ public function backfillStressDetailsSummary(TokenCredentials $tokenCredentials,
393393
* @return void
394394
* @throws Exception
395395
*/
396-
public function backfillUserMetricsSummary(TokenCredentials $tokenCredentials, array $params): void
396+
public function backfillUserMetricsSummary(TokenCredentials $tokenCredentials, array $params)
397397
{
398398
$this->backfill($tokenCredentials, 'userMetrics', $params);
399399
}
@@ -406,7 +406,7 @@ public function backfillUserMetricsSummary(TokenCredentials $tokenCredentials, a
406406
* @return void
407407
* @throws Exception
408408
*/
409-
public function backfillPulseOxSummary(TokenCredentials $tokenCredentials, array $params): void
409+
public function backfillPulseOxSummary(TokenCredentials $tokenCredentials, array $params)
410410
{
411411
$this->backfill($tokenCredentials, 'pulseOx', $params);
412412
}
@@ -419,7 +419,7 @@ public function backfillPulseOxSummary(TokenCredentials $tokenCredentials, array
419419
* @return void
420420
* @throws Exception
421421
*/
422-
public function backfillRespirationSummary(TokenCredentials $tokenCredentials, array $params): void
422+
public function backfillRespirationSummary(TokenCredentials $tokenCredentials, array $params)
423423
{
424424
$this->backfill($tokenCredentials, 'respiration', $params);
425425
}
@@ -431,7 +431,7 @@ public function backfillRespirationSummary(TokenCredentials $tokenCredentials, a
431431
* @return void
432432
* @throws Exception
433433
*/
434-
public function deleteUserAccessToken(TokenCredentials $tokenCredentials): void
434+
public function deleteUserAccessToken(TokenCredentials $tokenCredentials)
435435
{
436436
$uri = 'user/registration';
437437
$client = $this->createHttpClient();
@@ -457,7 +457,7 @@ public function deleteUserAccessToken(TokenCredentials $tokenCredentials): void
457457
*
458458
* @return string
459459
*/
460-
public function urlUserDetails(): string
460+
public function urlUserDetails()
461461
{
462462
return self::USER_API_URL . 'user/id';
463463
}
@@ -469,7 +469,7 @@ public function urlUserDetails(): string
469469
* @param TokenCredentials $tokenCredentials
470470
* @return User
471471
*/
472-
public function userDetails($data, TokenCredentials $tokenCredentials): User
472+
public function userDetails($data, TokenCredentials $tokenCredentials)
473473
{
474474
$user = new User();
475475

@@ -500,7 +500,7 @@ public function userUid($data, TokenCredentials $tokenCredentials)
500500
* @param TokenCredentials $tokenCredentials
501501
* @return string return empty string
502502
*/
503-
public function userEmail($data, TokenCredentials $tokenCredentials): string
503+
public function userEmail($data, TokenCredentials $tokenCredentials)
504504
{
505505
return '';
506506
}
@@ -512,7 +512,7 @@ public function userEmail($data, TokenCredentials $tokenCredentials): string
512512
* @param TokenCredentials $tokenCredentials
513513
* @return string return empty string
514514
*/
515-
public function userScreenName($data, TokenCredentials $tokenCredentials): string
515+
public function userScreenName($data, TokenCredentials $tokenCredentials)
516516
{
517517
return '';
518518
}

0 commit comments

Comments
 (0)