instapush 0.1.0

data/README.md

@@ -0,0 +1,27 @@
+InstaPush
+=========
+
+Add URLs to Instapaper.
+
+Installation
+------------
+
+    gem install instapush
+
+Usage
+-----
+
+    # Connect to Instapaper and add "http://kimjoar.net" to the user "kjbekkelund@gmail.com"
+    # The password is optional and can be omitted when you don't have a password
+    # on Instapaper.
+    InstaPush.connect "kjbekkelund@gmail.com", "password" do
+      add "http://kimjoar.net"
+    end
+    
+    # Similarly you can use:
+    conn = InstaPush.connect "kjbekkelund@gmail.com", "password"
+    conn.add "http://kimjoar.net"
+    
+    # Just authenticate with Instapaper. Calling this before adding pages is 
+    # not necessary.
+    InstaPush.authenticate "kjbekkelund@gmail.com", "password"

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "instapush"
+    gem.summary = "Ruby wrapper for the Instapaper API."
+    gem.description = "Ruby wrapper for the Instapaper API."
+    gem.email = "kjbekkelund@gmail.com"
+    gem.homepage = "http://github.com/kjbekkelund/instapush"
+    gem.author = "Kim Joar Bekkelund"
+    gem.add_development_dependency "rest_client", ">= 1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/instapush.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{instapush}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kim Joar Bekkelund"]
+  s.date = %q{2010-07-27}
+  s.description = %q{Ruby wrapper for the Instapaper API.}
+  s.email = %q{kjbekkelund@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION",
+     "instapush.gemspec",
+     "lib/instapush.rb",
+     "spec/instapush_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kjbekkelund/instapush}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby wrapper for the Instapaper API.}
+  s.test_files = [
+    "spec/instapush_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rest_client>, [">= 1"])
+    else
+      s.add_dependency(%q<rest_client>, [">= 1"])
+    end
+  else
+    s.add_dependency(%q<rest_client>, [">= 1"])
+  end
+end
+

data/lib/instapush.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+require 'rest_client'
+
+class InstaPush
+  class AuthFailedError < StandardError; end
+  
+  class << self
+    def connect(username, password = nil, &block)
+      conn = new username, password
+      
+      if block_given?
+        conn.instance_eval(&block)
+      else
+        conn
+      end
+    end
+    
+    def authenticate(username, password = nil)
+      conn = connect(username, password)
+      raise AuthFailedError unless conn.authenticate
+    end
+  end
+  
+  attr_reader :username, :password, :api_url
+  
+  def initialize(username, password)
+    @username = username
+    @password = password
+    @api_url = "https://www.instapaper.com/api/"
+  end
+  
+  def authenticate
+    RestClient.post authenticate_url,
+                    :username => username,
+                    :password => password
+  rescue RestClient::RequestFailed
+    errors << $!
+    false
+  end
+  
+  def add(url, opts = {})
+    opts.merge! :url      => url,
+                :username => username, 
+                :password => password
+    
+    RestClient.post add_url, opts
+  rescue RestClient::RequestFailed
+    errors << $!
+    false
+  end
+  
+  def errors
+    @errors ||= []
+  end
+  
+  def method_missing(sym)
+    raise NoMethodError unless sym.to_s.include? '_url'
+    api_url + sym.to_s.chomp('_url')
+  end
+end

data/spec/instapush_spec.rb

@@ -0,0 +1,89 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+RSpec::Mocks::setup(RestClient)
+
+describe InstaPush do
+  before do
+    RestClient.stub!(:post).with("https://www.instapaper.com/api/authenticate", hash_including(:username => 'not_working@gmail.com')).and_raise(RestClient::Forbidden)
+    RestClient.stub!(:post).with("https://www.instapaper.com/api/authenticate", hash_including(:username => 'kjbekkelund@gmail.com')).and_return("200")
+  end
+  
+  describe ".connect" do
+    it "should yield an instance of InstaPush if a block is given" do
+      yielded = nil
+      InstaPush.connect("kjbekkelund@gmail.com") { yielded = self }
+      yielded.should be_kind_of(InstaPush)
+    end
+    
+    it "should return an instance of InstaPush if a block is not given" do
+      conn = InstaPush.connect "kjbekkelund@gmail.com"
+      conn.should be_kind_of(InstaPush)
+    end
+  end
+  
+  describe ".authenticate" do
+    it "should raise an exception when it fails" do
+      lambda { InstaPush.authenticate("not_working@gmail.com") }.should raise_error(InstaPush::AuthFailedError)
+    end
+  end
+  
+  describe "#errors" do
+    it "should include an error when an api method has failed" do
+      InstaPush.connect "not_working@gmail.com" do
+        authenticate
+        errors.length.should == 1
+      end
+    end
+    
+    it "should include the exception raised" do
+      InstaPush.connect "not_working@gmail.com" do
+        authenticate
+        errors.first.to_s.should == "Forbidden"
+      end
+    end 
+  end
+  
+  context "a connected user" do
+    before do
+      @conn = InstaPush.connect "kjbekkelund@gmail.com"
+    end
+
+    describe "#authenticate" do
+      it "should return a status code of 200 if the authentication is successful" do
+        @conn.authenticate.should == "200"
+      end
+      
+      it "should return false if the authentication was unsuccessful" do
+        @conn = InstaPush.connect "not_working@gmail.com"
+        @conn.authenticate.should be_false
+      end
+    end
+    
+    describe "#add" do
+      it "should post the url to Instapaper" do
+        RestClient.should_receive(:post).once.with("https://www.instapaper.com/api/add", hash_including(:url => "http://kimjoar.net"))
+        @conn.add "http://kimjoar.net"
+      end
+      
+      it "should include additional parameters in the call to Instapaper" do
+        RestClient.should_receive(:post).once.with("https://www.instapaper.com/api/add", hash_including(:title=>"Kim Joar", :selection=>"description"))
+        @conn.add "http://kimjoar.net", :title => "Kim Joar", :selection => "description"
+      end
+      
+      it "should return a response code of 201 when successful" do
+        RestClient.should_receive(:post).once.with("https://www.instapaper.com/api/add", hash_including(:title=>"Kim Joar", :selection=>"description")).and_return("201")
+        @conn.add("http://kimjoar.net", :title => "Kim Joar", :selection => "description").should == "201"
+      end
+    end
+    
+    describe "#method_missing" do    
+      it "should return the extended api url if the input ends with _url" do
+        @conn.add_url.should == "https://www.instapaper.com/api/add"
+      end
+      
+      it "should raise a no method error if the method does not exist and the input does not end with _url" do
+        lambda { @conn.method_that_dont_exist }.should raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'instapush')

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: instapush
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kim Joar Bekkelund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest_client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+  type: :development
+  version_requirements: *id001
+description: Ruby wrapper for the Instapaper API.
+email: kjbekkelund@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- instapush.gemspec
+- lib/instapush.rb
+- spec/instapush_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kjbekkelund/instapush
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Instapaper API.
+test_files: 
+- spec/instapush_spec.rb
+- spec/spec_helper.rb