Skip to content

Commit

Permalink
Merge branch '1.x' into 2.x
Browse files Browse the repository at this point in the history
  • Loading branch information
crynobone committed Apr 11, 2020
2 parents 430dcd5 + 0c15b91 commit 19a6475
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG-1.x.md
Expand Up @@ -2,14 +2,18 @@

This changelog references the relevant changes (bug and security fixes) done to `katsana/minions`.

## 1.7.0 DRAFT
## 1.7.0

Released: 2020-04-11

### Added

* Added `Minions\Client\Minion::queue()` method.
* Added `Minions\Testing\TestResponse::output()` method.

### Changes

* Explicitly require `clue/buzz-react`, `nyholm/psr7` and `symfony/psr-http-message-bridge` to streamline out of the box feature.
* Update minimum `laravie/stream` to `v1.3`+.
* Allow project `token` and `signature` to be set to `null` for app to app communication under private intranet.
* Add `Minions\Exceptions\RequestException::report()` method to send custom error log to Laravel logger.
Expand Down
10 changes: 3 additions & 7 deletions README.md
Expand Up @@ -12,8 +12,6 @@ JSON-RPC Communication for Laravel
* [Setup](#setup)
- [Setting Project ID](#setting-project-id)
- [Configure Projects](#configure-projects)
- [Setup for Server](#setup-for-server)
- [Setup for Client](#setup-for-client)
* [Request Handler](#request-handler)
- [Registering the route](#registering-the-route)
- [Checking authorization](#checking-authorization)
Expand Down Expand Up @@ -86,13 +84,11 @@ return [
* `endpoint` is only required for configurating server project connection from a client project. A server will never send request to a client project.
* Each project should have a pair of unique `token` and `secret`, this will be shared only by the client and server as a form of message verification.

### Setup for Client
#### Security

To use Minions as a client, you need to install the following via Composer:
`token` is used as an `Authorization` bearer token header for the request and `signature` is used to sign the message sent via the request.

```
composer require "clue/buzz-react=^2.5"
```
> For projects running on private intranet you may skip setting up `token` and `signature` by setting the value to `null`.
## Request Handler

Expand Down
2 changes: 2 additions & 0 deletions composer.json
Expand Up @@ -35,6 +35,8 @@
"laravie/stream": "^1.3",
"nyholm/psr7": "^1.2",
"orchestra/canvas-core": "^4.7 || ^5.0",
"react/event-loop": "^1.1",
"react/promise": "^2.5",
"symfony/psr-http-message-bridge": "^1.3 || ^2.0"
},
"require-dev": {
Expand Down
1 change: 1 addition & 0 deletions src/Minion.php
Expand Up @@ -11,6 +11,7 @@
* @method \Minions\Client\Minion setEventLoop(\React\EventLoop\LoopInterface $eventLoop)
* @method void run()
* @method array|mixed await(array|\React\Promise\PromiseInterface $promises)
* @method \Clue\React\Mq\Queue queue(string $project, int $concurrency, ?int $limit)
*
* @see \Minions\Client\Minion
*/
Expand Down

0 comments on commit 19a6475

Please sign in to comment.