Merge pull request #1 from seatplus/develop

Version 0.9

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: seatplus

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
     - name: Ask a question
-      url: https://github.com/vendor_slug/package_slug/discussions/new?category=q-a
+      url: https://github.com/seatplus/esi-client/discussions/new?category=q-a
       about: Ask the community for help
     - name: Request a feature
-      url: https://github.com/vendor_slug/package_slug/discussions/new?category=ideas
+      url: https://github.com/seatplus/esi-client/discussions/new?category=ideas
       about: Share ideas for new features
     - name: Report a bug
-      url: https://github.com/vendor_slug/package_slug/issues/new
+      url: https://github.com/seatplus/esi-client/issues/new
       about: Report a reproducable bug

.github/SECURITY.md

@@ -1,3 +1,3 @@
 # Security Policy
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.

.github/workflows/run-tests.yml

@@ -2,9 +2,9 @@ name: Laravel
 
 on:
   push:
-    branches: [ main, dev ]
+    branches: [ main, develop ]
   pull_request:
-    branches: [ main, dev ]
+    branches: [ main, develop ]
 
 jobs:
   laravel:
@@ -26,10 +26,10 @@ jobs:
           redis-version: 6 # optional, default is latest, was 5
       - name: Install Dependencies
         run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
-#      - name: Test & publish code coverage
-#        uses: paambaati/[email protected]
-#        env:
-#          CC_TEST_REPORTER_ID: fe3081a529c6c268974ebebb2f0137c3b3f6351cdc8a2712d8eb86ec78f7bf22
-#        with:
-#          coverageCommand: vendor/bin/phpunit --coverage-clover build/logs/clover.xml
-#          debug: false
+      - name: Test & publish code coverage
+        uses: paambaati/[email protected]
+        env:
+          CC_TEST_REPORTER_ID: 55a033428e7f980c68f3fe5e8f335098915f318d06843848ad2070fef53e331e
+        with:
+          coverageCommand: vendor/bin/pest --coverage --min=85
+          debug: false

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `esi-client` will be documented in this file.
 
 ## 1.0.0 - 202X-XX-XX
 

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <[email protected]>
+Copyright (c) seatplus <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,62 +1,34 @@
-# :package_description
+# Esi-Client
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/vendor_slug/package_slug.svg?style=flat-square)](https://packagist.org/packages/vendor_slug/package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/vendor_slug/package_slug/run-tests?label=tests)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/vendor_slug/package_slug/Check%20&%20fix%20styling?label=code%20style)](https://github.com/vendor_slug/package_slug/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/vendor_slug/package_slug.svg?style=flat-square)](https://packagist.org/packages/vendor_slug/package_slug)
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/seatplus/esi-client.svg?style=flat-square)](https://packagist.org/packages/seatplus/esi-client)
+[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/seatplus/esi-client/run-tests?label=tests)](https://github.com/seatplus/esi-client/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/seatplus/esi-client/Check%20&%20fix%20styling?label=code%20style)](https://github.com/seatplus/esi-client/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/seatplus/esi-client.svg?style=flat-square)](https://packagist.org/packages/seatplus/esi-client)
 
----
-This repo can be used as to scaffold a Laravel package. Follow these steps to get started:
-
-1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
-2. Run "./configure-skeleton.sh" to run a script that will replace all placeholders throughout all the files
-3. Remove this block of text.
-4. Have fun creating your package.
-5. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+A standalone ESI (Eve Swagger Interface) Client Library using kevinrob/guzzle-cache-middleware.
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require vendor_slug/package_slug
+composer require seatplus/esi-client
 ```
 
-You can publish and run the migrations with:
 
-```bash
-php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
-```bash
-php artisan vendor:publish --provider="VendorName\Skeleton\SkeletonServiceProvider" --tag="package_slug-config"
-```
-
-This is the contents of the published config file:
+## Usage
 
 ```php
-return [
-];
-```
+$esi = new Seatplus\EsiClient\EsiClient();
 
-## Usage
+$esi->setVersion('v5'); // if you do not set a version, esi-client is using '/latest'
 
-```php
-$skeleton = new VendorName\Skeleton();
-echo $skeleton->echoPhrase('Hello, Spatie!');
+// make a call
+$character_info = $esi->invoke('get', '/characters/{character_id}/', [
+    'character_id' => 95725047,
+]);
+
+echo $character_info;
 ```
 
 ## Testing
@@ -71,6 +43,16 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
 
 ## Contributing
 
+As of today this esi client only supports Laravel Cache Middleware. However [`Kevinrob/guzzle-cache-middleware`](https://github.com/Kevinrob/guzzle-cache-middleware) supports various others such as:
+* Doctrine cache 
+* Laravel cache 
+* Flysystem 
+* PSR6 
+* WordPress Object Cache
+
+if you plan to use this client with any of these a proper CacheMiddleware would be needed.
+Same goes to the HTTP client. This client and its cache middleware had been designed to use with Guzzle7 (but you can use it with any PSR-7 HTTP client). Please submit your PR accordingly implementing other HTTP clients.
+
 Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities
@@ -79,7 +61,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Felix Huber](https://github.com/seatplus)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,40 +1,52 @@
 {
-    "name": "vendor_slug/package_slug",
-    "description": ":package_description",
+    "name": "seatplus/esi-client",
+    "description": "A standalone ESI (Eve Swagger Interface) Client Library using kevinrob/guzzle-cache-middleware",
     "keywords": [
-        ":vendor_name",
+        "seatplus",
+        "eve-online",
+        "eve online",
         "laravel",
-        "package_slug"
+        "esi",
+        "library",
+        "psr6",
+        "cache-control",
+        "rfc7234",
+        "cache"
     ],
-    "homepage": "https://github.com/vendor_slug/package_slug",
+    "homepage": "https://github.com/seatplus/esi-client",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "[email protected]",
+            "name": "Felix Huber",
+            "email": "[email protected]",
             "role": "Developer"
         }
     ],
     "require": {
         "php": "^8.0",
-        "seatplus/core": "^0.3",
-        "illuminate/contracts": "^8.37",
-      "seatplus/auth": "^0.8"
+        "ext-json": "*",
+        "firebase/php-jwt": "^5.4",
+        "kevinrob/guzzle-cache-middleware": "^3.4",
+        "nesbot/carbon": "^2.53",
+        "spatie/data-transfer-object": "^3.7"
     },
     "require-dev": {
+        "fzaninotto/faker": "^1.5",
+        "illuminate/cache": "^8.60",
+        "mockery/mockery": "^1.4",
         "nunomaduro/collision": "^5.3",
-        "orchestra/testbench": "^6.15",
-        "pestphp/pest-plugin-laravel": "^1.1"
+        "pestphp/pest-plugin-laravel": "^1.1",
+        "mikey179/vfsstream": "^1"
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src",
-            "VendorName\\Skeleton\\Database\\Factories\\": "database/factories"
+            "Seatplus\\EsiClient\\": "src",
+            "Seatplus\\EsiClient\\Database\\Factories\\": "database/factories"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests"
+            "Seatplus\\EsiClient\\Tests\\": "tests"
         }
     },
     "scripts": {
@@ -44,13 +56,6 @@
     "config": {
         "sort-packages": true
     },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "VendorName\\Skeleton\\SkeletonServiceProvider"
-            ]
-        }
-    },
     "minimum-stability": "dev",
     "prefer-stable": true
 }