improved docs & readme

Author: tiamo

README.md

@@ -24,24 +24,29 @@ composer require tiamo/phpas2
 ## Usage
 
 * [Documentation](./docs/index.md)
-* [Examples](./examples)
+* [Example](./example)
 
 Basic example
+
 ```bash
+cd example
+composer install
+chmod +x ./bin/console
+
 # start a server to receive messages in 8000 port
-php -S 127.0.0.1:8000 ./examples/server.php
-```
+php -S 127.0.0.1:8000 ./public/index.php
 
-```bash
-# init partners and storage
-php -f ./examples/init.php
-```
+# send a test message
+./bin/console send-message --from mycompanyAS2 --to phpas2
 
-```bash
-# send message
-php -f ./examples/outbound.php
+# send a file
+./bin/console send-message /path/to/the/file --from mycompanyAS2 --to phpas2
 ```
 
+## Changelog
+
+Please have a look in [CHANGELOG](CHANGELOG.md)
+
 ## License
 
 Licensed under the [MIT license](http://opensource.org/licenses/MIT).

docs/index.md

@@ -1,67 +1,62 @@
 # DOCUMENTATION
 
-TODO ...
+Please have a look at an example application based on Slim3 framework. 
+You can also create your own classes.
 
-- Implement Storage class based on \AS2\StorageInterface
+- Implement MessageRepository class based on \AS2\MessageRepositoryInterface
 - Implement Message class based on \AS2\MessageInterface
+- Implement PartnerRepository class based on \AS2\PartnerRepositoryInterface
 - Implement Partner class based on \AS2\PartnerInterface
 
 ### Example Receive AS2 Message
 ```php
-$server = new \AS2\Server(new \AS2\Management(), new FileStorage());
+$manager = new \AS2\Management();
+
+/** @var /AS2/MessageRepositoryInterface $messageRepository */
+$messageRepository = new MessageRepository();
+
+/** @var /AS2/PartnerRepositoryInterface $partnerRepository */
+$partnerRepository = new PartnerRepository();
+
+$server = new \AS2\Server($manager, $partnerRepository, $messageRepository);
+
 /** @var \GuzzleHttp\Psr7\Response $response */
 $response = $server->excecute();
-
 ```
 
 ### Example Send AS2 Message
 ```php
 
 $manager = new \AS2\Management();
-/** @var /AS2/StorageInterface $storage */
-$storage = new FileStorage();
 
-// Init new Message
-$message = $storage->initMessage(['id' => 'test' ...]);
-
-// Init sending Partner
-$sender = $storage->initPartner([
-    'id' => 'partner_a',
-    'target_url' => 'http://127.0.0.1/as2/receive',
-    'public_key' => file_get_contents('public_a.crt'),
-    'private_key' => file_get_contents('private_a.key'),
-    'private_key_pass_phrase' => 'password',
-    'content_type' => 'application/edi-x12',
-    'compression' => true,
-    'sign' => true,
-    'encrypt' => true,
-    'mdn_mode' => PartnerInterface::MDN_MODE_SYNC,
-    'mdn_options' => 'signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, SHA256'
-]);
+/** @var /AS2/MessageRepositoryInterface $messageRepository */
+$messageRepository = new MessageRepository();
 
-$message->setSender($sender);
+/** @var /AS2/PartnerRepositoryInterface $partnerRepository */
+$partnerRepository = new PartnerRepository();
 
-// Init receiving Partner
-$receiver = $storage->initPartner([
-    'id' => 'partner_b',
-    'target_url' => 'http://127.0.0.1/as2/receive',
-    'public_key' => file_get_contents('public_b.crt'),
-    'private_key' => file_get_contents('private_b.key'),
-    'private_key_pass_phrase' => 'password',
-    'content_type' => 'application/edi-x12',
-    'compression' => true,
-    'sign' => true,
-    'encrypt' => true,
-    'mdn_mode' => PartnerInterface::MDN_MODE_SYNC,
-    'mdn_options' => 'signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, SHA256'
-]);
+// Init partners
+$sender = $partnerRepository->findPartnerById('A');
+$receiver = $partnerRepository->findPartnerById('B');
 
-$message->setReceiver($receiver);
+// Generate new message ID
+$messageId = \AS2\Utils::generateMessageID($sender);
+$rawMessage = '
+Content-type: Application/EDI-X12
+Content-disposition: attachment; filename=payload
+Content-id: <test@test.com>
+
+ISA*00~';
 
-$manager->buildMessage($message);
+// Init new Message
+$message = $messageRepository->createMessage();
+$message->setMessageId($messageId);
+$message->setSender($sender);
+$message->setReceiver($receiver);
 
-$manager->sendMessage($message);
+$payload = $manager->buildMessage($message, $rawMessage);
+$manager->sendMessage($message, $payload);
 
-$storage->saveMessage($message);
+$messageRepository->saveMessage($message);
 
 ```