marcoarment / BugshotKit

iOS in-app bug reporting for developers and testers, with annotated screenshots and the console log.
MIT License
1.36k stars 138 forks source link

Post to JSON API ability #21

Closed claesjacobsson closed 10 years ago

claesjacobsson commented 10 years ago

Hi there!

I added ability to post bugshots to an API as an alternative to sending email. There is more work to be done, but it's a start. Hopefully it can be useful to others...

Claes

P.S. I did not update the readme file.

marcoarment commented 10 years ago

This was actually the original plan for BugshotKit, but I left it as email-only for a few reasons, including email's ubiquity, versatility, and built-in features that you get for free: a "from" address for reports, draft saving for later elaboration, retrying failed requests, and queuing outbound messages when offline.

The biggest reason was great, free text input. Putting up an email composer gives people a huge, versatile, standard text field for entering details about what they're reporting and why. Letting email do this job keeps BugshotKit much simpler.

Some of email's benefits aren't necessary to reproduce for all BugshotKit installations, but I don't think it makes sense to offer email-less server-API destinations without at least addressing text input, connection retries, and offline queuing — and that means a lot more code and possibly polluting the application's data directories, which I'd rather avoid.

claesjacobsson commented 10 years ago

You're right, it will take some work to make it ready for production. Even though BugshotKit is only for beta testing :-)

Also, I see your point regarding possible pollution. If BugshotKit would evolve to something running in production code it would probably be worth making an effort on the API code, but not now.