instapaper 0.1.0 → 0.2.0

data/spec/fixtures/bookmarks_list.json

@@ -0,0 +1,5 @@
+[{"type":"meta"},
+{"type":"user","user_id":1075837,"username":"steve.agalloco@gmail.com","subscription_is_active":"1"},
+{"type":"bookmark","bookmark_id":170939225,"url":"http:\/\/www.igvita.com\/2010\/11\/17\/routing-with-ruby-zeromq-devices\/","title":"Routing with Ruby & ZeroMQ Devices","description":"ZeroMQ sockets provide message-oriented messaging, support for multiple transports, transparent setup and teardown, and an entire array of routing patterns via different socket types","time":1307319089,"starred":"0","private_source":"","hash":"PGU0MMPw","progress":0,"progress_timestamp":0},
+{"type":"bookmark","bookmark_id":169529989,"url":"http:\/\/www.fastcodesign.com\/1662169\/ideos-axioms-for-starting-disruptive-new-businesses","title":"Ideo's Axioms for Starting Disruptive New Businesses | Co.Design","description":"www.fastcodesign.com","time":1306963988,"starred":"0","private_source":"","hash":"v27qHZc2","progress":"0","progress_timestamp":1307145892}
+]

data/spec/fixtures/bookmarks_move.json

@@ -0,0 +1 @@
+[{"type":"bookmark","bookmark_id":169529989,"url":"http:\/\/www.fastcodesign.com\/1662169\/ideos-axioms-for-starting-disruptive-new-businesses","title":"Ideo's Axioms for Starting Disruptive New Businesses | Co.Design","description":"www.fastcodesign.com","time":1307586766,"starred":"0","private_source":"","hash":"9GZzaC8U","progress":"0","progress_timestamp":1307585389}]

data/spec/fixtures/bookmarks_star.json

@@ -0,0 +1 @@
+[{"type":"bookmark","bookmark_id":170939225,"url":"http:\/\/www.igvita.com\/2010\/11\/17\/routing-with-ruby-zeromq-devices\/","title":"Routing with Ruby & ZeroMQ Devices","description":"ZeroMQ sockets provide message-oriented messaging, support for multiple transports, transparent setup and teardown, and an entire array of routing patterns via different socket types","time":1307319089,"starred":"1","private_source":"","hash":"PGU0MMPw","progress":0,"progress_timestamp":0}]

data/spec/fixtures/bookmarks_unarchive.json

@@ -0,0 +1 @@
+[{"type":"bookmark","bookmark_id":169529989,"url":"http:\/\/www.fastcodesign.com\/1662169\/ideos-axioms-for-starting-disruptive-new-businesses","title":"Ideo's Axioms for Starting Disruptive New Businesses | Co.Design","description":"www.fastcodesign.com","time":1307507347,"starred":"0","private_source":"","hash":"v27qHZc2","progress":"0","progress_timestamp":1307145892}]

data/spec/fixtures/bookmarks_unstar.json

@@ -0,0 +1 @@
+[{"type":"bookmark","bookmark_id":170939225,"url":"http:\/\/www.igvita.com\/2010\/11\/17\/routing-with-ruby-zeromq-devices\/","title":"Routing with Ruby & ZeroMQ Devices","description":"ZeroMQ sockets provide message-oriented messaging, support for multiple transports, transparent setup and teardown, and an entire array of routing patterns via different socket types","time":1307319089,"starred":"0","private_source":"","hash":"PGU0MMPw","progress":0,"progress_timestamp":0}]

data/spec/fixtures/bookmarks_update_read_progress.json

@@ -0,0 +1 @@
+[{"type":"bookmark","bookmark_id":169529989,"url":"http:\/\/www.fastcodesign.com\/1662169\/ideos-axioms-for-starting-disruptive-new-businesses","title":"Ideo's Axioms for Starting Disruptive New Businesses | Co.Design","description":"www.fastcodesign.com","time":1307507347,"starred":"0","private_source":"","hash":"6n9G6qFt","progress":"0.5","progress_timestamp":1307585332}]

