Merge pull request #3 from teamreflex/2.x

2.0

Author: xKairu

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: true
+            matrix:
+                php: [ 7.4 ]
+                dependency-version: [prefer-lowest, prefer-stable]
+
+        name: PHP ${{ matrix.php }} - ${{ matrix.dependency-version }}
+
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v1
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v1
+                with:
+                    php-version: ${{ matrix.php }}
+                    extensions: mbstring, sqlite, pdo_sqlite, iconv
+                    coverage: none
+
+            -   name: Cache dependencies
+                uses: actions/cache@v1
+                with:
+                    path: ~/.composer/cache/files
+                    key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+            -   name: Install dependencies
+                run: |
+                    composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+
+            -   name: Execute tests
+                run: vendor/bin/phpunit

.gitignore

@@ -1,7 +1,4 @@
-ChallongePHP.sublime-project
-ChallongePHP.sublime-workspace
-/vendor/
-
-composer.lock
-
-index.php
+/vendor
+/.idea
+/.phpunit.cache
+.phpunit.result.cache

README.md

@@ -1,9 +1,57 @@
 # ChallongePHP
-Package for interfacing with the [Challonge] API.
 
-You can find basic documentation in the wiki: https://github.com/teamreflex/ChallongePHP/wiki
+![Test](https://github.com/teamreflex/ChallongePHP/workflows/Test/badge.svg?branch=master)
+[![Latest Version](https://img.shields.io/packagist/v/team-reflex/challonge-php.svg)](https://packagist.org/packages/team-reflex/challonge-php)
+[![Downloads](https://img.shields.io/packagist/dt/team-reflex/challonge-php.svg)](https://packagist.org/packages/team-reflex/challonge-php)
 
-- [team-reflex.com](https://team-reflex.com)
+PSR-18 compliant package for interfacing with the [Challonge] API.
+
+## Installation
+Requires PHP 7.4 as it takes advantage of its type support.
+
+Install via composer:
+
+```bash
+composer require team-reflex/challonge-php
+```
+
+## Usage
+As the package is PSR-18 compliant, it does not come with an HTTP client by default.
+
+You can use a client such as Guzzle, and pass an instance of it when instantiating:
+
+```bash
+$http = new GuzzleHttp\Client();
+$challonge = new Challonge($http, 'api_key_here', true);
+```
+
+By default, the package maps the keys of any input, as Challonge requires its input to be in a format such as:
+
+```bash
+$tournament = $challonge->createTournament([
+    'tournament[name]' => 'test'
+]);
+```
+
+Which means you are able to use the package without prefixing your keys:
+
+```bash
+$tournament = $challonge->createTournament([
+    'name' => 'test'
+]);
+```
+
+You can change the third argument to `false` to disable this mapping if you would prefer to do it yourself.
+
+Now you're ready to make requests:
+
+```bash
+$tournament = $challonge->fetchTournament('challongephptest');
+```
+
+As the package is fully type-hinted, everything should be self documenting, however there is documentation in the wiki.
+
+## Contact
 - [@Reflexgg](http://twitter.com/Reflexgg)
 - [@Kairuxo](http://twitter.com/Kairuxo)
 

composer.json

@@ -1,8 +1,16 @@
 {
     "name": "team-reflex/challonge-php",
-    "description": "Unofficial API to interface with the bracket generator Challonge.",
+    "description": "PSR-18 compatible library to interface with the bracket generator Challonge.",
     "require": {
-        "guzzlehttp/guzzle": "^6.0"
+        "ext-json": "*",
+        "php": "^7.4",
+        "psr/http-client": "^1.0",
+        "illuminate/collections": "~8.0 | ~7.0 | ~6.0",
+        "spatie/data-transfer-object": "^2.5"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.4",
+        "guzzlehttp/guzzle": "^7.2"
     },
     "license": "MIT",
     "authors": [
@@ -15,5 +23,13 @@
         "psr-4": {
             "Reflex\\Challonge\\": "src/Challonge"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
     }
 }