ApiToken docs and filter update. #417

lonnieezell · 2022-09-02T05:39:35Z

Added the first of a handful of guides stepping through setup and use Access Tokens to handle various situations. This one covers generic API requests.

Along the way I discovered that the TokenAuth filter didn't support checking against a scope, so I updated the filter to handle a single permission added when used as a route filter.

$routes->get('users', 'UserController::list', ['filter' => 'tokens:users-read']);

jozefrebjak · 2022-09-02T08:07:07Z

Added the first of a handful of guides stepping through setup and use Access Tokens to handle various situations. This one covers generic API requests.

Along the way I discovered that the TokenAuth filter didn't support checking against a scope, so I updated the filter to handle a single permission added when used as a route filter.
$routes->get('users', 'UserController::list', ['filter' => 'tokens:users-read']);

@lonnieezell Thanks for this PR. It will be nice to have an CLI command to generate Token for user at start to test functionality before implementing the whole flow with user interface to interact with API access.

MGatner · 2022-09-02T10:08:33Z

This looks great! It's big, and I am short on time so will have to come back to it. Ideally you pull the token changes out to its own PR to make this smaller for review 🫣

docs/guides/api-tokens.md

Co-authored-by: MGatner <mgatner@icloud.com>

lonnieezell · 2022-09-07T03:30:32Z

@MGatner doc changes integrated.

kenjis · 2022-09-07T06:34:50Z

The following errors have nothing to do with this PR. I send #423 to fix.

Run vendor/bin/phpstan analyze
Note: Using configuration file /home/runner/work/shield/shield/phpstan.neon.dist.
   0/119 [░░░░░░░░░░░░░░░░░░░░░░░░░░░░]   0%
 119/119 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

Error: Cannot call method isBefore() on array|float|int<min, -1>|int<1, max>|object|string|true.
Error: Cannot call method format() on array|bool|float|int|object|string.
Error: Cannot call method getTimestamp() on array|bool|float|int|object|string.
Error: Cannot call method getTimestamp() on array|bool|float|int|object|string.
 ------ ------------------------------------------------------------------ 
  Line   src/Authentication/Authenticators/AccessTokens.php                
 ------ ------------------------------------------------------------------ 
  121    Cannot call method isBefore() on array|float|int<min, -1>|int<1,  
         max>|object|string|true.                                          
 ------ ------------------------------------------------------------------ 

 ------ -------------------------------------------------------------------- 
  Line   src/Models/UserModel.php                                            
 ------ -------------------------------------------------------------------- 
  329    Cannot call method format() on array|bool|float|int|object|string.  
 ------ -------------------------------------------------------------------- 

 ------ -------------------------------------- 
  Line   tests/Controllers/LoginTest.php       
 ------ -------------------------------------- 
  92     Cannot call method getTimestamp() on  
         array|bool|float|int|object|string.   
  154    Cannot call method getTimestamp() on  
         array|bool|float|int|object|string.   
 ------ -------------------------------------- 

Error:  [ERROR] Found 4 errors

https://github.com/codeigniter4/shield/runs/8220322852?check_suite_focus=true

docs/guides/api-tokens.md

kenjis · 2022-09-07T08:24:49Z

docs/guides/api-tokens.md

+
+```php
+$routes->get('/access/token', static function() {
+    $token = auth()->user()->generateAccessToken(request()->getVar('token_name));


request() ?
Do you mean service('request') ?

Don't mind him, Laravel gets the bills paid. Yes he meant to use the service.

Dang it :) I've considered adding a request() and response() helper method for years on this framework, but never did. I actually had to go double-check the code to ensure we didn't have it lol. But, yes, that's what I meant.

docs/guides/api-tokens.md

MGatner · 2022-09-07T10:31:36Z

We need a review process for reviews 🤦‍♂️ Thanks for catching wha to missed @kenjis.
@lonnieezell let us know if you'd just like us to finish this up, it's all tweaks.

Co-authored-by: kenjis <kenji.uui@gmail.com>

lonnieezell · 2022-09-07T13:23:58Z

@MGatner if you guys have the time and/or desire feel free to finish it up. I merged the suggestions.

docs/guides/api-tokens.md

MGatner

@kenjis or @datamweb one last review and merge?

lonnieezell added 2 commits September 2, 2022 00:35

ApiToken docs and filter update.

95b02fa

Update doc title and links

fb0f387

kenjis added enhancement New feature or request documentation Improvements or additions to documentation labels Sep 2, 2022

lonnieezell mentioned this pull request Sep 6, 2022

docs: mobile token guides #422

Merged

MGatner requested changes Sep 6, 2022

View reviewed changes

docs/guides/api-tokens.md Outdated Show resolved Hide resolved

docs/guides/api-tokens.md Outdated Show resolved Hide resolved

docs/guides/api-tokens.md Outdated Show resolved Hide resolved

docs/guides/api-tokens.md Outdated Show resolved Hide resolved

Apply suggestions from code review

b37ce68

Co-authored-by: MGatner <mgatner@icloud.com>

kenjis reviewed Sep 7, 2022

View reviewed changes