Skip to content

Commit

Permalink
Merge pull request #1 from bluemanos/master
Browse files Browse the repository at this point in the history 
Small code improvements
  • Loading branch information
@mdurys
mdurys committed Jun 23, 2015
2 parents e7e93d5 + ee2821d commit 2cf7f9d
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 53 deletions.
125 changes: 73 additions & 52 deletions lib/Client.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
* Client for accessing skapiec.pl API.
*
* @author Michał Durys <michal@durys.pl>
* @package SkapiecAPI
*
* @method mixed beta_addExpOpinion' => array(array $component_id_array, string $title, string $url, string $description)
* @method mixed beta_addOffer(string $component, int $id_skapiec, string $url)
Expand Down Expand Up @@ -49,7 +48,7 @@ class Client
const API_HOST = 'api.skapiec.pl';

/**
* Image size IDs for beta_getProductPhoto()
* Image size IDs for beta_getProductPhoto().
*/
const PHOTO_SIZE_ALL = 0;
const PHOTO_SIZE_XSMALL = 1;
Expand Down Expand Up @@ -159,83 +158,80 @@ public function __construct($apiUser, $apiPassword)
$this->curlHandle = curl_init();
curl_setopt_array($this->curlHandle, array(
CURLOPT_USERAGENT => 'SkapiecApiClient.php',
CURLOPT_USERPWD => $apiUser . ':' . $apiPassword,
CURLOPT_USERPWD => $apiUser.':'.$apiPassword,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => $this->timeout));
CURLOPT_TIMEOUT => $this->timeout, ));
}

