batman

Author: ay4t

.continueignore

@@ -0,0 +1,4 @@
+vendor/*
+*.lock
+*.cache
+phpunit.phar

.gitignore

@@ -0,0 +1,4 @@
+vendor/*
+*.lock
+*.cache
+phpunit.phar

composer.json

@@ -0,0 +1,28 @@
+{
+    "name": "ay4t/php-rest-client",
+    "description": "Multipurpose PHP rest client for consuming RESTful web services.",
+    "keywords": ["rest","client","http client"],
+    "homepage": "https://github.com/ay4t/php-rest-client",
+    "type": "library",
+    "version": "1.0.0", 
+    "require": {
+        "guzzlehttp/guzzle": "8.0.x-dev"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Ay4t\\RestClient\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Ayatulloh Ahad R",
+            "email": "kawoel@gmail.com"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require-dev": {
+        "phpunit/phpunit": "^11.4"
+    }
+}

src/Abstracts/AbstractClient.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Ay4t\RestClient\Abstracts;
+
+use Ay4t\RestClient\Config\Config;
+use GuzzleHttp\Client as GuzzleClient;
+use Ay4t\RestClient\Interfaces\ClientInterface;
+
+abstract class AbstractClient implements ClientInterface
+{
+    protected $client;
+    protected $config;
+
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+        $this->client = new GuzzleClient(['base_uri' => $config->apiUrl]);
+    }
+
+    protected function prepareHeaders(): array
+    {
+        return [
+            'Authorization' => 'Bearer ' . $this->config->apiKey,
+            'Accept' => 'application/json',
+        ];
+    }
+}

src/Client.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Ay4t\RestClient;
+
+use GuzzleHttp\Psr7\Request;
+use Ay4t\RestClient\Traits\RequestTrait;
+use GuzzleHttp\Exception\GuzzleException;
+use Ay4t\RestClient\Abstracts\AbstractClient;
+use Ay4t\RestClient\Interfaces\ClientInterface;
+
+class Client extends AbstractClient implements ClientInterface
+{
+    use RequestTrait;
+
+    /**
+     * Perform a request to the API server.
+     *
+     * @param string $method The HTTP method to use for the request.
+     * @param string $command The command to send to the API.
+     * @param array $params The parameters to send in the request.
+     * @return mixed The response from the API server.
+     * @throws \Exception If the request to the API server fails.
+     */
+    public function cmd(string $method = 'GET', string $command, array $params = [])
+    {
+        $url = $this->config->apiUrl . '/' . $command;
+        $options = [
+            'headers'   => $this->prepareHeaders(),
+            'query'     => $method === 'GET' ? $params : [],
+            'json'      => $method === 'POST' ? $params : [],
+        ];
+
+        try {
+            $response = $this->client->request($method, $url, $options);
+            return json_decode($response->getBody()->getContents(), $this->response_associative);
+        } catch (GuzzleException $e) {
+            // Error handling
+            throw new \Exception('API request failed: ' . $e->getMessage());
+        }
+    }
+}

src/Config/Config.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Ay4t\RestClient\Config;
+
+class Config
+{
+	/**
+	 * The API key used for authentication.
+	 * @var string
+	 */
+	public $apiKey;
+
+
+	/**
+	 * The secret key used for authentication.
+	 * @var string
+	 */
+	public $secretKey;
+
+	/**
+	 * The base URL of the API endpoint.
+	 * @var string
+	 */
+	public $apiUrl;
+
+	private function validateParameters(string $apiKey, string $secretKey, string $apiUrl): bool
+	{
+	  if (empty($apiKey) || empty($secretKey) || empty($apiUrl)) {
+	        throw new \InvalidArgumentException('API key, secret key, dan API URL tidak boleh kosong');
+	    }
+	
+	    if (!is_string($apiKey) || !is_string($secretKey) || !is_string($apiUrl)) {
+	        throw new \InvalidArgumentException('Semua parameter harus berupa string');
+	    }
+	
+	    if (strlen($apiKey) < 10 || strlen($secretKey) < 10) {
+	        throw new \InvalidArgumentException('API key dan secret key harus memiliki panjang minimal 10 karakter');
+	    }
+	
+	    if (!preg_match('/^https?:\/\//', $apiUrl)) {
+	        throw new \InvalidArgumentException('API URL tidak valid');
+	    }
+	
+	    return true;
+	}
+	
+	public function __construct(string $apiKey, string $secretKey, string $apiUrl)
+	{
+	    if ($this->validateParameters($apiKey, $secretKey, $apiUrl)) {
+	        $this->apiKey = $apiKey;
+	        $this->secretKey = $secretKey;
+	        $this->apiUrl = $apiUrl;
+	    }
+	}
+
+}

