Initial commit

Author: flexnst

.gitignore

@@ -0,0 +1,3 @@
+.idea
+.phpunit.result.cache
+vendor

README.md

@@ -0,0 +1,45 @@
+# ExampleCom client
+
+## Часть 1:
+
+Задача:
+> Есть список директорий неизвестно насколько большой вложенности
+> В директории может быть файл count
+> Нужно пройтись по всем директориям и вернуть сумму всех чисел из файла count (файлов count может быть много)
+
+Пример: `examples/part_1.php`
+
+## Часть 2:
+
+Задача:
+> Необходимо реализовать клиент для абстрактного (вымышленного) сервиса комментариев "example.com". Проект должен представлять класс или набор классов, который будет делать http запросы к серверу.
+>  На выходе должна получиться библиотека, который можно будет подключить через composer к любому другому проекту.
+>  У этого сервиса есть 3 метода:
+>
+>  GET http://example.com/comments - возвращает список комментариев
+> 
+>  POST http://example.com/comment - добавить комментарий.
+> 
+>  PUT http://example.com/comment/{id} - по идентификатору комментария обновляет поля, которые были в в запросе
+>   
+>  Объект comment содержит поля:
+>  id - тип int. Не нужно указывать при добавлении.
+>  name - тип string.
+>  text - тип string.
+>
+>  Написать phpunit тесты, на которых будет проверяться работоспособность клиента.
+>  Сервер example.com писать не надо! Только библиотеку для работы с ним.
+
+Пример: `examples/part_2.php`
+
+# Lint & Tests:
+
+```bash
+docker compose up
+```
+
+# Setup
+
+```bash
+composer require flexnst/example-com-client
+```

compose.yml

@@ -0,0 +1,18 @@
+services:
+  composer:
+    image: composer:2
+    pull_policy: always
+    restart: no
+    volumes:
+      - '.:/app'
+    working_dir: '/app'
+    entrypoint: [ "/bin/bash", "-c" ]
+    command:
+      - |
+        composer install --ignore-platform-reqs
+        vendor/bin/phpstan analyse examples src tests
+        echo -e "\n=== Задача №1: ==="
+        php examples/part_1.php
+        echo -e "\n\n=== Задача №2: ==="
+        vendor/bin/phpunit -c phpunit.xml --testsuite Unit
+        vendor/bin/phpunit -c phpunit.xml --testsuite Feature

composer.json