/**
* Destroy object and free allocated resources.
*/
public function __destruct()
{
if ($this->curlHandle)
{
if ($this->curlHandle) {
curl_close($this->curlHandle);
}
}

/**
* Handle virtual API methods: meta_*, beta_* and set*.
*
* @param string $name Name of called method.
* @param array $arguments Method arguments.
* @param string $name Name of called method.
* @param array $arguments Method arguments.
*
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($name, $arguments)
{
// handle setXXX methods which set query parameters
if (strncmp('set', $name, 3) == 0)
{
if (strncmp('set', $name, 3) == 0) {
$this->queryParams[self::camelcaseToUnderscore(substr($name, 3))] = current($arguments);

return $this;
}
// handle API methods
else if (in_array($name, array_keys(self::$apiMethods)))
{
elseif (in_array($name, array_keys(self::$apiMethods))) {
// check if this method has any required parameters
if (!empty(self::$apiMethods[$name]))
{
if (!empty(self::$apiMethods[$name])) {
// make sure that number of parameters is correct
if (count(self::$apiMethods[$name]) <> count($arguments))
{
throw new \BadMethodCallException(get_class($this) . '::' . $name . ' requires ' . count(self::$apiMethods[$name]) . ' argument(s)');
if (count(self::$apiMethods[$name]) != count($arguments)) {
throw new \BadMethodCallException(get_class($this).'::'.$name.' requires '.count(self::$apiMethods[$name]).' argument(s)');
}
// add method parameters to query
$this->queryParams += array_combine(self::$apiMethods[$name], $arguments);
}

// build query URL
$url = 'http://' . self::API_HOST . '/' . $name . '.' . $this->outputFormat;
if (!empty($this->queryParams))
{
$url .= '?' . http_build_query($this->queryParams);
$url = 'http://'.self::API_HOST.'/'.$name.'.'.$this->outputFormat;
if (!empty($this->queryParams)) {
$url .= '?'.http_build_query($this->queryParams);
$this->queryParams = array();
}

// at this point we're ready to make a call
return $this->query($url);
}

throw new \BadMethodCallException('Tried to call unknown method ' . get_class($this) . '::' . $name);
throw new \BadMethodCallException('Tried to call unknown method '.get_class($this).'::'.$name);
}

/**
* Execute Skapiec API query and return its result.
*
* @param string $url
*
* @return mixed
*
* @throws \MDurys\SkapiecAPI\Exception
*/
public function query($url)
{
// check if we need to pause execution
if ($this->queryDelay && $this->lastMicrotime)
{
if ($this->queryDelay && $this->lastMicrotime) {
$timeElapsed = microtime(true) - $this->lastMicrotime;
if ($timeElapsed < $this->queryDelay)
{
if ($timeElapsed < $this->queryDelay) {
usleep(intval(($this->queryDelay - $timeElapsed) * 1000000));
}
}
Expand All @@ -246,36 +242,37 @@ public function query($url)
$this->lastResult = curl_exec($this->curlHandle);
$this->lastMicrotime = microtime(true);
$this->lastCode = curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE);
if (false === $this->lastResult)
{
if (false === $this->lastResult) {
throw new Exception(curl_error($this->curlHandle), $this->lastCode, null, $url);
}
if ($this->lastCode != 200)
{
if ($this->lastCode != 200) {
throw new Exception($this->lastResult, $this->lastCode, null, $url);
}

switch ($this->outputFormat)
{
switch ($this->outputFormat) {
case 'json':
return json_decode($this->lastResult, true);
// return json_decode($this->lastResult, false);
case 'xml':
return simplexml_load_string($this->lastResult);
}

return $this->lastResult;
}

/**
* Get best offers for given product.
*
* Wrapper for beta_getOffersBestPrice().
*
* @param integer|array $idSkapiec
* @param int|array $idSkapiec
*
* @return mixed
*/
public function beta_getOffersBestPriceBySkapiecId($idSkapiec)
{
$this->queryParams['id_skapiec'] = $idSkapiec;

return $this->__call('beta_getOffersBestPrice', array());
}

Expand All @@ -284,12 +281,14 @@ public function beta_getOffersBestPriceBySkapiecId($idSkapiec)
*
* Wrapper for beta_getOffersBestPrice().
*
* @param integer|array $component
* @param int|array $component
*
* @return mixed
*/
public function beta_getOffersBestPriceByComponent($component)
{
$this->queryParams['component'] = $component;

return $this->__call('beta_getOffersBestPrice', array());
}

Expand All @@ -298,12 +297,14 @@ public function beta_getOffersBestPriceByComponent($component)
*
* Wrapper for beta_getOpinionsBestValue().
*
* @param integer|array $idSkapiec
* @param int|array $idSkapiec
*
* @return mixed
*/
public function beta_getOpinionsBestValueBySkapiecId($idSkapiec)
{
$this->queryParams['id_skapiec'] = $idSkapiec;

return $this->__call('beta_getOpinionsBestValue', array());
}

Expand All @@ -312,12 +313,14 @@ public function beta_getOpinionsBestValueBySkapiecId($idSkapiec)
*
* Wrapper for beta_getOpinionsBestValue().
*
* @param integer|array $component
* @param int|array $component
*
* @return mixed
*/
public function beta_getOpinionsBestValueByComponent($component)
{
$this->queryParams['component'] = $component;

return $this->__call('beta_getOpinionsBestValue', array());
}

Expand All @@ -326,12 +329,14 @@ public function beta_getOpinionsBestValueByComponent($component)
*
* Wrapper for beta_getOpinionsLatest().
*
* @param integer|array $idSkapiec
* @param int|array $idSkapiec
*
* @return mixed
*/
public function beta_getOpinionsLatestBySkapiecId($idSkapiec)
{
$this->queryParams['id_skapiec'] = $idSkapiec;

return $this->__call('beta_getOpinionsLatest', array());
}

Expand All @@ -340,12 +345,14 @@ public function beta_getOpinionsLatestBySkapiecId($idSkapiec)
*
* Wrapper for beta_getOpinionsLatest().
*
* @param integer|array $component
* @param int|array $component
*
* @return mixed
*/
public function beta_getOpinionsLatestByComponent($component)
{
$this->queryParams['component'] = $component;

return $this->__call('beta_getOpinionsLatest', array());
}

Expand All @@ -354,16 +361,18 @@ public function beta_getOpinionsLatestByComponent($component)
*
* Wrapper for beta_getProductMostPopular().
*
* There is a bug in beta_getProductMostPopular(), namely it doesn't accept
* There is a bug in beta_getProductMostPopular(), namely it does not accept
* offset=0 as valid parameter. This error was reported to Skapiec but
* hasn't been fixed so far.
* has not been fixed so far.
*
* @param int $department
*
* @param integer $department
* @return mixed
*/
public function beta_getProductMostPopularByDepartment($department)
{
$this->queryParams['department'] = $department;

return $this->__call('beta_getProductMostPopular', array());
}

Expand All @@ -372,16 +381,18 @@ public function beta_getProductMostPopularByDepartment($department)
*
* Wrapper for beta_getProductMostPopular().
*
* There is a bug in beta_getProductMostPopular(), namely it doesn't accept
* There is a bug in beta_getProductMostPopular(), namely it does not accept
* offset=0 as valid parameter. This error was reported to Skapiec but
* hasn't been fixed so far.
* has not been fixed so far.
*
* @param int $category
*
* @param integer $category
* @return mixed
*/
public function beta_getProductMostPopularByCategory($category)
{
$this->queryParams['category'] = $category;

return $this->__call('beta_getProductMostPopular', array());
}

Expand All @@ -390,12 +401,14 @@ public function beta_getProductMostPopularByCategory($category)
*
* The method accepts variable number of arguments.
*
* @param string $name,... Field name.
* @param string ...$name Field name.
*
* @return \mdurys\SkapiecAPI\Client
*/
public function onlyField()
{
$this->queryParams['onlyField'] = implode(',', func_get_args());

return $this;
}

Expand All @@ -404,12 +417,14 @@ public function onlyField()
*
* The method accepts variable number of arguments.
*
* @param string $name,... Field name.
* @param string ...$name Field name.
*
* @return \mdurys\SkapiecAPI\Client
*/
public function includeField()
{
$this->queryParams['includeField'] = implode(',', func_get_args());

return $this;
}

Expand All @@ -418,12 +433,14 @@ public function includeField()
*
* The method accepts variable number of arguments.
*
* @param string $name,... Field name.
* @param string ...$name Field name.
*
* @return \mdurys\SkapiecAPI\Client
*/
public function excludeField()
{
$this->queryParams['excludeField'] = implode(',', func_get_args());

return $this;
}

Expand Down Expand Up @@ -458,14 +475,17 @@ public function getLastResult()
}

/**
* Set required delay betweeen subsequent API calls. Setting delay to 0
* Set required delay between subsequent API calls. Setting delay to 0
* disables checking of delay.
*
* @param integer $seconds Delay in seconds.
* @param int $seconds Delay in seconds.
*
* @return $this
*/
public function setQueryDelay($seconds)
{
$this->queryDelay = $seconds;

return $this;
}

Expand All @@ -474,25 +494,26 @@ public function setQueryDelay($seconds)
* format.
*
* @param string $format 'json' or 'xml'
*
* @throws \InvalidArgumentException
*/
public function setOutputFormat($format)
{
switch ($format)
{
switch ($format) {
case 'xml':
case 'json':
$this->outputFormat = $format;
break;
default:
throw new \InvalidArgumentException($format . ' is not a valid output format');
throw new \InvalidArgumentException($format.' is not a valid output format');
}
}

/**
* Convert string in camelCase to underscore_notation.
*
* @param string $string
*
* @return string
*/
protected static function camelcaseToUnderscore($string)
Expand Down
1 change: 0 additions & 1 deletion lib/Exception.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
* Exception thrown by Client::query() method.
*
* @author Michał Durys <michal@durys.pl>
* @package SkapiecAPI
*/
class Exception extends \Exception
{
Expand Down

0 comments on commit 2cf7f9d

Please sign in to comment.