Stevenmaguire\Yelp\Client

Complexity

Total Complexity

21

Size/Duplication

Total Lines	368
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

98.88%

Importance

Changes	14
Bugs	0	Features	1

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	buildQueryParams()	0	11	1
A	buildUnsignedUrl()	0	4	1
A	createHttpClient()	0	19	1
A	getBusiness()	0	6	1
A	mapConfiguration()	0	17	2
A	parseConfiguration()	0	17	1
A	request()	0	14	2
A	search()	0	7	1
A	searchByPhone()	0	6	1
A	setConfig()	0	8	2
A	setDefaultLocation()	0	5	1
A	setDefaultTerm()	0	5	1
A	setHttpClient()	0	6	1
A	setSearchLimit()	0	7	2
A	__get()	0	8	2

<?php namespace Stevenmaguire\Yelp;

use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
use GuzzleHttp\Exception\ClientException;

class Client
{
    /**
     * API host url
     *
     * @var string
     */
    protected $apiHost;

    /**
     * Consumer key
     *
     * @var string
     */
    protected $consumerKey;

    /**
     * Consumer secret
     *
     * @var string
     */
    protected $consumerSecret;

    /**
     * Access token
     *
     * @var string
     */
    protected $token;

    /**
     * Access token secret
     *
     * @var string
     */
    protected $tokenSecret;

    /**
     * Default search term
     *
     * @var string
     */
    protected $defaultTerm = 'bar';

    /**
     * Default location
     *
     * @var string
     */
    protected $defaultLocation = 'Chicago, IL';

    /**
     * Default search limit
     *
     * @var integer
     */
    protected $searchLimit = 3;

    /**
     * Search path
     *
     * @var string
     */
    protected $searchPath = '/v2/search/';

    /**
     * Business path
     *
     * @var string
     */
    protected $businessPath = '/v2/business/';

    /**
     * Phone search path
     *
     * @var string
     */
    protected $phoneSearchPath = '/v2/phone_search/';

    /**
     * [$httpClient description]
     *
     * @var [type]
     */
    protected $httpClient;

    /**
     * Create new client
     *
     * @param array $configuration
     */
    public function __construct($configuration = [])
    {
        $this->parseConfiguration($configuration);

        /*
        $this->consumerKey = $configuration['consumerKey'];
        $this->consumerSecret = $configuration['consumerSecret'];
        $this->token = $configuration['token'];
        $this->tokenSecret = $configuration['tokenSecret'];
        $this->apiHost = $configuration['apiHost'];
        */
        $this->createHttpClient();
    }

    /**
     * Build query string params using defaults
     *
     * @param  array $attributes
     *
     * @return string
     */
    public function buildQueryParams($attributes = [])
    {
        $defaults = array(
            'term' => $this->defaultTerm,
            'location' => $this->defaultLocation,
            'limit' => $this->searchLimit
        );
        $attributes = array_merge($defaults, $attributes);

        return http_build_query($attributes);
    }

    /**
     * Build unsigned url
     *
     * @param  string   $host
     * @param  string   $path
     *
     * @return string   Unsigned url
     */
    protected function buildUnsignedUrl($host, $path)
    {
        return "http://" . $host . $path;
    }

    /**
     * Builds and sets a preferred http client.
     *
     * @return Client
     */
    protected function createHttpClient()
    {
        $stack = HandlerStack::create();

        $middleware = new Oauth1([
            'consumer_key'    => $this->consumerKey,
            'consumer_secret' => $this->consumerSecret,
            'token'           => $this->token,
            'token_secret'    => $this->tokenSecret
        ]);

        $stack->push($middleware);

        $client = new HttpClient([
            'handler' => $stack
        ]);

        return $this->setHttpClient($client);
    }

    /**
     * Query the Business API by business id
     *
     * @param    string   $businessId      The ID of the business to query
     *
     * @return   stdClass                   The JSON response from the request
     */
    public function getBusiness($businessId)
    {
        $businessPath = $this->businessPath . urlencode($businessId);

        return $this->request($businessPath);
    }

