ShopifyAPIComponent::callsMade() - Code Metrics - Inspection of "Update ShopifyDatabaseComponent.php" - multidimension-al/cakephpify - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — testing (17af2d)

by AJ

created 2017-01-13 05:34 UTC

ShopifyAPIComponent::callsMade() A

↳ Parent: ShopifyAPIComponent

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	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;

class ShopifyAPIComponent extends Component {

        
    public $api_key;

    
    private $shop_domain;

    private $token;
    private $shared_secret;

    private $is_private_app;

    private $private_app_password;

    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'));
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $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 setShopDomain($shop_domain) {

        return $this->shop_domain = $shop_domain;

    }
    
    public function getShopDomain() {

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

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

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

    public function callsLeft($response_headers) {

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

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

        
        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'));

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

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

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

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

        return $url;
        
    }

    public function getAccessToken($shop_domain, $code) {

    
        $this->shop_domain = $shop_domain;

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

            '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) {

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

        
    }

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

    
        return true;
        
    }
    
    public function getShopData() {

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

            
        if (!is_array($query) || empty($query['hmac']) || !is_string($query['hmac']) || (isset($query['state']) && $query['state'] != $this->getNonce($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() {

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

?>



1			<?php
2			/**
3			* CakePHPify : CakePHP Plugin for Shopify API Authentication
4			* Copyright (c) Multidimension.al (http://multidimension.al)
5			* Github : https://github.com/multidimension-al/cakephpify
6			*
7			* Licensed under The MIT License
8			* For full copyright and license information, please see the LICENSE file
9			* Redistributions of files must retain the above copyright notice.
10			*
11			* @copyright (c) Multidimension.al (http://multidimension.al)
12			* @link https://github.com/multidimension-al/cakephpify CakePHPify Github
13			* @license http://www.opensource.org/licenses/mit-license.php MIT License
14			*/
15
16			namespace Multidimensional\Shopify\Controller\Component;
17
18			use Cake\Core\Configure;
19			use Cake\Controller\Component;
20			use Cake\Routing\Router;
21			use Cake\Network\Http\Client;
22
23			class ShopifyAPIComponent extends Component {
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report The property $api_key is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report The property $shop_domain is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report The property $shared_secret is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report The property $is_private_app is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report The property $private_app_password is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
24
25			public $api_key;
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report `$api_key` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
26
27			private $shop_domain;
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report `$shop_domain` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
28			private $token;
29			private $shared_secret;
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report `$shared_secret` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
30			private $is_private_app;
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report `$is_private_app` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
31			private $private_app_password;
			0 ignored issues – show Coding Style introduced 2017-01-13 03:56 UTC by Report Bug Copy Issue Report `$private_app_password` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
32			private $nonce;
33
34			public function initialize(array $config = []) {

multidimension-al / cakephpify

Branch — testing (17af2d)

ShopifyAPIComponent::callsMade() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like