update API to use 8.1 and up (#55)

* update API to use 8.1 and up

* add dependabot and update actions

* replace travis with github actions

* update README

Author: gerbenjacobs

.github/dependabot.yml

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

.github/workflows/php.yml

@@ -1,32 +1,31 @@
-name: PHP Composer
+name: PHP Test
 
 on:
   push:
-    branches: [master]
+    branches: [ master ]
   pull_request:
-    branches: [master]
+    branches: [ master ]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-
+  run:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ 'ubuntu-latest' ]
+        php-versions: [ '8.1', '8.2', '8.3']
+        phpunit-versions: [ 'latest' ]
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Validate composer.json and composer.lock
-        run: composer validate --strict
-
-      - name: Cache Composer packages
-        id: composer-cache
-        uses: actions/cache@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
         with:
-          path: vendor
-          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-php-
-
+          php-version: ${{ matrix.php-versions }}
+          extensions: json, curl
+          tools: phpunit:${{ matrix.phpunit-versions }}
       - name: Install dependencies
-        run: composer install --prefer-dist --no-progress
-
-      - name: Run test suite
-        run: composer run-script test
+        run: |
+          composer install --prefer-dist --no-interaction
+      - name: Execute tests
+        run: vendor/bin/phpunit

.travis.yml

@@ -1,9 +1,10 @@
-[![Build status](https://api.travis-ci.org/gerbenjacobs/HabboAPI.svg)](https://travis-ci.org/gerbenjacobs/HabboAPI)
+[![Build status](https://github.com/gerbenjacobs/HabboAPI/actions/workflows/php.yml/badge.svg)](https://github.com/gerbenjacobs/HabboAPI/actions/workflows/php.yml)
 [![Latest Stable Version](https://poser.pugx.org/gerbenjacobs/habbo-api/v/stable.svg)](https://packagist.org/packages/gerbenjacobs/habbo-api)
-[![Join the chat at https://gitter.im/gerbenjacobs/HabboAPI](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gerbenjacobs/HabboAPI) 
 # HabboAPI
 This PHP wrapper library is used to collect data from the _undocumented_ Habbo API.  
-The project requires PHP 7.3 or higher and uses the Composer autoloader and PSR-4 standard.
+The project requires PHP 8.1 or higher and uses the Composer autoloader and PSR-4 standard.
+
+Older versions for PHP 7.4 are available at [Packagist](https://packagist.org/packages/gerbenjacobs/habbo-api).
 
 See the `example.php` file on how you could use this library.
 
@@ -35,6 +36,7 @@ See the `example.php` file on how you could use this library.
 ```
 
 ## Changelog
+- April 30th, 2023 v6.0.0 - Fully support PHP 8.1 and up
 - December 29th, 2020 v5.0.0 - Add support for PHP 8 and drop support below PHP 7.3
 - December 18th, 2020 v4.1.0 - Adds "sandbox" as hotel, includes new values for `Habbo` entity; online, lastAccessTime, currentLevel, currentLevelCompleted, totalExperience, starGemCount
 - March 30th, 2020 v4.0.0 - Use Carbon 2.0 and drop support for PHP below 7.1.8
@@ -59,4 +61,4 @@ See the `example.php` file on how you could use this library.
 ## Developer Installation
 1. Clone the project
 2. Run `composer install`
-3. Verify the install by running `./vendor/bin/phpunit` or opening the `example.php` page on a PHP server
+3. Verify the installation by running `vendor/bin/phpunit` or opening the `example.php` page on a PHP server

README.md

@@ -17,8 +17,8 @@
     }
   ],
   "require": {
-    "php": ">=7.3",
-    "nesbot/carbon": "~2",
+    "php": ">=8.1",
+    "nesbot/carbon": "^2.66",
     "ext-json": "*",
     "ext-curl": "*"
   },
@@ -28,9 +28,9 @@
     }
   },
   "require-dev": {
-    "phpunit/phpunit": "9.5.*"
+    "phpunit/phpunit": "^10.1"
   },
   "scripts": {
     "test": "vendor/bin/phpunit"
   }
-}
+}

composer.json

@@ -4,8 +4,6 @@
 
 // Shortcut for the FQN
 use HabboAPI\Entities\Badge;
-use HabboAPI\Entities\Habbo;
-use HabboAPI\Entities\Photo;
 use HabboAPI\Entities\Profile;
 use HabboAPI\HabboAPI;
 use HabboAPI\HabboParser;
@@ -15,12 +13,12 @@
 $habboApi = new HabboAPI($habboParser);
 
 try {
-    // Find the user 'koeientemmer' and get their ID
-    $myHabbo = $habboApi->getHabbo('koeientemmer');
+    // Find the user 'Macklebee' and get their ID
+    $myHabbo = $habboApi->getHabbo('Macklebee');
 
     // Get extra information about one of their groups
     // Note: This is actually a hardcoded group ID to showcase the parseGroup() endpoint
-    $group = $habboApi->getGroup("g-hhus-b0751bd6408cc83a8e046de6949fd747");
+    $group = $habboApi->getGroup("g-hhus-0419705237d0e8c004195c365810e7a7");
 } catch (Exception $e) {
     echo '
         <p>Oops. Can not find this Habbo!</p>
@@ -34,7 +32,6 @@
 
 if ($myHabbo->hasProfile()) {
     // Collect all the profile info
-    /** @var Profile $myProfile */
     $myProfile = $habboApi->getProfile($myHabbo->getId());
 } else {
     // This Habbo has a closed home, only show their Habbo object
@@ -59,7 +56,6 @@
 
 // Some markup for the Habbo part
 
-/* @var Habbo $habbo */
 $habbo = $myProfile->getHabbo();
 $onlineText = $habbo->isOnline() ? "yes" : "no";
 $lastAccess = ($habbo->getLastAccessTime()) ? $habbo->getLastAccessTime()->toFormattedDateString() : "N/A";
@@ -107,7 +103,6 @@
 
 // Generate the photos
 if ($myPhotos) {
-    /** @var Photo $myPhoto */
     foreach ($myPhotos as $myPhoto) {
         $html['photos'] .= '
             <div class="col-md-3">
@@ -216,7 +211,7 @@
                                 </p>
 
                                 <?php $members = $group->getMembers();
-                                if (count((array)$members) > 0) : ?>
+                                if (count($members) > 0) : ?>
                                     <p>This group has <strong><?php echo count($group->getMembers()); ?></strong> members.
                                         Here are 10 random ones:</p>
 

example.php

@@ -2,41 +2,46 @@
 /**
  * The entity model for an Achievement object
  */
+
 namespace HabboAPI\Entities;
 
+use Carbon\Carbon;
+
 /**
  * Class Achievement
  *
  * @package HabboAPI\Entities
  */
 class Achievement implements Entity
 {
-    private $id, $name, $category;
-    private $requirements;
-    private $level, $score;
+    private string $id, $name, $category, $state;
+    private \DateTimeInterface $creationTime;
+    private int $level, $score;
 
     /**
      * Parses achievement info array to Achievement object
-     * @param $achievement
+     * @param $data
      */
-    public function parse($achievement)
+    public function parse($data): void
     {
         // add default fields
-        $this->id = $achievement['achievement']['id'];
-        $this->name = $achievement['achievement']['name'];
-        $this->category = $achievement['achievement']['category'];
+        $this->id = $data['achievement']['id'];
+        $this->name = $data['achievement']['name'];
+        $this->category = $data['achievement']['category'];
+        if (isset($data['achievement']['state'])) {
+            $this->state = $data['achievement']['state'];
+        }
 
-        // add requirements if available
-        if (isset($achievement['requirements'])) {
-            $this->requirements = $achievement['requirements'];
+        if (isset($data['achievement']['creationTime'])) {
+            $this->creationTime = Carbon::parse($data['achievement']['creationTime']);
         }
 
         // add user state if available
-        if (isset($achievement['level'])) {
-            $this->level = $achievement['level'];
+        if (isset($data['level'])) {
+            $this->level = $data['level'];
         }
-        if (isset($achievement['score'])) {
-            $this->score = $achievement['score'];
+        if (isset($data['score'])) {
+            $this->score = $data['score'];
         }
     }
 
@@ -45,51 +50,51 @@ public function __toString()
         return $this->getName();
     }
 
-    /**
-     * @return int
-     */
-    public function getId()
+
+    public function getId(): int|string
     {
         return $this->id;
     }
 
-    /**
-     * @return string
-     */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @return string
-     */
-    public function getCategory()
+    public function getCategory(): string
     {
         return $this->category;
     }
 
-    /**
-     * @return string
-     */
-    public function getLevel()
+    public function getLevel(): int
     {
         return $this->level;
     }
 
-    /**
-     * @return string
-     */
-    public function getScore()
+
+    public function getScore(): int
     {
         return $this->score;
     }
 
-    /**
-     * @return array
-     */
-    public function getRequirements()
+
+    public function getState(): string
+    {
+        return $this->state;
+    }
+
+    public function setState(string $state): void
+    {
+        $this->state = $state;
+    }
+
+    public function getCreationTime(): \DateTimeInterface
+    {
+        return $this->creationTime;
+    }
+
+    public function setCreationTime(\DateTimeInterface $creationTime): void
     {
-        return $this->requirements;
+        $this->creationTime = $creationTime;
     }
 }