DynamoDbAdapter::describeTable() - Code Metrics - Inspection of "Namespace is now Guillermoandrae\DynamoDb." - guillermoandrae/php-dynamodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 20a668...02e94f )

by Guillermo A.
created 2020-01-07 00:31 UTC
DynamoDbAdapter::describeTable() A

↳ Parent: DynamoDbAdapter
Complexity

Conditions	3
Paths	8
Size

Total Lines	11
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	8
CRAP Score	3
Importance

Changes
Metric	Value
eloc	8
dl	0
loc	11
c	0
b	0
f	0
ccs	8
cts	8
cp	1
rs	10
cc	3
nc	8
nop	1
crap	3
<?php

namespace Guillermoandrae\DynamoDb;

use Aws\DynamoDb\DynamoDbClient;
use Aws\DynamoDb\Exception\DynamoDbException;
use Aws\DynamoDb\Marshaler;
use Guillermoandrae\Common\Collection;
use Guillermoandrae\Common\CollectionInterface;
use InvalidArgumentException;

final class DynamoDbAdapter implements DynamoDbAdapterInterface
{
    /**
     * @var DynamoDbClient The DynamoDb client.
     */
    private $client;

    /**
     * @var Marshaler The Marshaler.
     */
    private $marshaler;

    /**
     * @var string The table name.
     */
    private $tableName;

    /**
     * DynamoDBAdapter constructor.
     *
     * Registers AWS' DynamoDB client and marshaler with this object. If no options are provided, we pass the options
     * needed to connect to a local instance. This constructor also Passes the marshaler over to the request factory.
     *
     * @param array $options OPTIONAL The DynamoDb client options.
     */
    public function __construct(array $options = [
        'region' => 'us-west-2',
        'version'  => 'latest',
        'endpoint' => 'http://localhost:8000',
        'credentials' => [
            'key' => 'not-a-real-key',
            'secret' => 'not-a-real-secret',
        ]
    ])
    {
        $this->setClient(DynamoDbClient::factory($options));
        $this->setClient(/** @scrutinizer ignore-deprecated */ DynamoDbClient::factory($options));
        $this->marshaler = MarshalerFactory::factory();
        RequestFactory::setMarshaler($this->marshaler);
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#createtable
     */
    public function createTable(array $data, string $tableName = ''): bool
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('create-table', $tableName, $data)->get();
            $this->client->createTable($query);
            $this->client->waitUntil('TableExists', ['TableName' => $tableName]);
            return true;
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        } catch (InvalidArgumentException $ex) {
            throw new Exception('Bad key schema: ' . $ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deletetable
     */
    public function deleteTable(string $tableName = ''): bool
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('delete-table', $tableName)->get();
            $this->client->deleteTable($query);
            $this->client->waitUntil('TableNotExists', ['TableName' => $tableName]);
            return true;
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#describetable
     */
    public function describeTable(string $tableName = ''): ?array
    {
        try {
            if (empty($tableName)) {
                $tableName = $this->tableName;
            }
            $query = RequestFactory::factory('describe-table', $tableName)->get();
            $result = $this->client->describeTable($query);
            return $result['Table'];
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#listtables
     */
    public function tableExists(string $tableName = ''): bool
    {
        if (empty($tableName)) {
            $tableName = $this->tableName;
        }
        $tables = $this->listTables();
        if (empty($tables)) {
            return false;
        }
        return in_array(
            strtolower($tableName),
            array_map('strtolower', $tables)
        );
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#listtables
     */
    public function listTables(): ?array
    {
        $query = RequestFactory::factory('list-tables')->get();
        $results = $this->client->listTables($query);
        return $results['TableNames'];
    }

    /**
     * {@inheritDoc}
     */
    public function useTable(string $tableName): DynamoDbAdapterInterface
    {
        $this->tableName = $tableName;
        return $this;
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#query
     */
    public function findWhere(array $conditions, int $offset = 0, ?int $limit = null): CollectionInterface
    {
        try {
            $query = RequestFactory::factory('query', $this->tableName, $conditions)->get();
            $results = $this->client->query($query);
            $rows = [];
            foreach ($results['Items'] as $item) {
                $rows[] = $this->marshaler->unmarshalItem($item);
            }
            $collection = Collection::make($rows);
            return $collection->limit($offset, $limit);
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#scan
     */
    public function findAll(int $offset = 0, ?int $limit = null): CollectionInterface
    {
        try {
            $query = RequestFactory::factory('scan', $this->tableName)->get();
            $results = $this->client->scan($query);
            $rows = [];
            foreach ($results['Items'] as $item) {
                $rows[] = $this->marshaler->unmarshalItem($item);
            }
            $collection = Collection::make($rows);
            return $collection->limit($offset, $limit);
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#scan
     */
    public function findLatest(): ?array
    {
        try {
            $query = RequestFactory::factory('scan', $this->tableName)
                ->setLimit(1)
                ->/** @scrutinizer ignore-call */ setLimit(1)
                ->get();
            $results = $this->client->scan($query);
            return $this->marshaler->unmarshalItem($results['Items'][0]);

        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     */
    public function findById($id): array
    {
        return $this->findByPrimaryKey($id);
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#getitem
     */
    public function findByPrimaryKey($primaryKey): array
    {
        try {
            $query = RequestFactory::factory('get-item', $this->tableName, $primaryKey)->get();
            $results = $this->client->getItem($query);
            $item = [];
            if (is_array($results['Item'])) {
                $item = $this->marshaler->unmarshalItem($results['Item']);
                $item = $this->marshaler->unmarshalItem(/** @scrutinizer ignore-type */ $results['Item']);
            }
            return $item;

        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#putitem
     */
    public function insert(array $data): bool
    {
        try {
            $query = RequestFactory::factory('put-item', $this->tableName, $data)->get();
            $this->client->putItem($query);
            return true;
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-dynamodb-2012-08-10.html#deleteitem
     */
    public function delete($id): bool
    {
        try {
            $query = RequestFactory::factory('delete-item', $this->tableName, $id)->get();
            $this->client->deleteItem($query);
            return true;
        } catch (DynamoDbException $ex) {
            throw new Exception($ex->getMessage());
        }
    }

    /**
     * {@inheritDoc}
     */
    public function setClient($client): DynamoDbAdapterInterface
    {
        $this->client = $client;
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getClient(): DynamoDbClient
    {
        return $this->client;
    }
}

guillermoandrae / php-dynamodb

Push — master ( 20a668...02e94f )

DynamoDbAdapter::describeTable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
