kawa-kokosowa / msg Goto Github PK

• Better docstrings
• #19 (REST API Docs)

if staticfuzz is gonna use msg, then staticfuzz will be rate limited, not per-user. meaning everyone will have to share the same rate limits, which is bad.

like this: https://hypatiasoftware.org/2016/01/29/polling-is-a-hack-server-sent-events-eventsource-with-gevent-flask-nginx-and-freebsd/

IDK why.

Tested in Chrome with plugin.

Command used: http POST localhost:5000/message message="i love kittens" --auth kitten:yarn

Expected behavior:
Return error with message "text field required"

Actual Behavior:

  File "/Users/seabreeze/Projects/msgboard/msgboard/msg.py", line 201, in post
    text = json_data['text']
KeyError: 'text'

https://github.com/lillian-gardenia-seabreeze/msgboard/blob/master/api/msgboard.py#L213

Difficulty of unittesting SSE/EventSource, /stream

I'm not sure how to approach testing the event stream. It currently will get caught in the infinite loop of the stream resource. Another hurdle is POST'ing while listening with something like sseclient

a range

when returning messages (a list of messages) be sure they're ordered by time in ascending order by default, otherwise there should be a way to specify ascending_not_decending=True as a json property

should there be a modified timestamp? defaults to createddate. this way we can return the newest including by edit, not just created date alone

Although the flask sse module is really nice

See what's not being covered in red: https://coveralls.io/builds/7128688/source?filename=msgboard%2Fmsg.py

Is the a way to test when a token expires that wouldn't involve having python wait 10 minutes?

iterate on making core features mentioned in restful section perfect before progressing

architecture discussion herein. archive meaning exporting a ton or all of posts.

maximum number of items returned in config

it's out of date

also ideally there'd be three kinds of examples:

• imageboard type (eventually this'll be staticfuzz.
• instant messenger type/chat
• trello ripoff