0.08
No release in over a year
A Ruby wrapper for the Pocket API v3 (Add, Modify and Retrieve)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 1.0
>= 1.0.3, ~> 1.0
 Project Readme

pocket-ruby

Code Climate Gem Version

Ruby API for v3 of the Pocket API (formerly Read It Later)

Written by and previously maintained by @turadg.

Usage

Clone the repo and refer to demo-server.rb for examples on how to interact with the Pocket API.

git clone
cd pocket-ruby
bundle install
ruby demo-server.rb

Note: Changes to the demo-server.rb will require a restart to take effect (or you can use rerun).

Pocket-Ruby can be installed via the gem, gem install pocket-ruby

Or via bundler, gem 'pocket-ruby'

Pocket API Notes

Below are some aspects of the Pocket API that aren't covered in the official documentation, or that have been observed:

  • For very long articles, the maximum reported word_count is 65535, even if the article is longer.
  • If a count isn't specified, the Retreive call will return maximum of 5000 items.
  • The API response may contain a number of undocumented fields, including:
    • amp_url
    • domain_metadata
    • is_index
    • lang (ISO_639-1?)
    • listen_duration_estimate
    • sort_id
    • time_to_read
    • top_image_url
  • Every integer value is returned as a string, except for time_to_read, listen_duration_estimate and sort_id.
  • The time_to_read is in minutes, but listen_duration_estimate is in seconds.
  • If an article's status is "2" ('should be deleted') then most fields will not be present.