Skip to content

Commit 082a420

Browse files
glaubinixglaubinix
committed
Methods: rename update to edit
1 parent a2f2738 commit 082a420

File tree

9 files changed

+73
-25
lines changed

9 files changed

+73
-25
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ $customerData = [
7979
'urlName' => 'customer',
8080
'accessToVersionControlSource' => false,
8181
];
82-
$customer = $client->customers()->update($customerId, $customerData);
82+
$customer = $client->customers()->edit($customerId, $customerData);
8383
```
8484
Returns the customer.
8585

@@ -96,7 +96,7 @@ $packages = $client->customers()->listPackages($customerId);
9696
```
9797
Returns an array of customer packages.
9898

99-
##### Grant a customer access to a package or update the limitations
99+
##### Grant a customer access to a package or edit the limitations
100100
```php
101101
$customerId = 42;
102102
$packages = [
@@ -108,7 +108,7 @@ $packages = [
108108
];
109109
$packages = $client->customers()->addOrUpdatePackages($customerId, $packages);
110110
```
111-
Returns an array of all added or updated customer packages.
111+
Returns an array of all added or edited customer packages.
112112

113113
##### Revoke access to a package from a customer
114114
```php
@@ -125,7 +125,7 @@ $confirmation = [
125125
];
126126
$composerRepository = $client->customers()->regenerateToken($customerId, $confirmation);
127127
```
128-
Returns the updated Composer repository.
128+
Returns the edited Composer repository.
129129

130130
#### Project
131131

