Merge branch 'master' into bundle-use-null-transport-as-default

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/EnqueueExtensionTest.php

Author: makasim

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [0.4.0](https://github.com/php-enqueue/enqueue-dev/tree/0.4.0) (2017-05-12)
+[Full Changelog](https://github.com/php-enqueue/enqueue-dev/compare/0.3.8...0.4.0)
+
+- \[fs\] add DSN support [\#82](https://github.com/php-enqueue/enqueue-dev/pull/82) ([makasim](https://github.com/makasim))
+- \[amqp\] Configure by string DSN. [\#80](https://github.com/php-enqueue/enqueue-dev/pull/80) ([makasim](https://github.com/makasim))
+
+- \[Extensions\] extensions priority [\#79](https://github.com/php-enqueue/enqueue-dev/issues/79)
+
+- \[fs\] Filesystem transport must create a storage dir if it does not exists. [\#78](https://github.com/php-enqueue/enqueue-dev/pull/78) ([makasim](https://github.com/makasim))
+- \[magento\] Add basic docs for enqueue magento extension. [\#76](https://github.com/php-enqueue/enqueue-dev/pull/76) ([makasim](https://github.com/makasim))
+
 ## [0.3.8](https://github.com/php-enqueue/enqueue-dev/tree/0.3.8) (2017-05-10)
 [Full Changelog](https://github.com/php-enqueue/enqueue-dev/compare/0.3.7...0.3.8)
 

README.md

@@ -18,12 +18,14 @@ Features:
     - [Filesystem](docs/transport/filesystem.md)
     - [Null](docs/transport/null.md).
 * Generic purpose abstraction level (the transport level).
-* "Opinionated" easy to use abstraction level (the client level).
+* Easy to use abstraction level (the client level).
+* [Symfony bundle](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/bundle/quick_tour.md)
+* [Magento1 extension](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/magento/quick_tour.md)
 * [Message bus](http://www.enterpriseintegrationpatterns.com/patterns/messaging/MessageBus.html) support.
 * [RPC over MQ](https://www.rabbitmq.com/tutorials/tutorial-one-php.html) support.
 * Temporary queues support.
-* Well designed components (decoupled, reusable,).
-* Tested with unit and functional tests.
+* Well designed components decoupled and reusable.
+* Carefully tested including unit and functional tests.
 * For more visit [quick tour](docs/quick_tour.md).
 
 ## Resources
@@ -42,4 +44,4 @@ If you have any questions and inquires about our open source development, this p
 
 ## License
 
-It is released under the [MIT License](LICENSE).
+It is released under the [MIT License](LICENSE).

composer.json

@@ -27,6 +27,9 @@
     "friendsofphp/php-cs-fixer": "^2",
     "empi89/php-amqp-stubs": "*@dev"
   },
+  "autoload": {
+    "files": ["pkg/enqueue/functions_include.php"]
+  },
   "config": {
     "bin-dir": "bin"
   },

docker-compose.yml

@@ -10,6 +10,7 @@ services:
     volumes:
       - './:/mqdev'
     environment:
+      - AMQP_DSN=amqp://guest:guest@rabbitmq:5672/mqdev
       - SYMFONY__RABBITMQ__HOST=rabbitmq
       - SYMFONY__RABBITMQ__USER=guest
       - SYMFONY__RABBITMQ__PASSWORD=guest

docs/bundle/config_reference.md

@@ -43,11 +43,11 @@ enqueue:
             # Port on the host.
             port:                 5672
 
-            # The login name to use. Note: Max 128 characters.
-            login:                guest
+            # The user name to use. Note: Max 128 characters.
+            user:                 guest
 
             # Password. Note: Max 128 characters.
-            password:             guest
+            pass:                 guest
 
             # The virtual host on the host. Note: Max 128 characters.
             vhost:                /
@@ -70,11 +70,11 @@ enqueue:
             # Port on the host.
             port:                 5672
 
-            # The login name to use. Note: Max 128 characters.
-            login:                guest
+            # The user name to use. Note: Max 128 characters.
+            user:                 guest
 
             # Password. Note: Max 128 characters.
-            password:             guest
+            pass:                 guest
 
             # The virtual host on the host. Note: Max 128 characters.
             vhost:                /
@@ -95,7 +95,7 @@ enqueue:
         fs:
 
             # The store directory where all queue\topics files will be created and messages are stored
-            store_dir:            ~ # Required
+            path:            ~ # Required
 
             # The option tells how many messages should be read from file at once. The feature save resources but could lead to bigger messages lose.
             pre_fetch_count:      1

docs/bundle/quick_tour.md

@@ -1,6 +1,6 @@
 # EnqueueBundle. Quick tour.
 
-The bundle integrates enqueue library.
+The [EnqueueBundle](https://github.com/php-enqueue/enqueue-bundle) integrates enqueue library.
 It adds easy to use [configuration layer](config_reference.md), register services, adds handy [cli commands](cli_commands.md).
 
 ## Install
@@ -45,13 +45,7 @@ First, you have to configure a transport layer and set one to be default.
 
 enqueue:
     transport:
-        default: 'amqp'
-        amqp:
-            host: 'localhost'
-            port: 5672
-            login: 'guest'
-            password: 'guest'
-            vhost: '/'
+        default: "amqp://"
     client: ~
 ```
 

docs/client/quick_tour.md

@@ -22,21 +22,7 @@ use Enqueue\SimpleClient\SimpleClient;
 
 include __DIR__.'/vendor/autoload.php';
 
-$client = new SimpleClient([
-    'transport' => [
-        'default' => 'amqp',
-        'amqp' => [
-            'host'  => 'localhost',
-            'port'  => 5672,
-            'vhost' => '/',
-            'login' => 'guest',
-            'password' => 'guest',
-        ],
-    ],
-    'client' => [
-        'app_name' => 'plain_php',
-    ],
-]);
+$client = new SimpleClient('amqp://');
 ```
 
 ## Produce message

docs/client/rpc_call.md

@@ -1,18 +1,23 @@
 # Client. RPC call
 
 The client's [quick tour](quick_tour.md) describes how to get the client object. 
-We use you followed instructions there and have instance of `Enqueue\SimpleClient\SimpleClient` in `$client` var. 
+Here we'll use `Enqueue\SimpleClient\SimpleClient` though it is not required.
+You can get all that stuff from manually built client or get objects from a container (Symfony).
+
+The simple client could be created like this:
 
 ## The client side
 
 There is a handy class RpcClient shipped with the client component. 
-It allows you to easily send a message and wait for a reply.
+It allows you to easily perform [RPC calls](https://en.wikipedia.org/wiki/Remote_procedure_call).
+It send a message and wait for a reply.
 
 ```php
 <?php
 use Enqueue\Client\RpcClient;
+use Enqueue\SimpleClient\SimpleClient;
 
-/** @var \Enqueue\SimpleClient\SimpleClient $client */
+$client = new SimpleClient('amqp://');
 
 $rpcClient = new RpcClient($client->getProducer(), $context);
 
@@ -24,8 +29,9 @@ You can perform several requests asynchronously with `callAsync` and request rep
 ```php
 <?php
 use Enqueue\Client\RpcClient;
+use Enqueue\SimpleClient\SimpleClient;
 
-/** @var \Enqueue\SimpleClient\SimpleClient $client */
+$client = new SimpleClient('amqp://');
 
 $rpcClient = new RpcClient($client->getProducer(), $context);
 
@@ -54,10 +60,11 @@ use Enqueue\Psr\PsrContext;
 use Enqueue\Consumption\Result;
 use Enqueue\Consumption\ChainExtension;
 use Enqueue\Consumption\Extension\ReplyExtension;
+use Enqueue\SimpleClient\SimpleClient;
 
 /** @var \Enqueue\Psr\PsrContext $context */
 
-/** @var \Enqueue\SimpleClient\SimpleClient $client */
+$client = new SimpleClient('amqp://');
 
 $client->bind('greeting_topic', 'greeting_processor', function (PsrMessage $message, PsrContext $context) use (&$requestMessage) {
     echo $message->getBody();

docs/quick_tour.md

@@ -170,19 +170,11 @@ Here's an example of how you can send and consume messages.
 use Enqueue\SimpleClient\SimpleClient;
 use Enqueue\Psr\PsrMessage;
 
-$client = new SimpleClient([
-    'transport' => [
-        'default' => 'amqp',
-        'amqp' => [
-            'host'  => 'localhost',
-            'port'  => 5672,
-            'vhost' => '/',
-            'login' => 'guest',
-            'password' => 'guest',
-        ],
-    ],
-    'client' => true,
-]);
+// composer require enqueue/amqp-ext
+$client = new SimpleClient('amqp://');
+
+// composer require enqueue/fs
+$client = new SimpleClient('file://foo/bar');
 
 $client->setupBroker();
 

docs/transport/amqp.md

@@ -25,15 +25,28 @@ $ composer require enqueue/amqp-ext
 <?php
 use Enqueue\AmqpExt\AmqpConnectionFactory;
 
+// connects to localhost
+$connectionFactory = new AmqpConnectionFactory();
+
+// same as above
+$connectionFactory = new AmqpConnectionFactory('amqp://');
+
+// same as above
+$connectionFactory = new AmqpConnectionFactory([]);
+
+// connect to AMQP broker at example.com
 $connectionFactory = new AmqpConnectionFactory([
-    'host' => '127.0.0.1',
-    'port' => 5672,
+    'host' => 'example.com',
+    'port' => 1000,
     'vhost' => '/',
-    'login' => 'guest',
-    'password' => 'guest',
+    'user' => 'user',
+    'pass' => 'pass',
     'persisted' => false,
 ]);
 
+// same as above but given as DSN string
+$connectionFactory = new AmqpConnectionFactory('amqp://user:[email protected]:10000/%2f');
+
 $psrContext = $connectionFactory->createContext();
 ```