Init #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

TorstenDittmann merged 32 commits into utopia-php:main from sahilsaha7773:main

Oct 10, 2023

.github/workflows/codeql-analysis.yml

-Original file line number
+Diff line change
@@ -0,0 +1,21 @@
+    name: "CodeQL"
+    on: [ pull_request ]
+    jobs:
+      lint:
+        name: CodeQL
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout repository
+            uses: actions/checkout@v3
+            with:
+              fetch-depth: 2
+          - run: git checkout HEAD^2
+          - name: Install dependencies
+            run: composer install --profile --ignore-platform-reqs
+          - name: Run CodeQL
+            run: composer check

.github/workflows/linter.yml

-Original file line number
+Diff line change
@@ -0,0 +1,21 @@
+    name: "Linter"
+    on: [ pull_request ]
+    jobs:
+      lint:
+        name: Linter
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout repository
+            uses: actions/checkout@v3
+            with:
+              fetch-depth: 2
+          - run: git checkout HEAD^2
+          - name: Install dependencies
+            run: composer install --profile --ignore-platform-reqs
+          - name: Run Linter
+            run: composer lint

.github/workflows/tests.yml

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    name: "Tests"
+    on: [ pull_request ]
+    jobs:
+      lint:
+        name: Tests
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout repository
+            uses: actions/checkout@v3
+            with:
+              fetch-depth: 2
+          - run: git checkout HEAD^2
+          - name: Install dependencies
+            run: composer install --profile --ignore-platform-reqs
+          - name: Run Tests
+            run: php -S localhost:8000 tests/router.php &
+              composer test

.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    vendor
+    *.cache
+    composer.lock

README.md

-Original file line number
+Diff line change
@@ -0,0 +1,113 @@
+    # Utopia Fetch
+    Lite & fast micro PHP library that provides a convenient and flexible way to perform HTTP requests in PHP applications.
+    # Usage
+    The library provides a static method `Client::fetch()` that returns a `Response` object.
+    The `Client::fetch()` method accepts the following parameters:
+    - `url` - A **String** containing the URL to which the request is sent.
+    - `method` - A **String** containing the HTTP method for the request. The default method is `GET`.
+    - `headers` - An **associative array** of HTTP headers to send.
+    - `body` - An **associative array** of data to send as the body of the request.
+    - `query` - An **associative array** of query parameters.
+    - `timeout` - An **integer** representing the maximum number of seconds to allow cURL functions to execute, the default is `15`.
+    The `Response` object has the following methods:
+    - `isOk()` - Returns **true** if the response status code is in the range 200-299, **false** otherwise.
+    - `getBody()` - Returns the response body as a **String**.
+    - `getHeaders()` - Returns an **associative array** of response headers.
+    - `getStatusCode()` - Returns the response status code as an **integer**.
+    - `getMethod()` - Returns the request method as a **String**.
+    - `getUrl()` - Returns the request URL as a **String**.
+    - `text()` - Returns the response body as a **String**.
+    - `json()` - Returns the response body as an **associative array**.
+    - `blob()` - Converts the response body to blob and return it as a **String**.
+    ## Examples
+    ### GET request
+    ```php
+    <?php
+    require_once __DIR__ . '/vendor/autoload.php';
+    use Utopia\Fetch\Client;
+    $url = 'https://httpbin.org/get';
+    $method = 'GET';
+    $query = [
+      'foo' => 'bar'
+    ];
+    $resp = Client::fetch(
+      url: $url,
+      method: $method,
+      query: $query
+    );
+    if($resp->isOk()) {
+      print("Status Code: " . $resp->getStatusCode() . "\n");
+      print("Response Headers:\n");
+      print_r($resp->getHeaders());
+      print("Response Body:\n");
+      print($resp->getBody());
+    }
+    else {
+      print("Error: " . $resp->getStatusCode() . "\n");
+      print("Response Headers:\n");
+      print_r($resp->getHeaders());
+      print("Response Body:\n");
+      print($resp->getBody());
+    }
+    ```
+    ### POST request
+    ```php
+    <?php
+    require_once __DIR__ . '/vendor/autoload.php';
+    use Utopia\Fetch\Client;
+    $url = 'https://httpbin.org/post';
+    $method = 'POST';
+    $headers = [
+      'Content-Type' => 'application/json',
+    ];
+    $body = [
+      'name' => 'John Doe',
+    ];
+    $query = [
+      'foo' => 'bar'
+    ];
+    $resp = Client::fetch(
+      url: $url,
+      method: $method,
+      headers: $headers,
+      body: $body,
+      query: $query
+    );
+    print_r($resp->json());
+    ```
+    ### Send a file
+    ```php
+    <?php
+    require_once __DIR__ . '/vendor/autoload.php';
+    use Utopia\Fetch\Client;
+    $url = 'http://localhost:8000';
+    $method = 'POST';
+    $headers = [
+      'Content-Type' => 'application/json',
+    ];
+    $filePath = strval(realpath(__DIR__ . '/tests/resources/logo.png')); // Absolute path to the file
+    $body = [
+        'file' => new \CURLFile($filePath, 'image/png', 'logo.png')
+    ];
+    $resp = Client::fetch(
+      url: $url,
+      method: $method,
+      headers: $headers,
+      body: $body
+    );
+    print_r($resp->json());
+    ```

