Add custom Matcher, curl_options, configuration file.

Author: filippotoso

.gitignore

@@ -3,4 +3,6 @@
 composer.lock
 .php_cs.cache
 /vendor/
-update.bat
+update.bat
+.phpunit.result.cache
+todo.txt

README.md

@@ -7,7 +7,7 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/botman/botman/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/botman/botman/?branch=master)
 [![Packagist](https://img.shields.io/packagist/l/botman/botman.svg)]()
 [![StyleCI](https://styleci.io/repos/65017574/shield?branch=master)](https://styleci.io/repos/65017574)
-[![Slack](https://rauchg-slackin-jtdkltstsj.now.sh/badge.svg)](https://rauchg-slackin-jtdkltstsj.now.sh)
+[![Slack](https://slack.botman.io/badge.svg)](https://slack.botman.io)
 [![Monthly Downloads](https://img.shields.io/packagist/dm/botman/botman.svg?style=flat-square)](https://packagist.org/packages/botman/botman)
 
 [![https://phppackagedevelopment.com](https://display-demo.schlein.net/images/phppd.jpg)](https://phppackagedevelopment.com)
@@ -30,6 +30,14 @@ $botman->hears('I want cross-platform bots with PHP!', function (BotMan $bot) {
 
 You can find the BotMan documentation at [https://botman.io](https://botman.io).
 
+## Stand Alone Configuration
+
+If you are installing Botman in a stand alone Laravel application, you can publish the configuration file with the following command:
+
+```
+php artisan vendor:publish --tag=config --provider="BotMan\BotMan\BotManServiceProvider"
+```
+
 ## Support the development
 **Do you like this project? Support it by donating**
 

assets/config.php

@@ -0,0 +1,42 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Conversation Cache Time
+    |--------------------------------------------------------------------------
+    |
+    | BotMan caches each started conversation. This value defines the
+    | number of minutes that a conversation will remain stored in
+    | the cache.
+    |
+    */
+    'conversation_cache_time' => 40,
+
+    /*
+    |--------------------------------------------------------------------------
+    | User Cache Time
+    |--------------------------------------------------------------------------
+    |
+    | BotMan caches user information of the incoming messages.
+    | This value defines the number of minutes that this
+    | data will remain stored in the cache.
+    |
+    */
+    'user_cache_time' => 30,
+
+    /*
+    |--------------------------------------------------------------------------
+    | cURL Options
+    |--------------------------------------------------------------------------
+    |
+    | BotMan will use this array to prepare every cURL request.
+    | The same option can be set per driver in the relative
+    | driver configuration file. It uses the
+    | curl_setopt_array() function.
+    |
+    */
+    'curl_options' => [],
+
+];

composer.json

@@ -29,7 +29,8 @@
         "mockery/mockery": "^1.1",
         "doctrine/cache": "^1.6",
         "symfony/cache": "^3.4.35 || ^4.3.7 || ^5.0",
-        "ext-curl": "*"
+        "ext-curl": "*",
+        "dms/phpunit-arraysubset-asserts": "^0.4.0"
     },
     "suggest": {
         "doctrine/cache": "Use any Doctrine cache driver for cache",
@@ -63,4 +64,4 @@
     },
     "prefer-stable": true,
     "minimum-stability": "dev"
-}
+}

src/BotMan.php

@@ -127,20 +127,18 @@ class BotMan
      * @param array $config
      * @param StorageInterface $storage
      */
-    public function __construct(CacheInterface $cache, DriverInterface $driver, $config, StorageInterface $storage)
+    public function __construct(CacheInterface $cache, DriverInterface $driver, $config, StorageInterface $storage, ?Matcher $matcher = null)
     {
-        if (!isset($config['bot_id'])) {
-            $config['bot_id'] = '';
-        }
+        $this->config = $config;
+        $this->config['bot_id'] = $this->config['bot_id'] ?? '';
 
         $this->cache = $cache;
-        $this->message = new IncomingMessage('', '', '', null, $config['bot_id']);
+        $this->message = new IncomingMessage('', '', '', null, $this->config['bot_id']);
         $this->driver = $driver;
-        $this->config = $config;
         $this->storage = $storage;
         $this->matcher = new Matcher();
         $this->middleware = new MiddlewareManager($this);
-        $this->conversationManager = new ConversationManager();
+        $this->conversationManager = new ConversationManager($matcher);
         $this->exceptionHandler = new ExceptionHandler();
     }
 
@@ -234,13 +232,16 @@ public function runsOnSocket($running = null)
      */
     public function getUser()
     {
-        if ($user = $this->cache->get('user_'.$this->driver->getName().'_'.$this->getMessage()->getSender())) {
+        if ($user = $this->cache->get('user_' . $this->driver->getName() . '_' . $this->getMessage()->getSender())) {
             return $user;
         }
 
         $user = $this->getDriver()->getUser($this->getMessage());
-        $this->cache->put('user_'.$this->driver->getName().'_'.$user->getId(), $user,
-            $this->config['user_cache_time'] ?? 30);
+        $this->cache->put(
+            'user_' . $this->driver->getName() . '_' . $user->getId(),
+            $user,
+            $this->config['user_cache_time'] ?? 30
+        );
 
         return $user;
     }
@@ -269,7 +270,7 @@ protected function compileParameterNames($value)
     public function hears($pattern, $callback, $in = null)
     {
         if (is_array($pattern)) {
-            $pattern = '(?|'.implode('|', $pattern).')';
+            $pattern = '(?|' . implode('|', $pattern) . ')';
         }
 
         $command = new Command($pattern, $callback, $in);
@@ -288,7 +289,7 @@ public function hears($pattern, $callback, $in = null)
      */
     public function on($names, $callback)
     {
-        if (! is_array($names)) {
+        if (!is_array($names)) {
             $names = [$names];
         }
 
@@ -314,7 +315,7 @@ public function receivesImages($callback)
     }
 
     /**
-     * Listening for image files.
+     * Listening for video files.
      *
      * @param $callback
      * @return Command
@@ -419,7 +420,7 @@ public function listen()
         try {
             $isVerificationRequest = $this->verifyServices();
 
-            if (! $isVerificationRequest) {
+            if (!$isVerificationRequest) {
                 $this->fireDriverEvents();
 
                 if ($this->firedDriverEvents === false) {
@@ -428,15 +429,15 @@ public function listen()
                     if ($this->loadedConversation === false) {
                         $this->callMatchingMessages();
                     }
+                }
 
-                    /*
-                     * If the driver has a  "messagesHandled" method, call it.
-                     * This method can be used to trigger driver methods
-                     * once the messages are handles.
-                     */
-                    if (method_exists($this->getDriver(), 'messagesHandled')) {
-                        $this->getDriver()->messagesHandled();
-                    }
+                /*
+                * If the driver has a  "messagesHandled" method, call it.
+                * This method can be used to trigger driver methods
+                * once the messages are handles.
+                */
+                if (method_exists($this->getDriver(), 'messagesHandled')) {
+                    $this->getDriver()->messagesHandled();
                 }
 
                 $this->firedDriverEvents = false;
@@ -452,8 +453,12 @@ public function listen()
      */
     protected function callMatchingMessages()
     {
-        $matchingMessages = $this->conversationManager->getMatchingMessages($this->getMessages(), $this->middleware,
-            $this->getConversationAnswer(), $this->getDriver());
+        $matchingMessages = $this->conversationManager->getMatchingMessages(
+            $this->getMessages(),
+            $this->middleware,
+            $this->getConversationAnswer(),
+            $this->getDriver()
+        );
 
         foreach ($matchingMessages as $matchingMessage) {
             $this->command = $matchingMessage->getCommand();
@@ -468,15 +473,18 @@ protected function callMatchingMessages()
                 return $middleware instanceof Heard;
             })->toArray();
 
-            $this->message = $this->middleware->applyMiddleware('heard', $matchingMessage->getMessage(),
-                $commandMiddleware);
+            $this->message = $this->middleware->applyMiddleware(
+                'heard',
+                $matchingMessage->getMessage(),
+                $commandMiddleware
+            );
 
             $parameterNames = $this->compileParameterNames($this->command->getPattern());
 
             $parameters = $matchingMessage->getMatches();
             if (\count($parameterNames) !== \count($parameters)) {
                 $parameters = array_merge(
-                //First, all named parameters (eg. function ($a, $b, $c))
+                    //First, all named parameters (eg. function ($a, $b, $c))
                     array_filter(
                         $parameters,
                         '\is_string',
@@ -501,7 +509,7 @@ protected function callMatchingMessages()
             }
         }
 
-        if (empty($matchingMessages) && empty($this->getBotMessages()) && ! \is_null($this->fallbackMessage)) {
+        if (empty($matchingMessages) && empty($this->getBotMessages()) && !\is_null($this->fallbackMessage)) {
             $this->callFallbackMessage();
         }
     }
@@ -513,7 +521,7 @@ protected function callFallbackMessage()
     {
         $messages = $this->getMessages();
 
-        if (! isset($messages[0])) {
+        if (!isset($messages[0])) {
             return;
         }
 
@@ -537,7 +545,7 @@ protected function verifyServices()
     /**
      * @param string|Question|OutgoingMessage $message
      * @param string|array $recipients
-     * @param string|DriverInterface|null $driver
+     * @param string|DriverInterface|string|null $driver
      * @param array $additionalParameters
      * @return Response
      * @throws BotManException
@@ -559,12 +567,8 @@ public function say($message, $recipients, $driver = null, $additionalParameters
 
         $recipients = \is_array($recipients) ? $recipients : [$recipients];
 
-        if (!isset($this->config['bot_id'])) {
-            $this->config['bot_id'] = '';
-        }
-
         foreach ($recipients as $recipient) {
-            $this->message = new IncomingMessage('', $recipient, '', null, $this->config['bot_id']);
+            $this->message = new IncomingMessage('', $recipient, '', null, $this->config['bot_id'] ?? '');
             $response = $this->reply($message, $additionalParameters);
         }
 
@@ -584,7 +588,7 @@ public function say($message, $recipients, $driver = null, $additionalParameters
      */
     public function ask($question, $next, $additionalParameters = [], $recipient = null, $driver = null)
     {
-        if (! \is_null($recipient) && ! \is_null($driver)) {
+        if (!\is_null($recipient) && !\is_null($driver)) {
             if (\is_string($driver)) {
                 $driver = DriverManager::loadFromName($driver, $this->config);
             }
@@ -609,13 +613,12 @@ public function types()
     }
 
     /**
-     * @param int $seconds Number of seconds to wait
+     * @param float $seconds Number of seconds to wait
      * @return $this
      */
-    public function typesAndWaits($seconds)
+    public function typesAndWaits(float $seconds)
     {
-        $this->getDriver()->types($this->message);
-        sleep($seconds);
+        $this->getDriver()->typesAndWaits($this->message, $seconds);
 
         return $this;
     }
@@ -635,7 +638,7 @@ public function sendRequest($endpoint, $additionalParameters = [])
             return $driver->sendRequest($endpoint, $additionalParameters, $this->message);
         }
 
-        throw new BadMethodCallException('The driver '.$this->getDriver()->getName().' does not support low level requests.');
+        throw new BadMethodCallException('The driver ' . $this->getDriver()->getName() . ' does not support low level requests.');
     }
 
     /**
@@ -647,8 +650,11 @@ public function reply($message, $additionalParameters = [])
     {
         $this->outgoingMessage = \is_string($message) ? OutgoingMessage::create($message) : $message;
 
-        return $this->sendPayload($this->getDriver()->buildServicePayload($this->outgoingMessage, $this->message,
-            $additionalParameters));
+        return $this->sendPayload($this->getDriver()->buildServicePayload(
+            $this->outgoingMessage,
+            $this->message,
+            $additionalParameters
+        ));
     }
 
     /**
@@ -683,13 +689,14 @@ public function randomReply(array $messages)
      */
     protected function makeInvokableAction($action)
     {
-        if (! method_exists($action, '__invoke')) {
+        if (!method_exists($action, '__invoke')) {
             throw new UnexpectedValueException(sprintf(
-                'Invalid hears action: [%s]', $action
+                'Invalid hears action: [%s]',
+                $action
             ));
         }
 
-        return $action.'@__invoke';
+        return $action . '@__invoke';
     }
 
     /**
@@ -755,7 +762,7 @@ public function __call($name, $arguments)
             return \call_user_func_array([$this->getDriver(), $name], $arguments);
         }
 
-        throw new BadMethodCallException('Method ['.$name.'] does not exist.');
+        throw new BadMethodCallException('Method [' . $name . '] does not exist.');
     }
 
     /**

src/BotManFactory.php

@@ -64,7 +64,7 @@ public static function create(
             $storageDriver = new FileStorage(__DIR__);
         }
 
-        $driverManager = new DriverManager($config, new Curl());
+        $driverManager = new DriverManager($config, new Curl($config['curl_options'] ?? []));
         $driver = $driverManager->getMatchingDriver($request);
 
         return new BotMan($cache, $driver, $config, $storageDriver);
@@ -97,7 +97,7 @@ public static function createForSocket(
             $storageDriver = new FileStorage(__DIR__);
         }
 
-        $driverManager = new DriverManager($config, new Curl());
+        $driverManager = new DriverManager($config, new Curl($config['curl_options'] ?? []));
 
         $botman = new BotMan($cache, DriverManager::loadFromName('Null', $config), $config, $storageDriver);
         $botman->runsOnSocket(true);
@@ -129,7 +129,7 @@ public static function passRequestToSocket($port = 8080, Request $request = null
             $request = Request::createFromGlobals();
         }
 
-        $client = stream_socket_client('tcp://127.0.0.1:'.$port);
+        $client = stream_socket_client('tcp://127.0.0.1:' . $port);
         fwrite($client, json_encode([
             'attributes' => $request->attributes->all(),
             'query' => $request->query->all(),