Merge pull request #1 from APIstax/develop

Release 1.0.0

Author: andlinger

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: composer
+    directory: "/"
+    schedule:
+      interval: weekly

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+on:
+  - push
+
+name: Test
+
+jobs:
+  run:
+    name: Tests
+
+    strategy:
+      matrix:
+        php-versions: ['7.3', '7.4', '8.0', '8.1']
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: sockets, json, curl
+
+      - name: Install dependencies with composer
+        run: composer install
+
+      - name: Test with phpunit
+        run: vendor/bin/phpunit

.gitignore

@@ -134,4 +134,5 @@ Temporary Items
 
 .openapi-generator
 gen
-/composer.lock
+composer.lock
+.phpunit.result.cache

README.md

@@ -1,7 +1,34 @@
 # APIstax PHP Client
 
-[![Latest Version](https://img.shields.io/github/release/apistax/client-php.svg?style=flat-square)](https://github.com/apistax/client-php/releases)
+[![Latest Version](https://img.shields.io/github/v/tag/apistax/client-php?label=Latest%20Version)](https://packagist.org/packages/apistax/client)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
+APIstax PHP client is a complete PHP client implementation for the [APIstax](https://apistax.io?utm_source=github&utm_medium=apistax-php-client&utm_campaign=readme) platform.
+
+## Usage
+
+Install the latest version:
+
+```bash
+composer require 'apistax/client'
+```
+
+Get your APIstax API key [here](https://app.apistax.io/api-keys?utm_source=github&utm_medium=apistax-php-client&utm_campaign=readme).
+
+Initialise an `APIstaxClient` and start using it.
+
+```php
+<?php
+
+$config = new \APIstax\Configuration();
+$config->setApiKey("API_KEY");
+
+$client = new \APIstax\APIstaxClient($config);
+
+$payload = new \APIstax\Models\VatVerificationPayload();
+$payload->setVatId("VAT_ID");
+
+$result = $this->client->verifyVatId($payload);
+```
 
 The further information and documentation about the APIs can be found on [APIstax documentation](https://apistax.io/docs?utm_source=github&utm_medium=apistax-php-client&utm_campaign=readme) page.

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "apistax/client",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Secure and reliable APIs for your common business needs.",
   "type": "library",
   "keywords": [
@@ -34,6 +34,10 @@
     "guzzlehttp/guzzle": "^7.3",
     "guzzlehttp/psr7": "^1.7 || ^2.0"
   },
+  "require-dev": {
+    "phpunit/phpunit": "^9",
+    "donatj/mock-webserver": "^v2.5.0"
+  },
   "autoload": {
     "psr-4": {
       "APIstax\\": "lib/"

lib/APIstaxClient.php

@@ -20,22 +20,25 @@
 
 class APIstaxClient
 {
-    private const baseUrl = "https://api.apistax.io";
-
     /**
      * @var ClientInterface
      */
     private $client;
 
     /**
-     * @var string
+     * @var Configuration
      */
-    private $apiKey;
+    private $configuration;
 
-    public function __construct(string $apiKey)
+    public function __construct(Configuration $configuration = null)
     {
         $this->client = new Client();
-        $this->apiKey = $apiKey;
+
+        if($configuration === null) {
+            $this->configuration = Configuration::getDefaultConfiguration();
+        } else {
+            $this->configuration = $configuration;
+        }
     }
 
     /**
@@ -87,7 +90,7 @@ public function verifyVatId(VatVerificationPayload $payload): VatVerificationRes
      */
     public function geocodeSearch(GeocodeSearchPayload $payload): ?GeocodeResult
     {
-        return $this->requestJson("/v1/geocode/search", $payload, null, "\APIstax\Models\GeocodeSearchPayload");
+        return $this->requestJson("/v1/geocode/search", $payload, null, "\APIstax\Models\GeocodeResult");
     }
 
     /**
@@ -100,7 +103,7 @@ public function geocodeSearch(GeocodeSearchPayload $payload): ?GeocodeResult
      */
     public function geocodeReverse(GeocodeReversePayload $payload): ?GeocodeResult
     {
-        return $this->requestJson("/v1/geocode/reverse", $payload, null, "\APIstax\Models\GeocodeReversePayload");
+        return $this->requestJson("/v1/geocode/reverse", $payload, null, "\APIstax\Models\GeocodeResult");
     }
 
     /**
@@ -147,7 +150,7 @@ private function requestJson(string $path, $body, $query, string $type): ModelIn
      */
     private function request(string $path, $body, $query = null): ResponseInterface
     {
-        $url = self::baseUrl . $path;
+        $url = $this->configuration->getHost() . $path;
         $options = $this->createRequestOptions($body, $query);
 
         try {
@@ -176,8 +179,9 @@ private function createRequestOptions($body, $query): array
             'headers' => [
                 'User-Agent' => 'apistax-php-client',
                 'Content-Type' => 'application/json',
-                'Authorization' => 'Bearer ' . $this->apiKey
-            ]
+                'Authorization' => 'Bearer ' . $this->configuration->getApiKey()
+            ],
+            'http_errors' => false
         ];
 
         if (isset($query)) {