Merge branch 'feature/processing'

build/config/phpmd.xml

@@ -8,7 +8,10 @@
     <description>Ruleset for all DETAIL NET projects</description>
 
     <rule ref="rulesets/unusedcode.xml" />
-    <rule ref="rulesets/design.xml" />
+
+    <rule ref="rulesets/design.xml">
+        <exclude name="CouplingBetweenObjects"/>
+    </rule>
 
     <rule ref="rulesets/naming.xml">
         <exclude name="ShortVariable"/>

composer.json

@@ -24,10 +24,14 @@
         "zendframework/zend-stdlib": "~2.3.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4.4.0",
-        "squizlabs/php_codesniffer" : "~2.0.0",
+        "phpunit/phpunit": "~4.4.4",
+        "squizlabs/php_codesniffer" : "~2.2.0",
         "phpmd/phpmd": "~2.1.3",
-        "satooshi/php-coveralls": "dev-master"
+        "satooshi/php-coveralls": "dev-master",
+        "detailnet/blitline": "~0.3.3"
+    },
+    "suggest": {
+        "detailnet/blitline": "For usage of the Blitline adapter"
     },
     "autoload": {
         "psr-0": {

examples/bootstrap.php

@@ -13,10 +13,10 @@
 
 $loader->add('Detail\FileConversion', $basePath . 'src');
 
-if (!file_exists('config.php')) {
+if (!file_exists(__DIR__ . '/config.php')) {
     throw new RuntimeException(
         'Missing configuration file "config.php"; make a copy of "config.php.dist" and update it'
     );
 }
 
-return require 'config.php';
+return require __DIR__ . '/config.php';

examples/job-create.php → examples/client/job-create.php

@@ -2,7 +2,7 @@
 
 use Detail\FileConversion\Client\FileConversionClient;
 
-$config = require 'bootstrap.php';
+$config = require '../bootstrap.php';
 
 $imageUrl = isset($_GET['imageUrl']) ? $_GET['imageUrl'] : null;
 
@@ -24,7 +24,7 @@
 
 $client = FileConversionClient::factory($config);
 
-/** @var \Detail\FileConversion\Job\JobBuilder $jobBuilder */
+/** @var \Detail\FileConversion\Client\Job\JobBuilder $jobBuilder */
 $jobBuilder = $client->getJobBuilder();
 $jobBuilder->setDefaultOption(
     'action.save',

examples/job-info.php → examples/client/job-info.php

@@ -2,7 +2,7 @@
 
 use Detail\FileConversion\Client\FileConversionClient;
 
-$config = require 'bootstrap.php';
+$config = require '../bootstrap.php';
 
 $jobId = isset($_GET['job_id']) ? $_GET['job_id'] : null;
 

examples/job-list.php → examples/client/job-list.php

@@ -2,7 +2,7 @@
 
 use Detail\FileConversion\Client\FileConversionClient;
 
-$config = require 'bootstrap.php';
+$config = require '../bootstrap.php';
 $params = array();
 
 if (isset($_GET['page'])) {

src/Detail/FileConversion/Client/Exception/ExceptionInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Detail\FileConversion\Client\Exception;
+
+use Detail\FileConversion\Exception\ExceptionInterface as BaseExceptionInterface;
+
+interface ExceptionInterface extends BaseExceptionInterface
+{
+}

src/Detail/FileConversion/Client/Exception/InvalidArgumentException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Detail\FileConversion\Client\Exception;
+
+class InvalidArgumentException extends \InvalidArgumentException implements
+    ExceptionInterface
+{
+}

src/Detail/FileConversion/Client/Exception/RuntimeException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Detail\FileConversion\Client\Exception;
+
+class RuntimeException extends \RuntimeException implements
+    ExceptionInterface
+{
+}

src/Detail/FileConversion/Client/FileConversionClient.php

@@ -6,22 +6,22 @@
 use Guzzle\Service\Client;
 use Guzzle\Service\Description\ServiceDescription;
 
-//use Detail\FileConversion\Exception\InvalidArgumentException;
-use Detail\FileConversion\Job\Definition\DefinitionInterface;
-use Detail\FileConversion\Job\JobBuilder;
-use Detail\FileConversion\Job\JobBuilderInterface;
-use Detail\FileConversion\Response;
+//use Detail\FileConversion\Client\Exception\InvalidArgumentException;
+use Detail\FileConversion\Client\Job\Definition\DefinitionInterface;
+use Detail\FileConversion\Client\Job\JobBuilder;
+use Detail\FileConversion\Client\Job\JobBuilderInterface;
+use Detail\FileConversion\Client\Response;
 
 /**
  * FileConversion API client.
  *
  * @method Response\JobList listJobs(array $params = array())
  * @method Response\Job fetchJob(array $params = array())
- * @method Response\Job createJob(mixed $job = array())
+ * @method Response\Job submitJob(mixed $job = array())
  */
 class FileConversionClient extends Client
 {
-    const CLIENT_VERSION = '0.2.0';
+    const CLIENT_VERSION = '0.3.0';
 
     /**
      * @var JobBuilderInterface
@@ -58,7 +58,7 @@ public static function factory($options = array(), JobBuilderInterface $jobBuild
             )
         );
         $client->setDescription(
-            ServiceDescription::factory(__DIR__ . '/../ServiceDescription/FileConversion.php')
+            ServiceDescription::factory(__DIR__ . '/ServiceDescription/FileConversion.php')
         );
         $client->setUserAgent('dfw-fileconversion/' . self::CLIENT_VERSION, true);
 

src/Detail/FileConversion/Job/Definition/ActionDefinition.php → src/Detail/FileConversion/Client/Job/Definition/ActionDefinition.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 class ActionDefinition extends BaseDefinition implements
     ActionDefinitionInterface

src/Detail/FileConversion/Job/Definition/ActionDefinitionInterface.php → src/Detail/FileConversion/Client/Job/Definition/ActionDefinitionInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 interface ActionDefinitionInterface extends DefinitionInterface
 {

src/Detail/FileConversion/Job/Definition/BaseDefinition.php → src/Detail/FileConversion/Client/Job/Definition/BaseDefinition.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 use ArrayObject;
 use RecursiveIteratorIterator;
@@ -94,8 +94,9 @@ public function toArray()
             }
         }
 
-        // Helper function which recursively converts to a normal (recursive) array again
-        $toArray = function($data) use (&$toArray) { // Reference is required for "recursive closure"...
+        // Helper function which recursively converts to a normal (recursive) array again.
+        // Reference is required for "recursive closure"...
+        $toArray = function($data) use (&$toArray) {
             if ($data instanceof ArrayObject) {
                 $data = (array) $data;
             }

src/Detail/FileConversion/Job/Definition/DefinitionInterface.php → src/Detail/FileConversion/Client/Job/Definition/DefinitionInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 interface DefinitionInterface
 {

src/Detail/FileConversion/Job/Definition/JobDefinition.php → src/Detail/FileConversion/Client/Job/Definition/JobDefinition.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 class JobDefinition extends BaseDefinition implements
     JobDefinitionInterface

src/Detail/FileConversion/Job/Definition/JobDefinitionInterface.php → src/Detail/FileConversion/Client/Job/Definition/JobDefinitionInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 interface JobDefinitionInterface extends DefinitionInterface
 {

src/Detail/FileConversion/Job/Definition/NotificationDefinition.php → src/Detail/FileConversion/Client/Job/Definition/NotificationDefinition.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 class NotificationDefinition extends BaseDefinition implements
     NotificationDefinitionInterface

src/Detail/FileConversion/Job/Definition/NotificationDefinitionInterface.php → src/Detail/FileConversion/Client/Job/Definition/NotificationDefinitionInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job\Definition;
+namespace Detail\FileConversion\Client\Job\Definition;
 
 interface NotificationDefinitionInterface extends DefinitionInterface
 {

src/Detail/FileConversion/Job/JobBuilder.php → src/Detail/FileConversion/Client/Job/JobBuilder.php

@@ -1,9 +1,9 @@
 <?php
 
-namespace Detail\FileConversion\Job;
+namespace Detail\FileConversion\Client\Job;
 
-use Detail\FileConversion\Exception\RuntimeException;
-use Detail\FileConversion\Job\Definition\DefinitionInterface;
+use Detail\FileConversion\Client\Exception\RuntimeException;
+use Detail\FileConversion\Client\Job\Definition\DefinitionInterface;
 
 class JobBuilder implements
     JobBuilderInterface

src/Detail/FileConversion/Job/JobBuilderInterface.php → src/Detail/FileConversion/Client/Job/JobBuilderInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Job;
+namespace Detail\FileConversion\Client\Job;
 
 interface JobBuilderInterface
 {

src/Detail/FileConversion/Response/Action.php → src/Detail/FileConversion/Client/Response/Action.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class Action extends BaseResponse
 {

src/Detail/FileConversion/Response/BaseResponse.php → src/Detail/FileConversion/Client/Response/BaseResponse.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 use DateTime;
 
-use Detail\FileConversion\Exception\RuntimeException;
+use Detail\FileConversion\Client\Exception\RuntimeException;
 
 use Guzzle\Service\Command\OperationCommand;
 use Guzzle\Service\Command\ResponseClassInterface as GuzzleResponseInterface;

src/Detail/FileConversion/Response/Job.php → src/Detail/FileConversion/Client/Response/Job.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 use DateTime;
 
@@ -63,7 +63,7 @@ public function getActionCount()
 
     /**
      * @param boolean $asPlainResult
-     * @return array
+     * @return Action[]|array
      */
     public function getActions($asPlainResult = false)
     {
@@ -80,7 +80,7 @@ public function getNotificationCount()
 
     /**
      * @param boolean $asPlainResult
-     * @return array
+     * @return Notification[]|array
      */
     public function getNotifications($asPlainResult = false)
     {
@@ -97,7 +97,7 @@ public function getResultCount()
 
     /**
      * @param boolean $asPlainResult
-     * @return array
+     * @return Result[]|array
      */
     public function getResults($asPlainResult = false)
     {

src/Detail/FileConversion/Response/JobList.php → src/Detail/FileConversion/Client/Response/JobList.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class JobList extends ListResponse
 {
@@ -11,7 +11,7 @@ class JobList extends ListResponse
 
     /**
      * @param boolean $asPlainResult
-     * @return array
+     * @return Job[]|array
      */
     public function getItems($asPlainResult = false)
     {
@@ -20,7 +20,7 @@ public function getItems($asPlainResult = false)
 
     /**
      * @param boolean $asPlainResult
-     * @return array
+     * @return Job[]|array
      */
     protected function getJobs($asPlainResult = false)
     {

src/Detail/FileConversion/Response/ListResponse.php → src/Detail/FileConversion/Client/Response/ListResponse.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 abstract class ListResponse extends BaseResponse implements
     ListResponseInterface

src/Detail/FileConversion/Response/ListResponseInterface.php → src/Detail/FileConversion/Client/Response/ListResponseInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 interface ListResponseInterface
 {

src/Detail/FileConversion/Response/Notification.php → src/Detail/FileConversion/Client/Response/Notification.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class Notification extends BaseResponse
 {

src/Detail/FileConversion/Response/NotificationCall.php → src/Detail/FileConversion/Client/Response/NotificationCall.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class NotificationCall extends BaseResponse
 {

src/Detail/FileConversion/Response/ResponseInterface.php → src/Detail/FileConversion/Client/Response/ResponseInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 interface ResponseInterface
 {

src/Detail/FileConversion/Response/Result.php → src/Detail/FileConversion/Client/Response/Result.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class Result extends BaseResponse
 {

src/Detail/FileConversion/Response/SaveOptions.php → src/Detail/FileConversion/Client/Response/SaveOptions.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Detail\FileConversion\Response;
+namespace Detail\FileConversion\Client\Response;
 
 class SaveOptions extends BaseResponse
 {