instapaper 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2009-02-17
+
+Initial Release

data/Manifest.txt

@@ -0,0 +1,43 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/instapaper.rb
+lib/instapaper/base.rb
+lib/instapaper/constants.rb
+lib/instapaper/exceptions.rb
+lib/instapaper/protocol.rb
+lib/instapaper/request.rb
+lib/instapaper/request/abstract_request.rb
+lib/instapaper/request/add_url_request.rb
+lib/instapaper/request/authentication_request.rb
+lib/instapaper/request/request_error.rb
+lib/instapaper/request/request_errors.rb
+lib/instapaper/request/request_validation.rb
+lib/instapaper/response.rb
+lib/instapaper/response/abstract_response.rb
+lib/instapaper/response/add_url_success_response.rb
+lib/instapaper/response/authentication_invalid_response.rb
+lib/instapaper/response/authentication_success_response.rb
+lib/instapaper/response/bad_request_response.rb
+lib/instapaper/response/response_builder.rb
+lib/instapaper/response/service_error_response.rb
+lib/instapaper/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_instapaper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.rdoc

@@ -0,0 +1,73 @@
+= instapaper
+
+* http://instapaper.rubyforge.org
+
+== DESCRIPTION:
+
+The instapaper gem provides a neat interface to the Instapaper API.
+
+== SYNOPSIS:
+
+	# "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)
+
+
+== INSTALL:
+
+* sudo gem install instapaper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'instapaper/version'
+
+AUTHOR = 'Douglas Willcocks'  # can also be an array of Authors
+EMAIL = "douglas.willcocks@gmail.com"
+DESCRIPTION = "A simple wrapper for the Instapaper API"
+GEM_NAME = 'instapaper' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'instapaper' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Instapaper::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'instapaper documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/instapaper.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'instapaper/version'
+require 'instapaper/exceptions'
+require 'instapaper/constants'
+require 'instapaper/protocol'
+require 'instapaper/request'
+require 'instapaper/response'
+require 'instapaper/base'

data/lib/instapaper/base.rb

@@ -0,0 +1,113 @@
+# Copyright (c)  2009 Douglas Willcocks
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+
+# Provide a simple wrapper interface to Instapaper
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module Instapaper
+  class Base
+    
+    include Protocol
+    include Constants
+    include Request
+    include Response
+    include Exceptions
+    
+    # Instatiate a new Instapaper object that will act as the adaptor the Instapaper
+    # API.
+    #
+    # Usernames are mandatory, but passwords are optional as on Instapaper
+    def initialize(username, password = nil)
+      @username = username
+      @password = password
+      @protocol = PROTOCOLS[:secure]
+    end
+    
+    # Add a URL to Instapaper 
+    # 
+    # See Base#get_add_request
+    def add(url_data, options = {})
+      req = get_add_request(url_data,options)
+      
+      return send_request(req)
+    end
+    
+    # Create a request to add a URL to instapaper
+    #
+    # Takes a hash of options:
+    #
+    # :title 
+    #     plain text, no HTML, UTF-8
+    # :selection
+    #     plain text, no HTML, UTF-8
+    # :auto_title
+    #     Replaces title. Instapaper will crawl the URL to detect a title. 
+    #     Use this if you do not know a title for the URL, such as when it’s an 
+    #     inline link somewhere that hasn’t been opened.
+    #     Defaults to 1
+    #    
+    def get_add_request(url_data, options = {})
+      
+      raise InvalidRequestDetailsException unless options.is_a?(Hash)
+      
+      options[:url] = url_data
+      AddURLRequest.new(options,@username,@password)
+    end
+    
+    # Test the authentication credentials
+    def authenticate
+      req = AuthenticationRequest.new(@username,@password)
+      
+      return send_request(req)
+    end
+            
+    # Do the actual communication with the server
+    def send_request(request)
+ 
+      request.use_clear_protocol! unless secure?
+      request.prepare
+      
+      url = URI.parse(request.url)
+      req = Net::HTTP::Post.new(url.path)
+      
+      req.set_form_data(request.post_data)
+      
+      http = Net::HTTP.new(url.host,url.port)
+      
+      http.use_ssl      = secure?
+      
+      # Instapaper triggers an invalid SSL, so there's no way of telling
+      # if it's being spoofed. May as well just turn off warnings.
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      res = http.request(req)
+      
+      return ResponseBuilder.build(res,request)
+    end
+    
+  end
+end

data/lib/instapaper/constants.rb

@@ -0,0 +1,37 @@
+# Copyright (c)  2009 Douglas Willcocks
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+# Various constants 
+
+module Instapaper 
+  module Constants #:nodoc: all
+    
+    PROTOCOLS = {:clear => "http", :secure => "https"}.freeze
+    HOST      = "instapaper.com"
+    API_BASE  = "api"
+    
+    API_AUTH  = "authenticate"
+    API_ADD   = "add"
+    
+  end
+end

data/lib/instapaper/exceptions.rb

@@ -0,0 +1,41 @@
+# Copyright (c)  2009 Douglas Willcocks
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+# Errors thrown
+
+module Instapaper
+  module Exceptions
+    
+    class InstapaperException < Exception; end #:nodoc:
+    
+    # Thrown when the request object was built with incomplete data
+    class InvalidRequestDetailsException < InstapaperException; end
+                
+    # Thrown when trying to use an abstract request as an actual request
+    class AbstractRequestException < InstapaperException; end
+     
+    # Thrown when the server returns a response code we don't know how to handle
+    class UnrecognisedResponseCodeException < InstapaperException; end
+          
+  end
+end

data/lib/instapaper/protocol.rb

@@ -0,0 +1,47 @@
+# Copyright (c)  2009 Douglas Willcocks
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+module Instapaper
+  
+  module Protocol
+    
+    include Constants
+    
+    # Make the request using HTTPS (default)
+    def use_secure_protocol!
+      @protocol = PROTOCOLS[:secure]
+    end
+
+    # Make the request using HTTP (username/password passed in clear)
+    def use_clear_protocol!
+      @protocol = PROTOCOLS[:clear]
+    end
+
+    # Are we using HTTPS?
+    def secure?
+      @protocol == PROTOCOLS[:secure]
+    end
+    
+  end
+  
+end