sjs/instapaper
1
0
Fork 0
mirror of https://github.com/samsonjs/instapaper.git synced 2026-04-27 14:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

rename Instapaper::API::Highlights#highlight to add_highlight

Browse source
This commit is contained in:
stve 2015-08-30 22:46:53 -04:00
parent c424057b07
commit d64dfa1085
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/instapaper/api/highlights.rb
View file

@ -5,6 +5,7 @@ module Instapaper
# Defines methods related to highlights # Defines methods related to highlights
module Highlights module Highlights
# List highlights for a bookmark # List highlights for a bookmark
# @param bookmark_id [String, Integer]
def highlights(bookmark_id) def highlights(bookmark_id)
perform_post_with_objects("/api/1.1/bookmarks/#{bookmark_id}/highlights", {}, Instapaper::Highlight) perform_post_with_objects("/api/1.1/bookmarks/#{bookmark_id}/highlights", {}, Instapaper::Highlight)
end end
@ -16,7 +17,7 @@ module Instapaper
# @option options [String] :text The text for the highlight (HTML tags in text parameter should be unescaped.) # @option options [String] :text The text for the highlight (HTML tags in text parameter should be unescaped.)
# @option options [String, Integer] :posiiton The 0-indexed position of text in the content. Defaults to 0. # @option options [String, Integer] :posiiton The 0-indexed position of text in the content. Defaults to 0.
# @return [Instapaper::Highlight] # @return [Instapaper::Highlight]
def highlight(bookmark_id, options = {}) def add_highlight(bookmark_id, options = {})
perform_post_with_object("/api/1.1/bookmarks/#{bookmark_id}/highlight", options, Instapaper::Highlight) perform_post_with_object("/api/1.1/bookmarks/#{bookmark_id}/highlight", options, Instapaper::Highlight)
end end

6
spec/instapaper/api/highlights_spec.rb
View file

@ -22,19 +22,19 @@ describe Instapaper::Client::Highlights do
end end
end end
describe '#highlight' do describe '#add_highlight' do
before do before do
stub_post('/api/1.1/bookmarks/123/highlight') stub_post('/api/1.1/bookmarks/123/highlight')
.to_return(status: 200, body: fixture('highlight.json'), headers: {content_type: 'application/json; charset=utf-8'}) .to_return(status: 200, body: fixture('highlight.json'), headers: {content_type: 'application/json; charset=utf-8'})
end end
it 'gets the correct resource' do it 'gets the correct resource' do
client.highlight(123, text: 'This is the highlighted text.', position: 22) client.add_highlight(123, text: 'This is the highlighted text.', position: 22)
expect(a_post('/api/1.1/bookmarks/123/highlight')).to have_been_made expect(a_post('/api/1.1/bookmarks/123/highlight')).to have_been_made
end end
it 'returns an array containing folders on success' do it 'returns an array containing folders on success' do
highlight = client.highlight(123, text: 'This is the highlighted text.', position: 22) highlight = client.add_highlight(123, text: 'This is the highlighted text.', position: 22)
expect(highlight).to be_an Instapaper::Highlight expect(highlight).to be_an Instapaper::Highlight
end end
end end