refactor: #40 set project name once

Author: shaunthegeek

.github/workflows/ci.yml

@@ -38,10 +38,11 @@ jobs:
  - name: Acceptance Test
 run: ./vendor/bin/phpunit tests/Acceptance
 env:
-CODING_TOKEN: ${{secrets.CODING_TOKEN }}
+CODING_PERSONAL_TOKEN: ${{secrets.CODING_PERSONAL_TOKEN }}
 CODING_PASSWORD: ${{secrets.CODING_PASSWORD }}
 CODING_USERNAME: ${{secrets.CODING_USERNAME }}
 CODING_TEAM_DOMAIN: ${{secrets.CODING_TEAM_DOMAIN }}
+CODING_PROJECT_TOKEN: ${{secrets.CODING_PROJECT_TOKEN }}
 CODING_PROJECT_NAME: ${{secrets.CODING_PROJECT_NAME }}
 CODING_DEPOT_ID: ${{secrets.CODING_DEPOT_ID }}
 

README.md

@@ -20,15 +20,20 @@ composer require coding/sdk
 
 require 'vendor/autoload.php'
 
+use Coding\Client;
 use Coding\Iteration;
 
-$iteration = new Iteration('c127894e5a851cef22dc317f882dfb9ca6054321');
+$client = new Client();
 $projectName = 'project-foo'
+$client->setProjectName($projectName);
+$client->setProjectToken('c127894e5a851cef22dc317f882dfb9ca6054321');
+
+$iteration = new Iteration($client);
 $result = $iteration->create([
- 'ProjectName' => $projectName,
  'Name' => 'Sprint 1',
 ]);
