Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Ruby library for the Instapaper API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 VERSION
Octocat-spinner-32 gazette.gemspec
Octocat-spinner-32 todo.txt
README.md

Gazette

Gazette is a Ruby gem to interact with the Instapaper API. It implements all API features, including authentication and adding URLs to read later. Gazette operates over HTTP and HTTPS, and uses (Instapaper-preferred) HTTP basic authentication.

NOTE: This gem is still in beta. Production use not suggested, but encouraged.

Installation

At your favorite shell:

gem install gazette

Usage

All interaction with the Instapaper API is done with an instance of Gazette::Client. The constructor requires one argument: the user's Instapaper email or username. The second argument is an optional hash, which can contain a :password => "user_pass" to pass the user's password, and/or :https => true if you would like to communicate with the Instapaper API over HTTPS.

@client = Gazette::Client.new("user@eample.com", :password => "seeecrets")

By default Gazette communicates with the Instapaper API over good 'ol HTTP. You are strongly encouraged to use HTTPS if at all possible.

Authentication

With a @client in hand, you can call @client.authenticate to authenticate the user's credentials. Per the API documentation, authentication is a totally optional. It may be useful if you want to verify the credentials provided by a user, but is not a required step before adding URLs.

>> @client.authenticate

Adding URLs

To add URLs to the client's Instapaper account, call @client.add(url_string):

>> @client.add("http://patmaddox.com/blog/2010/5/9/a-response-to-unit-and-functional-tests-are-as-useful-as-100.html", :title => "How do you write 100% correct code?", :selection => "How do you guarantee an application's correctness?")

The #add method's first parameter, a string of the URL you want to add, is required. The 2nd parameter is an optional hash, which can contain any of the following. See the Instapaper API documentation for details:

  • :title => "string"
  • :selection => "string"
  • :redirect => :close - Response body contains HTML which displays a "Saved!" message with and attempts to close the browser window after a short delay.
  • :jsonp => "string" - Response body contains JSON response with the specified callback function.

Responses

If a successful API call was made, Gazette returns an instance of Gazette::Response::Success. Responses have the following instance methods to retrieve values returned by the Instapaper API:

  • #content_location Saved URL of the newly created item.
  • #instapaper_title Saved title of the newly created item.
  • #body Body of the response from the API request. Useful when the :redirect or :jsonp option is used in a @client.add call (see above).

Invalid responses from the API cause Gazette to raise a new exception. All exceptions are subclasses of Gazette::Response::Error:

  • Gazette::Response::InvalidCredentials - Invalid user credentials.
  • Gazette::Response::ServerError - API encountered an error. Please try again later.
  • Gazette::Response::UnknownError - Some other unknown error. File a bug...maybe.

Thus, for proper error checking, please rescue Gazette::Response::Error and/or the other specific exceptions.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2010 Jeff Pollard. See LICENSE for details.

Something went wrong with that request. Please try again.