wheniwork / loop

Loop

All our user feedback in one place. Built on Equip.

Loop grabs feedback items from a variety of different sources, including Twitter, Satismeter, Zendesk, and the Manager Tool. Feedback is posted to HipChat and saved in a database for any later analysis.

Setting Up

For local development, Homestead is recommended. Edit the folders and sites entries in Homestead.yaml to include the following:

folders:
    - map: local/path/to/loop
      to: /home/vagrant/loop

sites:
    - map: loop.dev
      to: /home/vagrant/loop/web

For the various endpoints to work, you will need a .env file in Loop's root directory with any keys you need. Take a look at Configuration.php to see what fields are expected.

Testing

There is no official testing procedure yet, so there are a few important things to keep in mind when testing:

• Using ?debug=true on an endpoint URL will still show new feedback items in the response body, but will prevent the endpoint from actually doing anything with those feedback items. Use this to test if an endpoint is getting the correct values but you don't want to post anything to HipChat or save anything in the database.
• Any new content will be automatically sent to the Loop room in HipChat, where the entire company can see it. Consider setting a different HipChat room key in your local .env file.

loop's Issues

Use formatting tool instead of HTML

Right now there is a significant amount of HTML being generated inside domain classes. Instead, all HTML should be rendered using a formatting system. Something along the lines of:

class FeedbackMessage
{
    private $title;
    private $body;
    private $source;
    private $tone;

    public function getSource()
    {
        return $this->source;
    }

    public function getTone()
    {
        return $this->source;
    }

    public function toArray()
    {
        return get_object_vars($this);
    }
}

class MessageFormatter
{
    private $format = '<strong>title</strong><br>body';

    public function format(FeedbackMessage $message)
    {
        return sprintf($this->format, $message->toArray());
    }
}

Just a simple example, but ensures that all messages are formatted the same, in one location.

Facebook service should store the access token

The access tokens generated by Facebook should be stored in memory (or persisted) as long as possible, instead of fetching a new token blindly before each request.

Service classes should not be static

Service classes should all be made into normal instances instead of static. Configuration should be done via the dependency injector, instead of being hard coded or pulled from environment variables.

Services can use existing HTTP client

As per the Diactoros docs it is possible to use the libraries already installed with Spark to make HTTP external requests. Configuration/injection of a configured service can be done using the dependency injector.