nbar1 / gs Goto Github PK

Migrate from TinySong API to the GrooveShark API for searching.

See title.

Personally I use lib/

Update config.php to reflect new changes, including storing database parameters and update GS password comment to note that passwords should no longer be in MD5 format.

Update the play page to be interactive.

Phase 1:
Queue on player page
Volume adjustable from player page.

$this->dbh does not exist (and shouldn't)

This issue found in multiple classes: Player, Queue, User, and Song

$this->dbh = $this->db->prepare("SELECT id, token, status FROM queue WHERE status='queued' OR status='playing' ORDER BY status ASC, priority ASC, position ASC LIMIT 2");
$this->dbh->execute();
$rows = $this->dbh->fetchAll(PDO::FETCH_ASSOC);

This would be better written as

$stmt = $this->db->prepare("SELECT id, token, status FROM queue WHERE status='queued' OR status='playing' ORDER BY status ASC, priority ASC, position ASC LIMIT 2");
$stmt->execute();
$rows = $stmt->fetchAll(PDO::FETCH_ASSOC);

unittests/phpunit.xml

<phpunit bootstrap="_path_to_autoloader_">
        <whitelist>
                <directory suffix=".php">./</directory>
        </whitelist>   
        <logging>
                <log type="coverage-clover" target="/tmp/coverage.xml"/>
                <log type="coverage-html" target="_path_to_coverage_reports_"/>
        </logging> 
</phpunit>

Rewrite player.js to be more like global.js

Fix issue with cookie when setting username, causing you to put in the username twice.

require('config.php');

Add a public variable called config in Base then load your config in.

public function __construct()
{
    require('config.php');
    $this->config = $config;

When this is done, remove any include config.php found in a class that extends Base and update to use $this->config

Bonus points for converting config.php to anything but a php file (yaml) This class may help you with parsing yaml and can be installed via composer.

Username page was not updated to new UI

Unit test the following files:

api/gsAPI.php
api/gsControl.php

This should be in the Base class. The getter would handle the code below that is required to handle authentication, and the setter would store the class in to a private variable made for this class (like the template class)

This way you can use getGsAPI when the class is needed.

Some sample code:

function getGsAPI() {
    if (!$this->gsapi) {
        $this->gsapi = new gsAPI($config['api']['key'], $config['api']['secret']);
        // init more of the class here
    }
    return $this->gsapi
}

function setGsAPI($gsapi) {
    $this->gsapi = $gsapi;
}

This will help you later on if you have to write a unittest and mock out gsAPI. The setGsAPI() method would be used in your test to set a mock version of gsAPI.

I would recommend using Base or something that more defines what that class does.

Break out gsControl.php into multiple classes:

Classes:
Song
Queue
User

Song should be a song object that holds data about a new song or a currently queued song (if given an ID).

Queue should process queue specific requests, including returning queued songs, and adding a song to the queue.

User should store user information, including name and available promotions.

An autoloader will help stop you from requiring every class file that you need. This is done by placing classes in a specific folder and keeping naming consistent.

This is a sample of what I use. You may have to make changes to where classes are stored and how they are named.

<?php
// Extra files that have to be included
include dirname(__FILE__) . '/vendor/autoload.php';
include dirname(__FILE__) . '/config.php';

function autoload($className)
{
    $className = ltrim($className, '\\');
    $fileName  = '';
    $namespace = '';
    if ($lastNsPos = strripos($className, '\\'))
    {
        $namespace = substr($className, 0, $lastNsPos);
        $className = substr($className, $lastNsPos + 1);
        $fileName  = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
    }
    $fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';

    $loaded = false;

    $class_file = dirname(__FILE__) . '/lib/classes/' . $fileName;

    if (file_exists($class_file))
    {
        require $class_file;
    }
    else
    {
        throw new Exception('Unable to load class: ' . $class_file);
    }
}

spl_autoload_register('autoload');