src/Interfaces/ClientInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Ay4t\RestClient\Interfaces;
+
+interface ClientInterface
+{
+    /**
+     * @param string $command
+     * @param array $params
+     * @param string $method
+     * @return mixed
+     */
+    public function cmd(string $method = 'GET', string $command, array $params = []);
+}

src/Traits/RequestTrait.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Ay4t\RestClient\Traits;
+
+trait RequestTrait
+{
+    /**
+     * Set response to associative array or object
+     * @var boolean
+     */
+    protected $response_associative = true;
+
+    
+    /**
+     * Set response to associative array or object
+     * @param {boolean} value if true, response will be associative array or object
+     * @return {this} instance of class
+     */
+    public function setResponseAssociative(bool $value) : self
+    {
+        $this->response_associative = $value;
+        return $this;
+    }
+
+    public function prepareParams(array $params): string
+    {
+        return http_build_query($params);
+    }
+}

tests/ClientTest.php

@@ -0,0 +1,71 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Ay4t\RestClient\Client;
+use GuzzleHttp\Psr7\Request;
+use GuzzleHttp\Psr7\Response;
+use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Handler\CurlHandler;
+use GuzzleHttp\Handler\MockHandler;
+use GuzzleHttp\Exception\RequestException;
+use PHPUnit\Framework\TestCase;
+use Ay4t\RestClient\Abstracts\AbstractClient;
+use Ay4t\RestClient\Config\Config;
+use Ay4t\RestClient\Traits\RequestTrait;
+
+class ClientTest extends TestCase
+{
+    private $client;
+    private $mockHandler;
+    private $handlerStack;
+
+    /* api endpoint Ollama LLM */
+    private $base_url_test = 'http://127.0.0.1:8080';
+
+    /**
+    * __construct
+    * @return parent::__construct()
+    */
+    public function init()
+    {
+        $this->mockHandler  = new MockHandler();
+        $this->handlerStack = HandlerStack::create($this->mockHandler);
+
+        $config             = new Config('api_key_panjang_sampai_10_karakter', 'secret_key_panjang_sampai_10_karakter', $this->base_url_test);
+        $this->client       = new Client($config);
+    }
+
+
+    public function testCmdSuccessPostRequest()
+    {
+        $this->init();
+
+        // Test
+        $result = $this->client->cmd('POST', 'v1/chat/completions', [
+            'model' => 'llama3.2:latest',
+            'messages' => [
+                [
+                    'role' => 'user',
+                    'content'  => 'hi, why is sea water salty?',
+                ], [
+                    'role'  => 'system',
+                    'content' => 'You are a helpful assistant.',
+                ]
+            ],
+            'stream' => false,
+        ]);
+
+        // $llm_response = $result->choices[0]->message->content;
+        // $llm_response = $result;
+        print_r($result);
+
+        $llm_response = $result['choices'][0]['message']['content'];
+        print_r($llm_response);
+        
+        $this->assertTrue(!empty($llm_response));
+
+    }
+
+}

tests/ConfigTest.php

@@ -0,0 +1,85 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Ay4t\RestClient\Config\Config;
+use PHPUnit\Framework\TestCase;
+
+class ConfigTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganApiKeySekretKeyDanApiUrl()
+    {
+        $apiKey = '1234567890';
+        $secretKey = 'abcdefghij';
+        $apiUrl = 'https://example.com/api';
+
+        $config = new Config($apiKey, $secretKey, $apiUrl);
+
+        $this->assertEquals($apiKey, $config->apiKey);
+        $this->assertEquals($secretKey, $config->secretKey);
+        $this->assertEquals($apiUrl, $config->apiUrl);
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganApiKeyKosong()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('', 'abcdefghij', 'https://example.com/api');
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganSecretKeyKosong()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('1234567890', '', 'https://example.com/api');
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganApiUrlKosong()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('1234567890', 'abcdefghij', '');
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganApiKeyTidakValid()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('abc', 'abcdefghij', 'https://example.com/api');
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganSecretKeyTidakValid()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('1234567890', 'abc', 'https://example.com/api');
+    }
+
+    /**
+     * @test
+     */
+    public function testKonstruktorDenganApiUrlTidakValid()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new Config('1234567890', 'abcdefghij', 'abc');
+    }
+}