remove unneeded getter methods from API classes

Author: xabbuh

.travis.yml

@@ -33,6 +33,7 @@ install:
   - if [ "$deps" = "" ]; then composer install; fi
 
 script:
+  - vendor/bin/phpspec run
   - if [[ "$xdebug" = "yes" ]]; then phpunit --coverage-clover=coverage.clover; else phpunit; fi
   - if [[ "$xdebug" = "yes" ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
   - if [[ "$xdebug" = "yes" ]]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

CHANGELOG.md

@@ -4,6 +4,39 @@ CHANGELOG
 0.3.0
 -----
 
+* Removed the `getRequestHandler()` method from the API classes:
+
+  * `ActivityProfileApiClient::getRequestHandler()`
+  * `AgentProfileApiClient::getRequestHandler()`
+  * `ApiClient::getRequestHandler()`
+  * `DocumentApiClient::getRequestHandler()`
+  * `StateApiClient::getRequestHandler()`
+  * `StatementsApiClient::getRequestHandler()`
+
+* Removed the `getVersion()` method from the API interfaces:
+
+  * `ActivityProfileApiClientInterface::getVersion()`
+  * `AgentProfileApiClientInterface::getVersion()`
+  * `StateApiClientInterface::getVersion()`
+  * `StatementsApiClientInterface::getVersion()`
+
+* Removed the `getVersion()` method from the API classes:
+
+  * `ActivityProfileApiClient::getVersion()`
+  * `AgentProfileApiClient::getVersion()`
+  * `ApiClient::getVersion()`
+  * `DocumentApiClient::getVersion()`
+  * `StateApiClient::getVersion()`
+  * `StatementsApiClient::getVersion()`
+  * `XApiClient::getVersion()`
+
+* Removed the `getUsername()` and `getPassword()` methods from the `HandlerInterface`
+  and the `Handler` class.
+
+* Removed the `getHttpClient()` method from the `Handler` class.
+
+* Removed the `getSerializerRegistry()` method from the `XApiClient` class.
+
 * Made all classes final.
 
 0.2.0

UPGRADE.md

@@ -4,6 +4,40 @@ UPGRADE
 Upgrading from 0.2 to 0.3
 -------------------------
 
+* Removed the `getRequestHandler()` method from the API classes:
+
+  * `ActivityProfileApiClient::getRequestHandler()`
+  * `AgentProfileApiClient::getRequestHandler()`
+  * `ApiClient::getRequestHandler()`
+  * `DocumentApiClient::getRequestHandler()`
+  * `StateApiClient::getRequestHandler()`
+  * `StatementsApiClient::getRequestHandler()`
+  * `XApiClient::getRequestHandler()`
+
+* Removed the `getVersion()` method from the API interfaces:
+
+  * `ActivityProfileApiClientInterface::getVersion()`
+  * `AgentProfileApiClientInterface::getVersion()`
+  * `StateApiClientInterface::getVersion()`
+  * `StatementsApiClientInterface::getVersion()`
+
+* Removed the `getVersion()` method from the API classes:
+
+  * `ActivityProfileApiClient::getVersion()`
+  * `AgentProfileApiClient::getVersion()`
+  * `ApiClient::getVersion()`
+  * `DocumentApiClient::getVersion()`
+  * `StateApiClient::getVersion()`
+  * `StatementsApiClient::getVersion()`
+  * `XApiClient::getVersion()`
+
+* Removed the `getUsername()` and `getPassword()` methods from the `HandlerInterface`
+  and the `Handler` class.
+
+* Removed the `getHttpClient()` method from the `Handler` class.
+
+* Removed the `getSerializerRegistry()` method from the `XApiClient` class.
+
 * All classes are final now which means that you can now longer extend them.
   Consider using composition/decoration instead if you need to build functionality
   on top of the built-in classes.

composer.json

@@ -19,6 +19,7 @@
         "php-xapi/serializer": "^0.3.0"
     },
     "require-dev": {
+        "phpspec/phpspec": "^2.3",
         "php-xapi/test-fixtures": "^0.5.0"
     },
     "conflict": {
@@ -31,6 +32,7 @@
     },
     "autoload-dev": {
         "psr-4": {
+            "spec\\Xabbuh\\XApi\\Client\\": "spec/",
             "Xabbuh\\XApi\\Client\\Tests\\": "tests/"
         }
     },

phpspec.yml.dist

@@ -0,0 +1,4 @@
+suites:
+  default:
+    namespace: Xabbuh\XApi\Client
+    psr4_prefix: Xabbuh\XApi\Client

spec/XApiClientBuilderSpec.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace spec\Xabbuh\XApi\Client;
+
+use PhpSpec\ObjectBehavior;
+
+class XApiClientBuilderSpec extends ObjectBehavior
+{
+    function it_is_an_xapi_client_builder()
+    {
+        $this->shouldHaveType('Xabbuh\XApi\Client\XApiClientBuilderInterface');
+    }
+
+    function it_creates_an_xapi_client()
+    {
+        $this->build()->shouldHaveType('Xabbuh\XApi\Client\XApiClientInterface');
+    }
+}

src/Api/ActivityProfileApiClientInterface.php

@@ -22,13 +22,6 @@
  */
 interface ActivityProfileApiClientInterface
 {
-    /**
-     * Returns the xAPI version.
-     *
-     * @return string The xAPI version
-     */
-    public function getVersion();
-
     /**
      * Stores a document for an activity profile. Updates an existing document
      * for this activity profile if one exists.

src/Api/AgentProfileApiClientInterface.php

@@ -22,13 +22,6 @@
  */
 interface AgentProfileApiClientInterface
 {
-    /**
-     * Returns the xAPI version.
-     *
-     * @return string The xAPI version
-     */
-    public function getVersion();
-
     /**
      * Stores a document for an agent profile. Updates an existing document for
      * this agent profile if one exists.

src/Api/ApiClient.php

@@ -33,14 +33,4 @@ public function __construct(HandlerInterface $requestHandler, $version)
         $this->requestHandler = $requestHandler;
         $this->version = $version;
     }
-
-    public function getRequestHandler()
-    {
-        return $this->requestHandler;
-    }
-
-    public function getVersion()
-    {
-        return $this->version;
-    }
 }

src/Api/StateApiClientInterface.php

@@ -21,13 +21,6 @@
  */
 interface StateApiClientInterface
 {
-    /**
-     * Returns the xAPI version.
-     *
-     * @return string The xAPI version
-     */
-    public function getVersion();
-
     /**
      * Stores a document for a state. Updates an existing document for this
      * state if one exists.