Multidimensional\Shopify\Controller\Component\ShopifyAPIComponent

Complexity

Total Complexity

43

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

15.45%

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
B	initialize()	0	10	6
A	startup()	0	3	1
A	setController()	0	6	2
A	setShopDomain()	0	3	1
A	getShopDomain()	0	3	1
A	setAccessToken()	0	3	1
A	callsMade()	0	3	1
A	callLimit()	0	3	1
A	callsLeft()	0	3	1
D	call()	0	27	9
A	shopApiCallLimitParam()	0	4	1
A	getAuthorizeUrl()	0	9	1
A	getAccessToken()	0	22	2
A	setNonce()	0	5	1
A	getNonce()	0	5	1
A	validDomain()	0	5	1
A	getShopData()	0	5	1
B	validateHMAC()	0	21	8
A	_urlEncode()	0	7	1
A	_isReady()	0	3	2

<?php
/**
 * CakePHPify : CakePHP Plugin for Shopify API Authentication
 * Copyright (c) Multidimension.al (http://multidimension.al)
 * Github : https://github.com/multidimension-al/cakephpify
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE file
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     (c) Multidimension.al (http://multidimension.al)
 * @link          https://github.com/multidimension-al/cakephpify CakePHPify Github
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */

namespace Multidimensional\Shopify\Controller\Component;

use Cake\Core\Configure;
use Cake\Controller\Component;
use Cake\Routing\Router;
use Cake\Network\Http\Client;
use Cake\Event\Event;

class ShopifyAPIComponent extends Component {

The property $api_key is not named in camelCase.

The property $shop_domain is not named in camelCase.

The property $shared_secret is not named in camelCase.

The property $is_private_app is not named in camelCase.

The property $private_app_password is not named in camelCase.

        
    public $api_key;

$api_key does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    
    private $shop_domain;

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    private $token;
    private $shared_secret;

$shared_secret does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    private $is_private_app;

$is_private_app does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    private $private_app_password;

$private_app_password does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    private $nonce;
        
    public function initialize(array $config = []) {
        
        parent::initialize($config);
        $this->api_key = ((isset($config['api_key'])) ? $config['api_key'] : Configure::read('Shopify.api_key'));
        $this->shared_secret = ((isset($config['shared_secret'])) ? $config['shared_secret'] : Configure::read('Shopify.shared_secret'));
        $this->scope = ((isset($config['scope'])) ? $config['scope'] : Configure::read('Shopify.scope'));

The property scope does not exist. Did you maybe forget to declare it?

            $this->is_private_app = ((isset($config['is_private_app'])) ? $config['is_private_app'] : Configure::read('Shopify.is_private_app'));
        $this->private_app_password = ((isset($config['private_app_password'])) ? $config['private_app_password'] : Configure::read('Shopify.private_app_password'));        
        
    }
        
    public function startup(Event $event) {
        $this->setController($event->subject());
    }
        
    public function setController($controller) {
        $this->controller = $controller;

The property controller does not exist. Did you maybe forget to declare it?

        if (!isset($this->controller->paginate)) {
            $this->controller->paginate = [];
        }
    }

    public function setShopDomain($shop_domain) {

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The return type could not be reliably inferred; please add a @return annotation.

        return $this->shop_domain = $shop_domain;

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }
    
    public function getShopDomain() {

The return type could not be reliably inferred; please add a @return annotation.

        return $this->shop_domain;
    }
    
    public function setAccessToken($token) {

The return type could not be reliably inferred; please add a @return annotation.

        return $this->token = $token;
    }
    
    public function callsMade() {
        return $this->shopApiCallLimitParam(0);
    }

    public function callLimit() {
        return $this->shopApiCallLimitParam(1);
    }

    public function callsLeft($response_headers) {

$response_headers does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The parameter $response_headers is not used and could be removed.

        return $this->callLimit() - $this->callsMade();
    }