composer.json

-Original file line number
+Diff line change
@@ -0,0 +1,26 @@
+    {
+        "name": "utopia-php/fetch",
+        "description": "A simple library that provides an interface for making HTTP Requests.",
+        "type": "library",
+        "license": "MIT",
+        "require": {
+            "php": ">=8.0"
+        },
+        "require-dev": {
+            "phpunit/phpunit": "^9.5",
+            "laravel/pint": "^1.5.0",
+            "phpstan/phpstan": "^1.10"
+        },
+        "scripts": {
+            "lint": "./vendor/bin/pint --test --config pint.json",
+            "format": "./vendor/bin/pint --config pint.json",
+            "check": "./vendor/bin/phpstan analyse -c phpstan.neon",
+            "test": "./vendor/bin/phpunit --configuration phpunit.xml --debug"
+        },
+        "autoload": {
+            "psr-4": {
+                "Utopia\\Fetch\\": "src/"
+            }
+        },
+        "authors": []
+    }

phpstan.neon

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    parameters:
+    	level: 8
+    	paths:
+    		- src
+    		- tests

phpunit.xml

-Original file line number
+Diff line change
@@ -0,0 +1,16 @@
+    <phpunit backupGlobals="false"
+             backupStaticAttributes="false"
+             bootstrap="vendor/autoload.php"
+             colors="true"
+             convertErrorsToExceptions="true"
+             convertNoticesToExceptions="true"
+             convertWarningsToExceptions="true"
+             processIsolation="false"
+             stopOnFailure="false"
+            >
+        <testsuites>
+            <testsuite name="Application Test Suite">
+                <directory>./tests/</directory>
+            </testsuite>
+        </testsuites>
+    </phpunit>

pint.json

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    {
+      "preset": "psr12"
+    }

src/Client.php

