expose the hypermedia headers in response

[volkanunsal]

No description provided.

[monfresh]

Thanks. Per our contribution guidelines, could you please add/update the specs for this feature?

Also, please provide a detailed commit message explaining what issue this is addressing and why it's important.

Finally, I would only include Link and X-Total-Count. The others will be removed since they are not used. Eventually, I think I might remove the X-Total-Count header and put that information in the JSON instead, like the GitHub API does it.

[monfresh]

Also, could you please rebase against master to pick up the Travis fix I just pushed? That way, your PR can run on Travis.

[monfresh]

If you haven't already picked up the Travis change, it might be easier to just update the Ruby version in your .travis.yml to 2.1.2 because I just pushed another change to master which will require you to run some migrations. Since this PR does not depend on the DB change I just pushed, it's probably simpler to just update the Travis file directly in this PR.

[volkanunsal]

Oh I haven't had time to do this yet. I will get on it today.

[volkanunsal]

Is the format of the Link header a standard? I'm scratching my head to figure out how to parse it. It's not like anything I've seen before.

[coveralls]

Coverage remained the same when pulling c1602b4 on volkanunsal:patch-1 into f624ded on codeforamerica:master.

[coveralls]

Coverage remained the same when pulling c1602b4 on volkanunsal:patch-1 into f624ded on codeforamerica:master.

[coveralls]

Coverage remained the same when pulling f109892 on volkanunsal:patch-1 into f624ded on codeforamerica:master.

[monfresh]

Yes it is. Are you asking about the parsing in general or related to this PR? You shouldn't need to parse it in this PR.

If you're trying to parse it for use in an app, you can use our Ruby wrapper, and access the Link data like this:

locations = Ohanakapa.locations
locations.concat Ohanakapa.last_response.rels[:next].get.data

Our Ruby wrapper is pretty much Octokit.rb, but I need to add a Pagination section to our README.

While testing this just now, I found a bug. It seems like the Link header is not returned when SSL is turned on.

[volkanunsal]

Not related to this PR. I tried accessing Links from the browser and had to write my own parser is JS. The format is really strange. I can't say how they came up with it, but I'd appreciate it much more if it just gave me a link I could drop on the page and not this:

<http:localhost:3000/xyz?abc=123> rel='next'; <http:localhost:3000/xyz?abc=124> rel='last';

[monfresh]

Getting back to this PR, could you please make the following changes:

1. Update the description of the updated specs to match the expected outcome. For example, it 'exposes the Link and X-Total-Count headers'.
2. Use single quotes instead of double quotes per the Ruby Style Guide that we follow (see our contribution guidelines).
3. Run script/test to make sure all tests pass and that no Style Guide offenses are present.
4. Once everything passes, please rebase your commits into one commit.

Thanks!

[coveralls]

Coverage remained the same when pulling 1566df5 on volkanunsal:patch-1 into 1ad8731 on codeforamerica:master.

[volkanunsal]

Ok, done.

[monfresh]

Thanks!