    /**
     * @param string $method
     * @param string $path
     */
    public function call($method, $path, $params = array()) {

The return type could not be reliably inferred; please add a @return annotation.

        
        if (!$this->_isReady()) {
            return false;
        }
        
        if (!in_array($method, array('POST', 'PUT', 'GET', 'DELETE'))) {
            return false;    
        }
        
        $http = new Client([
            'host' => $this->shop_domain,
            'scheme' => 'https',
            'headers' => (($this->is_private_app != 'true') ? (['X-Shopify-Access-Token' => $this->token]) : []),
            'auth' => (($this->is_private_app != 'true') ? [] : (['username' => $this->api_key, 'password' => $this->private_app_password]))
        ]);
                            
        $this->response = $http->{strtolower($method)}(
            $path,
            ((in_array($method, array('POST', 'PUT'))) ? json_encode($params) : $params),
            ((in_array($method, array('POST', 'PUT'))) ? ['type' => 'json'] : [])
        );
        $this->response = $this->response->json;

        return (is_array($this->response) && (count($this->response) > 0)) ? array_shift($this->response) : $this->response;
        
    }
    
    /**
     * @param integer $index
     */
    private function shopApiCallLimitParam($index) {
        $params = explode("/", $this->response->getHeaderLine('http_x_shopify_shop_api_call_limit'));

The method getHeaderLine() does not exist on Cake\Network\Response. Did you maybe mean header()?

        return (int) $params[$index];
    }
    
    public function getAuthorizeUrl($shop_domain, $redirect_url) {

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

                
        $url = 'https://' . $shop_domain . '/admin/oauth/authorize?client_id=' . $this->api_key;

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $url .= '&scope=' . urlencode($this->scope);
        $url .= '&redirect_uri=' . urlencode($redirect_url);

$redirect_url does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $url .= '&state=' . $this->getNonce($shop_domain);

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The call to ShopifyAPIComponent::getNonce() has too many arguments starting with $shop_domain.

        return $url;
        
    }

    public function getAccessToken($shop_domain, $code) {

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The return type could not be reliably inferred; please add a @return annotation.

    
        $this->shop_domain = $shop_domain;

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    
        $http = new Client([
            'host' => $shop_domain,

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            'scheme' => 'https'
        ]);
  
        $response = $http->post('/admin/oauth/access_token', 'client_id=' . $this->api_key . 
                                    '&client_secret=' . $this->shared_secret .
                                    '&code=' . $code);
        $response = $response->json; ;
        
        if (isset($response['access_token'])) {
            $this->token = $response['access_token'];
            return $this->token;
        } else {
            return false;
        }
    
        }

    public function setNonce($shop_domain) {

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        
        return $this->nonce = md5(strtolower($shop_domain));

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        
    }

    
    public function getNonce() {
        
        return $this->nonce;
        
    }
    
    public function validDomain($shop_domain) {

function validDomain() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

$shop_domain does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The parameter $shop_domain is not used and could be removed.

    
        return true;
        
    }
    
    public function getShopData() {

The return type could not be reliably inferred; please add a @return annotation.

    
        return $this->call('GET', '/admin/shop.json');
    
    }
    
    public function validateHMAC($query) {

function validateHMAC() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

            
        if (!is_array($query) || empty($query['hmac']) || !is_string($query['hmac']) || (isset($query['state']) && $query['state'] != $this->getNonce($query['shop']))) {

The call to ShopifyAPIComponent::getNonce() has too many arguments starting with $query['shop'].

            return false;
        }
 
        $dataString = array();
        
        foreach ($query as $key => $value) {
            $key = $this->_urlEncode(str_replace('=', '%3D', $key));
            $value = $this->_urlEncode($value);
            if ($key != 'hmac') {
                $dataString[] = $key . '=' . $value;
            }
        }

        sort($dataString);
        $string = implode("&", $dataString);
        return $query['hmac'] == hash_hmac('sha256', $string, $this->shared_secret);
    
        }

    /**
     * @param string $url
     */
    private function _urlEncode($url) {
    
        $url = str_replace('&', '%26', $url);
        $url = str_replace('%', '%25', $url);
        return $url;
        
    }
    
    private function _isReady() {

function _isReady() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

        return strlen($this->shop_domain) > 0 && strlen($this->token) > 0;
    }
    
}

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.