-echo "https://my-team.coding.net/p/{$projectName}/iterations/${result['Code']}/issues\n"
+$teamDomain = 'my-team'
+echo "https://${teamDomain}.coding.net/p/{$projectName}/iterations/${result['Code']}/issues\n"
 ```
 
 ## Resources

src/Base.php

@@ -7,16 +7,11 @@
 
 abstractclass Base
 {
-protectedCore$core;
+protectedClient$client;
 
-publicfunction__construct(string$token = '', Core$core = null)
+publicfunction__construct(Client$client = null)
 {
-$this->core = $core ?? newCore($token);
- }
-
-publicfunctionsetToken(string$token)
-{
-$this->core->setToken($token);
+$this->client = $client ?? newClient();
  }
 
 protectedfunctionvalidate(array$data, array$rules)

src/Client.php

@@ -0,0 +1,97 @@
+<?php
+
+namespaceCoding;
+
+useCoding\Exceptions\ApiError;
+useCoding\Exceptions\ValidationException;
+useGuzzleHttp\ClientasGuzzleClient;
+useGuzzleHttp\ClientInterface;
+useInvalidArgumentException;
+
+class Client
+{
+privateconstAPI_URL = 'https://e.coding.net/open-api';
+
+protectedarray$config;
+protectedstring$token;
+publicbool$usePersonalToken = false;
+protected ?ClientInterface$http = null;
+
+publicfunction__construct(array$config = [])
+{
+$this->config = array_merge([
+'api_url' => self::API_URL,
+'personal_token' => '',
+'project_name' => '',
+'project_token' => '',
+ ], $config);
+ }
+
+publicfunctionsetHttpClient(ClientInterface$http): void
+{
+$this->http = $http;
+ }
+
+publicfunctiongetHttpClient(): ClientInterface
+{
+if (null === $this->http){
+$this->http = newGuzzleClient();
+ }
+
+return$this->http;
+ }
+
+publicfunctionrequest(string$action, array$data)
+{
+$params = ['Action' => $action];
+$response = $this->getHttpClient()->request('POST', $this->config['api_url'], [
+'headers' => [
+'Accept' => 'application/json',
+'Authorization' => 'token ' . $this->getToken(),
+'Content-Type' => 'application/json'
+ ],
+'json' => array_merge($params, $data),
+ ]);
+$result = json_decode($response->getBody(), true);
+if (isset($result['Response']['Error']['Message'])){
+thrownewApiError($result['Response']['Error']['Message']);
+ }
+return$result['Response'];
+ }
+
+publicfunctionrequestProjectApi(string$action, array$data = [])
+{
+if (empty($this->config['project_name'])){
+thrownewValidationException('Need set project name first.');
+ }
+$data['ProjectName'] = $this->config['project_name'];
+return$this->request($action, $data);
+ }
+
+publicfunctionsetPersonalToken(string$token)
+{
+$this->config['personal_token'] = $token;
+ }
+
+publicfunctionsetProjectName(string$projectName)
+{
+$this->config['project_name'] = $projectName;
+ }
+
+publicfunctionsetProjectToken(string$token)
+{
+$this->config['project_token'] = $token;
+ }
+
+privatefunctiongetToken()
+{
+if ($this->usePersonalToken){
+if (empty($this->config['personal_token'])){
+thrownewInvalidArgumentException('Need set project token first.');
+ }
+return$this->config['personal_token'];
+ }
+return !empty($this->config['project_token']) ?
+$this->config['project_token'] : $this->config['personal_token'];
+ }
+}

src/Core.php

@@ -15,7 +15,7 @@ public function index(array $data)
 'KeyWord' => 'string', // 搜索关键字
  ]);
 $data['DepotId'] = intval($data['DepotId']);
-$response = $this->core->request('DescribeGitBranches', $data);
+$response = $this->client->requestProjectApi('DescribeGitBranches', $data);
 return$response['Branches'];
  }
 }

src/GitBranch.php

@@ -17,7 +17,6 @@ class Issue extends Base
 publicfunctioncreate(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'Name' => 'string|required',
 'Priority' => [
 'string',
@@ -58,34 +57,31 @@ public function create(array $data)
 // 自定义属性值列表 Array of IssueCustomFieldForm
 'CustomFieldValues' => 'nullable|array',
  ]);
-$response = $this->core->request('CreateIssue', $data);
+$response = $this->client->requestProjectApi('CreateIssue', $data);
 return$response['Issue'];
  }
 
 publicfunctiondelete(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IssueCode' => 'integer|required',
  ]);
-$this->core->request('DeleteIssue', $data);
+$this->client->requestProjectApi('DeleteIssue', $data);
 returntrue;
  }
 
 publicfunctionget(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IssueCode' => 'integer|required',
  ]);
-$response = $this->core->request('DescribeIssue', $data);
+$response = $this->client->requestProjectApi('DescribeIssue', $data);
 return$response['Issue'];
  }
 
 publicfunctionupdate(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IssueCode' => 'integer',
 'ParentCode' => 'nullable|integer',
 'Name' => 'nullable|string',
@@ -118,7 +114,7 @@ public function update(array $data)
 // 自定义属性值列表 Array of IssueCustomFieldForm
 'CustomFieldValues' => 'nullable|array',
  ]);
-$response = $this->core->request('ModifyIssue', $data);
+$response = $this->client->requestProjectApi('ModifyIssue', $data);
 return$response['Issue'];
  }
 }

src/Issue.php

@@ -7,49 +7,45 @@ class Iteration extends Base
 publicfunctioncreate(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'Name' => 'string|required',
 'Goal' => 'nullable|string',
 'Assignee' => 'nullable|integer',
 'StartAt' => 'nullable|date_format:Y-m-d',
 'EndAt' => 'nullable|date_format:Y-m-d|after:StartAt',
  ]);
-$response = $this->core->request('CreateIteration', $data);
+$response = $this->client->requestProjectApi('CreateIteration', $data);
 return$response['Iteration'];
  }
 
 publicfunctionget(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IterationCode' => 'integer|required',
  ]);
-$response = $this->core->request('DescribeIteration', $data);
+$response = $this->client->requestProjectApi('DescribeIteration', $data);
 return$response['Iteration'];
  }
 
 publicfunctionupdate(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IterationCode' => 'integer|required',
 'Name' => 'nullable|string',
 'Goal' => 'nullable|string',
 'Assignee' => 'nullable|integer',
 'StartAt' => 'nullable|date_format:Y-m-d',
 'EndAt' => 'nullable|date_format:Y-m-d|after:StartAt',
  ]);
-$response = $this->core->request('ModifyIteration', $data);
+$response = $this->client->requestProjectApi('ModifyIteration', $data);
 return$response['Iteration'];
  }
 
 publicfunctiondelete(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IterationCode' => 'integer|required',
  ]);
-$this->core->request('DeleteIteration', $data);
+$this->client->requestProjectApi('DeleteIteration', $data);
 returntrue;
  }
 }

src/Iteration.php

@@ -6,26 +6,22 @@
 
 class ProjectSetting extends Base
 {
-publicfunctiongetIssueTypes(array$data)
+publicfunctiongetIssueTypes()
 {
-$this->validate($data, [
-'ProjectName' => 'string|required',
- ]);
-$response = $this->core->request('DescribeProjectIssueTypeList', $data);
+$response = $this->client->requestProjectApi('DescribeProjectIssueTypeList');
 return$response['IssueTypes'];
  }
 
 publicfunctiongetIssueStatuses(array$data)
 {
 $this->validate($data, [
-'ProjectName' => 'string|required',
 'IssueType' => [
 'required_without:IssueTypeId',
  Rule::in(Issue::TYPE),
  ],
 'IssueTypeId' => 'nullable|integer',
  ]);
-$response = $this->core->request('DescribeProjectIssueStatusList', $data);
+$response = $this->client->requestProjectApi('DescribeProjectIssueStatusList', $data);
 return$response['ProjectIssueStatusList'];
  }
 }

src/ProjectSetting.php

@@ -2,9 +2,7 @@
 
 namespaceTests\Acceptance;
 
-useCoding\Core;
-useCoding\Issue;
-useGuzzleHttp\Client;
+useGuzzleHttp\ClientasGuzzleClient;
 useGuzzleHttp\Psr7;
 
 class ArtifactTest extends TestCase
@@ -16,22 +14,22 @@ public function testUploadAndDownload()
 $package = 'status.txt';
 $version = date('Ymd.Hi.s', time());
 file_put_contents($package, $version);
-$client = newClient();
+$http = newGuzzleClient();
 $body = Psr7\Utils::tryFopen($package, 'r');
 $url = "https://${teamDomain}-generic.pkg.coding.net/${projectName}/generic/${package}?version=${version}";
 $auth = [
 getenv('CODING_USERNAME'),
 getenv('CODING_PASSWORD'),
  ];
-$response = $client->request('PUT', $url, [
+$response = $http->request('PUT', $url, [
 'auth' => $auth,
 'body' => $body,
  ]);
 $this->assertEquals(200, $response->getStatusCode());
 
 // Download
 $tmpfname = tempnam(sys_get_temp_dir(), $package);
-$client->request('GET', $url, [
+$http->request('GET', $url, [
 'auth' => $auth,
 'sink' => $tmpfname,
  ]);