Merge branch '10.2' into 11.0

Author: GrahamCampbell

CHANGELOG.md

@@ -1,50 +1,62 @@
-CHANGE LOG
-==========
+# Changelog
 
+All notable changes to this project will be documented in this file.
 
-## 11.0.0-RC1 (UPCOMING)
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [11.0.0-RC1] - UPCOMING
 
 * Removed models API
 * Bumped min PHP to 7.2.5
 
+[11.0.0-RC1]: https://github.com/GitLabPHP/Client/compare/10.2.0...11.0.0-RC1
+
+## [10.2.0] - UPCOMING
 
-## 10.2.0 (UPCOMING)
+* Added variable_type to addVariable and updateVariable
 
+[10.2.0]: https://github.com/GitLabPHP/Client/compare/10.1.1...10.2.0
 
-## 10.1.1 (26/10/2020)
+## [10.1.1] - 2020-10-26
 
 * Fixed phpdoc typo
 * Fixed broken query builder
 
+[10.1.1]: https://github.com/GitLabPHP/Client/compare/10.1.0...10.1.1
 
-## 10.1.0 (24/10/2020)
+## [10.1.0] - 2020-10-24
 
 * Added method to get protected branches for a project
 * Added with_merge_status_recheck option for fetching MRs
 * Added commit cherry-pick API
 * Added support for optional Note parameters 
 * Deprecated models API
 
+[10.1.0]: https://github.com/GitLabPHP/Client/compare/10.0.1...10.1.0
 
-## 10.0.1 (24/10/2020)
+## [10.0.1] - 2020-10-24
 
 * Fixed using the name of a group as an ID
 * Fixed various phpdoc issues
 * Reverted query builder changes
 
+[10.0.1]: https://github.com/GitLabPHP/Client/compare/10.0.0...10.0.1
 
-## 10.0.0 (15/08/2020)
+## [10.0.0] - 2020-08-15
 
 * Added void return types to void methods
 
+[10.0.0]: https://github.com/GitLabPHP/Client/compare/10.0.0-RC2...10.0.0
 
-## 10.0.0-RC2 (23/07/2020)
+## [10.0.0-RC2] - 2020-07-23
 
 * Restored 9.x behaviour for empty JSON responses
 * Support the issue link link_type parameter
 
+[10.0.0-RC2]: https://github.com/GitLabPHP/Client/compare/10.0.0-RC1...10.0.0-RC2
 
-## 10.0.0-RC1 (22/07/2020)
+## [10.0.0-RC1] - 2020-07-22
 
 * Removed all deprecated functionality
 * Switched to PSR-17 and PSR-18
@@ -55,14 +67,16 @@ CHANGE LOG
 * Added scalar param types
 * Added user events API
 
+[10.0.0-RC1]: https://github.com/GitLabPHP/Client/compare/9.18.1...10.0.0-RC1
 
-## 9.18.1 (22/07/2020)
+## [9.18.1] - 2020-07-22
 
 * Fixed error in getHeader function
 * Fixed incorrect param type doc
 
+[9.18.1]: https://github.com/GitLabPHP/Client/compare/9.18.0...9.18.1
 
-## 9.18.0 (11/07/2020)
+## [9.18.0] - 2020-07-11
 
 * Deprecated all APIs that are deprecated or removed as of GitLab 13.1
 * Deprecated old authentication methods and deprecated not specifying an authentication mode
@@ -82,18 +96,22 @@ CHANGE LOG
 * Allow to search and find issues by "assignee_id"
 * Updated Issues to support updated_after
 
+[9.18.0]: https://github.com/GitLabPHP/Client/compare/9.17.1...9.18.0
 
-## 9.17.1 (17/02/2020)
+## [9.17.1] - 2020-02-17
 
 * Fixed text encoding for `Repositories::createCommit()`
 * Corrected lots of phpdoc errors and edges cases
 
+[9.17.1]: https://github.com/GitLabPHP/Client/compare/9.17.0...9.17.1
 
-## 9.17.0 (17/02/2020)
+## [9.17.0] - 2020-02-17
 
 * Added support for the wiki APIs
 * Implemented `Environments::show()`
 * Implemented `Issues::showParticipants()`
 * Add method to get issues for a group
 * Add forks API call to return all forked projects
 * Added users projects request parameters normalization
+
+[9.17.0]: https://github.com/GitLabPHP/Client/compare/9.16.0...9.17.0

src/Api/Projects.php

@@ -848,15 +848,19 @@ public function variable($project_id, string $key)
     }
 
     /**
-     * @param int|string  $project_id
-     * @param string      $key
-     * @param string      $value
-     * @param bool|null   $protected
-     * @param string|null $environment_scope
+     * @param int|string          $project_id
+     * @param string              $key
+     * @param string              $value
+     * @param bool|null           $protected
+     * @param string|null         $environment_scope
+     * @param array<string,mixed> $parameters        {
+     *
+     *      @var string $variable_type  env_var (default) or file
+     * }
      *
      * @return mixed
      */