@@ -161,7 +161,7 @@ $teams = $client->projects()->listTeams($projectName);
161161
```
162162
Returns an array of projects teams.
163163

164-
##### Add a team to a project or update the permission
164+
##### Add a team to a project or edit the permission
165165
```php
166166
$projectName = 'project';
167167
$teams = [
@@ -272,14 +272,14 @@ Returns a new job.
272272

273273
##### Update a vcs package
274274
```php
275-
$job = $client->packages()->updateVcsPackage('acme-website/package', 'https://github.com/acme-website/package');
275+
$job = $client->packages()->editVcsPackage('acme-website/package', 'https://github.com/acme-website/package');
276276
```
277277
Returns a new job.
278278

279279
##### Update a custom package
280280
```php
281281
$packageDefinition = '{...}'
282-
$job = $client->packages()->updateCustomPackage('acme-website/package', $packageDefinition);
282+
$job = $client->packages()->editCustomPackage('acme-website/package', $packageDefinition);
283283
```
284284
Returns a new job.
285285

@@ -320,9 +320,9 @@ Returns the new credential.
320320
```php
321321
$credentialId = 42;
322322
$type = \PrivatePackagist\ApiClient\Api\Credentials::TYPE_HTTP_BASIC;
323-
$credential = $client->credentials()->update($credentialId, $type, 'username', 'password');
323+
$credential = $client->credentials()->edit($credentialId, $type, 'username', 'password');
324324
```
325-
Returns the updated credential.
325+
Returns the edited credential.
326326

327327
##### Delete a credential
328328
```php

‎src/Api/Credentials.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,15 @@ public function create($description, $type, $domain, $username, $credential)
3232
]);
3333
}
3434

35+
/**
36+
* @deprecated Use edit instead
37+
*/
3538
public function update($credentialId, $type, $username, $credential)
39+
{
40+
return $this->edit($credentialId, $type, $username, $credential);
41+
}
42+
43+
public function edit($credentialId, $type, $username, $credential)
3644
{
3745
return $this->put(sprintf('/credentials/%s/', $credentialId), [
3846
'username' => $username,

‎src/Api/Customers.php‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,15 @@ public function create($name, $accessToVersionControlSource = false)
2121
return $this->post('/customers/', ['name' => $name, 'accessToVersionControlSource' => $accessToVersionControlSource]);
2222
}
2323

24+
/**
25+
* @deprecated Use edit instead
26+
*/
2427
public function update($customerId, array $customer)
28+
{
29+
return $this->edit($customerId, $customer);
30+
}
31+
32+
public function edit($customerId, array $customer)
2533
{
2634
return $this->put(sprintf('/customers/%s/', $customerId), $customer);
2735
}
@@ -36,7 +44,15 @@ public function listPackages($customerId)
3644
return $this->get(sprintf('/customers/%s/packages/', $customerId));
3745
}
3846

47+
/**
48+
* @deprecated Use addOrEditPackages instead
49+
*/
3950
public function addOrUpdatePackages($customerId, array $packages)
51+
{
52+
return $this->addOrEditPackages($customerId, $packages);
53+
}
54+
55+
public function addOrEditPackages($customerId, array $packages)
4056
{
4157
foreach ($packages as $package) {
4258
if (!isset($package['name'])) {
@@ -48,11 +64,11 @@ public function addOrUpdatePackages($customerId, array $packages)
4864
}
4965

5066
/**
51-
* @deprecated Use addOrUpdatePackages instead
67+
* @deprecated Use addOrEditPackages instead
5268
*/
5369
public function addPackages($customerId, array $packages)
5470
{
55-
return $this->addOrUpdatePackages($customerId, $packages);
71+
return $this->addOrEditPackages($customerId, $packages);
5672
}
5773

5874
public function removePackage($customerId, $packageName)

‎src/Api/Packages.php‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,28 @@ public function createCustomPackage($customJson, $credentials = null)
4646
return $this->post('/packages/', ['repoType' => 'package', 'repoConfig' => $customJson, 'credentials' => $credentials]);
4747
}
4848

49+
/**
50+
* @deprecated Use editVcsPackage instead
51+
*/
4952
public function updateVcsPackage($packageName, $url, $credentials = null)
53+
{
54+
return $this->editVcsPackage($packageName, $url, $credentials);
55+
}
56+
57+
public function editVcsPackage($packageName, $url, $credentials = null)
5058
{
5159
return $this->put(sprintf('/packages/%s/', $packageName), ['repoType' => 'vcs', 'repoUrl' => $url, 'credentials' => $credentials]);
5260
}
5361

62+
/**
63+
* @deprecated Use editCustomPackage instead
64+
*/
5465
public function updateCustomPackage($packageName, $customJson, $credentials = null)
66+
{
67+
return $this->editVcsPackage($packageName, $customJson, $credentials);
68+
}
69+
70+
public function editCustomPackage($packageName, $customJson, $credentials = null)
5571
{
5672
return $this->put(sprintf('/packages/%s/', $packageName), ['repoType' => 'package', 'repoConfig' => $customJson, 'credentials' => $credentials]);
5773
}

‎src/Api/Projects.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,15 @@ public function listTeams($projectsName)
3131
return $this->get(sprintf('/projects/%s/teams/', $projectsName));
3232
}
3333

34+
/**
35+
* @deprecated Use addOrEditTeams instead
36+
*/
3437
public function addOrUpdateTeams($projectName, array $teams)
38+
{
39+
return $this->addOrEditTeams($projectName, $teams);
40+
}
41+
42+
public function addOrEditTeams($projectName, array $teams)
3543
{
3644
foreach ($teams as $team) {
3745
if (!isset($team['id'])) {

‎tests/Api/CredentialsTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public function testCreate()
6969
$this->assertSame($expected, $api->create('My secret credential', 'http-basic', 'localhost', 'username', 'password'));
7070
}
7171

72-
public function testUpdate()
72+
public function testEdit()
7373
{
7474
$expected = [
7575
'id' => 1,
@@ -87,7 +87,7 @@ public function testUpdate()
8787
->with($this->equalTo('/credentials/1/'), $this->equalTo(['type' => 'http-basic', 'username' => 'username', 'credential' => 'password']))
8888
->will($this->returnValue($expected));
8989

90-
$this->assertSame($expected, $api->update(1, 'http-basic', 'username', 'password'));
90+
$this->assertSame($expected, $api->edit(1, 'http-basic', 'username', 'password'));
9191
}
9292

9393
public function testRemove()

‎tests/Api/CustomersTest.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function testCreate()
6363
$this->assertSame($expected, $api->create($name));
6464
}
6565

66-
public function testUpdate()
66+
public function tesEdit()
6767
{
6868
$expected = [
6969
[
@@ -88,7 +88,7 @@ public function testUpdate()
8888
->with($this->equalTo('/customers/1/'), $this->equalTo($customer))
8989
->will($this->returnValue($expected));
9090

91-
$this->assertSame($expected, $api->update(1, $customer));
91+
$this->assertSame($expected, $api->edit(1, $customer));
9292
}
9393

9494
public function testRemove()
@@ -126,7 +126,7 @@ public function testListPackages()
126126
$this->assertSame($expected, $api->listPackages(1));
127127
}
128128

129-
public function testAddOrUpdatePackages()
129+
public function testAddOrEditPackages()
130130
{
131131
$expected = [
132132
[
@@ -146,19 +146,19 @@ public function testAddOrUpdatePackages()
146146
->with($this->equalTo('/customers/1/packages/'), $this->equalTo($packages))
147147
->will($this->returnValue($expected));
148148

149-
$this->assertSame($expected, $api->addOrUpdatePackages(1, $packages));
149+
$this->assertSame($expected, $api->addOrEditPackages(1, $packages));
150150
}
151151

152152
/**
153153
* @expectedException \PrivatePackagist\ApiClient\Exception\InvalidArgumentException
154154
* @expectedExceptionMessage Parameter "name" is required.
155155
*/
156-
public function testAddOrUpdatePackagesMissingName()
156+
public function testAddOrEditPackagesMissingName()
157157
{
158158
/** @var Customers&\PHPUnit_Framework_MockObject_MockObject $api */
159159
$api = $this->getApiMock();
160160

161-
$api->addOrUpdatePackages(1, [[]]);
161+
$api->addOrEditPackages(1, [[]]);
162162
}
163163

164164
public function testRemovePackage()

‎tests/Api/PackagesTest.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public function testCreateCustomPackage()
114114
$this->assertSame($expected, $api->createCustomPackage('{}'));
115115
}
116116

117-
public function testUpdateVcsPackage()
117+
public function testEditVcsPackage()
118118
{
119119
$expected = [
120120
'id' => 'job-id',
@@ -128,10 +128,10 @@ public function testUpdateVcsPackage()
128128
->with($this->equalTo('/packages/acme-website/package/'), $this->equalTo(['repoType' => 'vcs', 'repoUrl' => 'localhost', 'credentials' => null]))
129129
->will($this->returnValue($expected));
130130

131-
$this->assertSame($expected, $api->updateVcsPackage('acme-website/package', 'localhost'));
131+
$this->assertSame($expected, $api->editVcsPackage('acme-website/package', 'localhost'));
132132
}
133133

134-
public function testUpdateCustomPackage()
134+
public function testEditCustomPackage()
135135
{
136136
$expected = [
137137
'id' => 'job-id',
@@ -145,7 +145,7 @@ public function testUpdateCustomPackage()
145145
->with($this->equalTo('/packages/acme-website/package/'), $this->equalTo(['repoType' => 'package', 'repoConfig' => '{}', 'credentials' => null]))
146146
->will($this->returnValue($expected));
147147

148-
$this->assertSame($expected, $api->updateCustomPackage('acme-website/package', '{}'));
148+
$this->assertSame($expected, $api->editCustomPackage('acme-website/package', '{}'));
149149
}
150150

151151
public function testRemove()

‎tests/Api/ProjectsTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public function testListTeams()
8686
$this->assertSame($expected, $api->listTeams('project'));
8787
}
8888

89-
public function testAddOrUpdateTeam()
89+
public function testAddOrEditTeam()
9090
{
9191
$expected = [
9292
[
@@ -107,7 +107,7 @@ public function testAddOrUpdateTeam()
107107
->with($this->equalTo('/projects/project/teams/'), $this->equalTo($teams))
108108
->will($this->returnValue($expected));
109109

110-
$this->assertSame($expected, $api->addOrUpdateTeams('project', $teams));
110+
$this->assertSame($expected, $api->addOrEditTeams('project', $teams));
111111
}
112112

113113
public function testRemoveTeam()

0 commit comments

Comments
 (0)