@@ -0,0 +1,42 @@
+{
+  "name": "flexnst/example-com-client",
+  "description": "Example.com comments client",
+  "version": "1.0.0",
+  "type": "library",
+  "keywords": [
+    "tz",
+    "example.com",
+    "comments",
+    "client"
+  ],
+  "authors": [
+    {
+      "name": "Alexandr Chernov",
+      "email": "flex.nst@gmail.com"
+    }
+  ],
+  "require": {
+    "php": "8.2",
+    "guzzlehttp/guzzle": "^7.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^10.0",
+    "phpstan/phpstan": "^1.11"
+  },
+  "autoload": {
+    "psr-4": {
+      "ExampleCom\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
+  "config": {
+    "optimize-autoloader": true,
+    "preferred-install": "dist",
+    "sort-packages": true
+  },
+  "prefer-stable": true
+}

composer.lock

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+function getSumFromFiles(string $path, string $filename): float
+{
+    $sum = 0;
+
+    foreach (new FilesystemIterator($path, FilesystemIterator::SKIP_DOTS) as $file) {
+        /** @var SplFileInfo $file */
+        if ($file->isDir()) {
+            $sum += getSumFromFiles($file->getPathname(), $filename);
+            continue;
+        }
+
+        if ($file->getFilename() !== $filename) {
+            continue;
+        }
+
+        if (!$file->isReadable()) {
+            echo "File {$file->getPathname()} is not readable\n";
+            continue;
+        }
+
+        $contents = file_get_contents($file->getPathname());
+
+        if (is_numeric($contents)) {
+            $sum += (float) $contents;
+        }
+    }
+
+    return $sum;
+}
+
+echo getSumFromFiles(__DIR__ . '/part_1_dir', 'count');

examples/part_1.php

@@ -0,0 +1 @@
+1

examples/part_1_dir/count

@@ -0,0 +1 @@
+2

examples/part_1_dir/dir1/count

@@ -0,0 +1 @@
+7

examples/part_1_dir/dir1/dir2/count

@@ -0,0 +1 @@
+A

examples/part_1_dir/dir1/dir2/dir3/count

@@ -0,0 +1 @@
+123

examples/part_1_dir/nocount

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+use Psr\Http\Client\ClientExceptionInterface;
+
+$psr7httpClient = new \GuzzleHttp\Client([
+    'base_uri' => 'https://example.com',
+]);
+
+$exampleCom = new \ExampleCom\Client($psr7httpClient);
+
+/**
+ * 1. Получить список комментариев
+ */
+try {
+    $comments = $exampleCom->getComments();
+} catch (ClientExceptionInterface $exception) {
+    // Исключения оставлены на этом уровне для более гибкой обработки ошибок
+    // на уровне приложения, использующего данный пакет
+    // $logger->error($exception->getMessage(), ...);
+}
+
+/**
+ * 2. Добавить комментарий
+ */
+try {
+    $exampleCom->addComment('Ivanov Ivan', 'Lorem ipsum dolor.');
+} catch (ClientExceptionInterface $exception) {
+    // $logger->error($exception->getMessage(), ...);
+}
+
+/**
+ * 3. Обновить комментарий
+ */
+try {
+    $exampleCom->updateComment(123, 'Ivan Ivanovitch', 'Lorem ipsum dolor sit amet...');
+} catch (ClientExceptionInterface $exception) {
+    // $logger->error($exception->getMessage(), ...);
+} catch (\ExampleCom\Exception\UpdateCommentException $exception) {
+    // $logger->error($exception->getMessage(), ...);
+}
+
+

examples/part_2.php

@@ -0,0 +1,6 @@
+parameters:
+    paths:
+        - examples/
+        - src/
+        - tests/
+    level: 9

phpstan.neon

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+    <testsuites>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <coverage/>
+    <php/>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>

phpunit.xml

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom;
+
+use ExampleCom\Exception\UpdateCommentException;
+use ExampleCom\Request\AddCommentRequest;
+use ExampleCom\Request\GetCommentsRequest;
+use ExampleCom\Request\UpdateCommentRequest;
+use ExampleCom\Response\GetCommentsResponse;
+use JsonException;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Client\ClientInterface;
+
+class Client
+{
+    public function __construct(
+        private readonly ClientInterface $httpClient,
+    ) {
+    }
+
+    /**
+     * @return array<Comment>
+     * @throws ClientExceptionInterface
+     */
+    public function getComments(): array
+    {
+        $response = $this->httpClient->sendRequest(new GetCommentsRequest());
+
+        return (new GetCommentsResponse($response))->getComments();
+    }
+
+    /**
+     * @throws ClientExceptionInterface
+     * @throws JsonException
+     */
+    public function addComment(string $name, string $text): bool
+    {
+        $response = $this->httpClient
+            ->sendRequest(new AddCommentRequest(new Comment($name, $text)));
+
+        return $response->getStatusCode() === 200;
+    }
+
+    /**
+     * @throws ClientExceptionInterface
+     * @throws UpdateCommentException
+     * @throws JsonException
+     */
+    public function updateComment(int $commentId, string $name, string $text): bool
+    {
+        $response = $this->httpClient
+            ->sendRequest(new UpdateCommentRequest(new Comment($name, $text, $commentId)));
+
+        return $response->getStatusCode() === 200;
+    }
+}

src/Client.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom;
+
+class Comment
+{
+    public function __construct(
+        public string $name,
+        public string $text,
+        public ?int $id = null,
+    ) {
+    }
+}

src/Comment.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom\Exception;
+
+use ErrorException;
+
+class UpdateCommentException extends ErrorException
+{
+}

src/Exception/UpdateCommentException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom\Request;
+
+use ExampleCom\Comment;
+use GuzzleHttp\Psr7\Request;
+use Psr\Http\Message\RequestInterface;
+
+class AddCommentRequest extends Request implements RequestInterface
+{
+    public function __construct(Comment $comment)
+    {
+        $json = json_encode([
+            'name' => $comment->name,
+            'text' => $comment->text,
+        ], JSON_THROW_ON_ERROR);
+
+        parent::__construct('POST', '/comment', [], $json);
+    }
+}

src/Request/AddCommentRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom\Request;
+
+use GuzzleHttp\Psr7\Request;
+use Psr\Http\Message\RequestInterface;
+
+class GetCommentsRequest extends Request implements RequestInterface
+{
+    public function __construct()
+    {
+        parent::__construct('GET', '/comments');
+    }
+}

src/Request/GetCommentsRequest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom\Request;
+
+use ExampleCom\Comment;
+use ExampleCom\Exception\UpdateCommentException;
+use GuzzleHttp\Psr7\Request;
+use JsonException;
+use Psr\Http\Message\RequestInterface;
+
+class UpdateCommentRequest extends Request implements RequestInterface
+{
+    /**
+     * @throws UpdateCommentException
+     * @throws JsonException
+     */
+    public function __construct(Comment $comment)
+    {
+        if (!is_int($comment->id)) {
+            throw new UpdateCommentException('Comment id must be an integer.');
+        }
+
+        $json = json_encode([
+            'name' => $comment->name,
+            'text' => $comment->text,
+        ], JSON_THROW_ON_ERROR);
+
+        parent::__construct('PUT', "/comment/{$comment->id}", [], $json);
+    }
+}

src/Request/UpdateCommentRequest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ExampleCom\Response;
+
+use ExampleCom\Comment;
+use Psr\Http\Message\ResponseInterface;
+
+class GetCommentsResponse
+{
+    public function __construct(
+        private readonly ResponseInterface $response
+    ) {
+    }
+
+    /**
+     * @return array<int, Comment>
+     */
+    public function getComments(): array
+    {
+        $this->response->getBody()->rewind();
+        /** @var array<int, array<string, string|int>> $json */
+        $json = json_decode($this->response->getBody()->getContents(), true);
+        $comments = [];
+
+        foreach ($json as $comment) {
+            $comments[] = new Comment(
+                (string) $comment['name'],
+                (string) $comment['text'],
+                (int) $comment['id'],
+            );
+        }
+
+        return $comments;
+    }
+}

src/Response/GetCommentsResponse.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Feature;
+
+use ExampleCom\Client;
+use ExampleCom\Comment;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientInterface;
+
+class ClientTest extends TestCase
+{
+    public function testAddCommentSuccess(): void
+    {
+        $exampleCom = $this->mockClient(new Response(200, [], ''));
+
+        self::assertTrue($exampleCom->addComment('Alice', 'Foo'));
+    }
+
+    public function testAddCommentError(): void
+    {
+        $exampleCom = $this->mockClient(new Response(400, [], ''));
+
+        self::assertFalse($exampleCom->addComment('Alice', 'Foo'));
+    }
+
+    public function testGetComments(): void
+    {
+        $exampleCom = $this->mockClient(new Response(200, [], (string) json_encode([
+            [
+                'id' => 1,
+                'name' => 'Alice',
+                'text' => 'Foo',
+            ],
+            [
+                'id' => 2,
+                'name' => 'Bob',
+                'text' => 'Bar',
+            ]
+        ])));
+
+        $comments = $exampleCom->getComments();
+
+        // Проверим кол-во элементов ответа
+        self::assertEquals(2, count($comments));
+
+        // Проверим что первый элемент соответсвует Mock
+        self::assertEquals($comments[0], new Comment(
+            'Alice',
+            'Foo',
+            1
+        ));
+
+        // Проверим что второй элемент соответсвует Mock
+        self::assertEquals($comments[1], new Comment(
+            'Bob',
+            'Bar',
+            2
+        ));
+    }
+
+    public function testUpdateComment(): void
+    {
+        $exampleCom = $this->mockClient(new Response(200, [], ''));
+
+        self::assertTrue($exampleCom->updateComment(1,'Alice', 'Foo'));
+    }
+
+    private function mockClient(Response $response): Client
+    {
+        $httpClientMock = $this->createMock(ClientInterface::class);
+        $httpClientMock->method('sendRequest')->willReturn($response);
+
+        return new Client($httpClientMock);
+    }
+}

tests/Feature/ClientTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use ExampleCom\Comment;
+use ExampleCom\Request\AddCommentRequest;
+use GuzzleHttp\Psr7\Uri;
+use PHPUnit\Framework\TestCase;
+
+class AddCommentRequestTest extends TestCase
+{
+    /**
+     * @dataProvider commentsDataProvider
+     */
+    public function testAddCommentRequest(string $name, string $text): void
+    {
+        $request = new AddCommentRequest(new Comment(
+            $name,
+            $text,
+        ));
+
+        self::assertEquals('POST', $request->getMethod());
+        self::assertEquals(new Uri('/comment'), $request->getUri()->getPath());
+
+        $request->getBody()->rewind();
+
+        self::assertEquals(
+            '{"name":"' . $name . '","text":"' . $text . '"}',
+            $request->getBody()->getContents()
+        );
+    }
+
+    /**
+     * @return array<int, array<int, string>>
+     */
+    public static function commentsDataProvider(): array
+    {
+        return [
+            ['name1', 'my comment'],
+            ['Alice', 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'],
+            ['Bob', 'Hello!'],
+        ];
+    }
+}

tests/Unit/AddCommentRequestTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use ExampleCom\Comment;
+use PHPUnit\Framework\TestCase;
+
+class CommentTest extends TestCase
+{
+    /**
+     * @param int|null $id
+     * @param string $name
+     * @param string $text
+     * @dataProvider commentsDataProvider
+     */
+    public function testComment(?int $id, string $name, string $text): void
+    {
+        $comment = new Comment($name, $text, $id);
+
+        self::assertEquals($id, $comment->id);
+        self::assertEquals($name, $comment->name);
+        self::assertEquals($text, $comment->text);
+    }
+
+    /**
+     * @return array<int, array<int, int|null|string>>
+     */
+    public static function commentsDataProvider(): array
+    {
+        return [
+            [null, 'Vasia', 'Predev'],
+            [1, 'Ivan', 'Lorem ipsum'],
+            [99999, 'Alice', 'Lorem ipsum dolor sit amet'],
+        ];
+    }
+}

tests/Unit/CommentTest.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use ExampleCom\Request\GetCommentsRequest;
+use GuzzleHttp\Psr7\Uri;
+use PHPUnit\Framework\TestCase;
+
+class GetCommentsRequestTest extends TestCase
+{
+    public function testGetCommentsRequest(): void
+    {
+        $request = new GetCommentsRequest();
+
+        self::assertEquals('GET', $request->getMethod());
+        self::assertEquals(new Uri('/comments'), $request->getUri()->getPath());
+
+        $request->getBody()->rewind();
+
+        self::assertEquals('', $request->getBody()->getContents());
+    }
+}

tests/Unit/GetCommentsRequestTest.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use ExampleCom\Comment;
+use ExampleCom\Response\GetCommentsResponse;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+
+class GetCommentsResponseTest extends TestCase
+{
+    /**
+     * @param string $jsonResponse
+     * @param array<int, Comment> $comments
+     * @dataProvider commentsDataProvider
+     */
+    public function testGetCommentsResponse(string $jsonResponse, array $comments): void
+    {
+        $response = new GetCommentsResponse(new Response(200, [], $jsonResponse));
+
+        self::assertEquals($response->getComments(), $comments);
+    }
+
+    /**
+     * @return array<int, array<int, string|array<int, Comment>>>
+     */
+    public static function commentsDataProvider(): array
+    {
+        return [
+            [
+                '[{"id":1,"name":"aaa","text":"comment 1"},{"id":2,"name":"bbb","text":"comment 2"}]',
+                [
+                    new Comment('aaa', 'comment 1', 1),
+                    new Comment('bbb', 'comment 2', 2),
+                ]
+            ],
+            [
+                '[{"id":3,"name":"ccc","text":"comment 3"},{"id":4,"name":"ddd","text":"comment 4"}]',
+                [
+                    new Comment('ccc', 'comment 3', 3),
+                    new Comment('ddd', 'comment 4', 4),
+                ]
+            ],
+        ];
+    }
+}

tests/Unit/GetCommentsResponseTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use ExampleCom\Comment;
+use ExampleCom\Exception\UpdateCommentException;
+use ExampleCom\Request\UpdateCommentRequest;
+use GuzzleHttp\Psr7\Uri;
+use PHPUnit\Framework\TestCase;
+
+class UpdateCommentRequestTest extends TestCase
+{
+    /**
+     * @dataProvider commentDataProvider
+     */
+    public function testAddCommentRequest(string $name, string $text, ?int $commentId): void
+    {
+        if ($commentId === null) {
+            $this->expectException(UpdateCommentException::class);
+        }
+
+        $request = new UpdateCommentRequest(new Comment(
+            $name,
+            $text,
+            $commentId
+        ));
+
+        self::assertEquals('PUT', $request->getMethod());
+        self::assertEquals(new Uri("/comment/{$commentId}"), $request->getUri()->getPath());
+
+        $request->getBody()->rewind();
+
+        self::assertEquals(
+            '{"name":"' . $name . '","text":"' . $text . '"}',
+            $request->getBody()->getContents()
+        );
+    }
+
+    /**
+     * @return array<int, array<int, int|string|null>>
+     */
+    public static function commentDataProvider(): array
+    {
+        return [
+            ['name1', 'my comment', 1],
+            ['Alice', 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', null],
+            ['Bob', 'Hello!', 3],
+        ];
+    }
+}