Contents

h1. instapaper

h2. What

The instapaper gem provides a neat interface to the Instapaper API.

h2. Installing

<pre syntax="ruby">sudo gem install instapaper</pre>

h2. Demonstration of usage

<pre syntax="ruby">
	
	# "password" is optional
	base = Instapaper::Base.new("username","password")
	
	# Test authentication (not required to add url)
	result = base.authenticate 
		# => Instapaper::Response::AuthenticationSuccessResponse
	
	result.code  # => 200
	
	# Add URL
	result = base.add("http://example.org/some-article.html") 
		# => Instapaper::Response::AddURLSuccess

	result.code	 # => 200
	
	# Bad Auth
	base   = Instapaper::Base.new("baduser","badpass")
	result = base.authenticate 
		# => Instapaper::Response::AuthenticationInvalidResponse
	
	result.code  # => 403
	
	# Advanced usage
	base    = Instapaper::Base.new("username","password")
	options = {:url => "http://example.org/some-article.html", :title => "MyArticle"}
	request = AddURLRequest.new(options,"username","password")
	
	base.secure? # => true (as default)
	
	base.use_clear_protocol! 
		# => connection will now use HTTP instead of HTTPS
	
	response = base.send_request(request)
	
</pre>


h3. Build and test instructions

<pre>cd instapaper
rake test
rake install_gem</pre>

h2. Limits

The gem implements all the functionality provided by the Instapaper API.

h2. License

This code is free to use under the terms of the MIT license. 

h2. Contact

Comments are welcome. Send an email to "Douglas Willcocks":mailto:[e-mail]

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
instapaper-0.1.0	website/index.txt