Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
da763a5a2f
|
|||
| af9406be47 | |||
|
1345b7eddb
|
|||
| 3734327357 | |||
|
af9c360684
|
|||
|
44f437eaf3
|
|||
|
1ebdffe2a6
|
|||
| d854732143 | |||
|
9b021296eb
|
|||
|
d581afa793
|
|||
| 95ca655eb0 | |||
|
25887a47d3
|
|||
|
1f7816c917
|
|||
|
fb7b4baa32
|
|||
|
2c4eedbf8b
|
|||
| c790adf611 | |||
|
c6094566b4
|
|||
| 0ac5e64c17 | |||
|
40cc852328
|
|||
|
c4961b1238
|
|||
|
c630af8795
|
|||
|
9947987c20
|
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
/.idea
|
||||
/.vscode
|
||||
/vendor
|
||||
.phpunit.result.cache
|
||||
.phpunit.cache
|
||||
|
||||
73
README.md
73
README.md
@@ -15,6 +15,8 @@ These formats are supported for now: `http`, `curl`, `wget`.
|
||||
## Supported features
|
||||
|
||||
* [collection schema **v2.1**](https://schema.postman.com/json/collection/v2.1.0/collection.json);
|
||||
* `Bearer` auth;
|
||||
* replace vars in requests by stored in collection and environment file;
|
||||
* export one or several collections (or even whole directories) into one or all of formats supported at the same time;
|
||||
* all headers (including disabled for `http`-format);
|
||||
* `json` body (forces header `Content-Type` to `application/json`);
|
||||
@@ -22,17 +24,15 @@ These formats are supported for now: `http`, `curl`, `wget`.
|
||||
|
||||
## Planned features
|
||||
|
||||
- support as many as possible/necessary of authentication kinds (_currently no ones_);
|
||||
- support as many as possible/necessary of authentication kinds (_currently only `Bearer` supported_);
|
||||
- support as many as possible/necessary of body formats (_currently only `json` and `formdata`_);
|
||||
- documentation generation support (markdown) with responce examples (if present);
|
||||
- maybe some another convert formats (like httpie or something...);
|
||||
- replace `{{vars}}` from folder;
|
||||
- replace `{{vars}}` from environment;
|
||||
- better logging;
|
||||
- tests, phpcs, psalm, etc.;
|
||||
- web version.
|
||||
|
||||
## Installation
|
||||
## Install and upgrade
|
||||
|
||||
```
|
||||
composer global r axenov/pm-convert
|
||||
@@ -52,45 +52,62 @@ export PATH="$PATH:~/.config/composer/vendor/bin"
|
||||
$ pm-convert --help
|
||||
Postman collection converter
|
||||
Usage:
|
||||
./pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
php pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
composer pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
./vendor/bin/pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
./pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
php pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
composer pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
./vendor/bin/pm-convert -f|-d PATH -o OUTPUT_PATH [ARGUMENTS] [FORMATS]
|
||||
|
||||
Possible ARGUMENTS:
|
||||
-f, --file - a PATH to single collection located in PATH to convert from
|
||||
-d, --dir - a directory with collections located in COLLECTION_FILEPATH to convert from
|
||||
-o, --output - a directory OUTPUT_PATH to put results in
|
||||
-p, --preserve - do not delete OUTPUT_PATH (if exists)
|
||||
-h, --help - show this help message and exit
|
||||
-v, --version - show version info and exit
|
||||
-f, --file - a PATH to single collection located in PATH to convert from
|
||||
-d, --dir - a directory with collections located in COLLECTION_FILEPATH to convert from
|
||||
-o, --output - a directory OUTPUT_PATH to put results in
|
||||
-e, --env - use environment file with variable values to replace in request
|
||||
-p, --preserve - do not delete OUTPUT_PATH (if exists)
|
||||
-h, --help - show this help message and exit
|
||||
-v, --version - show version info and exit
|
||||
|
||||
If both -c and -d are specified then only unique set of files will be converted.
|
||||
If no ARGUMENTS passed then --help implied.
|
||||
If both -f and -d are specified then only unique set of files will be converted.
|
||||
-f or -d are required to be specified at least once, but each may be specified multiple times.
|
||||
PATH must be a valid path to readable json-file or directory.
|
||||
OUTPUT_PATH must be a valid path to writeable directory.
|
||||
If -o is specified several times then only last one will be applied.
|
||||
If -o is specified several times then only last one will be used.
|
||||
If -e is specified several times then only last one will be used.
|
||||
If -e is not specified then only collection vars will be replaced (if any).
|
||||
|
||||
Possible FORMATS:
|
||||
--http - generate raw *.http files (default)
|
||||
--curl - generate shell scripts with curl command
|
||||
--wget - generate shell scripts with wget command
|
||||
--http - generate raw *.http files (default)
|
||||
--curl - generate shell scripts with curl command
|
||||
--wget - generate shell scripts with wget command
|
||||
If no FORMATS specified then --http implied.
|
||||
Any of FORMATS can be specified at the same time.
|
||||
|
||||
Example:
|
||||
./pm-convert \
|
||||
-f ~/dir1/first.postman_collection.json \
|
||||
--directory ~/team \
|
||||
--file ~/dir2/second.postman_collection.json \
|
||||
-d ~/personal \
|
||||
./pm-convert \
|
||||
-f ~/dir1/first.postman_collection.json \
|
||||
--directory ~/team \
|
||||
--file ~/dir2/second.postman_collection.json \
|
||||
--env ~/localhost.postman_environment.json \
|
||||
-d ~/personal \
|
||||
-o ~/postman_export
|
||||
```
|
||||
### Notice
|
||||
|
||||
Make sure every (I mean _every_) collection (not collection file), its folders and/or requests has unique names.
|
||||
If not, you can rename them in Postman or convert collections with similar names into different directories.
|
||||
Otherwise converted files may be overwritten by each other.
|
||||
### Notices
|
||||
|
||||
1. Result of `pm-convert` execution is bunch of generated files.
|
||||
Most likely they will contain errors such as not interpolated `{{variables}}` values (due to missed ones in collection),
|
||||
wrong command format or `GET`s with bodies.
|
||||
You must review any generated file before using.
|
||||
2. Make sure every (I mean _every_) collection (not collection file), its folders and/or requests has unique names.
|
||||
If not, you can rename them in Postman or convert collections with similar names into different directories.
|
||||
Otherwise any generated file may be accidently overwritten by another one.
|
||||
|
||||
## How to implement a new format
|
||||
|
||||
1. Create new namespace in `./src/Converters` and name it according to format of your choice
|
||||
2. Create two classes for converter and request object which extends `Converters\Abstract\Abstract{Converter, Request}` respectively
|
||||
3. Change constants values in your new request class according to format you want to implement
|
||||
4. Write your own logic in converter's `__toString()` method, write new methods and override abstract ones
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "axenov/pm-convert",
|
||||
"type": "library",
|
||||
"description": "Postman collection coverter",
|
||||
"description": "Postman collection converter",
|
||||
"license": "MIT",
|
||||
"homepage": "https://axenov.dev/",
|
||||
"authors": [
|
||||
@@ -15,9 +15,7 @@
|
||||
"php": "^8.1",
|
||||
"ext-json": "*"
|
||||
},
|
||||
"bin": [
|
||||
"pm-convert"
|
||||
],
|
||||
"bin": ["pm-convert"],
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"PmConverter\\": "src\\"
|
||||
@@ -30,5 +28,8 @@
|
||||
"optimize-autoloader": true,
|
||||
"preferred-install": "dist",
|
||||
"sort-packages": true
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^10.3"
|
||||
}
|
||||
}
|
||||
|
||||
1614
composer.lock
generated
1614
composer.lock
generated
File diff suppressed because it is too large
Load Diff
26
phpunit.xml
Normal file
26
phpunit.xml
Normal file
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
|
||||
bootstrap="vendor/autoload.php"
|
||||
cacheDirectory=".phpunit.cache"
|
||||
executionOrder="depends,defects"
|
||||
requireCoverageMetadata="true"
|
||||
beStrictAboutCoverageMetadata="true"
|
||||
beStrictAboutOutputDuringTests="true"
|
||||
failOnRisky="true"
|
||||
failOnWarning="true">
|
||||
<testsuites>
|
||||
<testsuite name="Main">
|
||||
<!-- <directory>tests</directory>-->
|
||||
<file>tests/AbstractRequestTest.php</file>
|
||||
<file>tests/HttpRequestTest.php</file>
|
||||
<file>tests/WgetRequestTest.php</file>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
<source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
|
||||
<include>
|
||||
<directory>src</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env php
|
||||
<?php
|
||||
|
||||
declare(strict_types = 1);
|
||||
declare(strict_types=1);
|
||||
|
||||
use PmConverter\Processor;
|
||||
|
||||
@@ -20,8 +20,13 @@ foreach ($paths as $path) {
|
||||
|
||||
is_null($file) && throw new RuntimeException('Unable to locate autoload.php file.');
|
||||
|
||||
$processor = new Processor($argv);
|
||||
try {
|
||||
(new Processor($argv))->convert();
|
||||
$processor->convert();
|
||||
} catch (InvalidArgumentException $e) {
|
||||
fwrite(STDERR, sprintf('ERROR: %s%s', $e->getMessage(), PHP_EOL));
|
||||
print(implode(PHP_EOL, $processor->usage()));
|
||||
die(1);
|
||||
} catch (Exception $e) {
|
||||
fwrite(STDERR, sprintf('ERROR: %s%s', $e->getMessage(), PHP_EOL));
|
||||
die(1);
|
||||
|
||||
@@ -2,17 +2,20 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Abstract;
|
||||
namespace PmConverter\Converters\Abstract;
|
||||
|
||||
use Exception;
|
||||
use PmConverter\Exporters\{
|
||||
use PmConverter\Converters\{
|
||||
ConverterContract,
|
||||
RequestContract};
|
||||
use PmConverter\Environment;
|
||||
use PmConverter\Exceptions\InvalidHttpVersionException;
|
||||
use PmConverter\FileSystem;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
abstract class AbstractConverter
|
||||
abstract class AbstractConverter implements ConverterContract
|
||||
{
|
||||
/**
|
||||
* @var object|null
|
||||
@@ -25,6 +28,30 @@ abstract class AbstractConverter
|
||||
protected string $outputPath;
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
protected array $vars = [];
|
||||
|
||||
/**
|
||||
* @var Environment|null
|
||||
*/
|
||||
protected ?Environment $env = null;
|
||||
|
||||
/**
|
||||
* Sets an environment with vars
|
||||
*
|
||||
* @param Environment $env
|
||||
* @return $this
|
||||
*/
|
||||
public function withEnv(Environment $env): static
|
||||
{
|
||||
$this->env = $env;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts collection requests
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
public function convert(object $collection, string $outputPath): void
|
||||
@@ -32,12 +59,30 @@ abstract class AbstractConverter
|
||||
$outputPath = sprintf('%s%s%s', $outputPath, DIRECTORY_SEPARATOR, static::OUTPUT_DIR);
|
||||
$this->outputPath = FileSystem::makeDir($outputPath);
|
||||
$this->collection = $collection;
|
||||
$this->setVariables();
|
||||
foreach ($collection->item as $item) {
|
||||
$this->convertItem($item);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares collection variables
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
protected function setVariables(): static
|
||||
{
|
||||
if (isset($this->collection?->variable)) {
|
||||
foreach ($this->collection->variable as $var) {
|
||||
$this->vars["{{{$var->key}}}"] = $var->value;
|
||||
}
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns output path
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getOutputPath(): string
|
||||
@@ -46,6 +91,8 @@ abstract class AbstractConverter
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether item contains another items or not
|
||||
*
|
||||
* @param object $item
|
||||
* @return bool
|
||||
*/
|
||||
@@ -55,6 +102,8 @@ abstract class AbstractConverter
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts an item to request object and writes it into file
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
protected function convertItem(mixed $item): void
|
||||
@@ -77,18 +126,25 @@ abstract class AbstractConverter
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialiazes request object to be written in file
|
||||
*
|
||||
* @param object $item
|
||||
* @return RequestContract
|
||||
* @throws InvalidHttpVersionException
|
||||
*/
|
||||
protected function initRequest(object $item): RequestContract
|
||||
{
|
||||
$request_class = static::REQUEST;
|
||||
$request_class = static::REQUEST_CLASS;
|
||||
|
||||
/** @var RequestContract $result */
|
||||
$result = new $request_class();
|
||||
$result->setName($item->name);
|
||||
$result->setHttpVersion(1.1); //TODO http version?
|
||||
$result->setDescription($item->request?->description ?? null);
|
||||
$result->setVerb($item->request->method);
|
||||
$result->setUrl($item->request->url->raw);
|
||||
$result->setHeaders($item->request->header);
|
||||
$result->setAuth($item->request?->auth ?? $this->collection?->auth ?? null);
|
||||
if ($item->request->method !== 'GET' && !empty($item->request->body)) {
|
||||
$result->setBody($item->request->body);
|
||||
}
|
||||
@@ -96,6 +152,8 @@ abstract class AbstractConverter
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes converted request object to file
|
||||
*
|
||||
* @param RequestContract $request
|
||||
* @param string|null $subpath
|
||||
* @return bool
|
||||
@@ -106,6 +164,33 @@ abstract class AbstractConverter
|
||||
$filedir = sprintf('%s%s%s', $this->outputPath, DIRECTORY_SEPARATOR, $subpath);
|
||||
$filedir = FileSystem::makeDir($filedir);
|
||||
$filepath = sprintf('%s%s%s.%s', $filedir, DIRECTORY_SEPARATOR, $request->getName(), static::FILE_EXT);
|
||||
return file_put_contents($filepath, (string)$request) > 0;
|
||||
$content = $this->interpolate((string)$request);
|
||||
return file_put_contents($filepath, $content) > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces variables in request with values from collection or environment
|
||||
*
|
||||
* @param string $content
|
||||
* @return string
|
||||
*/
|
||||
protected function interpolate(string $content): string
|
||||
{
|
||||
if (empty($this->vars) && !$this->env?->hasVars()) {
|
||||
return $content;
|
||||
}
|
||||
$matches = [];
|
||||
if (preg_match_all('/\{\{[a-zA-Z][a-zA-Z0-9]*}}/m', $content, $matches, PREG_PATTERN_ORDER) > 0) {
|
||||
foreach ($matches[0] as $key => $var) {
|
||||
if (str_contains($content, $var)) {
|
||||
$content = str_replace($var, $this->vars[$var] ?? $this->env[$var] ?? $var, $content);
|
||||
unset($matches[0][$key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
// if (!empty($matches[0])) {
|
||||
// fwrite(STDERR, sprintf(' No values found: %s%s', implode(', ', $matches[0]), PHP_EOL));
|
||||
// }
|
||||
return $content;
|
||||
}
|
||||
}
|
||||
295
src/Converters/Abstract/AbstractRequest.php
Normal file
295
src/Converters/Abstract/AbstractRequest.php
Normal file
@@ -0,0 +1,295 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Converters\Abstract;
|
||||
|
||||
use PmConverter\Converters\RequestContract;
|
||||
use PmConverter\Exceptions\{
|
||||
EmptyHttpVerbException,
|
||||
InvalidHttpVersionException};
|
||||
use PmConverter\HttpVersions;
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* Class to determine file content with any request format
|
||||
*/
|
||||
abstract class AbstractRequest implements Stringable, RequestContract
|
||||
{
|
||||
/**
|
||||
* @var string HTTP verb (GET, POST, etc.)
|
||||
*/
|
||||
protected string $verb;
|
||||
|
||||
/**
|
||||
* @var string URL where to send a request
|
||||
*/
|
||||
protected string $url;
|
||||
|
||||
/**
|
||||
* @var float HTTP protocol version
|
||||
*/
|
||||
protected float $httpVersion = 1.1;
|
||||
|
||||
/**
|
||||
* @var string Request name
|
||||
*/
|
||||
protected string $name;
|
||||
|
||||
/**
|
||||
* @var string|null Request description
|
||||
*/
|
||||
protected ?string $description = null;
|
||||
|
||||
/**
|
||||
* @var array Request headers
|
||||
*/
|
||||
protected array $headers = [];
|
||||
|
||||
/**
|
||||
* @var mixed Request body
|
||||
*/
|
||||
protected mixed $body = null;
|
||||
|
||||
/**
|
||||
* @var string Request body type
|
||||
*/
|
||||
protected string $bodymode = 'raw';
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setHttpVersion(float $version): static
|
||||
{
|
||||
if (!in_array($version, HttpVersions::values())) {
|
||||
throw new InvalidHttpVersionException(
|
||||
'Only these HTTP versions are supported: ' . implode(', ', HttpVersions::values())
|
||||
);
|
||||
}
|
||||
$this->httpVersion = $version;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getHttpVersion(): float
|
||||
{
|
||||
return $this->httpVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setName(string $name): static
|
||||
{
|
||||
$this->name = $name;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getName(): string
|
||||
{
|
||||
return str_replace(DIRECTORY_SEPARATOR, '_', $this->name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setDescription(?string $description): static
|
||||
{
|
||||
$this->description = $description;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getDescription(): ?string
|
||||
{
|
||||
return $this->description;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setVerb(string $verb): static
|
||||
{
|
||||
$this->verb = $verb;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getVerb(): string
|
||||
{
|
||||
empty($this->verb) && throw new EmptyHttpVerbException('Request HTTP verb must be defined before conversion');
|
||||
return $this->verb;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setUrl(string $url): static
|
||||
{
|
||||
$this->url = $url;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getUrl(): string
|
||||
{
|
||||
return $this->url ?: '<empty url>';
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setHeaders(?array $headers): static
|
||||
{
|
||||
foreach ($headers as $header) {
|
||||
$this->setHeader($header->key, $header->value, $header?->disabled ?? false);
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setHeader(string $name, mixed $value, bool $disabled = false): static
|
||||
{
|
||||
$this->headers[$name] = [
|
||||
'value' => $value,
|
||||
'disabled' => $disabled,
|
||||
];
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getHeaders(): array
|
||||
{
|
||||
return $this->headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setAuth(?object $auth): static
|
||||
{
|
||||
if (!empty($auth)) {
|
||||
switch ($auth->type) {
|
||||
case 'bearer':
|
||||
$this->setHeader('Authorization', 'Bearer ' . $auth->{$auth->type}[0]->value);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setBodymode(string $bodymode): static
|
||||
{
|
||||
$this->bodymode = $bodymode;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getBodymode(): string
|
||||
{
|
||||
return $this->bodymode;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function setBody(object $body): static
|
||||
{
|
||||
$this->setBodymode($body->mode);
|
||||
if ($body->mode === 'formdata') {
|
||||
$this->setHeader('Content-Type', 'multipart/form-data')
|
||||
->setFormdataBody($body);
|
||||
} elseif (!empty($body->options) && $body->options->{$this->bodymode}->language === 'json') {
|
||||
$this->setHeader('Content-Type', 'application/json')
|
||||
->setJsonBody($body);
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets body content from multipart/formdata
|
||||
*
|
||||
* @param object $body
|
||||
* @return $this
|
||||
*/
|
||||
protected function setFormdataBody(object $body): static
|
||||
{
|
||||
foreach ($body->formdata as $field) {
|
||||
$this->body[$field->key] = [
|
||||
'value' => $field->type === 'file' ? $field->src : $field->value,
|
||||
'type' => $field->type,
|
||||
];
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets body content from application/json
|
||||
*
|
||||
* @param object $body
|
||||
* @return $this
|
||||
*/
|
||||
protected function setJsonBody(object $body): static
|
||||
{
|
||||
$this->body = $body->{$this->getBodymode()};
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getBody(): mixed
|
||||
{
|
||||
return $this->body;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns array of description lines
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
abstract protected function prepareDescription(): array;
|
||||
|
||||
/**
|
||||
* Returns array of headers
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
abstract protected function prepareHeaders(): array;
|
||||
|
||||
/**
|
||||
* Returns array of request body lines
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
abstract protected function prepareBody(): array;
|
||||
|
||||
/**
|
||||
* Converts request object to string to be written in result file
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
abstract public function __toString(): string;
|
||||
}
|
||||
@@ -2,12 +2,13 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters;
|
||||
namespace PmConverter\Converters;
|
||||
|
||||
|
||||
use PmConverter\Exporters\Curl\CurlConverter;
|
||||
use PmConverter\Exporters\Http\HttpConverter;
|
||||
use PmConverter\Exporters\Wget\WgetConverter;
|
||||
use PmConverter\Converters\{
|
||||
Curl\CurlConverter,
|
||||
Http\HttpConverter,
|
||||
Wget\WgetConverter};
|
||||
|
||||
enum ConvertFormat: string
|
||||
{
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters;
|
||||
namespace PmConverter\Converters;
|
||||
|
||||
interface ConverterContract
|
||||
{
|
||||
@@ -2,16 +2,17 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Curl;
|
||||
namespace PmConverter\Converters\Curl;
|
||||
|
||||
use PmConverter\Exporters\{
|
||||
use PmConverter\Converters\{
|
||||
Abstract\AbstractConverter,
|
||||
ConverterContract};
|
||||
|
||||
class CurlConverter extends AbstractConverter implements ConverterContract
|
||||
{
|
||||
protected const FILE_EXT = 'sh';
|
||||
|
||||
protected const OUTPUT_DIR = 'curl';
|
||||
|
||||
protected const REQUEST = CurlRequest::class;
|
||||
protected const REQUEST_CLASS = CurlRequest::class;
|
||||
}
|
||||
83
src/Converters/Curl/CurlRequest.php
Normal file
83
src/Converters/Curl/CurlRequest.php
Normal file
@@ -0,0 +1,83 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Converters\Curl;
|
||||
|
||||
use PmConverter\Converters\Abstract\AbstractRequest;
|
||||
|
||||
/**
|
||||
* Class to determine file content with curl request format
|
||||
*/
|
||||
class CurlRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareDescription(): array
|
||||
{
|
||||
return empty($this->description)
|
||||
? []
|
||||
: ['# ' . str_replace("\n", "\n# ", $this->description), ''];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareHeaders(): array
|
||||
{
|
||||
$output = [];
|
||||
foreach ($this->headers as $header_key => $header) {
|
||||
if ($header['disabled']) {
|
||||
continue;
|
||||
}
|
||||
$output[] = sprintf("\t--header '%s: %s' \ ", $header_key, $header['value']);
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareBody(): array
|
||||
{
|
||||
$output = [];
|
||||
switch ($this->bodymode) {
|
||||
case 'formdata':
|
||||
foreach ($this->body as $key => $data) {
|
||||
$output[] = sprintf(
|
||||
"%s\t--form '%s=%s' \ ",
|
||||
isset($data['disabled']) ? '# ' : '',
|
||||
$key,
|
||||
$data['type'] === 'file' ? "@" . $data['value'] : $data['value']
|
||||
);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
$output = ["\t--data '$this->body'"];
|
||||
break;
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
$output = array_merge(
|
||||
['#!/bin/sh'],
|
||||
$this->prepareDescription(),
|
||||
[
|
||||
"curl \ ",
|
||||
"\t--http1.1 \ ", //TODO proto
|
||||
"\t--request $this->verb \ ",
|
||||
"\t--location $this->url \ ",
|
||||
],
|
||||
$this->prepareHeaders(),
|
||||
$this->prepareBody()
|
||||
);
|
||||
$output[] = rtrim(array_pop($output), '\ ');
|
||||
return implode(PHP_EOL, array_merge($output, ['']));
|
||||
}
|
||||
}
|
||||
@@ -2,16 +2,17 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Http;
|
||||
namespace PmConverter\Converters\Http;
|
||||
|
||||
use PmConverter\Exporters\{
|
||||
use PmConverter\Converters\{
|
||||
Abstract\AbstractConverter,
|
||||
ConverterContract};
|
||||
|
||||
class HttpConverter extends AbstractConverter implements ConverterContract
|
||||
{
|
||||
protected const FILE_EXT = 'http';
|
||||
|
||||
protected const OUTPUT_DIR = 'http';
|
||||
|
||||
protected const REQUEST = HttpRequest::class;
|
||||
protected const REQUEST_CLASS = HttpRequest::class;
|
||||
}
|
||||
74
src/Converters/Http/HttpRequest.php
Normal file
74
src/Converters/Http/HttpRequest.php
Normal file
@@ -0,0 +1,74 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Converters\Http;
|
||||
|
||||
use PmConverter\Converters\Abstract\AbstractRequest;
|
||||
use PmConverter\Exceptions\{
|
||||
EmptyHttpVerbException};
|
||||
|
||||
/**
|
||||
* Class to determine file content with http request format
|
||||
*/
|
||||
class HttpRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareDescription(): array
|
||||
{
|
||||
return empty($this->description)
|
||||
? []
|
||||
: ['# ' . str_replace("\n", "\n# ", $this->description), ''];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
protected function prepareHeaders(): array
|
||||
{
|
||||
$output[] = sprintf('%s %s HTTP/%s', $this->getVerb(), $this->getUrl(), $this->getHttpVersion());
|
||||
foreach ($this->headers as $name => $data) {
|
||||
$output[] = sprintf('%s%s: %s', $data['disabled'] ? '# ' : '', $name, $data['value']);
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareBody(): array
|
||||
{
|
||||
switch ($this->getBodymode()) {
|
||||
case 'formdata':
|
||||
$output = [''];
|
||||
foreach ($this->body as $key => $data) {
|
||||
$output[] = sprintf(
|
||||
'%s%s=%s',
|
||||
empty($data['disabled']) ? '' : '# ',
|
||||
$key,
|
||||
$data['type'] === 'file' ? '@' . $data['value'] : $data['value']
|
||||
);
|
||||
}
|
||||
return $output;
|
||||
default:
|
||||
return ['', $this->body];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
$output = array_merge(
|
||||
$this->prepareDescription(),
|
||||
$this->prepareHeaders(),
|
||||
$this->prepareBody()
|
||||
);
|
||||
return implode(PHP_EOL, $output);
|
||||
}
|
||||
}
|
||||
153
src/Converters/RequestContract.php
Normal file
153
src/Converters/RequestContract.php
Normal file
@@ -0,0 +1,153 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Converters;
|
||||
|
||||
use PmConverter\Converters\Http\HttpRequest;
|
||||
use PmConverter\Exceptions\{
|
||||
EmptyHttpVerbException,
|
||||
InvalidHttpVersionException};
|
||||
|
||||
interface RequestContract
|
||||
{
|
||||
/**
|
||||
* Sets HTTP protocol version
|
||||
*
|
||||
* @param float $version
|
||||
* @return $this
|
||||
* @throws InvalidHttpVersionException
|
||||
*/
|
||||
public function setHttpVersion(float $version): static;
|
||||
|
||||
/**
|
||||
* Returns HTTP protocol version
|
||||
*
|
||||
* @return float
|
||||
*/
|
||||
public function getHttpVersion(): float;
|
||||
|
||||
/**
|
||||
* Sets name from collection item to request object
|
||||
*
|
||||
* @param string $name
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setName(string $name): static;
|
||||
|
||||
/**
|
||||
* Returns name of request
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getName(): string;
|
||||
|
||||
/**
|
||||
* Sets description from collection item to request object
|
||||
*
|
||||
* @param string|null $description
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setDescription(?string $description): static;
|
||||
|
||||
/**
|
||||
* Returns description request
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getDescription(): ?string;
|
||||
|
||||
/**
|
||||
* Sets HTTP verb from collection item to request object
|
||||
*
|
||||
* @param string $verb
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setVerb(string $verb): static;
|
||||
|
||||
/**
|
||||
* Returns HTTP verb of request
|
||||
*
|
||||
* @return string
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
public function getVerb(): string;
|
||||
|
||||
/**
|
||||
* Sets URL from collection item to request object
|
||||
*
|
||||
* @param string $url
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setUrl(string $url): static;
|
||||
|
||||
/**
|
||||
* Returns URL of request
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getUrl(): string;
|
||||
|
||||
/**
|
||||
* Sets headers from collection item to request object
|
||||
*
|
||||
* @param object[]|null $headers
|
||||
* @return $this
|
||||
*/
|
||||
public function setHeaders(?array $headers): static;
|
||||
|
||||
/**
|
||||
* Sets one header to request object
|
||||
*
|
||||
* @param string $name Header's name
|
||||
* @param mixed $value Header's value
|
||||
* @param bool $disabled Pass true to skip (or comment out) this header
|
||||
* @return $this
|
||||
*/
|
||||
public function setHeader(string $name, mixed $value, bool $disabled = false): static;
|
||||
|
||||
/**
|
||||
* Returns array of prepared headers
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getHeaders(): array;
|
||||
|
||||
/**
|
||||
* Sets authorization headers
|
||||
*
|
||||
* @param object|null $auth
|
||||
* @return $this
|
||||
*/
|
||||
public function setAuth(object $auth): static;
|
||||
|
||||
/**
|
||||
* Sets body mode from collection item to request object
|
||||
*
|
||||
* @param string $bodymode
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setBodymode(string $bodymode): static;
|
||||
|
||||
/**
|
||||
* Returns body mode of request
|
||||
*
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function getBodymode(): string;
|
||||
|
||||
/**
|
||||
* Sets body from collection item to request object
|
||||
*
|
||||
* @param object $body
|
||||
* @return $this
|
||||
*/
|
||||
public function setBody(object $body): static;
|
||||
|
||||
/**
|
||||
* Returns body content
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function getBody(): mixed;
|
||||
}
|
||||
@@ -2,16 +2,17 @@
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Wget;
|
||||
namespace PmConverter\Converters\Wget;
|
||||
|
||||
use PmConverter\Exporters\{
|
||||
use PmConverter\Converters\{
|
||||
Abstract\AbstractConverter,
|
||||
ConverterContract};
|
||||
|
||||
class WgetConverter extends AbstractConverter implements ConverterContract
|
||||
{
|
||||
protected const FILE_EXT = 'sh';
|
||||
|
||||
protected const OUTPUT_DIR = 'wget';
|
||||
|
||||
protected const REQUEST = WgetRequest::class;
|
||||
protected const REQUEST_CLASS = WgetRequest::class;
|
||||
}
|
||||
94
src/Converters/Wget/WgetRequest.php
Normal file
94
src/Converters/Wget/WgetRequest.php
Normal file
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Converters\Wget;
|
||||
|
||||
use PmConverter\Converters\Abstract\AbstractRequest;
|
||||
use PmConverter\Exceptions\EmptyHttpVerbException;
|
||||
|
||||
/**
|
||||
* Class to determine file content with wget request format
|
||||
*/
|
||||
class WgetRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareDescription(): array
|
||||
{
|
||||
return empty($this->description)
|
||||
? []
|
||||
: ['# ' . str_replace("\n", "\n# ", $this->description), ''];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareHeaders(): array
|
||||
{
|
||||
$output = [];
|
||||
foreach ($this->headers as $header_key => $header) {
|
||||
if ($header['disabled']) {
|
||||
continue;
|
||||
}
|
||||
$output[] = sprintf("\t--header '%s: %s' \ ", $header_key, $header['value']);
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
protected function prepareBody(): array
|
||||
{
|
||||
switch ($this->bodymode) {
|
||||
case 'formdata':
|
||||
$output = [];
|
||||
foreach ($this->body as $key => $data) {
|
||||
if ($data['type'] === 'file') {
|
||||
continue;
|
||||
}
|
||||
$output[$key] = $data['value'];
|
||||
}
|
||||
return $output;
|
||||
default:
|
||||
return [$this->body];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
$output = array_merge(
|
||||
['#!/bin/sh'],
|
||||
$this->prepareDescription(),
|
||||
[
|
||||
'wget \ ',
|
||||
"\t--no-check-certificate \ ",
|
||||
"\t--timeout 0 \ ",
|
||||
"\t--method $this->verb \ ",
|
||||
],
|
||||
$this->prepareHeaders(),
|
||||
);
|
||||
if ($this->getBodymode() === 'formdata') {
|
||||
if ($this->getBody()) {
|
||||
if ($this->getVerb() === 'GET') {
|
||||
$output[] = sprintf("\t%s?%s", $this->getUrl(), http_build_query($this->prepareBody()));
|
||||
} else {
|
||||
$output[] = sprintf("\t--body-data '%s' \ ", http_build_query($this->prepareBody()));
|
||||
$output[] = sprintf("\t%s", $this->getUrl());
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if ($this->getVerb() !== 'GET') {
|
||||
$output[] = sprintf("\t--body-data '%s' \ ", implode("\n", $this->prepareBody()));
|
||||
$output[] = sprintf("\t%s", $this->getUrl());
|
||||
}
|
||||
}
|
||||
return implode(PHP_EOL, array_merge($output, ['']));
|
||||
}
|
||||
}
|
||||
65
src/Environment.php
Normal file
65
src/Environment.php
Normal file
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter;
|
||||
|
||||
class Environment implements \ArrayAccess
|
||||
{
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected array $vars = [];
|
||||
|
||||
/**
|
||||
* @param object $env
|
||||
*/
|
||||
public function __construct(protected object $env)
|
||||
{
|
||||
foreach ($env->values as $var) {
|
||||
$this->vars["{{{$var->key}}}"] = $var->value;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells if there are some vars or not
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function hasVars(): bool
|
||||
{
|
||||
return !empty($this->vars);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetExists(mixed $offset): bool
|
||||
{
|
||||
return array_key_exists($offset, $this->vars);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetGet(mixed $offset): mixed
|
||||
{
|
||||
return $this->vars[$offset];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetSet(mixed $offset, mixed $value): void
|
||||
{
|
||||
$this->vars[$offset] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetUnset(mixed $offset): void
|
||||
{
|
||||
unset($this->vars[$offset]);
|
||||
}
|
||||
}
|
||||
11
src/Exceptions/EmptyHttpVerbException.php
Normal file
11
src/Exceptions/EmptyHttpVerbException.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class EmptyHttpVerbException extends Exception
|
||||
{
|
||||
}
|
||||
11
src/Exceptions/EmptyURLException.php
Normal file
11
src/Exceptions/EmptyURLException.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class EmptyURLException extends Exception
|
||||
{
|
||||
}
|
||||
11
src/Exceptions/InvalidHttpVersionException.php
Normal file
11
src/Exceptions/InvalidHttpVersionException.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class InvalidHttpVersionException extends Exception
|
||||
{
|
||||
}
|
||||
@@ -1,164 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Abstract;
|
||||
|
||||
use PmConverter\Exporters\Http\HttpRequest;
|
||||
use PmConverter\Exporters\RequestContract;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
abstract class AbstractRequest implements RequestContract
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $http = 'HTTP/1.1'; //TODO verb
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $name;
|
||||
|
||||
/**
|
||||
* @var string|null
|
||||
*/
|
||||
protected ?string $description = null;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
protected array $headers = [];
|
||||
|
||||
/**
|
||||
* @var mixed
|
||||
*/
|
||||
protected mixed $body = null;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $bodymode = 'raw';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $verb;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $url;
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setName(string $name): static
|
||||
{
|
||||
$this->name = $name;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getName(): string
|
||||
{
|
||||
return str_replace(DIRECTORY_SEPARATOR, '_', $this->name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|null $description
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setDescription(?string $description): static
|
||||
{
|
||||
$this->description = $description;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $verb
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setVerb(string $verb): static
|
||||
{
|
||||
$this->verb = $verb;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $url
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setUrl(string $url): static
|
||||
{
|
||||
$this->url = $url;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param object[]|null $headers
|
||||
* @return $this
|
||||
*/
|
||||
public function setHeaders(?array $headers): static
|
||||
{
|
||||
foreach ($headers as $header) {
|
||||
$this->headers[$header->key] = [
|
||||
'value' => $header->value,
|
||||
'disabled' => $header?->disabled ?? false,
|
||||
];
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $bodymode
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setBodymode(string $bodymode): static
|
||||
{
|
||||
$this->bodymode = $bodymode;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $body
|
||||
* @return HttpRequest
|
||||
*/
|
||||
public function setBody(object $body): static
|
||||
{
|
||||
$this->setBodymode($body->mode);
|
||||
if (!empty($body->options) && $body->options->{$this->bodymode}->language === 'json') {
|
||||
empty($this->headers['Content-Type']) && $this->setHeaders([
|
||||
(object)[
|
||||
'key' => 'Content-Type',
|
||||
'value' => 'application/json',
|
||||
'disabled' => false,
|
||||
],
|
||||
]);
|
||||
}
|
||||
$body->mode === 'formdata' && $this->setHeaders([
|
||||
(object)[
|
||||
'key' => 'Content-Type',
|
||||
'value' => 'multipart/form-data',
|
||||
'disabled' => false,
|
||||
],
|
||||
]);
|
||||
$this->body = $body->{$body->mode};
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
abstract protected function prepareBody(): ?string;
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
abstract public function __toString(): string;
|
||||
}
|
||||
@@ -1,65 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Curl;
|
||||
|
||||
use PmConverter\Exporters\Abstract\AbstractRequest;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
class CurlRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
protected function prepareBody(): ?string
|
||||
{
|
||||
switch ($this->bodymode) {
|
||||
case 'formdata':
|
||||
$body = [];
|
||||
foreach ($this->body as $data) {
|
||||
$body[] = sprintf(
|
||||
"%s\t--form '%s=%s' \ ",
|
||||
isset($data->disabled) ? '# ' : '',
|
||||
$data->key,
|
||||
$data->type === 'file' ? "@$data->src" : $data->value
|
||||
);
|
||||
}
|
||||
return implode(PHP_EOL, $body);
|
||||
default:
|
||||
return $this->body;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
$output[] = '#!/bin/sh';
|
||||
if ($this->description) {
|
||||
$output[] = '# ' . str_replace("\n", "\n# ", $this->description);
|
||||
$output[] = '';
|
||||
}
|
||||
$output[] = "curl \ ";
|
||||
$output[] = "\t--http1.1 \ "; //TODO verb
|
||||
$output[] = "\t--request $this->verb \ ";
|
||||
$output[] = "\t--location $this->url \ ";
|
||||
foreach ($this->headers as $header_key => $header) {
|
||||
if ($header['disabled']) {
|
||||
continue;
|
||||
}
|
||||
$output[] = sprintf("\t--header '%s=%s' \ ", $header_key, $header['value']);
|
||||
}
|
||||
if (!is_null($body = $this->prepareBody())) {
|
||||
$output[] = match ($this->bodymode) {
|
||||
'formdata' => $body,
|
||||
default => "\t--data '$body'",
|
||||
};
|
||||
}
|
||||
$output[] = rtrim(array_pop($output), '\ ');
|
||||
return implode(PHP_EOL, $output);
|
||||
}
|
||||
}
|
||||
@@ -1,53 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Http;
|
||||
|
||||
use PmConverter\Exporters\Abstract\AbstractRequest;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
class HttpRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
protected function prepareBody(): ?string
|
||||
{
|
||||
switch ($this->bodymode) {
|
||||
case 'formdata':
|
||||
$body = [];
|
||||
foreach ($this->body as $data) {
|
||||
$body[] = sprintf(
|
||||
'%s%s=%s',
|
||||
empty($data->disabled) ? '' : '# ',
|
||||
$data->key,
|
||||
$data->type === 'file' ? "$data->src" : $data->value
|
||||
);
|
||||
}
|
||||
return implode(PHP_EOL, $body);
|
||||
default:
|
||||
return $this->body;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
if ($this->description) {
|
||||
$output[] = '# ' . str_replace("\n", "\n# ", $this->description);
|
||||
$output[] = '';
|
||||
}
|
||||
$output[] = "$this->verb $this->url $this->http";
|
||||
foreach ($this->headers as $header_key => $header) {
|
||||
$output[] = sprintf('%s%s: %s', $header['disabled'] ? '# ' : '', $header_key, $header['value']);
|
||||
}
|
||||
$output[] = '';
|
||||
$output[] = (string)$this->prepareBody();
|
||||
return implode(PHP_EOL, $output);
|
||||
}
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters;
|
||||
|
||||
interface RequestContract
|
||||
{
|
||||
public function setName(string $name): static;
|
||||
public function getName(): string;
|
||||
public function setDescription(?string $description): static;
|
||||
public function setVerb(string $verb): static;
|
||||
public function setUrl(string $url): static;
|
||||
public function setHeaders(?array $headers): static;
|
||||
public function setBodymode(string $bodymode): static;
|
||||
public function setBody(object $body): static;
|
||||
public function __toString(): string;
|
||||
}
|
||||
@@ -1,63 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter\Exporters\Wget;
|
||||
|
||||
use PmConverter\Exporters\Abstract\AbstractRequest;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
class WgetRequest extends AbstractRequest
|
||||
{
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
protected function prepareBody(): ?string
|
||||
{
|
||||
switch ($this->bodymode) {
|
||||
case 'formdata':
|
||||
$lines = [];
|
||||
foreach ($this->body as &$data) {
|
||||
if ($data->type === 'file') {
|
||||
continue;
|
||||
}
|
||||
$lines[$data->key] = $data->value;
|
||||
}
|
||||
$body[] = http_build_query($lines);
|
||||
return implode(PHP_EOL, $body);
|
||||
default:
|
||||
return $this->body;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function __toString(): string
|
||||
{
|
||||
$output[] = '#!/bin/sh';
|
||||
if ($this->description) {
|
||||
$output[] = '# ' . str_replace("\n", "\n# ", $this->description);
|
||||
$output[] = '';
|
||||
}
|
||||
$output[] = 'wget \ ';
|
||||
$output[] = "\t--no-check-certificate \ ";
|
||||
$output[] = "\t--quiet \ ";
|
||||
$output[] = "\t--timeout=0 \ ";
|
||||
$output[] = "\t--method $this->verb \ ";
|
||||
foreach ($this->headers as $header_key => $header) {
|
||||
if ($header['disabled']) {
|
||||
continue;
|
||||
}
|
||||
$output[] = sprintf("\t--header '%s=%s' \ ", $header_key, $header['value']);
|
||||
}
|
||||
if (!is_null($body = $this->prepareBody())) {
|
||||
$output[] = "\t--body-data '$body' \ ";
|
||||
}
|
||||
$output[] = rtrim(array_pop($output), '\ ');
|
||||
$output[] = "\t'$this->url'";
|
||||
return implode(PHP_EOL, $output);
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types = 1);
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter;
|
||||
|
||||
|
||||
21
src/HttpVersions.php
Normal file
21
src/HttpVersions.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace PmConverter;
|
||||
|
||||
enum HttpVersions: string
|
||||
{
|
||||
case Version10 = '1.0';
|
||||
case Version11 = '1.1';
|
||||
case Version2 = '2';
|
||||
case Version3 = '3';
|
||||
|
||||
public static function values(): array
|
||||
{
|
||||
return array_combine(
|
||||
array_column(self::cases(), 'name'),
|
||||
array_column(self::cases(), 'value'),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -7,22 +7,21 @@ namespace PmConverter;
|
||||
use Exception;
|
||||
use InvalidArgumentException;
|
||||
use JsonException;
|
||||
use PmConverter\Exceptions\CannotCreateDirectoryException;
|
||||
use PmConverter\Exceptions\DirectoryIsNotReadableException;
|
||||
use PmConverter\Exceptions\DirectoryIsNotWriteableException;
|
||||
use PmConverter\Exceptions\DirectoryNotExistsException;
|
||||
use PmConverter\Exporters\ConverterContract;
|
||||
use PmConverter\Exporters\ConvertFormat;
|
||||
use PmConverter\Converters\{
|
||||
ConverterContract,
|
||||
ConvertFormat};
|
||||
use PmConverter\Exceptions\{
|
||||
CannotCreateDirectoryException,
|
||||
DirectoryIsNotReadableException,
|
||||
DirectoryIsNotWriteableException,
|
||||
DirectoryNotExistsException};
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
class Processor
|
||||
{
|
||||
/**
|
||||
* Converter version
|
||||
*/
|
||||
public const VERSION = '1.1.1';
|
||||
public const VERSION = '1.3.0';
|
||||
|
||||
/**
|
||||
* @var string[] Paths to collection files
|
||||
@@ -57,12 +56,22 @@ class Processor
|
||||
/**
|
||||
* @var int Initial timestamp
|
||||
*/
|
||||
protected int $init_time;
|
||||
protected int $initTime;
|
||||
|
||||
/**
|
||||
* @var int Initial RAM usage
|
||||
*/
|
||||
protected int $init_ram;
|
||||
protected int $initRam;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected string $envFile;
|
||||
|
||||
/**
|
||||
* @var Environment
|
||||
*/
|
||||
protected Environment $env;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
@@ -71,17 +80,14 @@ class Processor
|
||||
*/
|
||||
public function __construct(protected array $argv)
|
||||
{
|
||||
$this->init_time = hrtime(true);
|
||||
$this->init_ram = memory_get_usage(true);
|
||||
$this->initTime = hrtime(true);
|
||||
$this->initRam = memory_get_usage(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses an array of arguments came from cli
|
||||
*
|
||||
* @return void
|
||||
* @throws DirectoryIsNotWriteableException
|
||||
* @throws DirectoryNotExistsException
|
||||
* @throws DirectoryIsNotReadableException
|
||||
*/
|
||||
protected function parseArgs(): void
|
||||
{
|
||||
@@ -115,14 +121,19 @@ class Processor
|
||||
if (empty($this->argv[$idx + 1])) {
|
||||
throw new InvalidArgumentException('a directory path is expected for -d (--dir)');
|
||||
}
|
||||
$normpath = $this->argv[$idx + 1];
|
||||
$rawpath = $this->argv[$idx + 1];
|
||||
$files = array_filter(
|
||||
FileSystem::dirContents($normpath),
|
||||
FileSystem::dirContents($rawpath),
|
||||
static fn($filename) => FileSystem::isCollectionFile($filename)
|
||||
);
|
||||
$this->collectionPaths = array_unique(array_merge($this?->collectionPaths ?? [], $files));
|
||||
break;
|
||||
|
||||
case '-e':
|
||||
case '--env':
|
||||
$this->envFile = FileSystem::normalizePath($this->argv[$idx + 1]);
|
||||
break;
|
||||
|
||||
case '-p':
|
||||
case '--preserve':
|
||||
$this->preserveOutput = true;
|
||||
@@ -152,12 +163,17 @@ class Processor
|
||||
if (empty($this->collectionPaths)) {
|
||||
throw new InvalidArgumentException('there are no collections to convert');
|
||||
}
|
||||
if (empty($this->outputPath)) {
|
||||
throw new InvalidArgumentException('-o is required');
|
||||
}
|
||||
if (empty($this->formats)) {
|
||||
$this->formats = [ConvertFormat::Http->name => ConvertFormat::Http];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes output directory
|
||||
*
|
||||
* @return void
|
||||
* @throws CannotCreateDirectoryException
|
||||
* @throws DirectoryIsNotWriteableException
|
||||
@@ -185,6 +201,8 @@ class Processor
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes collection objects
|
||||
*
|
||||
* @throws JsonException
|
||||
*/
|
||||
protected function initCollections(): void
|
||||
@@ -199,6 +217,25 @@ class Processor
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes environment object
|
||||
*
|
||||
* @return void
|
||||
* @throws JsonException
|
||||
*/
|
||||
protected function initEnv(): void
|
||||
{
|
||||
if (!isset($this->envFile)) {
|
||||
return;
|
||||
}
|
||||
$content = file_get_contents(FileSystem::normalizePath($this->envFile));
|
||||
$content = json_decode($content, flags: JSON_THROW_ON_ERROR);
|
||||
if (!property_exists($content, 'environment') || empty($content?->environment)) {
|
||||
throw new JsonException("not a valid environment: $this->envFile");
|
||||
}
|
||||
$this->env = new Environment($content->environment);
|
||||
}
|
||||
|
||||
/**
|
||||
* Begins a conversion
|
||||
*
|
||||
@@ -210,6 +247,7 @@ class Processor
|
||||
$this->initOutputDirectory();
|
||||
$this->initConverters();
|
||||
$this->initCollections();
|
||||
$this->initEnv();
|
||||
$count = count($this->collections);
|
||||
$current = 0;
|
||||
$success = 0;
|
||||
@@ -218,10 +256,13 @@ class Processor
|
||||
++$current;
|
||||
printf("Converting '%s' (%d/%d):%s", $collectionName, $current, $count, PHP_EOL);
|
||||
foreach ($this->converters as $type => $exporter) {
|
||||
printf(' > %s', strtolower($type));
|
||||
printf('> %s%s', strtolower($type), PHP_EOL);
|
||||
$outputPath = sprintf('%s%s%s', $this->outputPath, DIRECTORY_SEPARATOR, $collectionName);
|
||||
if (!empty($this->env)) {
|
||||
$exporter->withEnv($this->env);
|
||||
}
|
||||
$exporter->convert($collection, $outputPath);
|
||||
printf(' - OK: %s%s', $exporter->getOutputPath(), PHP_EOL);
|
||||
printf(' OK: %s%s', $exporter->getOutputPath(), PHP_EOL);
|
||||
}
|
||||
print(PHP_EOL);
|
||||
++$success;
|
||||
@@ -238,15 +279,15 @@ class Processor
|
||||
*/
|
||||
protected function printStats(int $success, int $count): void
|
||||
{
|
||||
$time = (hrtime(true) - $this->init_time) / 1_000_000;
|
||||
$ram = (memory_get_peak_usage(true) - $this->init_ram) / 1024 / 1024;
|
||||
printf('Converted %d of %d in %.3f ms using %.3f MiB RAM', $success, $count, $time, $ram);
|
||||
$time = (hrtime(true) - $this->initTime) / 1_000_000;
|
||||
$ram = (memory_get_peak_usage(true) - $this->initRam) / 1024 / 1024;
|
||||
printf('Converted %d of %d in %.3f ms using %.3f MiB RAM%s', $success, $count, $time, $ram, PHP_EOL);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
protected function version(): array
|
||||
public function version(): array
|
||||
{
|
||||
return ["Postman collection converter v" . self::VERSION];
|
||||
}
|
||||
@@ -254,7 +295,7 @@ class Processor
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
protected function copyright(): array
|
||||
public function copyright(): array
|
||||
{
|
||||
return [
|
||||
'Anthony Axenov (c) ' . date('Y') . ", MIT license",
|
||||
@@ -265,7 +306,7 @@ class Processor
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
protected function usage(): array
|
||||
public function usage(): array
|
||||
{
|
||||
return array_merge($this->version(), [
|
||||
'Usage:',
|
||||
@@ -276,23 +317,27 @@ class Processor
|
||||
'',
|
||||
'Possible ARGUMENTS:',
|
||||
"\t-f, --file - a PATH to single collection located in PATH to convert from",
|
||||
"\t-d, --dir - a directory with collections located in COLLECTION_FILEPATH to convert from",
|
||||
"\t-d, --dir - a directory with collections located in PATH to convert from",
|
||||
"\t-o, --output - a directory OUTPUT_PATH to put results in",
|
||||
"\t-e, --env - use environment file with variable values to replace in request",
|
||||
"\t-p, --preserve - do not delete OUTPUT_PATH (if exists)",
|
||||
"\t-h, --help - show this help message and exit",
|
||||
"\t-v, --version - show version info and exit",
|
||||
'',
|
||||
'If no ARGUMENTS passed then --help implied.',
|
||||
'If both -c and -d are specified then only unique set of files will be converted.',
|
||||
'If both -f and -d are specified then only unique set of files will be converted.',
|
||||
'-f or -d are required to be specified at least once, but each may be specified multiple times.',
|
||||
'PATH must be a valid path to readable json-file or directory.',
|
||||
'OUTPUT_PATH must be a valid path to writeable directory.',
|
||||
'If -o is specified several times then only last one will be used.',
|
||||
'If -e is specified several times then only last one will be used.',
|
||||
'If -e is not specified then only collection vars will be replaced (if any).',
|
||||
'',
|
||||
'Possible FORMATS:',
|
||||
"\t--http - generate raw *.http files (default)",
|
||||
"\t--curl - generate shell scripts with curl command",
|
||||
"\t--wget - generate shell scripts with wget command",
|
||||
'',
|
||||
'If no FORMATS specified then --http implied.',
|
||||
'Any of FORMATS can be specified at the same time.',
|
||||
'',
|
||||
@@ -301,6 +346,7 @@ class Processor
|
||||
" -f ~/dir1/first.postman_collection.json \ ",
|
||||
" --directory ~/team \ ",
|
||||
" --file ~/dir2/second.postman_collection.json \ ",
|
||||
" --env ~/localhost.postman_environment.json \ ",
|
||||
" -d ~/personal \ ",
|
||||
" -o ~/postman_export ",
|
||||
"",
|
||||
|
||||
297
tests/AbstractRequestTest.php
Normal file
297
tests/AbstractRequestTest.php
Normal file
@@ -0,0 +1,297 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use PmConverter\Exceptions\{
|
||||
EmptyHttpVerbException,
|
||||
InvalidHttpVersionException};
|
||||
|
||||
class AbstractRequestTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\HttpVersions
|
||||
* @return void
|
||||
* @throws InvalidHttpVersionException
|
||||
*/
|
||||
public function testHttpVersion(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setHttpVersion(2.0);
|
||||
|
||||
$this->assertSame(2.0, $request->getHttpVersion());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getVerb()
|
||||
* @covers PmConverter\HttpVersions
|
||||
* @return void
|
||||
* @throws InvalidHttpVersionException
|
||||
*/
|
||||
public function testInvalidHttpVersionException(): void
|
||||
{
|
||||
$this->expectException(InvalidHttpVersionException::class);
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setHttpVersion(5);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setVerb()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getVerb()
|
||||
* @return void
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
public function testVerb(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setVerb('GET');
|
||||
|
||||
$this->assertSame('GET', $request->getVerb());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getVerb()
|
||||
* @return void
|
||||
* @throws EmptyHttpVerbException
|
||||
*/
|
||||
public function testEmptyHttpVerbException(): void
|
||||
{
|
||||
$this->expectException(EmptyHttpVerbException::class);
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->getVerb();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setUrl()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getUrl()
|
||||
* @return void
|
||||
*/
|
||||
public function testUrl(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setUrl('http://localhost');
|
||||
|
||||
$this->assertSame('http://localhost', $request->getUrl());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setName()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getName()
|
||||
* @return void
|
||||
*/
|
||||
public function testName(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setName('lorem ipsum');
|
||||
|
||||
$this->assertSame('lorem ipsum', $request->getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setDescription()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getDescription()
|
||||
* @return void
|
||||
*/
|
||||
public function testDescription(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setDescription("lorem ipsum\ndolor sit\namet");
|
||||
|
||||
$this->assertSame("lorem ipsum\ndolor sit\namet", $request->getDescription());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setBodymode()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getBodymode()
|
||||
* @return void
|
||||
*/
|
||||
public function testBodyMode(): void
|
||||
{
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setBodymode('raw');
|
||||
|
||||
$this->assertSame('raw', $request->getBodymode());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setHeaders()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setHeader()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getHeaders()
|
||||
* @return void
|
||||
*/
|
||||
public function testHeaders(): void
|
||||
{
|
||||
$headers = [
|
||||
(object)[
|
||||
'key' => 'Header 1',
|
||||
'value' => 'Value 1',
|
||||
'disabled' => true,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header 2',
|
||||
'value' => 'Value 2',
|
||||
'disabled' => false,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header 3',
|
||||
'value' => 'Value 3',
|
||||
],
|
||||
];
|
||||
$expected = [
|
||||
'Header 1' => [
|
||||
'value' => 'Value 1',
|
||||
'disabled' => true,
|
||||
],
|
||||
'Header 2' => [
|
||||
'value' => 'Value 2',
|
||||
'disabled' => false,
|
||||
],
|
||||
'Header 3' => [
|
||||
'value' => 'Value 3',
|
||||
'disabled' => false,
|
||||
],
|
||||
'Header 4' => [
|
||||
'value' => 'Value 4',
|
||||
'disabled' => false,
|
||||
],
|
||||
'Header 5' => [
|
||||
'value' => 'Value 5',
|
||||
'disabled' => true,
|
||||
],
|
||||
];
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setHeaders($headers)
|
||||
->setHeader('Header 4', 'Value 4')
|
||||
->setHeader('Header 5', 'Value 5', true);
|
||||
|
||||
$this->assertSame($expected, $request->getHeaders());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setAuth()
|
||||
* @return void
|
||||
*/
|
||||
public function testAuthBearer(): void
|
||||
{
|
||||
$auth = (object)[
|
||||
'type' => 'bearer',
|
||||
'bearer' => [
|
||||
(object)[
|
||||
'key' => 'token',
|
||||
'value' => 'qwerty',
|
||||
'type' => 'string',
|
||||
]
|
||||
]
|
||||
];
|
||||
$expected = [
|
||||
'Authorization' => [
|
||||
'value' => 'Bearer qwerty',
|
||||
'disabled' => false,
|
||||
],
|
||||
];
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setAuth($auth);
|
||||
|
||||
$this->assertSame($expected, $request->getHeaders());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setBodymode()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setHeader()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setBody()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setJsonBody()
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getBody()
|
||||
* @return void
|
||||
*/
|
||||
public function testJson(): void
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'raw',
|
||||
'raw' => $expectedBody = '["lorem ipsum dolor sit amet"]',
|
||||
'options' => (object)[
|
||||
'raw' => (object)[
|
||||
'language' => 'json',
|
||||
]
|
||||
]
|
||||
];
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setBody($body);
|
||||
|
||||
$expectedHeaders = [
|
||||
'Content-Type' => [
|
||||
'value' => 'application/json',
|
||||
'disabled' => false,
|
||||
],
|
||||
];
|
||||
|
||||
$this->assertSame($expectedHeaders, $request->getHeaders());
|
||||
$this->assertSame($expectedBody, $request->getBody());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setBodymode
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setHeader
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setBody
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::setFormdataBody
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest::getBody
|
||||
* @return void
|
||||
*/
|
||||
public function testFormdata(): void
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'formdata',
|
||||
'formdata' => [
|
||||
(object)[
|
||||
'key' => 'param1',
|
||||
'value' => 'value1',
|
||||
'type' => 'text',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param2',
|
||||
'src' => '/tmp/somefile.txt',
|
||||
'type' => 'file',
|
||||
],
|
||||
],
|
||||
];
|
||||
$expectedBody = [
|
||||
'param1' => [
|
||||
'value' => 'value1',
|
||||
'type' => 'text',
|
||||
],
|
||||
'param2' => [
|
||||
'value' => '/tmp/somefile.txt',
|
||||
'type' => 'file',
|
||||
],
|
||||
];
|
||||
$expectedHeaders = [
|
||||
'Content-Type' => [
|
||||
'value' => 'multipart/form-data',
|
||||
'disabled' => false,
|
||||
],
|
||||
];
|
||||
|
||||
$request = new \PmConverter\Converters\Http\HttpRequest();
|
||||
$request->setBody($body);
|
||||
|
||||
$this->assertSame($expectedHeaders, $request->getHeaders());
|
||||
$this->assertSame($expectedBody, $request->getBody());
|
||||
}
|
||||
}
|
||||
140
tests/HttpRequestTest.php
Normal file
140
tests/HttpRequestTest.php
Normal file
@@ -0,0 +1,140 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use PmConverter\Converters\Http\HttpRequest;
|
||||
|
||||
class HttpRequestTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::prepareDescription()
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareDescription()
|
||||
{
|
||||
$description = [
|
||||
'lorem ipsum',
|
||||
'dolor sit',
|
||||
'amet',
|
||||
];
|
||||
$needle = implode("\n", [
|
||||
'# lorem ipsum',
|
||||
'# dolor sit',
|
||||
'# amet',
|
||||
]);
|
||||
|
||||
$request = (new HttpRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setDescription(implode("\n", $description));
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::prepareHeaders()
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareHeaders()
|
||||
{
|
||||
$headers = [
|
||||
(object)[
|
||||
'key' => 'Header1',
|
||||
'value' => 'Value 1',
|
||||
'disabled' => true,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header2',
|
||||
'value' => 'Value 2',
|
||||
'disabled' => false,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header3',
|
||||
'value' => 'Value 3',
|
||||
],
|
||||
];
|
||||
$needle = implode("\n", [
|
||||
'# Header1: Value 1',
|
||||
'Header2: Value 2',
|
||||
'Header3: Value 3',
|
||||
]);
|
||||
|
||||
$request = (new HttpRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setHeaders($headers);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareFormdataBody()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'formdata',
|
||||
'formdata' => [
|
||||
(object)[
|
||||
'key' => 'param1',
|
||||
'value' => 'value1',
|
||||
'type' => 'text',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param2',
|
||||
'src' => '/tmp/somefile.txt',
|
||||
'type' => 'file',
|
||||
],
|
||||
],
|
||||
];
|
||||
$needle = implode("\n", [
|
||||
'param1=value1',
|
||||
'param2=@/tmp/somefile.txt',
|
||||
]);
|
||||
|
||||
$request = (new HttpRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Http\HttpRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareJsonBody()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'raw',
|
||||
'raw' => $needle = '["lorem ipsum dolor sit amet"]',
|
||||
'options' => (object)[
|
||||
'raw' => (object)[
|
||||
'language' => 'json',
|
||||
]
|
||||
]
|
||||
];
|
||||
|
||||
$request = (new HttpRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
}
|
||||
232
tests/WgetRequestTest.php
Normal file
232
tests/WgetRequestTest.php
Normal file
@@ -0,0 +1,232 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use PmConverter\Converters\Wget\WgetRequest;
|
||||
|
||||
class WgetRequestTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareDescription()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareNotEmptyDescription()
|
||||
{
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setDescription(null);
|
||||
|
||||
$result = explode("\n", (string)$request);
|
||||
|
||||
$this->assertFalse(str_starts_with($result[0], '# ') && str_starts_with($result[1], '# '));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareDescription()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareEmptyDescription()
|
||||
{
|
||||
$description = [
|
||||
'lorem ipsum',
|
||||
'dolor sit',
|
||||
'amet',
|
||||
];
|
||||
$needle = implode("\n", [
|
||||
'# lorem ipsum',
|
||||
'# dolor sit',
|
||||
'# amet',
|
||||
]);
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setDescription(implode("\n", $description));
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareHeaders()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareHeaders()
|
||||
{
|
||||
$headers = [
|
||||
(object)[
|
||||
'key' => 'Header1',
|
||||
'value' => 'Value 1',
|
||||
'disabled' => true,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header2',
|
||||
'value' => 'Value 2',
|
||||
'disabled' => false,
|
||||
],
|
||||
(object)[
|
||||
'key' => 'Header3',
|
||||
'value' => 'Value 3',
|
||||
],
|
||||
];
|
||||
$needle = implode("\n", [
|
||||
"\t--header 'Header2: Value 2' \ ",
|
||||
"\t--header 'Header3: Value 3' \ ",
|
||||
]);
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setHeaders($headers);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareFormdataBodyGet()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'formdata',
|
||||
'formdata' => [
|
||||
(object)[
|
||||
'key' => 'param1',
|
||||
'value' => 'value1',
|
||||
'type' => 'text',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param2',
|
||||
'src' => '/tmp/somefile.txt',
|
||||
'type' => 'file',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param3',
|
||||
'value' => 'value3',
|
||||
'type' => 'text',
|
||||
],
|
||||
],
|
||||
];
|
||||
$needle = 'http://localhost?' . http_build_query([
|
||||
'param1' => 'value1',
|
||||
'param3' => 'value3',
|
||||
]);
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareFormdataBodyPost()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'formdata',
|
||||
'formdata' => [
|
||||
(object)[
|
||||
'key' => 'param1',
|
||||
'value' => 'value1',
|
||||
'type' => 'text',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param2',
|
||||
'src' => '/tmp/somefile.txt',
|
||||
'type' => 'file',
|
||||
],
|
||||
(object)[
|
||||
'key' => 'param3',
|
||||
'value' => 'value3',
|
||||
'type' => 'text',
|
||||
],
|
||||
],
|
||||
];
|
||||
$needle = http_build_query([
|
||||
'param1' => 'value1',
|
||||
'param3' => 'value3',
|
||||
]);
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('POST')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareJsonBodyGet()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'raw',
|
||||
'raw' => $needle = '["lorem ipsum dolor sit amet"]',
|
||||
'options' => (object)[
|
||||
'raw' => (object)[
|
||||
'language' => 'json',
|
||||
]
|
||||
]
|
||||
];
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('GET')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringNotContainsString($needle, (string)$request);
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers PmConverter\Converters\Abstract\AbstractRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::prepareBody()
|
||||
* @covers PmConverter\Converters\Wget\WgetRequest::__toString()
|
||||
* @return void
|
||||
*/
|
||||
public function testPrepareJsonBodyPost()
|
||||
{
|
||||
$body = (object)[
|
||||
'mode' => 'raw',
|
||||
'raw' => $needle = '["lorem ipsum dolor sit amet"]',
|
||||
'options' => (object)[
|
||||
'raw' => (object)[
|
||||
'language' => 'json',
|
||||
]
|
||||
]
|
||||
];
|
||||
|
||||
$request = (new WgetRequest())
|
||||
->setVerb('POST')
|
||||
->setUrl('http://localhost')
|
||||
->setBody($body);
|
||||
|
||||
$this->assertStringContainsString($needle, (string)$request);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user