ricepaper 0.0.1 → 0.0.2

data/README.txt

@@ -1,4 +1,6 @@
 RicePaper is a tiny little command-line utility to post URLs to
 InstantPaper. It also works as a Ruby library in a pinch also.
 
-RicePaper is still a work in progress.
+See the examples/ directory for example usage, or use
+'ricepaper -h' for command-line usage.
+

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ricepaper"
+    gemspec.summary = "A small library for adding URLs to Instapaper"
+    gemspec.email = "lee@writequit.org"
+    gemspec.homepage = "http://github.com/dakrone/ricepaper"
+    gemspec.description = "Ricepaper is a library that allows you to add URLs to Instapaper, either by using it as a CLI or as a Ruby library."
+    gemspec.authors = ["Lee Hinman"]
+    gemspec.rubyforge_project = 'writequit'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/ricepaper/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/add_sites.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# 
+# Add sites to Instapaper using Ricepaper
+#
+
+require 'ricepaper'
+
+rp = RicePaper.new("username", "password")
+
+sites = [
+  "http://google.com",
+  "http://ruby-lang.org",
+  "http://instapaper.com"
+]
+
+sites.each { |site|
+  puts "Added #{site}." if rp.add(site)
+}

data/examples/authentication_test.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# 
+# Test authenticating the user to Instapaper
+#
+
+require 'ricepaper'
+
+rp = RicePaper.new("username", "password")
+
+if rp.authenticate
+  puts "Authentication successfull."
+else
+  puts "Authentication failed."
+end

data/lib/ricepaper.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#
+# Library for adding URLs to instapaper.
+# by Matthew Lee Hinman (http://writequit.org)
+#
+
+require 'rubygems'
+require 'rest_client'
+
+# Encapsulation class
+
+class RicePaper
+
+  attr_accessor :username, :password, :apiurl
+  attr_reader   :error
+
+  def initialize(username, password, apiurl = "https://www.instapaper.com/api/")
+    @username = username
+    @password = password
+    @apiurl = apiurl
+    @error = ""
+  end
+
+  # Handle Errors - sets the error code appropriately
+  # so that it can be reported
+  def handle_error(err)
+    result = /(\d+)/.match(err.to_s)[1]
+    @error = case result
+                when "400" then "Bad Request"
+                when "403" then "Invalid username of password"
+                when "500" then "There was a server error. Please try again later."
+                else "An unknown error occured"
+              end
+  end
+
+  # Authenticate with instapaper, returning true if auth
+  # was successful, false otherwise
+  def authenticate
+    RestClient.post @apiurl + "authenticate", 
+      :username => @username, 
+      :password => @password
+  rescue RestClient::RequestFailed
+    handle_error($!)
+    return false
+  end
+
+  # Add a url to instapaper, given a url and an optional
+  # title; if no title is given, auto-title by instapaper
+  def add(url, title=nil)
+    result = RestClient.post @apiurl + "add",
+      :username     => @username,
+      :password     => @password,
+      :url          => url,
+      :title        => title,
+      :"auto-title" => title.nil? ? "1" : "0"
+  rescue RestClient::RequestFailed
+    handle_error($!)
+    return false
+  end
+end

data/ricepaper.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ricepaper}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lee Hinman"]
+  s.date = %q{2009-07-21}
+  s.default_executable = %q{ricepaper}
+  s.description = %q{Ricepaper is a library that allows you to add URLs to Instapaper, either by using it as a CLI or as a Ruby library.}
+  s.email = %q{lee@writequit.org}
+  s.executables = ["ricepaper"]
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    "README.txt",
+     "Rakefile",
+     "VERSION",
+     "bin/ricepaper",
+     "examples/add_sites.rb",
+     "examples/authentication_test.rb",
+     "lib/ricepaper.rb",
+     "ricepaper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dakrone/ricepaper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{writequit}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{A small library for adding URLs to Instapaper}
+  s.test_files = [
+    "examples/add_sites.rb",
+     "examples/authentication_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ricepaper
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Lee Hinman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-10 00:00:00 -06:00
+date: 2009-07-21 00:00:00 -06:00
 default_executable: ricepaper
 dependencies: []
 
@@ -23,6 +23,13 @@ extra_rdoc_files:
 - README.txt
 files: 
 - README.txt
+- Rakefile
+- VERSION
+- bin/ricepaper
+- examples/add_sites.rb
+- examples/authentication_test.rb
+- lib/ricepaper.rb
+- ricepaper.gemspec
 has_rdoc: true
 homepage: http://github.com/dakrone/ricepaper
 licenses: []
@@ -51,5 +58,6 @@ rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: A small library for adding URLs to Instapaper
-test_files: []
-
+test_files: 
+- examples/add_sites.rb
+- examples/authentication_test.rb