feat: fixes for subscriber and publisher semantics (#164)

.gitignore

@@ -13,3 +13,4 @@ template/.phpunit.result.cache
 .env
 template/.env
 .idea/
+*.DS_Store

filters/all.js

@@ -14,10 +14,10 @@ function toPHPType(str) {
         case 'date':
             return 'DateTime';
         case 'time':
-            return '\DateTime';
+            return '\\DateTime';
         case 'dateTime':
         case 'date-time':
-            return '\DateTime';
+            return '\\DateTime';
         case 'string':
         case 'password':
         case 'byte':
@@ -26,7 +26,7 @@ function toPHPType(str) {
         case 'double':
             return 'float';
         default:
-            return '\stdClass';
+            return '\\stdClass';
     }
 }
 

template/README.md

@@ -1,4 +1,4 @@
-# BrokerAPI
+# AsyncAPI
 
 [//]: # "[![Latest Version on Packagist][ico-version]][link-packagist]"
 
@@ -13,7 +13,7 @@
 [//]: # "[![Total Downloads][ico-downloads]][link-downloads]"
 
 
-BrokerAPI is a wrapper for Message-driven API's built on top of most used industry plugins such as [PHP AMQP lib](https://packagist.org/packages/php-amqplib/php-amqplib) for RabbitMQ.
+AsyncAPI is a wrapper for Message-driven API's built on top of most used industry plugins such as [PHP AMQP lib](https://packagist.org/packages/php-amqplib/php-amqplib) for RabbitMQ.
 It is built for usage altogether with [AsyncAPI specs and generators](https://github.com/asyncapi/generator)
 
 ## Structure
@@ -46,12 +46,12 @@ Once you hvae the generator installed, you can try to generate code from any val
 
 Refer to the examples folder for further details on PHP usage
 ``` bash
-$brokerAPI = new BrokerAPI();
+$brokerAPI = new AsyncAPI();
 $factory = $brokerAPI->init();
 
-/** @var \{{ params.packageName }}\Applications\Producer $producer */
-$producer = $factory->createApplication(
-    PRODUCER_KEY,
+/** @var \{{ params.packageName }}\Applications\Subscriber $subscriber */
+$subscriber = $factory->createApplication(
+    SUBSCRIBER_KEY,
     [
         BROKER_HOST_KEY         => 'localhost',
         BROKER_USER_KEY         => 'guest',
@@ -68,7 +68,7 @@ $message = $factory->createMessage(
     ]
 );
 
-$producer->requestExampleById($message);
+$subscriber->requestExampleById($message);
 ```
 
 ## Change log
@@ -92,17 +92,17 @@ If you discover any security related issues, please email [email protected] ins
 
 The MIT License (MIT). Please see [License File](../LICENSE.md) for more information.
 
-[ico-version]: https://img.shields.io/packagist/v/GA/BrokerAPI.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/GA/AsyncAPI.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/GA/BrokerAPI/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/GA/BrokerAPI.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/GA/BrokerAPI.svg?style=flat-square
-[ico-downloads]: https://img.shields.io/packagist/dt/GA/BrokerAPI.svg?style=flat-square
-
-[link-packagist]: https://packagist.org/packages/GA/BrokerAPI
-[link-travis]: https://travis-ci.org/GA/BrokerAPI
-[link-scrutinizer]: https://scrutinizer-ci.com/g/GA/BrokerAPI/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/GA/BrokerAPI
-[link-downloads]: https://packagist.org/packages/GA/BrokerAPI
+[ico-travis]: https://img.shields.io/travis/GA/AsyncAPI/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/GA/AsyncAPI.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/GA/AsyncAPI.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/GA/AsyncAPI.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/GA/AsyncAPI
+[link-travis]: https://travis-ci.org/GA/AsyncAPI
+[link-scrutinizer]: https://scrutinizer-ci.com/g/GA/AsyncAPI/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/GA/AsyncAPI
+[link-downloads]: https://packagist.org/packages/GA/AsyncAPI
 [link-author]: https://github.com/emilianozublena
 [link-contributors]: https://github.com/asyncapi/php-template/graphs/contributors

template/configs/consts.php

@@ -28,6 +28,6 @@
 /** END OF PROTOCOL LITERALS */
 
 /** APPLICATION LITERALS */
-const PRODUCER_KEY = 'producer';
-const CONSUMER_KEY = 'consumer';
+const SUBSCRIBER_KEY = 'subscriber';
+const PUBLISHER_KEY = 'publisher';
 /** END OF APPLICATION LITERALS */

template/examples/basic/producer/index.php → template/examples/basic/publisher/index.php

@@ -4,12 +4,12 @@
 use {{ params.packageName }};
 use {{ params.packageName }}\Messages\Example;
 
-$brokerAPI = new BrokerAPI();
+$brokerAPI = new AsyncAPI();
 $factory = $brokerAPI->init();
 
-/** @var \{{ params.packageName }}\Applications\Producer $producer */
-$producer = $factory->createApplication(
-    PRODUCER_KEY,
+/** @var \{{ params.packageName }}\Applications\Publisher $publisher */
+$publisher = $factory->createApplication(
+    PUBLISHER_KEY,
     [
         BROKER_HOST_KEY         => $_ENV[ENV_BROKER_HOST_KEY] ?? BROKER_HOST_DEFAULT,
         BROKER_USER_KEY         => $_ENV[ENV_BROKER_USER_KEY] ?? BROKER_USER_DEFAULT,
@@ -25,4 +25,4 @@
         'id' => 1,
     ]
 );
-$producer->requestExampleById($message);
+$publisher->requestExampleById($message);

template/examples/basic/consumer/Handlers/ExampleHandler.php → template/examples/basic/subscriber/Handlers/ExampleHandler.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Examples\Basic\Consumer\Handlers;
+namespace Examples\Basic\Publisher\Handlers;
 
 use {{ params.packageName }}\Handlers\HandlerContract;
 use {{ params.packageName }}\Messages\MessageContract;

template/examples/basic/consumer/index.php → template/examples/basic/subscriber/index.php

@@ -4,12 +4,12 @@
 
 use {{ params.packageName }};
 
-$brokerAPI = new BrokerAPI();
+$brokerAPI = new AsyncAPI();
 $factory = $brokerAPI->init();
 
-/** @var \{{ params.packageName }}\Applications\Consumer $consumer */
-$consumer = $factory->createApplication(
-    CONSUMER_KEY,
+/** @var \{{ params.packageName }}\Applications\Subscriber $subscriber */
+$subscriber = $factory->createApplication(
+    SUBSCRIBER_KEY,
     [
         BROKER_HOST_KEY         => $_ENV[ENV_BROKER_HOST_KEY] ?? BROKER_HOST_DEFAULT,
         BROKER_USER_KEY         => $_ENV[ENV_BROKER_USER_KEY] ?? BROKER_USER_DEFAULT,
@@ -18,5 +18,5 @@
         BROKER_VIRTUAL_HOST_KEY => $_ENV[ENV_BROKER_VIRTUAL_HOST_KEY] ?? BROKER_VIRTUAL_HOST_DEFAULT,
     ]
 );
-$handler = new \Examples\Basic\Consumer\Handlers\ExampleHandler();
-$consumer->retrieveExampleById($handler);
+$handler = new \Examples\Basic\Subscriber\Handlers\ExampleHandler();
+$subscriber->retrieveExampleById($handler);

template/examples/rpc/producer/index.php → template/examples/rpc/publisher/index.php

@@ -4,12 +4,12 @@
 use {{ params.packageName }};
 use {{ params.packageName }}\Messages\Example;
 
-$brokerAPI = new BrokerAPI();
+$brokerAPI = new AsyncAPI();
 $factory = $brokerAPI->init();
 
-/** @var \{{ params.packageName }}\Applications\Producer $producer */
-$producer = $factory->createApplication(
-    PRODUCER_KEY,
+/** @var \{{ params.packageName }}\Applications\Publisher $publisher */
+$publisher = $factory->createApplication(
+    PUBLISHER_KEY,
     [
         BROKER_HOST_KEY         => $_ENV[ENV_BROKER_HOST_KEY] ?? BROKER_HOST_DEFAULT,
         BROKER_USER_KEY         => $_ENV[ENV_BROKER_USER_KEY] ?? BROKER_USER_DEFAULT,
@@ -26,5 +26,5 @@
     ]
 );
 /** @var \PhpAmqpLib\Message\AMQPMessage $return */
-$return = $producer->requestExampleByIdRPC($message);
+$return = $publisher->requestExampleByIdRPC($message);
 print_r($return->getBody());

template/examples/rpc/consumer/Handlers/RPCExampleHandler.php → template/examples/rpc/subscriber/Handlers/RPCExampleHandler.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Examples\RPC\Consumer\Handlers;
+namespace Examples\RPC\Publisher\Handlers;
 
 use PhpAmqpLib\Message\AMQPMessage;
 use {{ params.packageName }}\Common\AMQPFactory;

template/examples/rpc/consumer/index.php → template/examples/rpc/subscriber/index.php

@@ -4,12 +4,12 @@
 
 use {{ params.packageName }};
 
-$brokerAPI = new BrokerAPI();
+$brokerAPI = new AsyncAPI();
 $factory = $brokerAPI->init();
 
-/** @var \{{ params.packageName }}\Applications\Consumer $consumer */
-$consumer = $factory->createApplication(
-    CONSUMER_KEY,
+/** @var \{{ params.packageName }}\Applications\Subscriber $subscriber */
+$subscriber = $factory->createApplication(
+    SUBSCRIBER_KEY,
     [
         BROKER_HOST_KEY         => $_ENV[ENV_BROKER_HOST_KEY] ?? BROKER_HOST_DEFAULT,
         BROKER_USER_KEY         => $_ENV[ENV_BROKER_USER_KEY] ?? BROKER_USER_DEFAULT,
@@ -18,5 +18,5 @@
         BROKER_VIRTUAL_HOST_KEY => $_ENV[ENV_BROKER_VIRTUAL_HOST_KEY] ?? BROKER_VIRTUAL_HOST_DEFAULT,
     ]
 );
-$handler = new \Examples\RPC\Consumer\Handlers\RPCExampleHandler();
-$consumer->retrieveExampleByIdRPC($handler);
+$handler = new \Examples\RPC\Subscriber\Handlers\RPCExampleHandler();
+$subscriber->retrieveExampleByIdRPC($handler);

template/phpcs.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
-<ruleset name="BrokerAPI">
-    <description>The coding standard of BrokerAPI package</description>
+<ruleset name="AsyncAPI">
+    <description>The coding standard of AsyncAPI package</description>
     <arg value="p" />
 
     <config name="ignore_warnings_on_exit" value="1" />
@@ -11,4 +11,4 @@
 
     <!-- Use the PSR2 Standard-->
     <rule ref="PSR2" />
-</ruleset>
+</ruleset>

template/phpunit.xml

@@ -11,7 +11,7 @@
          stopOnFailure               = "true">
 
     <testsuites>
-        <testsuite name="BrokerAPI Test Suite">
+        <testsuite name="AsyncAPI Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
@@ -20,4 +20,4 @@
         <env name="APP_ENV" value="testing"/>
     </php>
 
-</phpunit>
+</phpunit>

template/src/Applications/ApplicationContract.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * Base interface for all Applications
- * In BrokerAPI applications can either be Producers or Consumers
+ * In AsyncAPI applications can either be Subscribers or Publishers
  * (depending on message protocol these often get called as publishers/subscribers)
  * Application classes should never be extended
  *

template/src/Applications/Producer.php → template/src/Applications/Publisher.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * Producer application is the single final class that you should obtain from concrete factory
+ * Subscriber application is the single final class that you should obtain from concrete factory
  * This application will have methods for each channel/operation and you should only
  * pass messages and handlers that will implement any business logic needed (eg: rpc calls)
- * Producer = Publisher
+ * Subscriber = Publisher
  *
  * User: emiliano
  * Date: 30/12/20
@@ -15,13 +15,13 @@
 use {{ params.packageName }}\Messages\MessageContract;
 use {{ params.packageName }}\Handlers\AMQPRPCClientHandler;
 
-final class Producer extends ApplicationContract
+final class Publisher extends ApplicationContract
 {
 {%- for channelName, channel in asyncapi.channels() %}
-{%- if channel.hasPublish() %}
-    {%- set methodName = channel.publish().id() %}
-    {%- set methodDescription = channel.publish().description() %}
-    {%- set amqpBindings = channel.publish().bindings().amqp %}
+{%- if channel.hasSubscribe() %}
+    {%- set methodName = channel.subscribe().id() %}
+    {%- set methodDescription = channel.subscribe().description() %}
+    {%- set amqpBindings = channel.subscribe().bindings().amqp %}
     {%- if amqpBindings["x-type"] == 'basic' %}
     /**
      * {{ methodDescription }}

template/src/Applications/Consumer.php → template/src/Applications/Subscriber.php

@@ -1,9 +1,9 @@
 <?php
 /**
- * Consumer application is the single final class that you should obtain from concrete factory
+ * Publisher application is the single final class that you should obtain from concrete factory
  * This application will have methods for each channel/operation and you should only
  * Pass custom handlers to those methods for any business logic needed on message received
- * Consumer = Worker = Subscriber
+ * Publisher = Worker = Subscriber
  * User: emiliano
  * Date: 7/1/21
  * Time: 12:24
@@ -14,13 +14,13 @@
 use {{ params.packageName }}\Handlers\HandlerContract;
 use {{ params.packageName }}\Handlers\AMQPRPCServerHandler;
 
-final class Consumer extends ApplicationContract
+final class Subscriber extends ApplicationContract
 {
 {%- for channelName, channel in asyncapi.channels() %}
-{%- if channel.hasSubscribe() %}
-    {%- set methodName = channel.subscribe().id() %}
-    {%- set methodDescription = channel.subscribe().description() %}
-    {%- set amqpBindings = channel.subscribe().bindings().amqp %}
+{%- if channel.hasPublish() %}
+    {%- set methodName = channel.publish().id() %}
+    {%- set methodDescription = channel.publish().description() %}
+    {%- set amqpBindings = channel.publish().bindings().amqp %}
     {%- if amqpBindings["x-type"] == 'basic' %}
     /**
      * {{ methodDescription }}
@@ -43,7 +43,7 @@ public function {{ methodName }}(
             {%- set queueAutoDelete = amqpBindings.queue.autoDelete %}
             $config = array_merge([
                 'queue'           => '',
-                'consumerTag'     => '',
+                'publisherTag'     => '',
                 'noLocal'         => false,
                 'noAck'           => false,
                 'exclusive'       => {{queueExclusive}},

template/src/BrokerAPI.php → template/src/AsyncAPI.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * This is the single entry point for the BrokerAPI.
+ * This is the single entry point for the AsyncAPI.
  * This class will be in charge of instantiating whatever Factory is needed
  * depending on what's the default protocol on async api file
  * This default protocol can be overwritten by just sending it while instantiating this class
@@ -15,13 +15,13 @@
 use {{ params.packageName }}\Common\AMQPFactory;
 use {{ params.packageName }}\Common\FactoryContract;
 
-final class BrokerAPI
+final class AsyncAPI
 {
     /** @var string $protocol */
     private $protocol;
 
     /**
-     * BrokerAPI constructor.
+     * AsyncAPI constructor.
      * @param string $protocol
      */
     public function __construct(string $protocol = '{{-asyncapi | getDefaultProtocol}}')

template/src/Common/AMQPFactory.php

@@ -15,8 +15,8 @@
 use {{ params.packageName }}\Infrastructure\AMQPBrokerClient;
 use {{ params.packageName }}\Messages\MessageContract;
 use {{ params.packageName }}\Applications\ApplicationContract;
-use {{ params.packageName }}\Applications\Consumer;
-use {{ params.packageName }}\Applications\Producer;
+use {{ params.packageName }}\Applications\Publisher;
+use {{ params.packageName }}\Applications\Subscriber;
 use PhpAmqpLib\Connection\AMQPStreamConnection;
 use PhpAmqpLib\Message\AMQPMessage;
 
@@ -75,13 +75,13 @@ public function createApplication(
         $brokerClient = $this->createBrokerClient($config);
 
         switch ($applicationType) {
-            case PRODUCER_KEY:
-                $application = new Producer(
+            case SUBSCRIBER_KEY:
+                $application = new Subscriber(
                     $brokerClient
                 );
                 break;
-            case CONSUMER_KEY:
-                $application = new Consumer(
+            case PUBLISHER_KEY:
+                $application = new Publisher(
                     $brokerClient
                 );
                 break;

template/src/Handlers/AMQPRPCClientHandler.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * This class is used by a Consumer as a means to implement business logic "OnRequest"
+ * This class is used by a Publisher as a means to implement business logic "OnRequest"
  * From any given RPC client (Publisher)
  *
  * User: emiliano

template/src/Handlers/AMQPRPCServerHandler.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * This class is used by a Consumer as a means to implement business logic "OnRequest"
+ * This class is used by a Publisher as a means to implement business logic "OnRequest"
  * From any given RPC client (Publisher)
  *
  * User: emiliano