joestrong / retroachievements-composer Goto Github PK

View Code? Open in Web Editor NEW

7.0 2.0 7.0 28 KB

PHP API wrapper for RetroAchievements.org

PHP 100.00%

retroachievements retro achievements

retroachievements-composer's Introduction

RetroAchievements composer package

Install with:

composer require joestrong/retroachievements

Use in a project:

require_once('../vendor/autoload.php');

use JoeStrong\RetroAchievements\RetroAchievements;

$ra = new RetroAchievements($username, $apiKey);
$users = $ra->getTopTenUsers();

foreach ($users as $user) {
    echo "$user->username<br>";
}

Methods

Auth with the API

$ra = new RetroAchievements($username, $apiKey);

Get the top 10 users

$ra->getTopTenUsers();

Get the consoles

$ra->getConsoles();

Get games for console

$ra->getGamesForConsole($consoleId);

Get game info

$ra->getGameInfo($gameId);

Contributing

See CONTRIBUTING.md

retroachievements-composer's People

Contributors

Stargazers

Watchers

Forkers

walecloud supun94 royalmitten malise-obert mannion007 mostertb 4lexkidd

retroachievements-composer's Issues

Add composer.lock to gitignore

Composer.lock is being tracked by git, this file is generated when composer is installed/updated and should be in the project and not tracket by git.

Add a line in .gitignore file to remove the composer.lock from git track

Add PHPCS-FIXER

Would like to use this to help conform to PSR-2

Add nicer tests

The current tests aren't doing much

Mainly the API endpoint needs to be mocked so the endpoint isn't a part of the test

I'm happy for phpspec to be replaced by phpunit etc

What about strict types?

<?php
declare(strict_types=1);
...

http://php.net/manual/en/control-structures.declare.php

Security Disclosure to CONTRIBUTING.md

Eg. like this https://github.com/tarlepp/symfony-backend/blob/master/.github/CONTRIBUTING.md#security-disclosure

Issue template

Eg. like https://github.com/tarlepp/symfony-backend/blob/master/.github/ISSUE_TEMPLATE.md

Generate docs

It would be nice to create some docs for interacting with this library

It would be nice to use https://apiblueprint.org format

Add CONTRIBUTING.md

Important contents for the CONTRIBUTING.md:

Creating a new branch off of the develop branch
All changes to the code should have appropriate unit tests
All code should match PSR-2 style
Submit a pull request againt develop as the base branch
All travis checks will need to pass

Official RetroAchievements Web API Client

Hey there,
I'm just about to set up the repository and composer package for an official RetroAchievements Web API Client.

Reason for this happening is that there will be a new V2 API at some point and I want to make sure the process of upgrading to the new web api will be as streamlined as possible for any existing projects.

The initial plan was to just push the currently downloadable client class file as is (properly named though), release it as 1.0 and proceed with the implementation of new client versions.
(http://retroachievements.org/GetRA_API.php)

As I was made aware of this project and getting the impression that it has a proper setup altogether, I wondered if you'd be interested in moving/allowing to mirror the current setup to said repository (https://github.com/RetroAchievements/RAWebApiClientPHP) to stand as the current V1 PHP client implementation but also as the basis for the newer versions.

Appropriate mentions of source and contributors are implied.

Automated tests
PHPCS-Fixer integration