Allow cron execution by defining groups of commands that can be called individually.

Author: noplanman

CHANGELOG.md

@@ -4,6 +4,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ## [Unreleased]
 ### Added
 - Ability to define custom valid IPs to access webhook.
+- Execute commands via cron, using `cron` action and `g` parameter.
 ### Changed
 - Remodelled the config array to a more flexible structure.
 ### Deprecated

README.md

@@ -40,18 +40,20 @@ and then run `composer update`
 
 What use would this library be if you couldn't perform any actions?!
 
-There are 4 parameters available to get things rolling:
+There are a few parameters available to get things rolling:
 
 | Parameter | Description |
 | --------- | ----------- |
 | s         | **s**ecret: This is a special secret value defined in the main `manager.php` file. |
 |           | This parameter is required to call the script via browser! |
-| a         | **a**ction: The actual action to perform. (handle (default), set, unset, reset) |
-|           | **handle** executes the `getUpdates` method; **set** / **unset** / **reset** the Webhook. |
+| a         | **a**ction: The actual action to perform. (handle (default), cron, set, unset, reset) |
+|           | **handle** executes the `getUpdates` method; **cron** executes cron commands; **set** / **unset** / **reset** the webhook. |
 | l         | **l**oop: Number of seconds to loop the script for (used for getUpdates method). |
 |           | This would be used mainly via CLI, to continually get updates for a certain period. |
-| i         | **i**nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default: 2). |
+| i         | **i**nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default is 2). |
 |           | This would be used mainly via CLI, to continually get updates for a certain period, every **i** seconds. |
+| g         | **g**roup: Commands group for cron (only used together with `cron` action, default group is `default`). |
+|           | Define which group of commands to execute via cron. |
 
 #### via browser
 
@@ -102,7 +104,7 @@ Handle updates for 30 seconds, fetching every 5 seconds:
 You can name this file whatever you like, it just has to be somewhere inside your PHP project (preferably in the root folder to make things easier).
 (Let's assume our file is called `manager.php`)
 
-Let's start off with a simple example that uses the Webhook method:
+Let's start off with a simple example that uses the webhook method:
 ```php
 <?php
 
@@ -256,6 +258,24 @@ $bot = new BotManager([
         ],
     ],
 
+    // (array) All options that have to do with cron.
+    'cron'             => [
+        // (array) List of groups that contain the commands to execute.
+        'groups' => [
+            // Each group has a name and array of commands.
+            // When no group is defined, the default group gets executed.
+            'default'     => [
+                '/default_cron_command',
+            ],
+            'maintenance' => [
+                '/db_cleanup',
+                '/db_repair',
+                '/log_rotate',
+                '/message_admins Maintenance completed',
+            ],
+        ],
+    ],
+
     // (string) Override the custom input of your bot (mostly for testing purposes!).
     'custom_input'     => '{"some":"raw", "json":"update"}',
 ]);

src/Action.php

@@ -22,6 +22,7 @@ class Action
         'unset',
         'reset',
         'handle',
+        'cron',
     ];
 
     /**

src/BotManager.php

@@ -123,12 +123,18 @@ public function run(): self
         // Make sure this is a valid call.
         $this->validateSecret();
 
+        if (!$this->isValidRequest()) {
+            throw new InvalidAccessException('Invalid access');
+        }
+
         if ($this->action->isAction(['set', 'unset', 'reset'])) {
             $this->validateAndSetWebhook();
         } elseif ($this->action->isAction('handle')) {
-            // Set any extras.
             $this->setBotExtras();
             $this->handleRequest();
+        } elseif ($this->action->isAction('cron')) {
+            $this->setBotExtras();
+            $this->handleCron();
         }
 
         return $this;
@@ -337,6 +343,21 @@ public function handleRequest(): self
         return $this;
     }
 
+    /**
+     * Handle cron.
+     *
+     * @return \NPM\TelegramBotManager\BotManager
+     * @throws \Longman\TelegramBot\Exception\TelegramException
+     */
+    public function handleCron(): self
+    {
+        $group = $this->params->getScriptParam('g', 'default');
+        $commands = $this->params->getBotParam('cron.groups.' . $group, []);
+        $this->telegram->runCommands($commands);
+
+        return $this;
+    }
+
     /**
      * Get the number of seconds the script should loop.
      *
@@ -456,10 +477,6 @@ public function handleGetUpdates(): self
      */
     public function handleWebhook(): self
     {
-        if (!$this->isValidRequest()) {
-            throw new InvalidAccessException('Invalid access');
-        }
-
         $this->telegram->handle();
 
         return $this;

src/Params.php

@@ -18,10 +18,11 @@ class Params
      * @var array List of valid script parameters.
      */
     private static $valid_script_params = [
-        's',
-        'a',
-        'l',
-        'i',
+        's', // secret
+        'a', // action
+        'l', // loop
+        'i', // interval
+        'g', // group (for cron)
     ];
 
     /**
@@ -47,8 +48,8 @@ class Params
         'paths',
         'commands',
         'botan',
-        'custom_input',
         'cron',
+        'custom_input',
     ];
 
     /**

tests/TelegramBotManager/Tests/ActionTest.php

@@ -20,6 +20,7 @@ public function testConstruct()
         self::assertEquals('unset', (new Action('unset'))->getAction());
         self::assertEquals('reset', (new Action('reset'))->getAction());
         self::assertEquals('handle', (new Action('handle'))->getAction());
+        self::assertEquals('cron', (new Action('cron'))->getAction());
     }
 
     /**

tests/TelegramBotManager/Tests/ParamsTest.php

@@ -63,7 +63,19 @@ class ParamsTest extends \PHPUnit\Framework\TestCase
         'botan'            => [
             'token' => 'botan_12345',
         ],
-        'custom_input'     => '{"some":"raw", "json":"update"}',
+        'cron'             => [
+            'groups' => [
+                'default'     => [
+                    '/default_cron_command',
+                ],
+                'maintenance' => [
+                    '/db_cleanup',
+                    '/db_repair',
+                    '/log_rotate',
+                ],
+            ],
+        ],
+        'custom_input' => '{"some":"raw", "json":"update"}',
     ];
 
     public function setUp()