Merge pull request #11 from Textalk/mockclasses

Added mock classes for better testing.

Author: swedieman

lib/Connection.php

@@ -12,7 +12,7 @@
  * You can let the Connection-class hold named instances by using Connection::getInstance('name')
  * with different contexts (or even different backend URLs).
  */
-class Connection {
+class Connection implements ConnectionInterface {
   //
   // Static
   //
@@ -73,7 +73,7 @@ public function call($method, $params = null) {
 
     $request = $this->connection->sendRequest($method, $params);
 
-    if ($request->error) throw Exception::factory($this->connection, $request);
+    if ($request->error) throw Exception::factory($this, $request);
 
     return $request->result;
   }
@@ -125,6 +125,12 @@ public function getSession() {
     return $this->context['session'];
   }
 
+  public function getUri() {
+    $backend_uri = $this->backend;
+    if (!empty($this->context)) $backend_uri .= '?' . http_build_query($this->context);
+    return $backend_uri;
+  }
+
   //
   // Magic methods
   //

lib/ConnectionInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Textalk\WebshopClient;
+
+/**
+ * Interface for API Connections.
+ */
+interface ConnectionInterface {
+  public function getApiClass($class);
+  public function getApiInstance($class, $uid);
+  public function getUri();
+}

lib/Exception.php

@@ -2,8 +2,6 @@
 
 namespace Textalk\WebshopClient;
 
-use Tivoka\Client\Request;
-
 class Exception extends \Exception {
   protected static $class_by_code = array(
     -32700 => 'ParseError',
@@ -21,8 +19,8 @@ class Exception extends \Exception {
    *
    * @return Exception Generic or specific subclass
    */
-  public static function factory(\Tivoka\Client\Connection\WebSocket $connection,
-                                 Request $request) {
+  public static function factory(\Textalk\WebshopClient\ConnectionInterface $connection,
+                                 \Tivoka\Client\Request $request) {
     if (array_key_exists($request->error, self::$class_by_code)) {
       $exception_class
         = 'Textalk\\WebshopClient\\Exception\\' . self::$class_by_code[$request->error];
@@ -50,15 +48,16 @@ public function getRpcMessage() { return $this->request->errorMessage; }
   // Protected
   //
 
-  protected $request;    ///< Tivoka\Client\Request The request that failed
-  protected $connection; ///< Tivoka\Client\Connection\WebSocket The connection that was used
+  protected $connection; ///< Textalk\WebshopClient\ConnectionInterface The connection that was used.
+  protected $request;    ///< Tivoka\Client\Request The request that failed.
 
   /**
    * Construct a new Exception.
    *
    * This can't be protected since it extends Exception, but it shouldn't be used.  Use factory.
    */
-  public function __construct(\Tivoka\Client\Connection\WebSocket $connection, Request $request) {
+  public function __construct(\Textalk\WebshopClient\ConnectionInterface $connection,
+                              \Tivoka\Client\Request $request) {
     $this->request    = $request;
     $this->connection = $connection;
 

lib/Mock/ConnectionMock.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Textalk\WebshopClient\Mock;
+
+/**
+ * A mock connection to be used when testing.
+ */
+class ConnectionMock implements \Textalk\WebshopClient\ConnectionInterface {
+
+  public $classes = array(); // Array of ApiClassMock instances
+  public $instances = array(); // Array of ApiInstanceMock instance
+
+  public function getApiClass($class) {
+    if (isset($this->classes[$class])) return $this->classes[$class];
+    throw new Exception("Unexpected class: $class");
+  }
+
+  public function getApiInstance($class, $uid) {
+    if (isset($this->instances[$class][$uid])) return $this->classes[$class][$uid];
+    throw new Exception("Unexpected instance. Class: $class UID: $uid");
+  }
+
+  public function getUri() { return 'mock://mock'; }
+
+  public function __get($key) {
+    if (isset($this->classes[$key])) return $this->classes[$key];
+    throw new Exception("Unexpected get: $key");
+  }
+}

lib/Mock/RequestMock.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Textalk\WebshopClient\Mock;
+
+/**
+ * A mock Tivoka client request class.
+ */
+class RequestMock extends \Tivoka\Client\Request {
+
+  public $target = null;
+
+  /**
+   * Mock sending data to target.
+   * @param mixed $target Remote end-point definition
+   */
+  public function sendTo($target) {
+    $this->target = $target;
+  }
+
+}

tests/ExceptionTest.php

@@ -8,15 +8,13 @@
 
 class ExceptionTest extends PHPUnit_Framework_TestCase {
   public function testUnspecifiedExceptionCode() {
-    $connection = Client::connect('wss://shop.textalk.se/backend/jsonrpc/v1/');
-    $request    = $connection->sendRequest('Foo', 'bar');
-
+    $request = new Textalk\WebshopClient\Mock\RequestMock('Test.testMethod');
     $request->error = 424242;
     try {
-      throw Exception::factory($connection, $request);
+      throw Exception::factory(new Textalk\WebshopClient\Mock\ConnectionMock, $request);
     }
     catch (Textalk\WebshopClient\Exception $e) {
-      $this->assertInstanceOf('Textalk\WebshopClient\\Exception', $e);
+      $this->assertInstanceOf('Textalk\WebshopClient\Exception', $e);
     }
 
     $this->assertNotNull($e, 'A Textalk\WebshopClient\Exception should be thrown.');