latest Kimai API and API token support

Author: kevinpapst

README.md

@@ -1,10 +1,10 @@
 # Kimai - Remote Console
 
-A PHP application to access your Kimai 2 installation via its API (http).
+A PHP application to access your Kimai installation via its JSON API.
 
 **Requirements**
 
-- Kimai > v2.0.20
+- Kimai > v2.14.0
 - PHP 8.1 to 8.4
 - cURL extension
 - json extension
@@ -46,8 +46,7 @@ By default, the configuration file targets the demo installation and will work..
 but now it's time to target your own Kimai, so please edit the config file and change the settings: 
 
 - `URL`: the Kimai installation URL
-- `USERNAME`: the Kimai installation URL
-- `API_KEY`: your Kimai API key (can be set when editing your profile)
+- `API_TOKEN`: your Kimai API token (can be set when editing your profile)
 - `OPTIONS`: an array of request options for CURL (see [guzzle docs](http://docs.guzzlephp.org/en/stable/request-options.html))
 
 FAQ:
@@ -116,7 +115,7 @@ If you want to use the output in a script, instead of manually looking at them,
 The following environment variables are supported:
 
 - `KIMAI_MEMORY_LIMIT` - configures the allowed memory limit (eg `128MB`, or `-1` for unlimited) (see [here](https://www.php.net/manual/en/ini.core.php#ini.memory-limit)) 
-- `KIMAI_CONFIG` - path to your configuration file (defaults to: $HOME/.kimai2-console.json) 
+- `KIMAI_CONFIG` - path to your configuration file (defaults to: `$HOME/.kimai-api.json`) 
 
 ## FAQ
 

composer.json

@@ -15,7 +15,7 @@
         "ext-json": "*",
         "ext-curl": "*",
         "ext-mbstring": "*",
-        "kimai/api-php": "^1.0",
+        "kimai/api-php": "^2.0",
         "symfony/console": "6.*"
     },
     "require-dev": {
@@ -43,9 +43,7 @@
         }
     },
     "scripts": {
-        "phpstan": [
-            "vendor/bin/phpstan analyse src -c phpstan.neon --level=5"
-        ],
+        "phpstan": "vendor/bin/phpstan analyse src -c phpstan.neon --level=7",
         "codestyle": "vendor/bin/php-cs-fixer fix --dry-run --verbose --show-progress=none",
         "codestyle-fix": "vendor/bin/php-cs-fixer fix"
     }

composer.lock

@@ -12,32 +12,27 @@
 final class Configuration
 {
     /**
-     * @var array
+     * @param array{URL: string, API_TOKEN: string, OPTIONS: array<string, mixed>} $settings
+     * @throws \Exception
      */
-    private array $settings;
-
-    public function __construct(array $settings)
+    public function __construct(private readonly array $settings)
     {
         $this->validate($settings);
-
-        $this->settings = $settings;
     }
 
-    public function getUsername(): string
+    public function getApiToken(): string
     {
-        return $this->settings['USERNAME'];
-    }
-
-    public function getApiKey(): string
-    {
-        return $this->settings['API_KEY'];
+        return $this->settings['API_TOKEN'];
     }
 
     public function getUrl(): string
     {
         return $this->settings['URL'];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getCurlOptions(): array
     {
         if (!\array_key_exists('OPTIONS', $this->settings)) {
@@ -47,39 +42,43 @@ public function getCurlOptions(): array
         return $this->settings['OPTIONS'];
     }
 
+    /**
+     * @return array<string, string>
+     */
     public static function getDefaultConfiguration(): array
     {
         return [
             'URL' => 'https://demo.kimai.org/',
-            'USERNAME' => 'susan_super',
-            'API_KEY' => 'api_kitten',
+            'API_TOKEN' => 'token_super',
         ];
     }
 
     public static function getFilename(): string
     {
         if (false === ($filename = getenv('KIMAI_CONFIG'))) {
-            $filename = getenv('HOME') . DIRECTORY_SEPARATOR . '.kimai-api.json';
+            $old = getenv('HOME') . DIRECTORY_SEPARATOR . '.kimai2-console.json';
+            $new = getenv('HOME') . DIRECTORY_SEPARATOR . '.kimai-api.json';
+            if (file_exists($old)) {
+                rename($old, $new);
+            }
+            $filename = $new;
         }
 
         return $filename;
     }
 
     /**
-     * @param array $settings
-     * @return bool
+     * @param array{URL: string, API_TOKEN: string, OPTIONS: null|array<string, mixed>} $settings
      * @throws \Exception
      */
-    private function validate(array $settings)
+    private function validate(array $settings): bool
     {
-        $required = ['URL', 'USERNAME', 'API_KEY'];
+        if (!\array_key_exists('URL', $settings) || $settings['URL'] === '') {
+            throw new \Exception('Missing API URL with the key "URL"');
+        }
 
-        foreach ($required as $key) {
-            if (!\array_key_exists($key, $settings)) {
-                throw new \Exception('Missing config: ' . $key);
-            } elseif (empty($settings[$key])) {
-                throw new \Exception('Empty config: ' . $key);
-            }
+        if (!\array_key_exists('API_TOKEN', $settings) || $settings['API_TOKEN'] === '') {
+            throw new \Exception('Missing API token with the key "API_TOKEN"');
         }
 
         if (\array_key_exists('OPTIONS', $settings) && !\is_array($settings['OPTIONS'])) {

src/Api/Configuration.php

@@ -21,8 +21,7 @@ final class Connection
     public function __construct(Configuration $configuration)
     {
         $this->configuration = SwaggerConfiguration::getDefaultConfiguration();
-        $this->configuration->setApiKey('X-AUTH-TOKEN', $configuration->getApiKey());
-        $this->configuration->setApiKey('X-AUTH-USER', $configuration->getUsername());
+        $this->configuration->setAccessToken($configuration->getApiToken());
         $this->configuration->setHost(rtrim($configuration->getUrl(), '/'));
 
         $clientOptions = $configuration->getCurlOptions();

src/Api/Connection.php

@@ -22,7 +22,7 @@
 
 class Application extends SymfonyApplication
 {
-    private static $logo = ' _  _____ __  __    _    ___
+    private static string $logo = ' _  _____ __  __    _    ___
 | |/ /_ _|  \/  |  / \  |_ _|
 | \' / | || |\/| | / _ \  | |
 | . \ | || |  | |/ ___ \ | |

src/Application.php

@@ -51,8 +51,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $globals = '1';
         }
 
-        // null parameters are deprecated
-        $collection = $api->getGetActivities($project, null, $visible, $globals, $order_by, $order, $term);
+        $collection = $api->getGetActivities(
+            $project,
+            null, // @phpstan-ignore argument.type
+            $visible,
+            $globals,
+            $order_by,
+            $order,
+            $term
+        );
 
         $rows = [];
         foreach ($collection as $activity) {

src/Command/ActivityListCommand.php

@@ -28,10 +28,7 @@
 
 abstract class BaseCommand extends Command
 {
-    /**
-     * @var Connection
-     */
-    private $connection;
+    private ?Connection $connection = null;
 
     protected function getApi(): DefaultApi
     {
@@ -80,8 +77,13 @@ protected function getConnection(): Connection
                 throw new InvalidConfigurationException('Cannot read configuration: ' . $filename);
             }
 
+            $configFile = file_get_contents($filename);
+            if ($configFile === false) {
+                throw new InvalidConfigurationException('Failed reading configuration: ' . $filename);
+            }
+
             try {
-                $result = json_decode(file_get_contents($filename), true);
+                $result = json_decode($configFile, true);
                 $config = new Configuration($result);
             } catch (\Exception $ex) {
                 throw new InvalidConfigurationException('Invalid configuration: ' . $ex->getMessage());
@@ -97,6 +99,10 @@ protected function getConnection(): Connection
         return $this->connection;
     }
 
+    /**
+     * @param array<string> $headers
+     * @param list<array<int, mixed>> $rows
+     */
     protected function formatOutput(InputInterface $input, OutputInterface $output, array $headers, array $rows): void
     {
         $io = new SymfonyStyle($input, $output);

src/Command/BaseCommand.php

@@ -10,6 +10,7 @@
 namespace KimaiConsole\Command;
 
 use KimaiConsole\Api\Configuration;
+use KimaiConsole\Exception\InvalidConfigurationException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
@@ -34,14 +35,19 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if (file_exists($filename)) {
+            $configFile = file_get_contents($filename);
+            if ($configFile === false) {
+                throw new InvalidConfigurationException('Failed reading configuration: ' . $filename);
+            }
+
             try {
-                $result = json_decode(file_get_contents($filename), true);
+                $result = json_decode($configFile, true);
                 $config = new Configuration($result);
 
                 $io->success(
                     'Configuration file: ' . $filename . PHP_EOL .
                     'URL: ' . $config->getUrl() . PHP_EOL .
-                    'Username: ' . $config->getUsername() . PHP_EOL
+                    'API Token: ' . $config->getApiToken() . PHP_EOL
                 );
 
                 return 0;

src/Command/ConfigurationCommand.php

@@ -50,7 +50,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $order_by = 'customer';
 
         // null parameters are deprecated
-        $collection = $api->getGetProjects($customer, null, $visible, $start, $end, $ignore_dates, $global_activities, $order, $order_by, $term);
+        $collection = $api->getGetProjects(
+            $customer,
+            null,  // @phpstan-ignore argument.type
+            $visible,
+            $start,
+            $end,
+            $ignore_dates,
+            $global_activities,
+            $order,
+            $order_by,
+            $term
+        );
 
         $rows = [];
         foreach ($collection as $project) {