-Original file line number
+Diff line change
@@ -0,0 +1,130 @@
+    <?php
+    namespace Utopia\Fetch;
+    /**
+     * Client class
+     * @package Utopia\Fetch
+     */
+    class Client
+    {
+        public const METHOD_GET = 'GET';
+        public const METHOD_POST = 'POST';
+        public const METHOD_PUT = 'PUT';
+        public const METHOD_PATCH = 'PATCH';
+        public const METHOD_DELETE = 'DELETE';
+        public const METHOD_HEAD = 'HEAD';
+        public const METHOD_OPTIONS = 'OPTIONS';
+        public const METHOD_CONNECT = 'CONNECT';
+        public const METHOD_TRACE = 'TRACE';
+        public const CONTENT_TYPE_APPLICATION_JSON = 'application/json';
+        public const CONTENT_TYPE_APPLICATION_FORM_URLENCODED = 'application/x-www-form-urlencoded';
+        public const CONTENT_TYPE_MULTIPART_FORM_DATA = 'multipart/form-data';
+        public const CONTENT_TYPE_GRAPHQL = 'application/graphql';
+        /**
+         * Flatten request body array to PHP multiple format
+         *
+         * @param array<mixed> $data
+         * @param string $prefix
+         * @return array<mixed>
+         */
+        private static function flatten(array $data, string $prefix = ''): array
+        {
+            $output = [];
+            foreach ($data as $key => $value) {
+                $finalKey = $prefix ? "{$prefix}[{$key}]" : $key;
+                if (is_array($value)) {
+                    $output += self::flatten($value, $finalKey); // @todo: handle name collision here if needed
+                } else {
+                    $output[$finalKey] = $value;
+                }
+            }
+            return $output;
+        }
+        /**
+         * This method is used to make a request to the server
+         * @param string $url
+         * @param array<string, string> $headers
+         * @param string $method
+         * @param array<string>|array<string, mixed> $body
+         * @param array<string, mixed> $query
+         * @param int $timeout
+         * @return Response
+         */
+        public static function fetch(
+            string $url,
+            array $headers = [],
+            string $method = self::METHOD_GET,
+            array $body = [],
+            array $query = [],
+            int $timeout = 15
+        ): Response {
+            // Process the data before making the request
+            if (!in_array($method, [self::METHOD_PATCH, self::METHOD_GET, self::METHOD_CONNECT, self::METHOD_DELETE, self::METHOD_POST, self::METHOD_HEAD, self::METHOD_OPTIONS, self::METHOD_PUT, self::METHOD_TRACE ])) { // If the method is not supported
+                throw new FetchException("Unsupported HTTP method");
+            }
+            if(isset($headers['content-type'])) {
+                match ($headers['content-type']) { // Convert the body to the appropriate format
+                    self::CONTENT_TYPE_APPLICATION_JSON => $body = json_encode($body),
+                    self::CONTENT_TYPE_APPLICATION_FORM_URLENCODED, self::CONTENT_TYPE_MULTIPART_FORM_DATA => $body = self::flatten($body),
+                    self::CONTENT_TYPE_GRAPHQL => $body = $body[0],
+                    default => $body = $body,
+                };
+            }
+            $headers = array_map(function ($i, $header) { // convert headers to appropriate format
+                return $i . ':' . $header;
+            }, array_keys($headers), $headers);
+            if($query) {  // if the request has a query string, append it to the request URI
+                $url = rtrim($url, '?');
+                $url .= '?' . http_build_query($query);
+            }
+            $responseHeaders = [];
+            // Initialize the curl session
+            $ch = curl_init();
+            // Set the request URI
+            curl_setopt($ch, CURLOPT_URL, $url);
+            // Set the request headers
+            curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
+            // Set the request method
+            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
+            // Set the request body
+            curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
+            // Save the response headers
+            curl_setopt($ch, CURLOPT_HEADERFUNCTION, function ($curl, $header) use (&$responseHeaders) {
+                $len = strlen($header);
+                $header = explode(':', $header, 2);
+                if (count($header) < 2) { // ignore invalid headers
+                    return $len;
+                }
+                $responseHeaders[strtolower(trim($header[0]))] = trim($header[1]);
+                return $len;
+            });
+            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 60);
+            curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
+            curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+            $responseBody = curl_exec($ch); // Execute the curl session
+            $responseStatusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+            if (curl_errno($ch)) {
+                $errorMsg = curl_error($ch);
+            }
+            curl_close($ch);
+            if (isset($errorMsg)) {
+                throw new FetchException($errorMsg);
+            }
+            $response = new Response(
+                statusCode: $responseStatusCode,
+                headers: $responseHeaders,
+                body: $responseBody
+            );
+            return $response;
+        }
+    }

src/FetchException.php

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    <?php
+    namespace Utopia\Fetch;
+    class FetchException extends \Exception
+    {
+        /**
+         * Constructor
+         * @param string $message
+         */
+        public function __construct($message)
+        {
+            parent::__construct($message); // Call the parent constructor
+        }
+        public function __toString()
+        {
+            return __CLASS__ . " {$this->message}\n"; // Return the class name, code and message
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Init #1

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!