search

mozillascience / PaperBadger

Issuing badges to credit authors for their work on academic papers
https://badges.mozillascience.org/
Mozilla Public License 2.0
95 stars 48 forks source link

Fix incorrect api paths in README. #177

Closed geeeeeeeeek closed 8 years ago

geeeeeeeeek commented 8 years ago

There are some typos in the README. users were typed into badges. I found them when writing a GSoC proposal for your project.@acabunoc

Actually this kind of api doc is not convenient to maintain, I suggest using Swagger to drive the API documentation. I will further clarify that in my porposal.

geeeeeeeeek commented 8 years ago

There is a connection error in the integration test against the real Badge server. Maybe you should look into that.

Also, the word integration in your test/app.js is misspelled. I'll just leave it to yourself. : )

josmas commented 8 years ago

Hi @geeeeeeeeek tests are running fine here; you need credentials that @acabunoc can provide.

The spelling error was corrected in #175.

geeeeeeeeek commented 8 years ago

@josmas I don't get it. Shouldn't credentials be stored in Travis's environment variables?

josmas commented 8 years ago

If you want to run tests locally, you'll need the credentials locally. There's info in the readme for local setup.

I guess you were referring to the automated tests triggered by the pull request (in travis), and yes, that needs to be looked after. I thought you were trying to run tests locally.

geeeeeeeeek commented 8 years ago

@josmas Sorry I didn't express myself. I was talking about the CI build. If the failure was with the CI itself, I think this pr can be merged.

abbycabs commented 8 years ago

Hey @geeeeeeeeek & @josmas!

Sorry for the delay, busy day :) yes we have the credentials in Travis, but it only works when the branch is in the MozillaScience/paperbadger repo. This is a known issue, I think @audy was looking at this awhile ago. Can't seem to find this in our issue tracker though, so thanks for flagging, @geeeeeeeeek!

abbycabs commented 8 years ago

Swagger seems like a good idea, especially as we get more mature

abbycabs commented 8 years ago

Filed the CI issue here: https://github.com/mozillascience/PaperBadger/issues/178

abbycabs commented 8 years ago

So, we also list all these API endpoints in home.jsx (I know, it's not the best solution)

I'd like to update both pages together, if possible. @geeeeeeeeek can you updates those endpoints there, too?

geeeeeeeeek commented 8 years ago

@acabunoc I'd love to.

geeeeeeeeek commented 8 years ago

@acabunoc Done. I'll look into other issues and see what I can do.

abbycabs commented 8 years ago

Thanks friend :)

R+