Initial version of client

Author: kornrunner

README.md

@@ -1,4 +1,4 @@
-co-reg-api
-==========
+DatingVIP API Client
+====================
 
-Co-Registration API (PHP)
+PHP implementation of API client to DatingVIP platform

composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "datingvip/api",
+    "type": "library",
+    "description": "DatingVIP API Client",
+    "keywords": ["datingvip", "api client"],
+    "homepage": "https://github.com/DatingVIP/api-client",
+    "license": "LGPLv3",
+    "authors": [
+        {
+            "name": "Boris Momčilović",
+            "email": "[email protected]",
+            "homepage": "http://firstbeatmedia.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=5.4.0",
+		"datingvip/curl": "dev-master"
+    },
+    "autoload": {
+        "psr-4": {
+            "DatingVIP\\API\\": "src"
+        }
+    }
+}

composer.lock

@@ -0,0 +1,152 @@
+<?php
+/**
+ * API Client
+ *
+ * @package DatingVIP
+ * @subpackage api
+ * @category lib
+ * @author Boris Momčilović <[email protected]>
+ * @copyright All rights reserved
+ * @version 1.0
+ */
+
+namespace DatingVIP\API;
+
+use DatingVIP\cURL\Request as cURL;
+use Exception;
+
+class Client
+{
+    const COMMAND = 'cmd';
+
+/**
+ * API URL
+ *
+ * @var string
+ * @access protected
+ */
+    protected $url;
+
+/**
+ * API authorization user
+ *
+ * @var string
+ * @access protected
+ */
+    protected $user;
+
+/**
+ * API authorization pass
+ *
+ * @var string $pass
+ * @access	protected
+ */
+    protected $pass;
+
+/**
+ * Instance of DatingVIP\cURL\Request lib
+ *
+ * @var Request
+ * @access private
+ */
+    private $curl;
+
+/**
+ * Set API url
+ *
+ * @param string $url
+ * @access public
+ * @return bool
+ */
+    public function setUrl($url)
+    {
+        $this->url = (string) $url;
+
+        return !empty ($this->url);
+    }
+
+/**
+ * Set auth data for API
+ *
+ * @param string $user
+ * @param string $pass
+ * @access public
+ * @return bool
+ */
+    public function setAuth($user, $pass)
+    {
+        $this->user	= (string) $user;
+        $this->pass	= (string) $pass;
+
+        return $this->hasAuth ();
+    }
+
+/**
+ * Execute API command
+ *
+ * @param Command $command
+ * @access public
+ * @return Response
+ * @throws \Exception
+ */
+    public function execute(Command $command)
+    {
+        if (!$command->isValid ()) {
+            throw new Exception ('Invalid API command supplied');
+        }
+
+        $result = $this->curl()->post ($this->getUrl ($command), $command->getData ());
+
+        return new Response ($result->getData ());
+    }
+
+/**
+ * Get browser for making API requests
+ * - create an instance
+ * - assign auth data if we have it
+ *
+ * @param void
+ * @access private
+ * @return cURL
+ */
+    private function curl()
+    {
+        if (! ($this->curl instanceof cURL)) {
+            $this->curl = new cURL ();
+        }
+
+        if ($this->hasAuth ()) {
+            $this->curl->setCredentials ($this->user, $this->pass);
+        }
+
+        return $this->curl;
+    }
+
+/**
+ * Get API URL for given command
+ *
+ * @param Command $command
+ * @access private
+ * @return string
+ */
+    private function getUrl(Command $command)
+    {
+        return $this->url
+            . (stripos ($this->url, '?') !== false ? '&' : '?')
+            . http_build_query ([self::COMMAND => $command->getName ()]);
+    }
+
+/**
+ * Check if API has auth data set
+ * - checks if user and pass aren't empty
+ *
+ * @param void
+ * @access private
+ * @return bool
+ */
+    private function hasAuth()
+    {
+        return !empty ($this->user) && !empty ($this->pass);
+    }
+
+}

src/DatingVIP/API/Client.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * API Command
+ *
+ * @package DatingVIP
+ * @subpackage api
+ * @category lib
+ * @author Boris Momčilović <[email protected]>
+ * @copyright All rights reserved
+ * @version 1.0
+ */
+
+namespace DatingVIP\API;
+
+class Command
+{
+    const VAR_CONTROLLER = 'c';
+
+/**
+ * Command name
+ *
+ * @var string
+ * @access private
+ */
+    private $name;
+
+/**
+ * Command data
+ *
+ * @var array
+ * @access private
+ */
+    private $data;
+
+/**
+ * Default command constructor
+ * - shorthand to set method
+ *
+ * @param string $name [= '']
+ * @param array $data [= []]
+ * @access public
+ */
+    public function __construct($name = '', array $data = [])
+    {
+        $this->set ($name, $data);
+    }
+
+/**
+ * Set command and optionally set data
+ * - return if set command is valid
+ *
+ * @param	string	$name
+ * @param	array	$data	[= []]
+ * @access	public
+ * @return	bool
+ */
+    public function set($name, array $data = [])
+    {
+        $this->setName ($name);
+        $this->setData ($data);
+        return $this->isValid ();
+    }
+
+/**
+ * Get command name
+ *
+ * @param void
+ * @access public
+ * @return string
+ */
+    public function getName()
+    {
+        return (string) $this->name;
+    }
+
+/**
+ * Get command data
+ *
+ * @param void
+ * @access public
+ * @return array
+ */
+    public function getData()
+    {
+        return (array) $this->data;
+    }
+
+/**
+ * Check if set name is considered valid
+ * - must not be empty
+ * - must have a dot
+ *
+ * @param void
+ * @access public
+ * @return bool
+ */
+    public function isValid()
+    {
+        return !empty ($this->name) && strpos ($this->name, '.') !== false;
+    }
+
+/**
+ * Set command name
+ * - return if set name is considered valid
+ *
+ * @param string $name
+ * @access private
+ * @return bool
+ */
+    private function setName($name)
+    {
+        $this->name = (string) $name;
+        return $this->isValid ();
+    }
+
+/**
+ * Set command data
+ *
+ * @param array $data
+ * @access private
+ * @return bool
+ */
+    private function setData(array $data)
+    {
+        $this->data = (array) $data;
+
+        // remove reserved stuff
+        if (isset ($this->data[self::VAR_CONTROLLER]))		{ unset ($this->data[self::VAR_CONTROLLER]); }
+
+        return !empty ($this->data);
+    }
+
+}