Refactorings

- important curl and wget improvements
- initial test coverage
- setters and getters in Request classes
- namespace fixes
- some additions in README
- docblocks and code-style

src/Converters/Abstract/AbstractConverter.php

@@ -0,0 +1,196 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PmConverter\Converters\Abstract;
+
+use Exception;
+use PmConverter\Converters\{
+    ConverterContract,
+    RequestContract};
+use PmConverter\Environment;
+use PmConverter\Exceptions\InvalidHttpVersionException;
+use PmConverter\FileSystem;
+
+/**
+ *
+ */
+abstract class AbstractConverter implements ConverterContract
+{
+    /**
+     * @var object|null
+     */
+    protected ?object $collection = null;
+
+    /**
+     * @var string
+     */
+    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
+    {
+        $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
+    {
+        return $this->outputPath;
+    }
+
+    /**
+     * Checks whether item contains another items or not
+     *
+     * @param object $item
+     * @return bool
+     */
+    protected function isItemFolder(object $item): bool
+    {
+        return !empty($item->item) && empty($item->request);
+    }
+
+    /**
+     * Converts an item to request object and writes it into file
+     *
+     * @throws Exception
+     */
+    protected function convertItem(mixed $item): void
+    {
+        if ($this->isItemFolder($item)) {
+            static $dir_tree;
+            foreach ($item->item as $subitem) {
+                $dir_tree[] = $item->name;
+                $path = implode(DIRECTORY_SEPARATOR, $dir_tree);
+                if ($this->isItemFolder($subitem)) {
+                    $this->convertItem($subitem);
+                } else {
+                    $this->writeRequest($this->initRequest($subitem), $path);
+                }
+                array_pop($dir_tree);
+            }
+        } else {
+            $this->writeRequest($this->initRequest($item));
+        }
+    }
+
+    /**
+     * 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_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);
+        }
+        return $result;
+    }
+
+    /**
+     * Writes converted request object to file
+     *
+     * @param RequestContract $request
+     * @param string|null $subpath
+     * @return bool
+     * @throws Exception
+     */
+    protected function writeRequest(RequestContract $request, string $subpath = null): bool
+    {
+        $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);
+        $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;
+    }
+}