edi-design / asana-hipchat Goto Github PK

View Code? Open in Web Editor NEW

20.0 5.0 8.0 483 KB

Script that pushes changes from an asana workspace to a hipchat room

License: GNU General Public License v2.0

PHP 100.00%

asana-hipchat's Introduction

asana-hipchat

Here you'll find a script that pushes changes from an Asana workspace to a HipChat room.

This script was created during our work on hikewith.me.

Thanks goes out to HipChat and Ajimix for their libraries.

notification features

new workspace has been created
new project has been created
new task has been created
task changes
- assigned
- completed
- due date changed
- task informations changed (due, name ...)

planed feature

notifications on task comments
send creator on new workspace, project

installation

dependencies

php5-sqlite
```
  # apt-get install php5-sqlite
```

script installation

$ git clone https://github.com/edi-design/asana-hipchat.git asana_hipchat
$ cd asana_hipchat/ext-lib
$ wget https://raw.github.com/ajimix/asana-api-php-class/master/asana.php
$ wget https://raw2.github.com/hipchat/hipchat-php/master/src/HipChat/HipChat.php
$ cd ../config
$ cp config.example.php config.php
$ vi config.php

Edit the config.php according to your asana and hipchat installation. The following params need to be set.

/**
 * Asana configuration
 */
// api key
define('ASANA_API_KEY', 'asana_api_key_here');

// if workspace id is empty, it will check all workspaces
/**
 * @todo implement this feature
 */
define('ASANA_WORKSPACE_ID', 'asana_workspace_id_here');


/**
 * hipchat configuration
 */
// api_key
define('HIPCHAT_API_KEY', 'hipchat_api_key_here');

// room_id
define('HIPCHAT_API_ROOM', 0000);

// turn notifications on and off
define('HIPCHAT_NOTIFICATIONS', true);

// hipchat name of notifier
define('HIPCHAT_NOTIFIER', 'Asana');


/**
 * script configuration
 */
define('SQLITE_DATA_FILE', BASE_DIR . '/db/asana.sqlite');

run script

simple one-time run
```
  $ php asana.php 
```

cron script every 5 minutes

  $ crontab -e
  */5  *    *    *    *  /usr/bin/php /path/to/script/asana.php

asana-hipchat's People

Contributors

Stargazers

Watchers

Forkers

michaelx pixelapse whockey conspire-org cweems cycomachead zambarauu marcan2020

asana-hipchat's Issues

Fatal error

I am getting the following

ben@Canary008:~/asana_hipchat$ php asana.php
PHP Fatal error:  Uncaught exception 'PDOException' with message 'could not find driver' in /home/ben/asana_hipchat/lib/AsanaHipchat.php:157
Stack trace:
#0 /home/ben/asana_hipchat/lib/AsanaHipchat.php(157): PDO->__construct('sqlite:/home/be...')
#1 /home/ben/asana_hipchat/asana.php(39): AsanaHipchat->run()
#2 {main}
  thrown in /home/ben/asana_hipchat/lib/AsanaHipchat.php on line 157

asana.php missing in ext-lib

Not sure where to post this question, so I filed an issue. Let me know if you need any more info, really want to use this integration :)

Getting this error when I run:
php asana.php

Fatal error: require_once(): Failed opening required '/Users/mattw/asana_hipchat/ext-lib/asana.php' (include_path='.:') in /Users/mattw/asana_hipchat/asana.php on line 21

Version of PHP:
PHP 5.5.14 (cli) (built: Sep 9 2014 19:09:25)
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies
mattw-mba-2:asana_hipchat mattw$

Version of Sqlite:
SQLite version 3.8.5 2014-08-15 22:37:57

Don't show changes of completed tasks

Don't show changes of completed tasks. Only show future changes when the task has been re-opened.

Example of current implementation:

The following task has been completed. 
✓ Task XY (due on not set, →)

The following task has been changed. 
▢ Task XY (due on not set, →) 
Field [ creator ] was changed from "" to "".

5min delay before push "new X" notification

Asana creates the new element (task, project, workspace) as soon as you press the new button.
This could cause empty notifications, if we check at this moment but you are not ready entering the task details.

Is there a way to use all projects in a workspace?

I've tried setting $ALLOWED_PROJECTS to NULL, and that doesn't seem to do the trick.

Thanks!

encoding problem with name field

all non standard utf8 chars will be encoded wrong within hipchat.

Asana IDs do not fit in 32bit integer

On a 32bit php system, the asana ids are to big and will be represented as an signed negativ value instead of the real id.

only notify if update from asana was complete

got the issue sometimes, that asana refuses call for one request => project has no tasks
this causes the script to send all tasks as a notification on the next cycle.

show subtasks

If i create subtasks for a task, i would like to see them monitored as well.

Add assignee to completed tasks

Add "was assigned to ".

Example:
✓ Update footer copyright (#Website, due on 2014-02-28, was assigned to Michael Xander, →)

use sqlite instead of file storage

for larger projects, the file storage will be to slow.
use sqlite as backend.

Wait X minutes until posting a new task

Wait X (configurable) minutes until posting the creation of a new task to ensure it has been completely entered.

Currently new tasks are often time instantly followed by a change notification.

if creation_date !< 10m

Use asana "modified since" to prevent unnecessary API calls.

Asana added to its tasks endpoint a modified_since filter option.
We should implement this to save api calls for task not modified since last check.

Comments are pushing a mistakenly [ creator ] update

When comments or attachments are added to a task, the script pushes a mistakenly "field [ creator ]" update. If at least two followers exist, the non-creator gets posted as creator.

Example

Jon is the creator of the task, Amy follows it too. Jon writes a comment. The following happens:

The following task has been changed.
▢ Task title
Field [ creator ] was changed from "Jon" to "Amy".

Character escaping isn‘t working properly; infinite task updates

Seems like characters like ' ‘ aren‘t correctly escaped, because tasks who include those characters are pushed infinite to HipChat.