A new version of tuneefy built for PHP 7 from the ground up
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
deploy
examples
src/tuneefy
tests
var
web
.gitignore
.php_cs
LICENSE
README.md
codeception.yml.dist
composer.json
composer.lock
deploy.php
gulpfile.js
package.json
structure.sql

README.md

tuneefy 2

A new version of tuneefy built for PHP 7, from the ground up, using the minimal Slim framework and a few helper libraries.

Installing

This project uses composer. Just run :

composer install

Creating tables

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

mysql -u user -p database_name < ./structure.sql

Building assets & API doc

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

npm install

npm run build-assets
npm run api-documentation

Composer packages used

Dev packages

NPM (dev) packages used

  • Gulp , including gulp-sass, gulp-uglify and pump for building assets
  • Aglio for generating the API docs

On the frontend side of things

I'm using JQuery to cover the DOM manipulation tasks and related stuff.

Code structure

This project is a very basic composer project with a PSR-4 autoloader. The source is in src/tuneefy and is organised as such :

  • MusicalEntity includes the model for a musical entity (album or track)
  • Controller includes the controllers for the various routes (api and frontend)
  • Platform includes all the platform-related code, especially the specific methods for each remote API call
  • Utils includes various utilities such as custom Slim error handlers
  • and two top-level classes : Application and PlatformEngine that deal with the application itself and how it interacts with the platforms

Tests

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

vendor/bin/codecept run --steps

Beforehand, do not forget to launch a development web server so that the functional tests have an endpoint to test. For instance :

php -S localhost:8000 -t web

There should be 36 tests containing 673 assertions.

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

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 !