    /**
     * Maps legacy configuration keys to updated keys.
     *
     * @param  array   $configuration
     *
     * @return array
     */
    protected function mapConfiguration(array $configuration)
    {
        $map = [
            'consumer_key' => 'consumerKey',
            'consumer_secret' => 'consumerSecret',
            'token_secret' => 'tokenSecret',
            'api_host' => 'apiHost',
        ];

        array_walk($map, function ($value, $key) use (&$configuration) {
            if (isset($configuration[$key])) {
                $configuration[$value] = $configuration[$key];
            }
        });

        return $configuration;
    }

    /**
     * Parse configuration using defaults
     *
     * @param  array $configuration
     *
     * @return array $configuration
     */
    protected function parseConfiguration(&$configuration = [])
    {
        $defaults = array(
            'consumerKey' => null,
            'consumerSecret' => null,
            'token' => null,
            'tokenSecret' => null,
            'apiHost' => 'api.yelp.com'
        );

        $configuration = array_merge(
            $defaults,
            $this->mapConfiguration($configuration)
        );

        array_walk($configuration, [$this, 'setConfig']);
    }

    /**
     * Makes a request to the Yelp API and returns the response
     *
     * @param    string $path    The path of the APi after the domain
     *
     * @return   stdClass The JSON response from the request
     * @throws   Exception
     */
    protected function request($path)
    {
        $url = $this->buildUnsignedUrl($this->apiHost, $path);

        try {
            $response = $this->httpClient->get($url, ['auth' => 'oauth']);
        } catch (ClientException $e) {
            $exception = new Exception($e->getMessage());

            throw $exception->setResponseBody($e->getResponse()->getBody());
        }

        return json_decode($response->getBody());
    }

    /**
     * Query the Search API by a search term and location
     *
     * @param    array    $attributes   Query attributes
     *
     * @return   stdClass               The JSON response from the request
     */
    public function search($attributes = [])
    {
        $query_string = $this->buildQueryParams($attributes);
        $searchPath = $this->searchPath . "?" . $query_string;

        return $this->request($searchPath);
    }

    /**
     * Search for businesses by phone number
     *
     * @see https://www.yelp.com/developers/documentation/v2/phone_search
     *
     * @param    array    $attributes   Query attributes
     *
     * @return   stdClass               The JSON response from the request
     */
    public function searchByPhone($attributes = [])
    {
        $searchPath = $this->phoneSearchPath . "?" . http_build_query($attributes);

        return $this->request($searchPath);
    }

    /**
     * Attempts to set a given value.
     *
     * @param mixed   $value
     * @param string  $key
     *
     * @return Client
     */
    protected function setConfig($value, $key)
    {
        if (property_exists($this, $key)) {
            $this->$key = $value;
        }

        return $this;
    }

    /**
     * Set default location
     *
     * @param string $location
     *
     * @return Client
     */
    public function setDefaultLocation($location)
    {
        $this->defaultLocation = $location;
        return $this;
    }

    /**
     * Set default term
     *
     * @param string $term
     *
     * @return Client
     */
    public function setDefaultTerm($term)
    {
        $this->defaultTerm = $term;
        return $this;
    }

    /**
     * Updates the yelp client's http client to the given http client. Client.
     *
     * @param HttpClient  $client
     *
     * @return  Client
     */
    public function setHttpClient(HttpClient $client)
    {
        $this->httpClient = $client;

        return $this;
    }

    /**
     * Set search limit
     *
     * @param integer $limit
     *
     * @return Client
     */
    public function setSearchLimit($limit)
    {
        if (is_int($limit)) {
            $this->searchLimit = $limit;
        }
        return $this;
    }

    /**
     * Retrives the value of a given property from the client.
     *
     * @param  string  $property
     *
     * @return mixed|null
     */
    public function __get($property)
    {
        if (property_exists($this, $property)) {
            return $this->$property;
        }

        return null;
    }
}