StripeResource::checkIsCollectionObject() - Code Metrics - Inspection of "Updating the package" - ARCANEDEV/Stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#62)

by ARCANEDEV
created 2017-10-25 14:42 UTC
StripeResource::checkIsCollectionObject() A

↳ Parent: StripeResource
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	2.5
Importance

Changes
Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	8
ccs	2
cts	4
cp	0.5
crap	2.5
rs	9.4285
c	0
b	0
f	0
<?php namespace Arcanedev\Stripe;

use Arcanedev\Stripe\Contracts\StripeResource as StripeResourceContract;
use Arcanedev\Stripe\Http\RequestOptions;
use Arcanedev\Stripe\Http\Requestor;
use Arcanedev\Stripe\Utilities\Util;
use ReflectionClass;

/**
 * Class     StripeResource
 *
 * @package  Arcanedev\Stripe
 * @author   ARCANEDEV <[email protected]>
 */
abstract class StripeResource extends StripeObject implements StripeResourceContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var array */
    private static $persistedHeaders = [
        'Stripe-Account' => true,
        'Stripe-Version' => true,
    ];

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the base url.
     *
     * @return string
     */
    public static function baseUrl()
    {
        return Stripe::getApiBaseUrl();
    }

    /**
     * Get the refreshed resource.
     *
     * @return self
     */
    public function refresh()
    {
        list($response, $this->opts->apiKey) = Requestor::make($this->opts->apiKey, self::baseUrl())
            ->get($this->instanceUrl(), $this->retrieveParameters, $this->opts->headers);

        /** @var \Arcanedev\Stripe\Http\Response $response */
        $this->setLastResponse($response);
        $this->refreshFrom($response->getJson(), $this->opts);

        return $this;
    }

    /**
     * Get The name of the class, with namespacing and underscores stripped.
     *
     * @param  string  $class
     *
     * @return string
     */
    public static function className($class = '')
    {
        $name = self::getShortNameClass($class);
        $name = str_split_camelcase($name, '_');

        return strtolower(urlencode($name));
    }

    /**
     * Get Class short name.
     *
     * @param  string  $class
     *
     * @return string
     */
    protected static function getShortNameClass($class = '')
    {
        if (empty($class))
            $class = get_called_class();

        return (new ReflectionClass($class))->getShortName();
    }

    /**
     * Get the endpoint URL for the given class.
     *
     * @param  string  $class
     *
     * @return string
     */
    public static function classUrl($class = '')
    {
        $base = self::className($class);

        return "/v1/${base}s";
    }

    /**
     * Get Instance URL.
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidRequestException
     *
     * @return string
     */
    public function instanceUrl()
    {
        return static::resourceUrl($this['id']);
    }

    /**
     * Get the instance endpoint URL for the given class.
     *
     * @param  string  $id
     *
     * @return string
     *
     * @throws Exceptions\InvalidRequestException
     */
    public static function resourceUrl($id)
    {
        if ($id === null) {
            $class = get_called_class();
            throw new Exceptions\InvalidRequestException(
                "Could not determine which URL to request: $class instance has invalid ID: $id", null
            );
        }

        return static::classUrl().'/'.urlencode(str_utf8($id));
    }

    /* ------------------------------------------------------------------------------------------------
     |  Request Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make a request.
     *
     * @param  string             $method
     * @param  string             $url
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return array
     */
    protected function request($method, $url, $params = [], $options = null)
    {
        $opts = $this->opts->merge($options);

        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $options) = static::staticRequest($method, $url, $params, $opts);
        $this->setLastResponse($response);

        return [$response->getJson(), $options];
    }

    /**
     * Make a request (static).
     *
     * @param  string             $method
     * @param  string             $url
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return array
     */
    protected static function staticRequest($method, $url, $params, $options)
    {
        $opts      = RequestOptions::parse($options);
        $requestor = Requestor::make($opts->apiKey, static::baseUrl());

        list($response, $opts->apiKey) =
            $requestor->request($method, $url, $params, $opts->headers);

        foreach ($opts->headers as $k => $v) {
            if ( ! array_key_exists($k, self::$persistedHeaders))
                unset($opts->headers[$k]);
        }

        return [$response, $opts];
    }

    /* -----------------------------------------------------------------
     |  CRUD Scope Methods
     | -----------------------------------------------------------------
     */

    /**
     * Retrieve scope.
     *
     * @param  string             $id
     * @param  array|string|null  $options
     *
     * @return self
     */
    protected static function scopedRetrieve($id, $options = null)
    {
        $class = get_called_class();

        /** @var self $resource */
        $resource = new $class($id, RequestOptions::parse($options));
        $resource->refresh();

        return $resource;
    }

    /**
     * List scope.
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return \Arcanedev\Stripe\Collection|array
     */
    protected static function scopedAll($params = [], $options = null)
    {
        self::checkArguments($params, $options);

        $url = static::classUrl();

        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $opts) = self::staticRequest('get', $url, $params, $options);

        $object = Util::convertToStripeObject($response->getJson(), $opts);

        self::checkIsCollectionObject($object);

        $object->setLastResponse($response);
        $object->setRequestParams($params);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        return $object;
    }

    /**
     * Create scope.
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     *
     * @return self
     */
    protected static function scopedCreate($params = [], $options = null)
    {
        self::checkArguments($params, $options);

        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $opts) = static::staticRequest('post', static::classUrl(), $params, $options);

        $object = Util::convertToStripeObject($response->getJson(), $opts);

        $object->setLastResponse($response);

        return $object;
    }

    /**
     * Update scope.
     *
     * @param  string             $id
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    protected static function scopedUpdate($id, $params = null, $options = null)
    {
        self::checkArguments($params, $options);

        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $opts) = static::staticRequest('post', static::resourceUrl($id), $params, $options);

        $object = Util::convertToStripeObject($response->getJson(), $opts);

        $object->setLastResponse($response);

        return $object;
    }

    /**
     * Save scope.
     *
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidRequestException
     *
     * @return self
     */
    protected function scopedSave($options = null)
    {
        if (count($params = $this->serializeParameters()) > 0) {
            self::checkArguments(null, $options);
            list($response, $opts) = $this->request('post', $this->instanceUrl(), $params, $options);
            $this->refreshFrom($response, $opts);
        }

        return $this;
    }

    /**
     * Delete Scope.
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidRequestException
     *
     * @return self
     */
    protected function scopedDelete($params = [], $options = null)
    {
        self::checkArguments($params, $options);

        list($response, $opts) = $this->request('delete', $this->instanceUrl(), $params, $options);
        $this->refreshFrom($response, $opts);

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Nested Resources Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create a nested resource.
     *
     * @param  string             $id
     * @param  string             $nestedPath
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return mixed
     */
    protected static function createNestedResource($id, $nestedPath, $params = null, $options = null)
    {
        $url = static::nestedResourceUrl($id, $nestedPath);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        return self::nestedResourceRequest('post', $url, $params, $options);
    }

    /**
     * Retrieve a nested resource.
     *
     * @param  string             $id
     * @param  string             $nestedPath
     * @param  string             $nestedId
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return mixed
     */
    protected static function retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
    {
        $url = static::nestedResourceUrl($id, $nestedPath, $nestedId);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        return self::nestedResourceRequest('get', $url, $params, $options);
    }

    /**
     * Update a nested resource.
     *
     * @param  string             $id
     * @param  string             $nestedPath
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return mixed
     */
    protected static function updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
    {
        $url = static::nestedResourceUrl($id, $nestedPath, $nestedId);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        return self::nestedResourceRequest('post', $url, $params, $options);
    }

    /**
     * Delete a nested resource.
     *
     * @param  string             $id
     * @param  string             $nestedPath
     * @param  string             $nestedId
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return mixed
     */
    protected static function deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
    {
        $url = static::nestedResourceUrl($id, $nestedPath, $nestedId);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        return self::nestedResourceRequest('delete', $url, $params, $options);
    }

    /**
     * Get all the nested resources.
     *
     * @param  string             $id
     * @param  string             $nestedPath
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return \Arcanedev\Stripe\Collection
     */
    protected static function allNestedResources($id, $nestedPath, $params = null, $options = null)
    {
        $url = static::nestedResourceUrl($id, $nestedPath);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        return self::nestedResourceRequest('get', $url, $params, $options);
    }

    /**
     * Make a request call to a nested nested resource.
     *
     * @param  string             $method
     * @param  string             $url
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return mixed
     */
    protected static function nestedResourceRequest($method, $url, $params = null, $options = null)
    {
        static::checkParameters($params);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}

        list($response, $opts) = static::staticRequest($method, $url, $params, $options);

        return Utilities\Util::convertToStripeObject($response->getJson(), $opts)
            ->setLastResponse($response);
    }

    /**
     * Prepare the nested resource URL.
     *
     * @param  string       $id
     * @param  string       $nestedPath
     * @param  string|null  $nestedId
     *
     * @return string
     */
    private static function nestedResourceUrl($id, $nestedPath, $nestedId = null)
    {
        $url = static::resourceUrl($id).$nestedPath;

        return is_null($nestedId) ? $url : "$url/$nestedId";
    }

    /* -----------------------------------------------------------------
     |  Custom Scope Methods
     | -----------------------------------------------------------------
     */

    /**
     * Custom Post Call.
     *
     * @param  string             $url
     * @param  array|null         $params
     * @param  array|string|null  $options
     *
     * @return self
     */
    protected function scopedPostCall($url, $params = [], $options = null)
    {
        /** @var \Arcanedev\Stripe\Http\Response $response */
        list($response, $options) = Requestor::make(RequestOptions::parse($options)->getApiKey(), static::baseUrl())
            ->post($url, $params);

        $this->refreshFrom($response->getJson(), $options);
        $this->setLastResponse($response);

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check Arguments.
     *
     * @param  array|null         $params
     * @param  array|string|null  $options
     */
    protected static function checkArguments($params = [], $options = null)
    {
        self::checkParameters($params);
        self::checkOptions($options);
    }

    /**
     * Check parameters.
     *
     * @param  array|null  $params
     *
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private static function checkParameters($params)
    {
        if ($params && ! is_array($params)) {
            throw new Exceptions\InvalidArgumentException(
                'You must pass an array as the first argument to Stripe API method calls.  '.
                '(HINT: an example call to create a charge would be: '.
                "StripeCharge::create(['amount' => 100, 'currency' => 'usd', 'source' => 'tok_1234']))"
            );
        }
    }

    /**
     * Check Options.
     *
     * @param  array|string|null  $options
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkOptions($options)
    {
        if ($options && (
                ! $options instanceof RequestOptions &&
                ! is_string($options) &&
                ! is_array($options)
            )
        ) {
            throw new Exceptions\ApiException(
                'The second argument to Stripe API method calls is an '
                . 'optional per-request apiKey, which must be a string.  '
                . '(HINT: you can set a global apiKey by "Stripe::setApiKey(<apiKey>)")',
                500
            );
        }
    }

    /**
     * Check the object is a Collection class.
     *
     * @param  mixed  $object
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkIsCollectionObject($object)
    {
        if ( ! is_a($object, Collection::class)) {
            throw new Exceptions\ApiException(
                'Expected type "Arcanedev\Stripe\Collection", got "'.get_class($object).'" instead'
            );
        }
    }
}

ARCANEDEV / Stripe

Pull Request — master (#62)

StripeResource::checkIsCollectionObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like
