Add support for commenting on messages

[brentc]

Adds support for event:comment messages as outlined in the API Docs

[brentc]

Any comments? Anyone?

[brentc]

@lautis?

[lautis]

The API looks reasonable, but the inplementation might not work with flows with new id format (or at least the functionality is inconsistent with sending plain messages). I'll need to look of there's anything we could do on Flowdock API to fix this or does this require bigger overhaul for node-flowdock.

Ville Lautanala
Sent from my iPhone

On Wednesday 27. November 2013 at 19.43, Brent C wrote:

@lautis (https://github.com/lautis)?

—
Reply to this email directly or view it on GitHub (#5 (comment)).

[brentc]

I'm not sure what you mean with it not working with the "new id format". If you're referring to the first parameter being a combination of the org parameterized name and the flow parameterized name, I only did that to be consistent with the syntax of the session.message and session.status method parameters. The actual implementation takes the colon-separated names and uses them as the URL path as specified in the API docs for submitting a comment:

Comments can be posted to

POST /flows/:organization/:flow/messages/:message_id/comments

    orgFlowName = orgFlowName.replace(':', '/')
    @send "/flows/#{orgFlowName}/messages/#{messageId}/comments", data, callback

[Mumakil]

@brentc The issue here is that a while back the id's of new flows were changed from org:flow to a random string. The node-flowdock in general still makes assumptions about how to construct urls from the flow id, but it should instead use the api url of the flow provided by the api (see https://flowdock.com/api/flows), so the urls should be flow.url + "/messages/" + message_id + "/comments".

It is true that you can construct the orgFlowName by flow.organization.parameterized_name + ":" + flow.parameterized_name and give that as a parameter to the function, but the long term solution is to refactor the whole library a bit to use the correct url formats.

[brentc]

Ok... But right now sending a comment doesn't use the flow api url, it requires a URL that uses the org name and flow name as path parameters...

When do you...

1. Expect the API to change to send comments via the flow api endpoint
2. Expect to refactor this library to support that

And in the mean time.... Can this be accepted?

[lautis]

It might be reasonable to add a new endpoint to the Flowdock API, that would allow comments to be posted using flow id and message id. For example,

POST /comments
{"flow": "deadbeefdeadbeef", "message": 1234, "content": "comment content"}

[Mumakil]

Thanks @brentc! We added a new api endpoint to support commenting by flow id. I created a new pull request #6 that has a more unified api and up to date readme and copied the comment sending from this pull request there. We'll update the npm package asap.

[brentc]

@Mumakil Awesome! The new endpoint and refactored params seem much cleaner. Looking forward to #6 getting merged. 👍