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.
Test Failed
Push — master ( 292c14...96865b )
by Jamie
07:21
created

Container::getMetadata()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 2
Bugs 0 Features 2
Metric Value
c 2
b 0
f 2
dl 0
loc 5
ccs 2
cts 2
cp 1
rs 9.4285
cc 1
eloc 3
nc 1
nop 0
crap 1
1
<?php
2
3
namespace OpenStack\ObjectStore\v1\Models;
4
5
use GuzzleHttp\Promise\Promise;
6
use GuzzleHttp\Psr7\LimitStream;
7
use Psr\Http\Message\ResponseInterface;
8
use OpenStack\Common\Error\BadResponseError;
9
use OpenStack\Common\Resource\AbstractResource;
10
use OpenStack\Common\Resource\Creatable;
11
use OpenStack\Common\Resource\Deletable;
12
use OpenStack\Common\Resource\HasMetadata;
13
use OpenStack\Common\Resource\Listable;
14
use OpenStack\Common\Resource\Retrievable;
15
16
/**
17
 * @property \OpenStack\ObjectStore\v1\Api $api
18
 */
19
class Container extends AbstractResource implements Creatable, Deletable, Retrievable, Listable, HasMetadata
20
{
21
    use MetadataTrait;
22
23
    const METADATA_PREFIX = 'X-Container-Meta-';
24
25
    /** @var int */
26
    public $objectCount;
27
28
    /** @var int */
29
    public $bytesUsed;
30
31
    /** @var string */
32
    public $name;
33
34
    /** @var array */
35
    public $metadata;
36
37
    protected $markerKey = 'name';
38
39
    /**
40 4
     * {@inheritdoc}
41
     */
42 4
    public function populateFromResponse(ResponseInterface $response)
43
    {
44 4
        parent::populateFromResponse($response);
45 4
46 4
        $this->objectCount = $response->getHeaderLine('X-Container-Object-Count');
0 ignored issues
show
Documentation Bug introduced by
The property $objectCount was declared of type integer, but $response->getHeaderLine...ontainer-Object-Count') is of type string. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
47 4
        $this->bytesUsed = $response->getHeaderLine('X-Container-Bytes-Used');
0 ignored issues
show
Documentation Bug introduced by
The property $bytesUsed was declared of type integer, but $response->getHeaderLine...-Container-Bytes-Used') is of type string. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
48
        $this->metadata = $this->parseMetadata($response);
49
    }
50
51
    /**
52
     * Retrieves a collection of object resources in the form of a generator.
53
     *
54
     * @param array         $options {@see \OpenStack\ObjectStore\v1\Api::getContainer}
55
     * @param callable|null $mapFn   Allows a function to be mapped over each element.
56
     *
57 1
     * @return \Generator
58
     */
59 1
    public function listObjects(array $options = [], callable $mapFn = null)
60 1
    {
61
        $options = array_merge($options, ['name' => $this->name, 'format' => 'json']);
62
        return $this->model(Object::class)->enumerate($this->api->getContainer(), $options, $mapFn);
63
    }
64
65
    /**
66 1
     * {@inheritdoc}
67
     */
68 1
    public function retrieve()
69 1
    {
70 1
        $response = $this->executeWithState($this->api->headContainer());
71
        $this->populateFromResponse($response);
72
    }
73
74
    /**
75
     * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer}
76
     *
77 2
     * @return $this
78
     */
79 2
    public function create(array $data)
80
    {
81 2
        $response = $this->execute($this->api->putContainer(), $data);
82 2
83
        $this->populateFromResponse($response);
84 2
        $this->name = $data['name'];
85
86
        return $this;
87
    }
88
89
    /**
90 1
     * {@inheritdoc}
91
     */
92 1
    public function delete()
93 1
    {
94
        $this->executeWithState($this->api->deleteContainer());
95
    }
96
97
    /**
98 2
     * {@inheritdoc}
99
     */
100 2
    public function mergeMetadata(array $metadata)
101 1
    {
102
        $response = $this->execute($this->api->postContainer(), ['name' => $this->name, 'metadata' => $metadata]);
103
        return $this->parseMetadata($response);
104
    }
105
106
    /**
107 1
     * {@inheritdoc}
108
     */
109 View Code Duplication
    public function resetMetadata(array $metadata)
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...
110 1
    {
111 1
        $options = [
112 1
            'name'           => $this->name,
113 1
            'removeMetadata' => [],
114
            'metadata'       => $metadata,
115 1
        ];
116 1
117 1
        foreach ($this->getMetadata() as $key => $val) {
118 1
            if (!array_key_exists($key, $metadata)) {
119 1
                $options['removeMetadata'][$key] = 'True';
120
            }
121 1
        }
122 1
123
        $response = $this->execute($this->api->postContainer(), $options);
124
        return $this->parseMetadata($response);
125
    }
126
127
    /**
128 2
     * {@inheritdoc}
129
     */
130 2
    public function getMetadata()
131 2
    {
132
        $response = $this->executeWithState($this->api->headContainer());
133
        return $this->parseMetadata($response);
134
    }
135
136
    /**
137
     * Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and
138
     * the name of this container. A HTTP call will not be executed by default - you need to call
139
     * {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that.
140
     *
141
     * @param string $name The name of the object
142
     *
143 4
     * @return Object
144
     */
145 4
    public function getObject($name)
146
    {
147
        return $this->model(Object::class, ['containerName' => $this->name, 'name' => $name]);
148
    }
149
150
    /**
151
     * Identifies whether an object exists in this container.
152
     *
153
     * @param string $name The name of the object.
154
     *
155
     * @return bool TRUE if the object exists, FALSE if it does not.
156
     *
157
     * @throws BadResponseError For any other HTTP error which does not have a 404 Not Found status.
158 3
     * @throws \Exception       For any other type of fatal error.
159
     */
160 View Code Duplication
    public function objectExists($name)
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...
161 3
    {
162 1
        try {
163 2
            $this->getObject($name)->retrieve();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface OpenStack\Common\Resource\ResourceInterface as the method retrieve() does only exist in the following implementations of said interface: OpenStack\BlockStorage\v2\Models\Snapshot, OpenStack\BlockStorage\v2\Models\Volume, OpenStack\Compute\v2\Models\Flavor, OpenStack\Compute\v2\Models\Image, OpenStack\Compute\v2\Models\Server, OpenStack\Identity\v3\Models\Credential, OpenStack\Identity\v3\Models\Domain, OpenStack\Identity\v3\Models\Group, OpenStack\Identity\v3\Models\Policy, OpenStack\Identity\v3\Models\Project, OpenStack\Identity\v3\Models\Service, OpenStack\Identity\v3\Models\Token, OpenStack\Identity\v3\Models\User, OpenStack\Images\v2\Models\Image, OpenStack\Images\v2\Models\Member, OpenStack\Networking\v2\Models\Network, OpenStack\Networking\v2\Models\Subnet, OpenStack\ObjectStore\v1\Models\Account, OpenStack\ObjectStore\v1\Models\Container, OpenStack\ObjectStore\v1\Models\Object.

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...
164 2
            return true;
165 1
        } catch (BadResponseError $e) {
166
            if ($e->getResponse()->getStatusCode() === 404) {
167 1
                return false;
168
            }
169
            throw $e;
170
        }
171
    }
172
173
    /**
174
     * Creates a single object according to the values provided.
175
     *
176
     * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject}
177
     *
178 1
     * @return Object
179
     */
180 1
    public function createObject(array $data)
181
    {
182
        return $this->model(Object::class)->create($data + ['containerName' => $this->name]);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface OpenStack\Common\Resource\ResourceInterface as the method create() does only exist in the following implementations of said interface: OpenStack\BlockStorage\v2\Models\Snapshot, OpenStack\BlockStorage\v2\Models\Volume, OpenStack\BlockStorage\v2\Models\VolumeType, OpenStack\Compute\v2\Models\Server, OpenStack\Identity\v3\Models\Credential, OpenStack\Identity\v3\Models\Domain, OpenStack\Identity\v3\Models\Endpoint, OpenStack\Identity\v3\Models\Group, OpenStack\Identity\v3\Models\Policy, OpenStack\Identity\v3\Models\Project, OpenStack\Identity\v3\Models\Role, OpenStack\Identity\v3\Models\Service, OpenStack\Identity\v3\Models\Token, OpenStack\Identity\v3\Models\User, OpenStack\Images\v2\Models\Image, OpenStack\Images\v2\Models\Member, OpenStack\Networking\v2\Models\Network, OpenStack\Networking\v2\Models\Port, OpenStack\Networking\v2\Models\Subnet, OpenStack\ObjectStore\v1\Models\Container, OpenStack\ObjectStore\v1\Models\Object.

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...
183
    }
184
185
    /**
186
     * Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding
187
     * container. When this completes, a manifest file is uploaded which references the prefix of the segments,
188
     * allowing concatenation when a request is executed against the manifest.
189
     *
190
     * @param array  $data                     {@see \OpenStack\ObjectStore\v1\Api::putObject}
191
     * @param int    $data['segmentSize']      The size in Bytes of each segment
0 ignored issues
show
Bug introduced by
There is no parameter named $data['segmentSize']. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
192
     * @param string $data['segmentContainer'] The container to which each segment will be uploaded
0 ignored issues
show
Bug introduced by
There is no parameter named $data['segmentContainer']. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
193
     * @param string $data['segmentPrefix']    The prefix that will come before each segment. If omitted, a default
0 ignored issues
show
Bug introduced by
There is no parameter named $data['segmentPrefix']. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
194
     *                                         is used: name/timestamp/filesize
195
     *
196
     * @return Object
197
     */
198
    public function createLargeObject(array $data)
199
    {
200
        /** @var \Psr\Http\Message\StreamInterface $stream */
201
        $stream = $data['stream'];
202
203
        $segmentSize      = isset($data['segmentSize']) ? $data['segmentSize'] : 1073741824;
204
        $segmentContainer = isset($data['segmentContainer']) ? $data['segmentContainer'] : $this->name . '_segments';
205
        $segmentPrefix    = isset($data['segmentPrefix'])
206
            ? $data['segmentPrefix']
207
            : sprintf("%s/%s/%d", $data['name'], microtime(true), $stream->getSize());
208
209
        /** @var \OpenStack\ObjectStore\v1\Service $service */
210
        $service = $this->getService();
211
        if (!$service->containerExists($segmentContainer)) {
212
            $service->createContainer(['name' => $segmentContainer]);
213
        }
214
215
        $promises = [];
216
        $count    = 0;
217
218
        while (!$stream->eof() && $count < round($stream->getSize() / $segmentSize)) {
219
            $promises[] = $this->model(Object::class)->createAsync([
0 ignored issues
show
Bug introduced by
The method createAsync() does not seem to exist on object<OpenStack\Common\...urce\ResourceInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
220
                'name'          => sprintf("%s/%d", $segmentPrefix, ++$count),
221
                'stream'        => new LimitStream($stream, $segmentSize, ($count - 1) * $segmentSize),
222
                'containerName' => $segmentContainer,
223
            ]);
224
        }
225
226
        /** @var Promise $p */
227
        $p = \GuzzleHttp\Promise\all($promises);
228
        $p->wait();
229
230
        return $this->createObject([
231
            'name'           => $data['name'],
232
            'objectManifest' => sprintf("%s/%s", $segmentContainer, $segmentPrefix),
233
        ]);
234
    }
235
}