fix last-modified support #6
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Accept and honor last-modified header field
subapi.thread() now accepts another argument, lastModified. Previously
thread() returned an array of posts, now it returns an object with the
same array of posts under the property "posts", along slide the last
modified timestamp ("lastModified") and status field ("status"). In
order not to break backwards compatability the plain array of posts
is returned if no lastModified argument is given.
- Throw error on 404
If either subapi.thread() or api.board() encounters a 404 it will
now throw an error. Previously it returned undefined.
- Update board url
4chan api route for a thread is now:
http(s)://a.4cdn.org/[board]/thread/[threadnumber].json
Instead of:
http(s)://a.4cdn.org/[board]/res/[threadnumber].json
yocontra
requested changes
Jun 30, 2018
There was a problem hiding this comment.
I agree we need the functionality to be improved, but I'm not sure this is the right solution.
I think it might be simpler to do this by either allowing the user of the module to give a last modified time (for all methods, not just threads), or to do this globally using some kind of cache (so we know the last request time, and can use that as the last modified time).
The error handling behavior should also be applied globally, if any request returns status > 400 it should return an error for that code.
| cb(null, body.posts); | ||
| }); | ||
|
|
||
| return api; | ||
| }; | ||
|
|
||
| function threadChanges(num, lastModified, cb) { | ||
| console.log(arguments) |
| console.log(arguments) | ||
| var uri = [baseUrl, board, "thread", num+".json"].join("/"); | ||
|
|
||
| requestOptionsLocal = JSON.parse(JSON.stringify(requestOptions)); // clone global request options |
| @@ -9,11 +9,11 @@ describe('4chan api', function() { | |||
| it('should return a list of boards', function(done) { | |||
| this.timeout(5000); | |||
| api.boards(function(err, boards){ | |||
| should.not.exist(err); | |||
There was a problem hiding this comment.
can you remove these whitespace changes? this project uses 2 space tabs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The when making a request the 4chan api does not look to see if the last-modified header in the request is greater than the timestamp of the last change. Instead it just checks to see if they're equal. Thus if we want to make use of the last-modified header we have to pass it the exact value it returned in the header last time we made a request. This patch gives a way to pass that last-modified timestamp and to have it returned without breaking old code.
commit message:
Accept and honour last-modified header field
subapi.thread() now accepts another argument, lastModified. Previously
thread() returned an array of posts, now it returns an object with the
same array of posts under the property "posts", along slide the last
modified timestamp ("lastModified") and status field ("status"). In
order not to break backwards compatability the plain array of posts
is returned if no lastModified argument is given.
Throw error on 404
If either subapi.thread() or api.board() encounters a 404 it will
now throw an error. Previously it returned undefined.
Update board url
4chan api route for a thread is now:
http(s)://a.4cdn.org/[board]/thread/[threadnumber].json
Instead of:
http(s)://a.4cdn.org/[board]/res/[threadnumber].json