v2.0

Author: selviler

README.md

@@ -9,20 +9,16 @@
 This package provides a convenient wrapper to the [Cuttly API](https://cutt.ly/api-documentation/regular-api)  for Laravel applications.
 
 ## Requirements
-
-- PHP 8.0+
-- Laravel 9.x
+- PHP 8.1
+- Laravel 9.x | 10.x
 
 ## Installation
-
 To install this package tou can use composer:
-
 ```bash
 composer require slvler/cuttly
 ```
 
 ## Usage
-
 #### Find player
 ```php
 $data['short'] = 'google.com';
@@ -88,17 +84,14 @@ URL Stats:
 ```
 
 ## Testing
-
 ```bash
 composer test
 ```
 
 ## Credits
-
 - [slvler](https://github.com/slvler)
 
 ## License
-
 The MIT License (MIT). Please see [License File](https://github.com/slvler/balldontlie-service/blob/main/LICENSE.md) for more information.
 
 ## Contributing

composer.json

@@ -16,14 +16,15 @@
         }
     ],
     "require": {
-        "php": "^8.0.2",
+        "php": "^8.1",
         "guzzlehttp/guzzle": "^7.2",
-        "illuminate/support": "^9.0"
+        "illuminate/support": "^9.0|^10.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.6",
         "orchestra/testbench": "^7.0",
-        "phpunit/phpunit": "^9.5.8"
+        "phpunit/phpunit": "^9.5.8",
+        "laravel/pint": "^1.18"
     },
     "autoload": {
         "psr-4": {
@@ -37,6 +38,7 @@
     },
     "scripts": {
         "test": "vendor/bin/phpunit tests",
+        "pint": "vendor/bin/pint",
         "post-create-project-cmd": [
             "@php artisan key:generate --ansi"
         ]

config/cuttly.php

@@ -2,5 +2,5 @@
 
 return [
     'base_uri' => 'https://cutt.ly/api/api.php',
-    'api_key' => 'xxxxxxxxxxxxxxxxx'
+    'api_key' => '',
 ];

src/Cuttly.php

@@ -1,24 +1,34 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Slvler\Cuttly;
 
 use Illuminate\Contracts\Container\Container;
-
+use InvalidArgumentException;
+use Slvler\Cuttly\Exceptions\MissingApiKey;
 
 class Cuttly extends CuttlyApiWrapper
 {
     public array $data;
 
     public function __construct(Container $app)
     {
-        parent::__construct(
-            [
-                'base_uri' => $app['config']->get('cuttly.base_uri')
-            ]
-        );
+        $apiKey = $app['config']->get('cuttly.api_key');
+
+        if (empty($apiKey) || ! isset($apiKey)) {
+            throw MissingApiKey::create();
+        }
+
+        $baseURL = $app['config']->get('cuttly.api_key');
+
+        if (empty($baseURL) || ! isset($baseURL)) {
+            throw new InvalidArgumentException('Invalid Cuttly API base URL.');
+        }
 
-        $this->key = $app['config']->get('cuttly.api_key');
+        parent::__construct($baseURL);
 
+        $this->key = $apiKey;
     }
 
     public function short(array $data): string
@@ -28,8 +38,9 @@ public function short(array $data): string
         $this->data['short'] = urlencode($data['short']);
         $sendData = http_build_query($this->data);
 
-        $response = $this->getHttpClient()->request('GET','?'.$sendData);
-        $value =  new HttpResponse($response);
+        $response = $this->getHttpClient()->request('GET', '?'.$sendData);
+        $value = new HttpResponse($response);
+
         return $value->getBody();
     }
 
@@ -40,22 +51,22 @@ public function edit(array $data): string
         $this->data['edit'] = $data['edit'];
         $sendData = http_build_query($this->data);
 
-        $response = $this->getHttpClient()->request('GET','?'.$sendData);
-        $value =  new HttpResponse($response);
+        $response = $this->getHttpClient()->request('GET', '?'.$sendData);
+        $value = new HttpResponse($response);
+
         return $value->getBody();
     }
 
-
     public function stats(array $data): string
     {
         $this->data = $data;
         $this->data['key'] = $this->key;
         $this->data['stats'] = $data['stats'];
         $sendData = http_build_query($this->data);
 
-        $response = $this->getHttpClient()->request('GET','?'.$sendData);
-        $value =  new HttpResponse($response);
+        $response = $this->getHttpClient()->request('GET', '?'.$sendData);
+        $value = new HttpResponse($response);
+
         return $value->getBody();
     }
-
 }

src/CuttlyApiWrapper.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Slvler\Cuttly;
 
 use GuzzleHttp\Client;
@@ -8,10 +10,11 @@ class CuttlyApiWrapper
 {
     private Client $httpClient;
 
-    public function __construct(array $parameters)
+    public function __construct($baseUrl)
     {
-        $this->httpClient = new Client(
-            ['base_uri' => $parameters['base_uri']]
+        $this->httpClient = new Client([
+            'base_uri' => $baseUrl,
+        ]
         );
     }
 

src/CuttlyServiceProvider.php

@@ -1,12 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Slvler\Cuttly;
 
-use Illuminate\Support\Facades\Http;
-use Illuminate\Support\ServiceProvider;
 use Illuminate\Contracts\Container\Container;
-
-
+use Illuminate\Support\ServiceProvider;
 
 class CuttlyServiceProvider extends ServiceProvider
 {
@@ -18,6 +17,7 @@ public function boot()
             ], 'config');
         }
     }