-    public function addVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null)
+    public function addVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null, array $parameters = [])
     {
         $payload = [
             'key' => $key,
@@ -871,19 +875,25 @@ public function addVariable($project_id, string $key, string $value, ?bool $prot
             $payload['environment_scope'] = $environment_scope;
         }
 
+        $payload = \array_merge($parameters, $payload);
+
         return $this->post($this->getProjectPath($project_id, 'variables'), $payload);
     }
 
     /**
-     * @param int|string  $project_id
-     * @param string      $key
-     * @param string      $value
-     * @param bool|null   $protected
-     * @param string|null $environment_scope
+     * @param int|string          $project_id
+     * @param string              $key
+     * @param string              $value
+     * @param bool|null           $protected
+     * @param string|null         $environment_scope
+     * @param array<string,mixed> $parameters        {
+     *
+     *      @var string $variable_type  env_var (default) or file
+     *}
      *
      * @return mixed
      */
-    public function updateVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null)
+    public function updateVariable($project_id, string $key, string $value, ?bool $protected = null, ?string $environment_scope = null, array $parameters = [])
     {
         $payload = [
             'value' => $value,
@@ -897,6 +907,8 @@ public function updateVariable($project_id, string $key, string $value, ?bool $p
             $payload['environment_scope'] = $environment_scope;
         }
 
+        $payload = \array_merge($parameters, $payload);
+
         return $this->put($this->getProjectPath($project_id, 'variables/'.self::encodePath($key)), $payload);
     }
 

src/Api/Repositories.php

@@ -386,10 +386,13 @@ public function postCommitBuildStatus($project_id, string $sha, string $state, a
      */
     public function compare($project_id, string $fromShaOrMaster, string $toShaOrMaster, bool $straight = false)
     {
-        return $this->get($this->getProjectPath(
-            $project_id,
-            'repository/compare?from='.self::encodePath($fromShaOrMaster).'&to='.self::encodePath($toShaOrMaster).'&straight='.self::encodePath($straight ? 'true' : 'false')
-        ));
+        $params = [
+            'from' => self::encodePath($fromShaOrMaster),
+            'to' => self::encodePath($toShaOrMaster),
+            'straight' => self::encodePath($straight ? 'true' : 'false'),
+        ];
+
+        return $this->get($this->getProjectPath($project_id, 'repository/compare'), $params);
     }
 
     /**

tests/Api/ProjectsTest.php

@@ -1609,6 +1609,53 @@ public function shouldAddVariableWithProtectionAndEnvironment(): void
         );
     }
 
+    /**
+     * @test
+     */
+    public function shouldAddVariableWithEnvironmentAndVariableType(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+            'variable_type' => 'file',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/variables', $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['variable_type' => 'file'])
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function shouldAddVariableWithEnvironmentFromParameterList(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/variables', $expectedArray)
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->addVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['environment_scope' => 'production'])
+        );
+    }
+
     /**
      * @test
      */
@@ -1704,6 +1751,59 @@ public function shouldUpdateVariableWithProtectedAndEnvironment(): void
         );
     }
 
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithEnvironmentAndVariableType(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+            'variable_type' => 'file',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with(
+                'projects/1/variables/DEPLOY_SERVER',
+                ['value' => 'stage.example.com', 'environment_scope' => 'staging', 'variable_type' => 'file']
+            )
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['variable_type' => 'file'])
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateVariableWithEnvironmentFromParameterList(): void
+    {
+        $expectedArray = [
+            'key' => 'DEPLOY_SERVER',
+            'value' => 'stage.example.com',
+            'environment_scope' => 'staging',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('put')
+            ->with(
+                'projects/1/variables/DEPLOY_SERVER',
+                ['value' => 'stage.example.com', 'environment_scope' => 'staging']
+            )
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals(
+            $expectedArray,
+            $api->updateVariable(1, 'DEPLOY_SERVER', 'stage.example.com', null, 'staging', ['environment_scope' => 'production'])
+        );
+    }
+
     /**
      * @test
      */

tests/Api/RepositoriesTest.php

@@ -490,7 +490,7 @@ public function shouldCompareStraight(): void
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/repository/compare?from=master&to=feature&straight=true')
+            ->with('projects/1/repository/compare', ['from' => 'master', 'to' => 'feature', 'straight' => 'true'])
             ->will($this->returnValue($expectedArray))
         ;
 
@@ -507,7 +507,7 @@ public function shouldNotCompareStraight(): void
         $api = $this->getApiMock();
         $api->expects($this->once())
             ->method('get')
-            ->with('projects/1/repository/compare?from=master&to=feature&straight=false')
+            ->with('projects/1/repository/compare', ['from' => 'master', 'to' => 'feature', 'straight' => 'false'])
             ->will($this->returnValue($expectedArray))
         ;