GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Pull Request — master (#1)
by Cees-Jan
03:05
created

Repository::enable()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php declare(strict_types=1);
2
3
namespace ApiClients\Client\Travis\Resource\Async;
4
5
use ApiClients\Client\Pusher\AsyncClient;
6
use ApiClients\Client\Pusher\CommandBus\Command\SharedAppClientCommand;
7
use ApiClients\Client\Travis\CommandBus\Command\BranchesCommand;
8
use ApiClients\Client\Travis\CommandBus\Command\CachesCommand;
9
use ApiClients\Client\Travis\CommandBus\Command\RepositoryCommand;
10
use ApiClients\Client\Travis\CommandBus\Command\RepositoryKeyCommand;
11
use ApiClients\Client\Travis\CommandBus\Command\SettingsCommand;
12
use ApiClients\Client\Travis\CommandBus\Command\VarsCommand;
13
use ApiClients\Foundation\Hydrator\CommandBus\Command\HydrateCommand;
14
use ApiClients\Foundation\Transport\CommandBus\Command\RequestCommand;
15
use ApiClients\Foundation\Transport\CommandBus\Command\SimpleRequestCommand;
16
use ApiClients\Foundation\Transport\JsonStream;
17
use GuzzleHttp\Psr7\Request;
18
use Psr\Http\Message\ResponseInterface;
19
use React\Promise\PromiseInterface;
20
use Rx\Observable;
21
use Rx\ObservableInterface;
22
use Rx\Observer\CallbackObserver;
23
use Rx\ObserverInterface;
24
use Rx\React\Promise;
25
use Rx\SchedulerInterface;
26
use ApiClients\Client\Travis\ApiSettings;
27
use ApiClients\Client\Travis\Resource\Repository as BaseRepository;
28
use function React\Promise\reject;
29
use function React\Promise\resolve;
30
use function ApiClients\Tools\Rx\unwrapObservableFromPromise;
31
32
class Repository extends BaseRepository
33
{
34 View Code Duplication
    public function builds(): Observable
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
35
    {
36
        return Promise::toObservable(
37
            $this->handleCommand(new SimpleRequestCommand('repos/' . $this->slug() . '/builds'))
38
        )->flatMap(function (ResponseInterface $response) {
39
            return Observable::fromArray($response->getBody()->getJson()['builds']);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\StreamInterface as the method getJson() does only exist in the following implementations of said interface: ApiClients\Foundation\Transport\JsonStream.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
40
        })->flatMap(function (array $build) {
41
            return Promise::toObservable($this->handleCommand(new HydrateCommand('Build', $build)));
42
        });
43
    }
44
45
    public function jobs(int $buildId): Observable
46
    {
47
        return Promise::toObservable($this->build($buildId))->flatMap(function (Build $build) {
0 ignored issues
show
Compatibility introduced by
$this->build($buildId) of type object<React\Promise\PromiseInterface> is not a sub-type of object<React\Promise\CancellablePromiseInterface>. It seems like you assume a child interface of the interface React\Promise\PromiseInterface to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
48
            return $build->jobs();
49
        });
50
    }
51
52
    /**
53
     * @param int $id
54
     * @return PromiseInterface
55
     */
56 View Code Duplication
    public function build(int $id): PromiseInterface
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
57
    {
58
        return $this->handleCommand(
59
            new SimpleRequestCommand('repos/' . $this->slug() . '/builds/' . $id)
60
        )->then(function (ResponseInterface $response) {
61
            return resolve($this->handleCommand(
62
                new HydrateCommand('Build', $response->getBody()->getJson()['build'])
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\StreamInterface as the method getJson() does only exist in the following implementations of said interface: ApiClients\Foundation\Transport\JsonStream.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
63
            ));
64
        });
65
    }
66
67
    /**
68
     * @return ObservableInterface
69
     */
70 View Code Duplication
    public function commits(): ObservableInterface
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
71
    {
72
        return Promise::toObservable(
73
            $this->handleCommand(new SimpleRequestCommand('repos/' . $this->slug() . '/builds'))
74
        )->flatMap(function (ResponseInterface $response) {
75
            return Observable::fromArray($response->getBody()->getJson()['commits']);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\StreamInterface as the method getJson() does only exist in the following implementations of said interface: ApiClients\Foundation\Transport\JsonStream.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
76
        })->flatMap(function (array $commit) {
77
            return Promise::toObservable($this->handleCommand(new HydrateCommand('Commit', $commit)));
78
        });
79
    }
80
81
    public function events(): Observable
82
    {
83
        return Observable::create(function (
84
            ObserverInterface $observer,
85
            SchedulerInterface $scheduler
0 ignored issues
show
Unused Code introduced by
The parameter $scheduler is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
86
        ) {
87
            $this->handleCommand(
88
                new SharedAppClientCommand(ApiSettings::PUSHER_KEY)
89
            )->then(function ($pusher) use ($observer) {
90
                $pusher->channel('repo-' . $this->id)->filter(function ($message) {
91
                    return in_array($message->event, [
92
                        'build:created',
93
                        'build:started',
94
                        'build:finished',
95
                    ]);
96
                })->map(function ($message) {
97
                    return json_decode($message->data, true);
98
                })->filter(function ($json) {
99
                    return isset($json['repository']);
100
                })->flatMap(function ($json) {
101
                    return Promise::toObservable(
102
                        $this->handleCommand(
103
                            new HydrateCommand('Repository', $json['repository'])
104
                        )
105
                    );
106
                })->subscribe(new CallbackObserver(function ($repository) use ($observer) {
107
                    $observer->onNext($repository);
108
                }));
109
            });
110
        });
111
    }
112
113
    /**
114
     * @return PromiseInterface
115
     */
116
    public function settings(): PromiseInterface
117
    {
118
        return $this->handleCommand(
119
            new SettingsCommand($this->id())
120
        );
121
    }
122
123
    /**
124
     * @return PromiseInterface
125
     */
126
    public function isActive(): PromiseInterface
127
    {
128
        return $this->handleCommand(new SimpleRequestCommand('hooks'))->then(function (ResponseInterface $response) {
129
            $active = false;
130
            foreach ($response->getBody()->getJson()['hooks'] as $hook) {
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Psr\Http\Message\StreamInterface as the method getJson() does only exist in the following implementations of said interface: ApiClients\Foundation\Transport\JsonStream.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
131
                if ($hook['id'] == $this->id()) {
132
                    $active = (bool)$hook['active'];
133
                    break;
134
                }
135
            }
136
137
            if ($active) {
138
                return resolve($active);
139
            }
140
141
            return reject($active);
142
        });
143
    }
144
145
    /**
146
     * @return PromiseInterface
147
     */
148
    public function enable(): PromiseInterface
149
    {
150
        return $this->setActiveStatus(true);
151
    }
152
153
    /**
154
     * @return PromiseInterface
155
     */
156
    public function disable(): PromiseInterface
157
    {
158
        return $this->setActiveStatus(false);
159
    }
160
161
    /**
162
     * @param bool $status
163
     * @return PromiseInterface
164
     */
165
    protected function setActiveStatus(bool $status)
166
    {
167
        return $this->handleCommand(new RequestCommand(
168
            new Request(
169
                'PUT',
170
                'hooks/' . $this->id(),
171
                [],
172
                new JsonStream([
173
                    'hook' => [
174
                        'active' => $status,
175
                    ],
176
                ])
177
            )
178
        ))->then(function () {
179
            return $this->refresh();
180
        });
181
    }
182
183
    /**
184
     * @return ObservableInterface
185
     */
186
    public function branches(): ObservableInterface
187
    {
188
        return unwrapObservableFromPromise($this->handleCommand(
189
            new BranchesCommand($this->id())
190
        ));
191
    }
192
193
    /**
194
     * @return ObservableInterface
195
     */
196
    public function vars(): ObservableInterface
197
    {
198
        return unwrapObservableFromPromise($this->handleCommand(
199
            new VarsCommand($this->id())
200
        ));
201
    }
202
203
    /**
204
     * @return ObservableInterface
205
     */
206
    public function caches(): ObservableInterface
207
    {
208
        return unwrapObservableFromPromise($this->handleCommand(
209
            new CachesCommand($this->id())
210
        ));
211
    }
212
213
    /**
214
     * @return PromiseInterface
215
     */
216
    public function key(): PromiseInterface
217
    {
218
        return $this->handleCommand(
219
            new RepositoryKeyCommand($this->slug())
220
        );
221
    }
222
223
    public function refresh(): PromiseInterface
224
    {
225
        return $this->handleCommand(
226
            new RepositoryCommand($this->slug)
227
        );
228
    }
229
}
230