+
     public function register()
     {
         $this->mergeConfigFrom(__DIR__.'/../config/cuttly.php', 'cuttly');

src/Exceptions/MissingApiKey.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Slvler\Cuttly\Exceptions;
+
+use InvalidArgumentException;
+
+/**
+ * @internal
+ */
+class MissingApiKey extends InvalidArgumentException
+{
+    public static function create(): self
+    {
+        return new self(
+            'The Cuttly API Key is missing. Please publish the [cuttly.php] configuration file and set the [api_key].'
+        );
+    }
+}

src/Facades/Cuttly.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Slvler\Cuttly\Facades;
 
 use Illuminate\Support\Facades\Facade;

src/HttpResponse.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Slvler\Cuttly;
 
 class HttpResponse
@@ -13,13 +15,13 @@ public function __construct($response)
 
     public function getBody(): string
     {
-        return (string)$this->response->getBody();
+        return (string) $this->response->getBody();
     }
 
     public function toObject(): object
     {
-        $body = (string)$this->response->getBody();
+        $body = (string) $this->response->getBody();
 
-        return json_decode($body) ?? (object)[];
+        return json_decode($body) ?? (object) [];
     }
 }

tests/Feature/CuttlyTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Slvler\Cuttly\Tests\Feature;
 
 use Illuminate\Support\Facades\Config;
@@ -14,9 +13,9 @@ public function setUp(): void
         parent::setUp();
 
         Config::set([
-                'cuttly.base_uri' => 'https://cutt.ly/api/api.php',
-                'cuttly.api_key' => 'b4fa4f9976b41cbc0c9880c444fce27a28984',
-            ]);
+            'cuttly.base_uri' => 'https://cutt.ly/api/api.php',
+            'cuttly.api_key' => '',
+        ]);
     }
 
     /**
@@ -25,27 +24,29 @@ public function setUp(): void
     public function test_short()
     {
         $data = [
-            'short' => 'google.com'
+            'short' => 'google.com',
         ];
         $this->assertIsString(Cuttly::short($data));
     }
+
     /**
      * @test
      */
     public function test_edit()
     {
         $data = [
-            'edit' => 'cutt.ly/LwdCoBmo'
+            'edit' => 'cutt.ly/LwdCoBmo',
         ];
         $this->assertIsString(Cuttly::edit($data));
     }
+
     /**
      * @test
      */
     public function test_stast()
     {
         $data = [
-            'stats' => 'cutt.ly/ewdVijlY'
+            'stats' => 'cutt.ly/ewdVijlY',
         ];
         $this->assertIsString(Cuttly::stats($data));
     }