Merge branch 'master' of github.com:yiisoft/yii2

.travis.yml

@@ -21,6 +21,10 @@ services:
   - elasticsearch
   - mongodb
 
+# try running against postgres 9.3
+addons:
+  postgresql: "9.3"
+
 install:
   - composer self-update && composer --version
 # core framework:

apps/advanced/README.md

@@ -113,7 +113,7 @@ it will upgrade your database to the last state according migrations.
 
 To be able to run acceptance tests you need a running webserver. For this you can use the php builtin server and run it in the directory where your main project folder is located. For example if your application is located in `/www/advanced` all you need to is:
 `cd /www` and then `php -S 127.0.0.1:8080` because the default configuration of acceptance tests expects the url of the application to be `/advanced/`.
-If you already have a server configured or your application is not located in a folder called `advanced`, you may need to adjust the `TEST_ENTRY_URL` in `frontend/tests/_bootstrap.php` and `backend/tests/_bootstrap.php`.
+If you already have a server configured or your application is not located in a folder called `advanced`, you may need to adjust the `test_entry_url` in `backend/codeception.yml` and `frontend/codeception.yml`.
 
 After that is done you should be able to run your tests, for example to run `frontend` tests do:
 
@@ -123,5 +123,7 @@ After that is done you should be able to run your tests, for example to run `fro
 
 In similar way you can run tests for other application tiers - `backend`, `console`, `common`.
 
+If you already have run `../vendor/bin/codecept build` for each application, you can run all tests by one command: `vendor/bin/codecept run`
+
 You also can adjust you application suite configs and `_bootstrap.php` settings to use other urls and files, as it is can be done in `yii2-basic`.
 Current template also includes [yii2-faker](https://github.com/yiisoft/yii2/tree/master/extensions/faker) extension, that is correctly setup for each application tier.

apps/advanced/backend/codeception.yml

@@ -1,3 +1,4 @@
+namespace: backend
 actor: Tester
 paths:
     tests: tests
@@ -17,3 +18,7 @@ modules:
             user: ''
             password: ''
             dump: tests/_data/dump.sql
+config:
+    # the entry script URL (without host info) for functional and acceptance tests
+    # PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
+    test_entry_url: /advanced/backend/web/index-test.php

apps/advanced/backend/tests/_bootstrap.php

@@ -1,12 +1,5 @@
 <?php
 
-// the entry script URL (without host info) for functional and acceptance tests
-// PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
-defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/advanced/backend/web/index-test.php');
-
-// the entry script file path for functional and acceptance tests
-defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(__DIR__) . '/web/index-test.php');
-
 defined('YII_DEBUG') or define('YII_DEBUG', true);
 
 defined('YII_ENV') or define('YII_ENV', 'test');
@@ -18,6 +11,8 @@
 require(__DIR__ . '/../../common/config/aliases.php');
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
+
+// the entry script file path for functional and acceptance tests
+$_SERVER['SCRIPT_FILENAME'] = dirname(__DIR__) . '/web/index-test.php';
+$_SERVER['SCRIPT_NAME'] = \Codeception\Configuration::config()['config']['test_entry_url'];
 $_SERVER['SERVER_NAME'] = 'localhost';

apps/advanced/backend/tests/acceptance/LoginCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use common\tests\_pages\LoginPage;
+use backend\WebGuy;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure login page works');

apps/advanced/backend/tests/functional/LoginCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use common\tests\_pages\LoginPage;
+use backend\TestGuy;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure login page works');

apps/advanced/backend/tests/functional/_config.php

@@ -1,8 +1,8 @@
 <?php
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
+$_SERVER['SCRIPT_FILENAME'] = dirname(dirname(__DIR__)) . '/web/index-test.php';
+$_SERVER['SCRIPT_NAME'] = \Codeception\Configuration::config()['config']['test_entry_url'];;
 
 return yii\helpers\ArrayHelper::merge(
     require(__DIR__ . '/../../config/main.php'),

apps/advanced/codeception.yml

@@ -0,0 +1,11 @@
+include:
+  - common
+  - console
+  - backend
+  - frontend
+
+paths:
+  log: tests/_log
+
+settings:
+  colors: true

apps/advanced/common/codeception.yml

@@ -1,3 +1,4 @@
+namespace: common
 actor: Tester
 paths:
     tests: tests

apps/advanced/common/tests/_bootstrap.php

@@ -1,12 +1,5 @@
 <?php
 
-// the entry script URL (without host info) for functional and acceptance tests
-// PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
-defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/index-test.php');
-
-// the entry script file path for functional and acceptance tests
-defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(__DIR__) . '/index-test.php');
-
 defined('YII_DEBUG') or define('YII_DEBUG', true);
 
 defined('YII_ENV') or define('YII_ENV', 'test');
@@ -18,6 +11,4 @@
 require(__DIR__ . '/../../common/config/aliases.php');
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
 $_SERVER['SERVER_NAME'] = 'localhost';

apps/advanced/console/codeception.yml

@@ -1,3 +1,4 @@
+namespace: console
 actor: Tester
 paths:
     tests: tests

apps/advanced/console/tests/_bootstrap.php

@@ -1,12 +1,5 @@
 <?php
 
-// the entry script URL (without host info) for functional and acceptance tests
-// PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
-defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/index-test.php');
-
-// the entry script file path for functional and acceptance tests
-defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(__DIR__) . '/index-test.php');
-
 defined('YII_DEBUG') or define('YII_DEBUG', true);
 
 defined('YII_ENV') or define('YII_ENV', 'test');
@@ -18,6 +11,4 @@
 require(__DIR__ . '/../../common/config/aliases.php');
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
 $_SERVER['SERVER_NAME'] = 'localhost';

apps/advanced/frontend/codeception.yml

@@ -1,3 +1,4 @@
+namespace: frontend
 actor: Tester
 paths:
     tests: tests
@@ -17,3 +18,7 @@ modules:
             user: ''
             password: ''
             dump: tests/_data/dump.sql
+config:
+    # the entry script URL (without host info) for functional and acceptance tests
+    # PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
+    test_entry_url: /advanced/frontend/web/index-test.php

apps/advanced/frontend/tests/_bootstrap.php

@@ -1,12 +1,5 @@
 <?php
 
-// the entry script URL (without host info) for functional and acceptance tests
-// PLEASE ADJUST IT TO THE ACTUAL ENTRY SCRIPT URL
-defined('TEST_ENTRY_URL') or define('TEST_ENTRY_URL', '/advanced/frontend/web/index-test.php');
-
-// the entry script file path for functional and acceptance tests
-defined('TEST_ENTRY_FILE') or define('TEST_ENTRY_FILE', dirname(__DIR__) . '/web/index-test.php');
-
 defined('YII_DEBUG') or define('YII_DEBUG', true);
 
 defined('YII_ENV') or define('YII_ENV', 'test');
@@ -18,6 +11,8 @@
 require(__DIR__ . '/../../common/config/aliases.php');
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
+
+// the entry script file path for functional and acceptance tests
+$_SERVER['SCRIPT_FILENAME'] = dirname(__DIR__) . '/web/index-test.php';
+$_SERVER['SCRIPT_NAME'] = \Codeception\Configuration::config()['config']['test_entry_url'];
 $_SERVER['SERVER_NAME'] = 'localhost';

apps/advanced/frontend/tests/acceptance/AboutCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use frontend\tests\_pages\AboutPage;
+use frontend\WebGuy;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that about works');

apps/advanced/frontend/tests/acceptance/ContactCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use frontend\tests\_pages\ContactPage;
+use frontend\WebGuy;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that contact works');

apps/advanced/frontend/tests/acceptance/HomeCept.php

@@ -1,5 +1,7 @@
 <?php
 
+use frontend\WebGuy;
+
 $I = new WebGuy($scenario);
 $I->wantTo('ensure that home page works');
 $I->amOnPage(Yii::$app->homeUrl);

apps/advanced/frontend/tests/acceptance/LoginCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use common\tests\_pages\LoginPage;
+use frontend\WebGuy;
 
 $I = new WebGuy($scenario);
 $I->wantTo('ensure login page works');

apps/advanced/frontend/tests/functional/AboutCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use frontend\tests\_pages\AboutPage;
+use frontend\TestGuy;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that about works');

apps/advanced/frontend/tests/functional/ContactCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use frontend\tests\_pages\ContactPage;
+use frontend\TestGuy;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that contact works');

apps/advanced/frontend/tests/functional/HomeCept.php

@@ -1,5 +1,7 @@
 <?php
 
+use frontend\TestGuy;
+
 $I = new TestGuy($scenario);
 $I->wantTo('ensure that home page works');
 $I->amOnPage(Yii::$app->homeUrl);

apps/advanced/frontend/tests/functional/LoginCept.php

@@ -1,6 +1,7 @@
 <?php
 
 use common\tests\_pages\LoginPage;
+use frontend\TestGuy;
 
 $I = new TestGuy($scenario);
 $I->wantTo('ensure login page works');

apps/advanced/frontend/tests/functional/_config.php

@@ -1,8 +1,8 @@
 <?php
 
 // set correct script paths
-$_SERVER['SCRIPT_FILENAME'] = TEST_ENTRY_FILE;
-$_SERVER['SCRIPT_NAME'] = TEST_ENTRY_URL;
+$_SERVER['SCRIPT_FILENAME'] = dirname(dirname(__DIR__)) . '/web/index-test.php';
+$_SERVER['SCRIPT_NAME'] = \Codeception\Configuration::config()['config']['test_entry_url'];;
 
 return yii\helpers\ArrayHelper::merge(
     require(__DIR__ . '/../../config/main.php'),

apps/advanced/tests/_log/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

docs/guide-ru/rest-authentication.md

@@ -0,0 +1,124 @@
+Аутентификация
+==============
+
+В отличие от Web-приложений, RESTful API обычно не сохраняют информацию о состоянии, а это означает, что сессии и куки
+использовать не следует. Следовательно, раз состояние аутентификации пользователя не может быть сохранено в сессиях или куках,
+каждый запрос должен приходить вместе с определенным видом параметров аутентификации. Общепринятая практика состоит в том,
+что для аутентификации пользователя с каждый запросом отправляется секретный токен доступа. Так как токен доступа
+может использоваться для уникальной идентификации и аутентификации пользователя, **запросы к API всегда должны отсылаться
+через протокол HTTPS, чтобы предотвратить атаки «человек посередине» (англ. "man-in-the-middle", MitM)**.
+
+Есть различные способы отправки токена доступа:
+
+* [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication): токен доступа
+  отправляется как имя пользователя. Такой подход следует использовать только в том случае, когда токен доступа может быть безопасно сохранен
+  на стороне абонента API. Например, если API используется программой, запущенной на сервере.
+* Параметр запроса: токен доступа отправляется как параметр запроса в URL-адресе API, т.е. примерно таким образом:
+  `https://example.com/users?access-token=xxxxxxxx`. Так как большинство Web-серверов сохраняют параметры запроса в своих логах,
+  такой подход следует применять только при работе с `JSONP`-запросами, которые не могут отправлять токены доступа
+ в HTTP-заголовках.
+* [OAuth 2](http://oauth.net/2/): токен доступа выдается абоненту API сервером авторизации
+  и отправляется API-серверу через [HTTP Bearer Tokens](http://tools.ietf.org/html/rfc6750),
+  в соответствии с протоколом OAuth2.
+
+Yii поддерживает все выше перечисленные методы аутентификации. Вы также можете легко создавать новые методы аутентификации.
+
+Чтобы включить аутентификацию для ваших API, выполните следующие шаги:
+
+1. У компонента приложения `user` установите свойство [[yii\web\User::enableSession|enableSession]] равным false.
+2. Укажите, какие методы аутентификации вы планируете использовать, настроив поведение `authenticator`
+   в ваших классах REST-контроллеров.
+3. Реализуйте метод [[yii\web\IdentityInterface::findIdentityByAccessToken()]] *в вашем [[yii\web\User::identityClass|классе UserIdentity]]*.
+
+Шаг 1 не обязателен, но рекомендуется его все-таки выполнить, так как RESTful API не должны сохранять информацию о состоянии клиента. Когда свойство [[yii\web\User::enableSession|enableSession]]
+ установлено в false, состояние аутентификации пользователя НЕ БУДЕТ постоянно 
+сохраняться между запросами с использованием сессий. Вместо этого аутентификация будет выполняться для каждого запроса, что достигается шагами 2 и 3.
+
+> Подсказка: если вы разрабатываете RESTful API в пределах приложения, вы можете настроить свойство
+ [[yii\web\User::enableSession|enableSession]] компонента приложения `user` в конфигурации приложения. Если вы разрабатываете
+  RESTful API как модуль, можете добавить следующую строчку в метод `init()` модуля:
+> ```php
+public function init()
+{
+    parent::init();
+    \Yii::$app->user->enableSession = false;
+}
+```
+
+Например, для использования HTTP Basic Auth, вы можете настроить свойство `authenticator` следующим образом:
+
+```php
+use yii\filters\auth\HttpBasicAuth;
+
+public function behaviors()
+{
+    $behaviors = parent::behaviors();
+    $behaviors['authenticator'] = [
+        'class' => HttpBasicAuth::className(),
+    ];
+    return $behaviors;
+}
+```
+
+Если вы хотите включить поддержку всех трех описанных выше методов аутентификации, можете использовать `CompositeAuth`:
+
+```php
+use yii\filters\auth\CompositeAuth;
+use yii\filters\auth\HttpBasicAuth;
+use yii\filters\auth\HttpBearerAuth;
+use yii\filters\auth\QueryParamAuth;
+
+public function behaviors()
+{
+    $behaviors = parent::behaviors();
+    $behaviors['authenticator'] = [
+        'class' => CompositeAuth::className(),
+        'authMethods' => [
+            HttpBasicAuth::className(),
+            HttpBearerAuth::className(),
+            QueryParamAuth::className(),
+        ],
+    ];
+    return $behaviors;
+}
+```
+
+Каждый элемент в массиве `authMethods` должен быть названием класса метода аутентификации или массивом настроек.
+
+
+Реализация метода `findIdentityByAccessToken()` определяется особенностями приложения. Например, в простом варианте,
+когда у каждого пользователя есть только один токен доступа, вы можете хранить этот токен в поле `access_token`
+таблицы пользователей. В этом случае метод `findIdentityByAccessToken()` может быть легко реализован в классе `User` следующим образом:
+
+```php
+use yii\db\ActiveRecord;
+use yii\web\IdentityInterface;
+
+class User extends ActiveRecord implements IdentityInterface
+{
+    public static function findIdentityByAccessToken($token, $type = null)
+    {
+        return static::findOne(['access_token' => $token]);
+    }
+}
+```
+
+После включения аутентификации описанным выше способом при каждом запросе к API запрашиваемый контроллер
+будет пытаться аутентифицировать пользователя в своем методе `beforeAction()`.
+
+Если аутентификация прошла успешно, контроллер выполнит другие проверки (ограничение на количество запросов, авторизация)
+и затем выполнит действие. *Информация о подлинности аутентифицированного пользователя может быть получена из объекта `Yii::$app->user->identity`*.
+
+Если аутентификация прошла неудачно, будет возвращен ответ с HTTP-кодом состояния 401 вместе с другими необходимыми заголовками
+(такими, как заголовок `WWW-Authenticate` для HTTP Basic Auth).
+
+
+## Авторизация <a name="authorization"></a>
+
+После аутентификации пользователя вы, вероятно, захотите проверить, есть ли у него или у нее разрешение на выполнение запрошенного
+действия с запрошенным ресурсом. Этот процесс называется *авторизацией* и подробно описан
+в разделе [Авторизация](security-authorization.md).
+
+Если ваши контроллеры унаследованы от [[yii\rest\ActiveController]], вы можете переопределить
+метод [[yii\rest\Controller::checkAccess()|checkAccess()]] для выполнения авторизации. Этот метод будет вызываться
+встроенными действиями, предоставляемыми контроллером [[yii\rest\ActiveController]].