v2-beta

Author: ganigeorgiev

.bowerrc

@@ -0,0 +1,3 @@
+{
+    "directory" : "vendor/bower-asset"
+}

.gitignore

@@ -0,0 +1,35 @@
+# yii console command
+/yii
+/yii_test
+
+# phpstorm project files
+.idea
+
+# netbeans project files
+nbproject
+
+# zend studio for eclipse project files
+.buildpath
+.project
+.settings
+
+# windows thumbnail cache
+Thumbs.db
+
+# composer vendor dir
+/vendor
+
+# composer itself is not needed
+composer.phar
+
+# Mac DS_Store Files
+.DS_Store
+
+# phpunit itself is not needed
+phpunit.phar
+# local phpunit config
+/phpunit.xml
+
+# todo notes
+/todo.todo
+/todo.txt

LICENSE.md

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Gani Georgiev
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,138 @@
+Presentator v2 REST API [![Yii2](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](http://www.yiiframework.com/)
+======================================================================
+
+Presentator v2 REST API server implementation, written in PHP and based on [Yii2](https://www.yiiframework.com/).
+
+**Detailed API reference could be found here - [https://presentator.io/docs](https://presentator.io/docs).**
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Development](#development)
+
+> **This repository is READ-ONLY.**
+> **Report issues and send pull requests in the [main Presentator repository](https://github.com/presentator/presentator/issues).**
+
+
+## Requirements
+
+- Apache/Nginx HTTP server
+
+- SQL database (MySQL/MariadDB/PostgreSQL)
+
+- PHP 7.1+ with the following extensions:
+
+    ```
+    Reflection
+    PCRE
+    SPL
+    MBString
+    OpenSSL
+    Intl
+    ICU version
+    Fileinfo
+    DOM extensions
+    GD or Imagick
+    ```
+
+For more detailed check, run `php requirements.php` from the application root directory.
+
+
+## Installation
+
+Before getting started make sure that you have checked the project requirements and installed [Composer](https://getcomposer.org/).
+
+1. Clone or download the repo.
+
+    > **For security reasons, if you are using a shared hosting service it is recommended to place the project files outside from your default public_html(www) directory!**
+
+2. Setup a vhost/server address (eg. `http://api.presentator.local/`) and point it to `web/`.
+
+3. Run the following commands:
+
+    ```bash
+    # navigate to the project root dir
+    cd /path/to/project
+
+    # install vendor dependencies
+    composer install
+
+    # execute the init command and select the appropriate environment:
+    # dev     - for development
+    # prod    - for production
+    # starter - this is used only for the the starter project setup (https://github.com/presentator/presentator-starter)
+    php init
+    ```
+
+4. Create a new database (with `utf8mb4_unicode_ci` or `utf8_unicode_ci` collation) and adjust the db, mailer and other component configurations in `config/base-local.php` accordingly.
+
+    > **All available app components with their default values could be found in `config/base.php`.**
+
+5. Adjust the application parameters in `config/params-local.php.`.
+
+    > **All available app parameters with their default values could be found in `config/params.php`.**
+
+6. Apply DB migrations.
+
+    ```bash
+    php /path/to/project/yii migrate
+    ```
+
+7. (optional) Setup a cron task to process unread screen comments:
+
+    ```bash
+    # Every 30 minutes processes all unread screen comments and sends an email to the related users.
+    */30 * * * * php /path/to/project/yii mails/process-comments
+    ```
+
+**That's it!** You should be able to make HTTP requests to the previously defined server address.
+
+Additional console commands you may found useful:
+
+```bash
+# set Super User access rights to a single User model
+php /path/to/project/yii users/super [email protected]
+
+# set Regular User access rights to a single User model
+php /path/to/project/yii users/regular [email protected]
+```
+
+
+## Development
+
+#### Running tests
+
+Presentator uses [Codeception](https://codeception.com/) as its primary test framework.
+
+Running tests require an additional database, which will be cleaned up between tests.
+Create a new database and edit the db component settings in `config/test-local.php` and then run the following console commands:
+
+```bash
+# apply db migrations for the test database
+php path/to/project/yii_test migrate
+
+# build the test suites
+/path/to/project/vendor/bin/codecept build
+
+# start all application tests
+/path/to/project/vendor/bin/codecept run
+```
+
+> Currently only functional tests are available.
+
+#### Conventions
+
+The project makes use of the following conventions:
+
+- *(PHP)* Each class must follow the accepted [PSR standards](https://www.php-fig.org/psr/#accepted).
+- *(PHP)* Each class method should have comment block tags based on [PHPDoc](https://docs.phpdoc.org/references/phpdoc/index.html) (method description is optional).
+- *(DB)* Use InnoDB table engine.
+- *(DB)* Use `utf8mb4_unicode_ci` or `utf8_unicode_ci` collation.
+- *(DB)* Table names must match with the corresponding AR model class name (eg. `UserProjectRel`).
+- *(DB)* Table columns must be in camelCase format (eg. `passwordResetToken`)
+- *(DB)* Each database change must be applied via Yii migrations.
+- *(DB)* Whenever is possible add named foreign keys and indexes in the following format `fk_{FROM_TABLE}_to_{TO_TABLE}` and `idx_{TABLE}_{COLUMN(S)}` (eg. `fk_ProjectLink_to_Project`, `idx_ProjectLink_slug`)
+
+#### DB schema
+
+![erd](https://u.cubeupload.com/presentator/presentatorv2erd.png)
+

authclients/GitLab.php

@@ -0,0 +1,98 @@
+<?php
+namespace presentator\api\authclients;
+
+use yii\authclient\OAuth2;
+
+/**
+ * GitLab allows authentication via GitLab OAuth.
+ *
+ * In order to use GitLab OAuth you must register your application at <https://gitlab.com/profile/applications>.
+ *
+ * Example application configuration:
+ *
+ * ```php
+ * 'components' => [
+ *     'authClientCollection' => [
+ *         'class' => \yii\authclient\Collection::class,
+ *         'clients' => [
+ *             'gitlab' => [
+ *                 'class'        => \presentator\api\authclients\GitLab::class,
+ *                 'domain'       => 'https://gitlab.com'
+ *                 'clientId'     => 'gitlab_client_id',
+ *                 'clientSecret' => 'gitlab_client_secret',
+ *             ],
+ *         ],
+ *     ],
+ *     // ...
+ * ]
+ * ```
+ *
+ * @see https://docs.gitlab.com/ee/api/oauth2.html
+ * @see https://gitlab.com/profile/applications
+ *
+ * @author Dmitriy Kuts <[email protected]>
+ * @author Gani Georgiev <[email protected]>
+ */
+class GitLab extends OAuth2
+{
+    /**
+     * @var string
+     */
+    public $domain = 'https://gitlab.com';
+
+    /**
+     * {@inheritdoc}
+     */
+    public $authUrl = '/oauth/authorize';
+
+    /**
+     * {@inheritdoc}
+     */
+    public $tokenUrl = '/oauth/token';
+
+    /**
+     * {@inheritdoc}
+     */
+    public $apiBaseUrl = '/api/v4/';
+
+    /**
+     * {@inheritdoc}
+     */
+    public $scope = 'read_user';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function init()
+    {
+        parent::init();
+
+        $this->authUrl    = $this->domain . $this->authUrl;
+        $this->tokenUrl   = $this->domain . $this->tokenUrl;
+        $this->apiBaseUrl = $this->domain . $this->apiBaseUrl;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function initUserAttributes()
+    {
+        return $this->api('user', 'GET');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function defaultName()
+    {
+        return 'gitlab';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function defaultTitle()
+    {
+        return 'GitLab';
+    }
+}