added test mode in connection

added tests

Author: simialbi

.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.travis.yml

@@ -0,0 +1,35 @@
+language: php
+
+php:
+  - 5.6
+  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
+
+sudo: false
+
+# cache vendor dirs
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+install:
+  - travis_retry composer self-update && composer --version
+  - export PATH="$HOME/.composer/vendor/bin:$PATH"
+  - travis_retry composer install --prefer-dist --no-interaction
+
+before_script:
+  - |
+    if [ $TRAVIS_PHP_VERSION = '5.6' ]; then
+      PHPUNIT_FLAGS="--coverage-clover=coverage.clover"
+    fi
+script:
+  - ./vendor/bin/phpunit --verbose $PHPUNIT_FLAGS
+
+after_script:
+  - |
+    if [ $TRAVIS_PHP_VERSION = '5.6' ]; then
+      travis_retry wget https://scrutinizer-ci.com/ocular.phar
+      php ocular.phar code-coverage:upload --format=php-clover coverage.clover
+    fi

src/Connection.php

@@ -61,6 +61,11 @@ class Connection extends Component
      * @var boolean Whether to user pluralisation or not
      */
     public $usePluralisation = true;
+    /**
+     * @var boolean Whether we are in test mode or not (prevent execution)
+     */
+    public $isTestMode = false;
+
     /**
      * @var string|Closure authorization config
      */
@@ -265,7 +270,7 @@ public function getHandler()
      * @param string|array $url the URL for request, not including proto and site
      * @param array $data the request data
      *
-     * @return Response|false
+     * @return mixed|false
      * @throws \yii\httpclient\Exception
      */
     protected function request($method, $url, $data = [])
@@ -280,14 +285,19 @@ protected function request($method, $url, $data = [])
 
         Yii::beginProfile($profile, __METHOD__);
         /* @var $request \yii\httpclient\Request */
+
+        Yii::debug($this->handler->baseUrl . '/' . $url, __METHOD__ . '-url');
+        Yii::debug($data, __METHOD__ . '-data');
+        Yii::debug($headers, __METHOD__ . '-headers');
+
         $request = call_user_func([$this->handler, $method], $url, $data, $headers);
-        $this->_response = $request->send();
+        $this->_response = $this->isTestMode ? [] : $request->send();
         Yii::endProfile($profile, __METHOD__);
 
-        if (!$this->_response->isOk) {
+        if (!$this->isTestMode && !$this->_response->isOk) {
             return false;
         }
 
-        return $this->_response->data;
+        return $this->isTestMode ? [] : $this->_response->data;
     }
 }

tests/TestCase.php

@@ -12,6 +12,8 @@
 
 class TestCase extends \PHPUnit\Framework\TestCase
 {
+    private $_index = 0;
+
     /**
      * {@inheritdoc}
      */
@@ -44,7 +46,17 @@ protected function mockWebApplication($config = [], $appClass = '\yii\web\Applic
                 ],
                 'rest' => [
                     'class' => 'simialbi\yii2\rest\Connection',
-                    'baseUrl' => 'https:s//api.site.com/'
+                    'baseUrl' => 'https://api.site.com/',
+                    'isTestMode' => true
+                ],
+                'log' => [
+                    'traceLevel' => 3,
+                    'targets' => [
+                        [
+                            'class' => 'yiiunit\extensions\rest\log\ArrayTarget'
+                        ]
+                    ],
+                    'flushInterval' => 0
                 ]
             ]
         ], $config));
@@ -58,4 +70,38 @@ protected function destroyApplication()
         Yii::$app = null;
         Yii::$container = new Container();
     }
+
+    /**
+     * Parse log from index and returns data
+     * @return array
+     */
+    protected function parseLogs()
+    {
+        $url = '';
+        $data = [];
+        $headers = [];
+
+        $profile = false;
+        for (; $this->_index <= count(Yii::$app->log->logger->messages); $this->_index++) {
+            $message = Yii::$app->log->logger->messages[$this->_index];
+            if ($message[2] === 'simialbi\yii2\rest\Connection::request-url') {
+                $url = $message[0];
+            } elseif ($message[2] === 'simialbi\yii2\rest\Connection::request-data') {
+                $data = $message[0];
+            } elseif ($message[2] === 'simialbi\yii2\rest\Connection::request-headers') {
+                $data = $message[0];
+            } elseif ($message[2] === 'simialbi\yii2\rest\Connection::request') {
+                if ($profile) {
+                    break;
+                }
+                $profile = true;
+            }
+        }
+
+        return [
+            'url' => $url,
+            'data' => $data,
+            'headers' => $headers
+        ];
+    }
 }

