tuneefy 2

A new version of tuneefy built for PHP 8 and Node 18+, from the ground up, using Symfony and a few helper libraries.

Installing

This project uses composer 2. Just run :

composer install

Creating tables

Tuneefy needs a variety of tables to work properly; you can populate your database with the following :

bin/console doctrine:migrations:migrate

Building assets & API doc

To build the assets and the API documentation, I use yarn and some modules.

yarn install

yarn run build
yarn run api-documentation

Tests

The tests are under the ./tests folder and I use Codeception to run them.

Unit tests

Codeception reads its parameters from .env.test.local, so create it first (even empty):

touch .env.test.local
vendor/bin/codecept run Unit

Acceptance and Api tests, locally

The Acceptance suite drives the website and the Api suite the API, both served by a local test server in the test environment (database tuneefy_test, OAuth client test_id).

One-time setup, with a MariaDB reachable through the DATABASE_URL of .env:

php bin/console doctrine:database:create --env=test --if-not-exists
php bin/console doctrine:migrations:migrate --env=test -n
php bin/console league:oauth2-server:generate-keypair --env=test
php bin/console league:oauth2-server:create-client --env=test "Test client" test_id test_secret --grant-type client_credentials --scope api

The Api suite queries the real music platforms: put the platform credentials (from the server's .env.local) in .env.test.local, which is git-ignored, to test in real conditions.

Then start the test server (the website is routed on localhost, the API on 127.0.0.1):

APP_ENV=test php -d variables_order=EGPCS -S 127.0.0.1:9999 -t public

and run the suites:

vendor/bin/codecept run --steps

The Api tests that need no platform credentials are in the offline group (vendor/bin/codecept run Api -g offline): the CI runs them on every push.

Sometimes a platform fails to respond correctly due to network latencies or such. Re-run the tests in this case, it should pass fine the second time.

Api tests against production

The GitHub Actions workflow runs the Api suite against the production API every day. To do the same by hand, put the production test client credentials in .env.test.local (TEST_API_CLIENT_ID, TEST_API_CLIENT_SECRET) and run:

vendor/bin/codecept run Api --env production

API

The API endpoints require an OAuth access token. The token is necessary to authenticate all requests to the API.

The tuneefy API currently supports the OAuth 2 draft specification. All OAuth2 requests MUST use the SSL endpoint available at https://data.tuneefy.com/.

OAuth 2.0 is a simple and secure authentication mechanism. It allows applications to acquire an access token for tuneefy via a POST request to a token endpoint. Authentication with OAuth can be accomplished in the following steps:

1. Register for an API key by sending a mail to api@tuneefy.com
2. Exchange your customer id and secret for an access token
3. Make requests by passing the token in the Authorization header
4. When your token expires, you can get a new one

Apply for an API key

You can get an API key and associated secret by sending an email to api@tuneefy.com.

Web Service Rate Limits

Limits are placed on the number of API requests you may make using your API key. Rate limits may vary by service, but the defaults are 100 requests per hour.

Full documentation

The full documentation is available at https://data.tuneefy.com. An API blueprint is also available here — use your preferred renderer to build it. We use Aglio.

---

If you want to participate/contribute, feel free to create pull requests or issues so we can make Tuneefy better and more efficient !