Add dependency injection for all objects relying on ObjectSpec (#82)

* Add dependency injection for all objects relying on ObjectSpec (command frames and client)

* Changed ObjectSpec to be non-static class
* Removed NASK's ObjectSpec methods to better facilitate new ObjectSpec
* Modified examples to use new ObjectSpec way of doing things
* Removed unnecessary php-version dependent tests due to non-static ObjectSpec
* Added HTTPClient connection example
* Moved COZA extension example to Extension subdir in examples
* Added documentation in README.md
* Added recent changes to CHANGELOG.md

Author: johnny-bit

CHANGELOG.md

@@ -7,19 +7,25 @@
 - Updated code documentation (more contributions welcome)
 - Increased testing coverage
 - More detailed examples of using this library
+- All frame objects now accept ObjectSpec as dependency in order to fix static ObjectSpec problems (eg inability to have custom namespaces). This isn't breaking since without ObjectSpec being passed, default one is used
 
 ### Added
 
 - DNSSec dsData support in Domain classes ( @johnny-bit)
 - Introduced `HTTPClient` allowing EPP communication over HTTP(S) (@johnny-bit)
 - `AbstractClient` class and `ClientInterface` interface for ease of creating `Client` replacements(@johnny-bit)
-- NASK Extension - a full Polish domain registry support
+- NASK Extension - a full Polish domain registry support (@johnny-bit)
+- Dependency injection for ObjectSpec (especially useful for registrars not following EPP namespaces, like NASK) (@johnny-bit)
+- Nominet `release` extension for domains (@greenmato)
+- nic.it extensions (@bessone)
 
 ### Fixed
 
 - RFC5733 compatibility enhancements (added `extension` to voice and fax) for Contact calls(@johnny-bit)
 - Removed coverage checks from non-testable classes
 - Incorrect file permissions (execute bit) on source files
+- `verify_peer_name` logic (@domainregistrar)
+- Testing issues (@bessone)
 
 ## 1.0.0 - 2018-12-23
 

README.md

@@ -45,11 +45,12 @@ Features
     * [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/) & [PSR-4](http://www.php-fig.org/psr/psr-4/)
     * notice and warning free (find them, and I'll fix it!)
 * high-level usage (Plug & Play)
-* simplified client (auto login/logout, auto inject clTRID)
+* simplified client for socket and http(s) connections (auto login/logout, auto inject clTRID)
 * SSL (+local-cert)
 * XPath like setter to simplify the creation of complex XML structures
 * XML based responses for direct traversal via XPath
 * [RFC 5730](http://tools.ietf.org/html/rfc5730), [RFC 5731](http://tools.ietf.org/html/rfc5731), [RFC 5732](http://tools.ietf.org/html/rfc5732), [RFC 5733](http://tools.ietf.org/html/rfc5733), [RFC 5734](http://tools.ietf.org/html/rfc5734) & [RFC 3915](http://tools.ietf.org/html/rfc3915)
+* DNSSEC support [RFC 5910](http://tools.ietf.org/html/rfc5910)
 
 
 Install
@@ -119,7 +120,7 @@ require 'vendor/autoload.php';
 
 use AfriCC\EPP\Frame\Command\Create\Host as CreateHost;
 
-$frame = new CreateHost;
+$frame = new CreateHost();
 $frame->setHost('ns1.example.com');
 $frame->setHost('ns2.example.com');
 $frame->addAddr('8.8.8.8');
@@ -141,7 +142,7 @@ Method which will return an assoc array.
 use AfriCC\EPP\Frame\Command\Check\Domain as DomainCheck;
 use AfriCC\EPP\Frame\Response;
 
-$frame = new DomainCheck;
+$frame = new DomainCheck();
 $frame->addDomain('example.org');
 $frame->addDomain('example.net');
 $frame->addDomain('example.com');
@@ -170,12 +171,95 @@ foreach ($data['chkData']['cd'] as $cd) {
     printf('Domain: %s, available: %d' . PHP_EOL, $cd['name'], $cd['@name']['avail']);
 }
 ```
+### Custom ObjectSpec
 
+If registrar you're working with uses custom namespace names (eg NASK) you can 
+use custom ObjectSpec. Clients always use specified ObjectSpec when decoding
+responses from EPP server.
+
+You can use this feature as follows:
+
+```php
+use AfriCC\EPP\HTTPClient as EPPClient;
+use \AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
+use AfriCC\EPP\Frame\Command\Poll;
+
+$objectSpec = new NASKObjectSpec();
+$config = [
+    'host' => 'https://app.registrar.tld',
+    'username' => 'user',
+    'password' => 'pass',
+    'services' => $objectSpec->services,
+    'serviceExtensions' => $objectSpec->serviceExtensions,
+];
+
+$epp_client = new EPPClient($config, $objectSpec);
+
+$frame = new Poll($epp_client->getObjectSpec());
+```
+
+or you can create frames with custom ObjectSpec:
+
+```php
+use AfriCC\EPP\Extension\NASK\Update\Future as UpdateFuture;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
+
+$frame = new UpdateFuture(new NASKObjectSpec());
+$frame->setFuture('example7.pl');
+$frame->changeRegistrant('mak21');
+$frame->changeAuthInfo('2fooBAR');
+echo $frame;
+```
+
+You can also create different clients with different ObjectSpec and then you can
+use `getObjectSpec` method when creating any request frame:
+
+```php
+use AfriCC\EPP\ObjectSpec as DefaultObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
+use AfriCC\EPP\Client as EPPClient;
+use AfriCC\EPP\HTTPClient as HTTPEPPClient;
+use AfriCC\EPP\Frame\Command\Poll;
+
+//...
+$nask_objectspec = new NASKObjectSpec();
+$default_objectspec = new DefaultObjectSpec();
+
+$nask_client = new HTTPEPPClient($nask_config, $nask_objectspec);
+$http_client = new HTTPEPPClient($http_config, $default_objectspec);
+$socket_client = new EPPClient($socket_config, $default_objectspec);
+$nask_socket_client = new EPPClient($nask_socket_config, $nask_objectspec);
+
+$nask_poll = new Poll($nask_client->getObjectSpec());
+$default_poll = new Poll($socket_client->getObjectSpec());
+```
+
+You can also change Client's objectSpec on the fly via `setObjectSpec` method:
+
+```php
+use AfriCC\EPP\ObjectSpec as DefaultObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
+use AfriCC\EPP\Client as EPPClient;
+
+//...
+$nask_objectspec = new NASKObjectSpec();
+$default_objectspec = new DefaultObjectSpec();
+
+$variable_client = new EPPClient($socket_config, $default_objectspec);
+
+//calls to getObjectSpec will return default objectSpec and responses
+//will be parsed using default ObjectSpec
+
+$variable_client->setObjectSpec($nask_objectspec);
+
+//calls to getObjectSpec will return NASK objectSpec and responses
+//will be parsed using NASK ObjectSpec
+
+```
 
 Future
 ------
 
-* objectspec on login needs to be smarter (no global/static object, auto-injecter)
 * stricter response parsing
 * stricter request validation
 * make it server capable (in conjunction with apache mod_epp)
@@ -201,4 +285,3 @@ License
 php-epp2 is released under the GPLv3 License. See the bundled
 [LICENSE](https://github.com/AfriCC/php-epp2/blob/master/LICENSE) file for
 details.
-

examples/Connection/http_connect.php

@@ -0,0 +1,64 @@
+<?php
+
+// debug
+error_reporting(E_ALL);
+ini_set('display_errors', true);
+
+chdir(__DIR__);
+
+require '../../vendor/autoload.php';
+
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
+use AfriCC\EPP\Frame\Command\Poll;
+use AfriCC\EPP\HTTPClient as EPPClient;
+
+$objectSpec = new NASKObjectSpec();
+$config = [
+    'debug' => true,
+    'host' => 'https://app.registrar.tld',
+    'username' => 'user',
+    'password' => 'pass',
+    'services' => $objectSpec->services,
+    'serviceExtensions' => $objectSpec->serviceExtensions,
+    //'ssl' => true, //ssl forced to true by using "https" protocol
+    'ca_cert' => 'ca.crt',
+    'local_cert' => 'client.crt',
+    'pk_cert' => 'client.key',
+];
+
+$epp_client = new EPPClient($config, $objectSpec);
+
+try {
+    $greeting = $epp_client->connect();
+
+    echo $greeting;
+
+    $frame = new Poll($epp_client->getObjectSpec()); //use epp client default objectspec
+    $frame->request();
+
+    $response = $epp_client->request($frame);
+
+    while ($response->success() && $response->code() !== 1300) { // 1300 = result successful, no more mesages
+
+        echo 'Epp Poll message ID: ';
+        echo $response->queueId();
+        echo "\n";
+        echo 'Epp Poll Message: ';
+        echo $response->queueMessage();
+
+        $ackFrame = new Poll($epp_client->getObjectSpec());
+        $ackFrame->ack($response->queueId());
+        $ackResponse = $epp_client->request($ackFrame);
+        if (!$ackResponse->success()) {
+            echo "Couldn't ACK poll message\n";
+            break; // no ack!
+        }
+        $response = $client->request($frame); //reuse already existing poll request frame
+    }
+} catch (Exception $e) {
+    echo $e->getMessage() . PHP_EOL;
+    unset($epp_client);
+    exit(1);
+}
+
+$epp_client->close();

examples/connect.php renamed to examples/Connection/socket_connect.php

@@ -6,7 +6,7 @@
 
 chdir(__DIR__);
 
-require '../vendor/autoload.php';
+require '../../vendor/autoload.php';
 
 use AfriCC\EPP\Client as EPPClient;
 

examples/extension.php renamed to examples/Extension/COZA/contact_info.php

@@ -6,10 +6,9 @@
 
 chdir(__DIR__);
 
-require '../vendor/autoload.php';
+require '../../../vendor/autoload.php';
 
 use AfriCC\EPP\Extension\COZA\Info\CozaContact as CozaContactInfoExtension;
-use AfriCC\EPP\Extension\COZA\Update\CozaContact as CozaContactUpdateExtension;
 
 $frame = new CozaContactInfoExtension();
 $frame->setId('MyContact');
@@ -24,10 +23,3 @@
 $frame->setAuthInfo('password');
 $frame->requestDomainListing();
 echo $frame;
-
-echo PHP_EOL;
-
-$frame = new CozaContactUpdateExtension();
-$frame->setId('MyContact');
-$frame->cancelPendingAction();
-echo $frame;

examples/Extension/COZA/contact_update.php

@@ -0,0 +1,16 @@
+<?php
+
+// debug
+error_reporting(E_ALL);
+ini_set('display_errors', true);
+
+chdir(__DIR__);
+
+require '../../../vendor/autoload.php';
+
+use AfriCC\EPP\Extension\COZA\Update\CozaContact as CozaContactUpdateExtension;
+
+$frame = new CozaContactUpdateExtension();
+$frame->setId('MyContact');
+$frame->cancelPendingAction();
+echo $frame;

examples/Extension/NASK/check_future.php

@@ -8,11 +8,9 @@
 
 require './_autoload.php';
 use AfriCC\EPP\Extension\NASK\Check\Future as CheckFuture;
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 
-ObjectSpec::overwriteParent();
-
-$frame = new CheckFuture();
+$frame = new CheckFuture(new NASKObjectSpec());
 $frame->addFuture('ala.pl');
 $frame->addFuture('ela.com.pl');
 $frame->addFuture('ola.org');

examples/Extension/NASK/create_future.php

@@ -8,11 +8,9 @@
 
 require './_autoload.php';
 use AfriCC\EPP\Extension\NASK\Create\Future as CreateFuture;
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 
-ObjectSpec::overwriteParent();
-
-$frame = new CreateFuture();
+$frame = new CreateFuture(new NASKObjectSpec());
 $frame->setFuture('example.pl');
 $frame->setPeriod('3y');
 $frame->setRegistrant('jd1234');

examples/Extension/NASK/delete_future.php

@@ -8,10 +8,8 @@
 
 require './_autoload.php';
 use AfriCC\EPP\Extension\NASK\Delete\Future as DeleteFuture;
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 
-ObjectSpec::overwriteParent();
-
-$frame = new DeleteFuture();
+$frame = new DeleteFuture(new NASKObjectSpec());
 $frame->setFuture('futuretest.pl');
 echo $frame;

examples/Extension/NASK/info_future.php

@@ -8,11 +8,9 @@
 
 require './_autoload.php';
 use AfriCC\EPP\Extension\NASK\Info\Future as InfoFuture;
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 
-ObjectSpec::overwriteParent();
-
-$frame = new InfoFuture();
+$frame = new InfoFuture(new NASKObjectSpec());
 $frame->setFuture('example.pl');
 $frame->setAuthInfo('2fooBAR');
 echo $frame;

examples/Extension/NASK/renew_future.php

@@ -7,12 +7,10 @@
 chdir(__DIR__);
 
 require './_autoload.php';
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 use AfriCC\EPP\Extension\NASK\Renew\Future as RenewFuture;
 
-ObjectSpec::overwriteParent();
-
-$frame = new RenewFuture();
+$frame = new RenewFuture(new NASKObjectSpec());
 $frame->setFuture('example.pl');
 $frame->setCurrentExpirationDate('2010-10-30');
 $frame->setPeriod('3y');

examples/Extension/NASK/report_basic.php

@@ -7,12 +7,10 @@
 chdir(__DIR__);
 
 require './_autoload.php';
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 use AfriCC\EPP\Extension\NASK\Report;
 
-ObjectSpec::overwriteParent();
-
-$frame = new Report();
+$frame = new Report(new NASKObjectSpec());
 $frame->setOffset(0);
 $frame->setLimit(50);
 echo $frame;

examples/Extension/NASK/report_cancel.php

@@ -7,12 +7,10 @@
 chdir(__DIR__);
 
 require './_autoload.php';
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 use AfriCC\EPP\Extension\NASK\Report\Cancel as ReportCancel;
 
-ObjectSpec::overwriteParent();
-
-$frame = new ReportCancel();
+$frame = new ReportCancel(new NASKObjectSpec());
 $frame->setReportId('e264a95d-0ba0-40f1-a0e0-97407fd5cdbe');
 $frame->setOffset(0);
 $frame->setLimit(50);

examples/Extension/NASK/report_contact.php

@@ -7,12 +7,10 @@
 chdir(__DIR__);
 
 require './_autoload.php';
-use AfriCC\EPP\Extension\NASK\ObjectSpec;
+use AfriCC\EPP\Extension\NASK\ObjectSpec as NASKObjectSpec;
 use AfriCC\EPP\Extension\NASK\Report\Contact as ReportContact;
 
-ObjectSpec::overwriteParent();
-
-$frame = new ReportContact();
+$frame = new ReportContact(new NASKObjectSpec());
 $frame->setContactId('k13');
 $frame->setOffset(0);
 $frame->setLimit(50);