tests/UrlTest.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * @package yii2-rest-client
+ * @author Simon Karlen <[email protected]>
+ * @copyright Copyright © 2019 Simon Karlen
+ */
+
+namespace yiiunit\extensions\rest;
+
+use yiiunit\extensions\rest\models\RestModel;
+
+class UrlTest extends TestCase
+{
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->mockWebApplication();
+    }
+
+    public function testGetOne()
+    {
+        RestModel::findOne(1);
+
+        $logEntry = $this->parseLogs();
+
+        $this->assertEquals('https://api.site.com/rest-models/1', $logEntry['url']);
+    }
+
+    public function testGetAnotherOne()
+    {
+        RestModel::find()->where(['id' => 1])->one();
+
+        $logEntry = $this->parseLogs();
+
+        $this->assertEquals('https://api.site.com/rest-models/1', $logEntry['url']);
+    }
+}

tests/UrlWithoutPluralisationTest.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * @package yii2-rest-client
+ * @author Simon Karlen <[email protected]>
+ * @copyright Copyright © 2019 Simon Karlen
+ */
+
+namespace yiiunit\extensions\rest;
+
+
+use yiiunit\extensions\rest\models\RestModel;
+
+class UrlWithoutPluralisationTest extends TestCase
+{
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->mockWebApplication([
+            'components' => [
+                'rest' => [
+                    'usePluralisation' => false
+                ]
+            ]
+        ]);
+    }
+
+    public function testGetOne()
+    {
+        RestModel::findOne(1);
+
+        $logEntry = $this->parseLogs();
+
+        $this->assertEquals('https://api.site.com/rest-model/1', $logEntry['url']);
+    }
+
+    public function testGetAnotherOne()
+    {
+        RestModel::find()->where(['id' => 1])->one();
+
+        $logEntry = $this->parseLogs();
+
+        $this->assertEquals('https://api.site.com/rest-model/1', $logEntry['url']);
+    }
+}

tests/log/ArrayTarget.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * @package yii2-rest-client
+ * @author Simon Karlen <[email protected]>
+ * @copyright Copyright © 2019 Simon Karlen
+ */
+
+namespace yiiunit\extensions\rest\log;
+
+use yii\helpers\ArrayHelper;
+use yii\log\Target;
+
+/**
+ * Class ArrayTarget
+ * @package yiiunit\extensions\rest\log
+ *
+ * @property-read array $cache
+ */
+class ArrayTarget extends Target
+{
+    /**
+     * @var array Stores log data
+     */
+    private $_cache = [];
+
+    /**
+     * Exports log [[messages]] to a specific destination.
+     * Child classes must implement this method.
+     */
+    public function export()
+    {
+        $this->_cache = ArrayHelper::merge($this->_cache, $this->messages);
+    }
+
+    /**
+     * Getter for cache variable
+     * @return array
+     */
+    public function getCache()
+    {
+        return $this->_cache;
+    }
+}

tests/models/RestModel.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * @package yii2-rest-client
+ * @author Simon Karlen <[email protected]>
+ * @copyright Copyright © 2019 Simon Karlen
+ */
+
+namespace yiiunit\extensions\rest\models;
+
+
+use simialbi\yii2\rest\ActiveRecord;
+
+/**
+ * Class RestModel
+ * @package yiiunit\extensions\rest\models
+ *
+ * @property integer $id
+ * @property string $name
+ * @property string $description
+ * @property integer $created_at
+ * @property integer $updated_at
+ * @property string $created_by
+ * @property string $updated_by
+ */
+class RestModel extends ActiveRecord
+{
+    /**
+     * {@inheritDoc}
+     */
+    public static function primaryKey()
+    {
+        return ['id'];
+    }
+}