data/spec/fixtures/folders_add.json

@@ -0,0 +1 @@
+[{"type":"folder","folder_id":1121141,"title":"Ruby","sync_to_mobile":"1","position":1307330035}]

data/spec/fixtures/folders_delete.json

@@ -0,0 +1 @@
+[]

data/spec/fixtures/folders_list.json

@@ -0,0 +1 @@
+[{"type":"folder","folder_id":1121173,"title":"Ruby","sync_to_mobile":"1","position":1307331865},{"type":"folder","folder_id":1121174,"title":"JavaScript","sync_to_mobile":"1","position":1307331865}]

data/spec/fixtures/folders_set_order.json

@@ -0,0 +1 @@
+[{"type":"folder","folder_id":1121174,"title":"JavaScript","sync_to_mobile":"1","position":1},{"type":"folder","folder_id":1121173,"title":"Ruby","sync_to_mobile":"1","position":2}]

data/spec/fixtures/verify_credentials.json

@@ -0,0 +1 @@
+[{"type":"user","user_id":54321,"username":"TestUserOMGLOL"}]

data/spec/instapaper/client/account_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Instapaper::Client::Account do
+  before(:each) do
+    @client = Instapaper::Client.new
+  end
+
+  describe '.verify_credentials' do
+    before do
+      stub_post("account/verify_credentials").
+        to_return(:body => fixture("verify_credentials.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.verify_credentials
+      a_post("account/verify_credentials").
+        should have_been_made
+    end
+
+    it "should return the user" do
+      user = @client.verify_credentials.first
+      user.should be_a Hashie::Rash
+      user.username.should == 'TestUserOMGLOL'
+    end
+  end
+
+end

data/spec/instapaper/client/bookmark_spec.rb

@@ -0,0 +1,234 @@
+require 'spec_helper'
+
+describe Instapaper::Client::Bookmark do
+  before(:each) do
+    @client = Instapaper::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+  end
+
+  describe '.bookmarks' do
+    before do
+      stub_post("bookmarks/list").
+        to_return(:body => fixture("bookmarks_list.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.bookmarks
+      a_post("bookmarks/list").
+        should have_been_made
+    end
+
+    it "should return an array containing bookmarks on success" do
+      bookmarks = @client.bookmarks
+      bookmarks.should be_an Array
+      bookmarks.size.should == 2
+    end
+
+    it "should remove the meta and current user objects from the array" do
+      bookmarks = @client.bookmarks
+      bookmarks.each do |bookmark|
+        bookmark.should be_a Hashie::Rash
+        bookmark.type.should == 'bookmark'
+      end
+    end
+  end
+
+  describe '.update_read_progress' do
+    before do
+      @time = Time.now
+      stub_post("bookmarks/update_read_progress").
+        to_return(:body => fixture("bookmarks_update_read_progress.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.update_read_progress(123, 0.5, @time)
+      a_post("bookmarks/update_read_progress").with(:body => {:bookmark_id => "123", :progress => '0.5', :progress_timestamp => @time.to_i.to_s }).
+        should have_been_made
+    end
+
+    it "should return an array containing bookmarks on success" do
+      bookmark = @client.update_read_progress(123, 0.5, @time)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+      bookmark.progress.should == "0.5"
+    end
+  end
+
+  describe '.add_bookmark' do
+    before do
+      stub_post("bookmarks/add").
+        to_return(:body => fixture('bookmarks_add.json'), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description')
+      a_post("bookmarks/add").with(:body => {:url => "http://someurl.com", :title => 'This is the title', :description => 'This is the description' }).
+        should have_been_made
+    end
+
+    it "should return the bookmark on success" do
+      bookmark = @client.add_bookmark('http://someurl.com', :title => 'This is the title', :description => 'This is the description')
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+    end
+  end
+
+  describe '.delete_bookmark' do
+    before do
+      stub_post("bookmarks/delete").
+        to_return(:body => '[]', :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.delete_bookmark(123)
+      a_post("bookmarks/delete").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return an array containing bookmarks on success" do
+      confirm = @client.delete_bookmark(123)
+      confirm.should be_an Array
+      confirm.should be_empty
+    end
+  end
+
+  describe '.star' do
+    before do
+      stub_post("bookmarks/star").
+        to_return(:body => fixture("bookmarks_star.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.star(123)
+      a_post("bookmarks/star").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return a starred bookmark on success" do
+      bookmark = @client.star(123)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+      bookmark.starred.should == '1'
+    end
+
+    it 'should be aliased as .star_bookmark' do
+      @client.star(123).should == @client.star_bookmark(123)
+    end
+  end
+
+  describe '.unstar' do
+    before do
+      stub_post("bookmarks/unstar").
+        to_return(:body => fixture("bookmarks_unstar.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.unstar(123)
+      a_post("bookmarks/unstar").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return an unstarred bookmark on success" do
+      bookmark = @client.unstar(123)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+      bookmark.starred.should == '0'
+    end
+
+    it 'should be aliased as .unstar_bookmark' do
+      @client.unstar(123).should == @client.unstar_bookmark(123)
+    end
+  end
+
+  describe '.archive' do
+    before do
+      stub_post("bookmarks/archive").
+        to_return(:body => fixture("bookmarks_archive.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.archive(123)
+      a_post("bookmarks/archive").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return the bookmark on success" do
+      bookmark = @client.archive(123)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+    end
+
+    it 'should be aliased as .archive_bookmark' do
+      @client.archive(123).should == @client.archive_bookmark(123)
+    end
+  end
+
+  describe '.unarchive' do
+    before do
+      stub_post("bookmarks/unarchive").
+        to_return(:body => fixture("bookmarks_unarchive.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.unarchive(123)
+      a_post("bookmarks/unarchive").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return the bookmark on success" do
+      bookmark = @client.unarchive(123)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+    end
+
+    it 'should be aliased as .unarchive_bookmark' do
+      @client.unarchive(123).should == @client.unarchive_bookmark(123)
+    end
+  end
+
+  describe '.move' do
+    before do
+      stub_post("bookmarks/move").
+        to_return(:body => fixture("bookmarks_move.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.move(123, 12345)
+      a_post("bookmarks/move").with(:body => {:bookmark_id => "123", :folder_id => "12345" }).
+        should have_been_made
+    end
+
+    it "should return the bookmark on success" do
+      bookmark = @client.move(123, 12345)
+      bookmark.should be_a Hashie::Rash
+      bookmark.type.should == 'bookmark'
+    end
+
+    it 'should be aliased as .move_bookmark' do
+      @client.move(123, 12345).should == @client.move_bookmark(123, 12345)
+    end
+  end
+
+  describe '.text' do
+    before do
+      stub_post("bookmarks/get_text").
+        to_return(:body => fixture("bookmarks_get_text.txt"), :headers => {:content_type => "text/html; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.text(123)
+      a_post("bookmarks/get_text").with(:body => {:bookmark_id => "123" }).
+        should have_been_made
+    end
+
+    it "should return the bookmark's html on success" do
+      bookmark = @client.text(123)
+      bookmark.length.should > 0
+      bookmark.should include("Ideo's Axioms for Starting Disruptive New Businesses")
+    end
+
+    it 'should be aliased as .get_text' do
+      @client.text(123).should == @client.get_text(123)
+    end
+  end
+
+end

data/spec/instapaper/client/folder_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Instapaper::Client::Folder do
+  before(:each) do
+    @client = Instapaper::Client.new
+  end
+
+  describe '.folders' do
+    before do
+      stub_post("folders/list").
+        to_return(:body => fixture("folders_list.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.folders
+      a_post("folders/list").
+        should have_been_made
+    end
+
+    it "should return an array containing folders on success" do
+      folders = @client.folders
+      folders.should be_an Array
+      folders.size.should == 2
+      folders.first.should be_a Hashie::Rash
+      folders.first['title'].should == 'Ruby'
+    end
+  end
+
+  describe '.add_folder' do
+    before do
+      stub_post("folders/add").with(:body => {:title => "Ruby" }).
+        to_return(:body => fixture("folders_add.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.add_folder("Ruby")
+      a_post("folders/add").
+        should have_been_made
+    end
+
+    it "should return an array containing the new folder on success" do
+      folders = @client.add_folder("Ruby")
+      folders.should be_an Array
+      folders.should_not be_empty
+      folders.first.should be_a Hashie::Rash
+      folders.first['title'].should == 'Ruby'
+    end
+  end
+
+  describe '.delete_folder' do
+    before do
+      stub_post("folders/delete"). with(:body => {:folder_id => "1" }).
+        to_return(:body => fixture("folders_delete.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.delete_folder("1")
+      a_post("folders/delete").
+        should have_been_made
+    end
+
+    it "should return an empty array on success" do
+      confirm = @client.delete_folder("1")
+      confirm.should be_an Array
+      confirm.should be_empty
+    end
+  end
+
+  describe '.set_order' do
+    before do
+      stub_post("folders/set_order"). with(:body => {:order => "1121173:2,1121174:1" }).
+        to_return(:body => fixture("folders_set_order.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.set_order(['1121173:2','1121174:1'])
+      a_post("folders/set_order").
+        should have_been_made
+    end
+
+    it "should return an array reflecting the new order on success" do
+      folders = @client.set_order(['1121173:2','1121174:1'])
+      folders.should be_an Array
+      folders.first.should be_a Hashie::Rash
+      folders.first['position'].should == 1
+    end
+  end
+
+end

data/spec/instapaper/client/user_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Instapaper::Client::User do
+  before(:each) do
+    @client = Instapaper::Client.new
+  end
+
+  describe '.access_token' do
+    before do
+      stub_post("oauth/access_token").with(:body => { :x_auth_username => 'ohai', :x_auth_password => 'p455w0rd', :x_auth_mode => 'client_auth'}).
+        to_return(:body => fixture("access_token.qline"), :headers => {:content_type => "text/plain; charset=utf-8"})
+    end
+
+    it "should get the correct resource" do
+      @client.access_token('ohai', 'p455w0rd')
+      a_post("oauth/access_token").
+        should have_been_made
+    end
+
+    it "should return the a hash containing an oauth token and secret" do
+      tokens = @client.access_token('ohai', 'p455w0rd')
+      tokens.should be_a Hash
+      tokens.key?('oauth_token').should be_true
+      tokens.key?('oauth_token_secret').should be_true
+    end
+  end
+
+end

data/spec/instapaper/client_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Instapaper::Client do
+
+  before do
+    @options = { :adapter => :em_synchrony, :user_agent => 'Instapaper::Client spec' }
+    @keys = Instapaper::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  describe '.new' do
+    before(:each) do
+      @keys.each do |key|
+        Instapaper.send("#{key}=", key)
+      end
+    end
+
+    after do
+      Instapaper.reset
+    end
+
+    context 'with module configuration' do
+      it "should inherit module configuration" do
+        api = Instapaper::Client.new
+        @keys.each do |key|
+          api.send(key).should eq(key)
+        end
+      end
+    end
+
+    context 'with class configuration' do
+      context "during initialization" do
+        it "should override module configuration" do
+          api = Instapaper::Client.new(@options)
+          @keys.each do |key|
+            h = @options.has_key?(key) ? @options : Instapaper.options
+            api.send(key).should eq(h[key])
+          end
+        end
+      end
+
+      context "after initialization" do
+        it "should override module configuration after initialization" do
+          api = Instapaper::Client.new
+          @options.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            h = @options.has_key?(key) ? @options : Instapaper.options
+            api.send(key).should eq(h[key])
+          end
+        end
+      end
+    end
+  end
+
+  describe '.endpoint_with_prefix' do
+    before(:each) do
+      @client = Instapaper::Client.new
+    end
+
+    it 'should return the ' do
+      @client.endpoint_with_prefix.should == Instapaper.endpoint + Instapaper.path_prefix
+    end
+  end
+end