wayback 0.1.0

data/spec/wayback/api/archive_spec.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+describe Wayback::API::Archive do
+
+  before do
+    @client = Wayback::Client.new
+  end
+
+  # N.B. IN SPEC, NOT USING http:// DUE TO PARSING ISSUE WITH DOUBLE BACKSLASH.
+
+  describe "#list" do
+    before do
+      stub_get("/list/timemap/link/gleu.ch").to_return(:body => fixture("list.timemap"), :headers => {:content_type => "application/link-format"})
+    end
+    it "requests the correct resource" do
+      @client.list('gleu.ch')
+      expect(a_get("/list/timemap/link/gleu.ch")).to have_been_made
+    end
+    it "returns the link data" do
+      timemap = @client.list('gleu.ch')
+      expect(timemap).to be_a Wayback::Archive
+      expect(timemap.id).to eq ('http://gleu.ch')
+      expect(timemap.first_date).to eq (1303064571)
+      expect(timemap.first_date?).to be_true
+    end
+  end
+
+  describe "#page" do
+    before do
+      stub_get("/memento/20130129170322/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+    end
+    it "requests the correct resource" do
+      @client.page('gleu.ch', 20130129170322)
+      expect(a_get("/memento/20130129170322/gleu.ch")).to have_been_made
+    end
+    it "returns the desired page on date" do
+      page = @client.page('gleu.ch', 20130129170322)
+      expect(page).to be_a Wayback::Page
+      expect(page.html).to match /^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im
+    end
+    it "returns the first desired page" do
+      stub_get("/memento/0/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+      page = @client.page('gleu.ch', :first)
+      expect(page).to be_a Wayback::Page
+      expect(page.html).to match /^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im
+    end
+    it "returns the last desired page" do
+      stub_get("/memento/#{Time.now.to_i}/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+      page = @client.page('gleu.ch', :last)
+      expect(page).to be_a Wayback::Page
+      expect(page.html).to match(/^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im)
+    end
+    it "returns the desired page for Time" do
+      stub_get("/memento/#{Time.now.to_i}/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+      page = @client.page('gleu.ch', Time.now)
+      expect(page).to be_a Wayback::Page
+      expect(page.html).to match(/^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im)
+    end
+    it "returns the desired page for Time string" do
+      stub_get("/memento/#{Time.now.to_i}/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+      page = @client.page('gleu.ch', Time.now.to_s)
+      expect(page).to be_a Wayback::Page
+      expect(page.html).to match(/^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im)
+    end
+    # it "handles when error exists" do
+    #   stub_get("/memento/#{Time.now.to_i}/gleu.ch").to_return(:status => 204, :body => '', :headers => {:content_type => "text/xml"})
+    #   page = @client.page('gleu.ch', Time.now.to_s)
+    #   expect(page).to be_a Wayback::Page
+    #   expect(page.html).to match(/^\<\!DOCTYPE html\>.*http\:\/\/gleu\.ch.*\<\/html\>/im)
+    # end
+  end
+
+end

data/spec/wayback/archive_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Wayback::Archive do
+
+  describe "#==" do
+    it "returns true when objects IDs are the same" do
+      saved_search = Wayback::Archive.new(:id => 1, :name => "foo")
+      other = Wayback::Archive.new(:id => 1, :name => "bar")
+      expect(saved_search == other).to be_true
+    end
+    it "returns false when objects IDs are different" do
+      saved_search = Wayback::Archive.new(:id => 1)
+      other = Wayback::Archive.new(:id => 2)
+      expect(saved_search == other).to be_false
+    end
+    it "returns false when classes are different" do
+      saved_search = Wayback::Archive.new(:id => 1)
+      other = Wayback::Identity.new(:id => 1)
+      expect(saved_search == other).to be_false
+    end
+  end
+
+end

data/spec/wayback/base_spec.rb

@@ -0,0 +1,117 @@
+require 'helper'
+
+describe Wayback::Base do
+
+  context "identity map enabled" do
+    before do
+      Wayback.identity_map = Wayback::IdentityMap
+      object = Wayback::Base.new(:id => 1)
+      @base = Wayback::Base.store(object)
+    end
+
+    after do
+      Wayback.identity_map = false
+    end
+
+    describe ".identity_map" do
+      it "returns an instance of the identity map" do
+        expect(Wayback::Base.identity_map).to be_a Wayback::IdentityMap
+      end
+    end
+
+    describe ".fetch" do
+      it "returns existing objects" do
+        expect(Wayback::Base.fetch(:id => 1)).to be
+      end
+
+      it "raises an error on objects that don't exist" do
+        expect{Wayback::Base.fetch(:id => 6)}.to raise_error Wayback::Error::IdentityMapKeyError
+      end
+    end
+
+    describe ".store" do
+      it "stores Wayback::Base objects" do
+        object = Wayback::Base.new(:id => 4)
+        expect(Wayback::Base.store(object)).to be_a Wayback::Base
+      end
+    end
+
+    describe ".fetch_or_new" do
+      it "returns existing objects" do
+        expect(Wayback::Base.fetch_or_new(:id => 1)).to be
+      end
+      it "creates new objects and stores them" do
+        expect(Wayback::Base.fetch_or_new(:id => 2)).to be
+        expect(Wayback::Base.fetch(:id => 2)).to be
+      end
+    end
+
+    describe "#[]" do
+      it "calls methods using [] with symbol" do
+        expect(@base[:object_id]).to be_an Integer
+      end
+      it "calls methods using [] with string" do
+        expect(@base['object_id']).to be_an Integer
+      end
+      it "returns nil for missing method" do
+        expect(@base[:foo]).to be_nil
+        expect(@base['foo']).to be_nil
+      end
+    end
+
+    describe "#to_hash" do
+      it "returns a hash" do
+        expect(@base.to_hash).to be_a Hash
+        expect(@base.to_hash[:id]).to eq 1
+      end
+    end
+
+    describe "identical objects" do
+      it "have the same object_id" do
+        expect(@base.object_id).to eq Wayback::Base.fetch(:id => 1).object_id
+      end
+    end
+
+  end
+
+  context "identity map disabled" do
+    before(:all) do
+      Wayback.identity_map = false
+    end
+    after(:all) do
+      Wayback.identity_map = Wayback::IdentityMap
+    end
+
+    describe ".identity_map" do
+      it "returns nil" do
+        expect(Wayback::Base.identity_map).to be_nil
+      end
+    end
+
+    describe ".fetch" do
+      it "returns nil" do
+        expect(Wayback::Base.fetch(:id => 1)).to be_nil
+      end
+    end
+
+    describe ".store" do
+      it "returns an instance of the object" do
+        expect(Wayback::Base.store(Wayback::Base.new(:id => 1))).to be_a Wayback::Base
+      end
+    end
+
+    describe ".fetch_or_new" do
+      it "creates new objects" do
+        expect(Wayback::Base.fetch_or_new(:id => 2)).to be
+        expect(Wayback.identity_map).to be_false
+      end
+    end
+  end
+
+  describe '#attrs' do
+    it 'returns a hash of attributes' do
+      expect(Wayback::Base.new(:id => 1).attrs).to eq({:id => 1})
+    end
+  end
+
+end

data/spec/wayback/client_spec.rb

@@ -0,0 +1,114 @@
+require 'helper'
+
+describe Wayback::Client do
+
+  subject do
+    Wayback::Client.new(:consumer_key => "CK", :consumer_secret => "CS", :oauth_token => "OT", :oauth_token_secret => "OS")
+  end
+
+  context "with module configuration" do
+
+    before do
+      Wayback.configure do |config|
+        Wayback::Configurable.keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Wayback.reset!
+    end
+
+    it "inherits the module configuration" do
+      client = Wayback::Client.new
+      Wayback::Configurable.keys.each do |key|
+        expect(client.instance_variable_get(:"@#{key}")).to eq key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :connection_options => {:timeout => 10},
+          :endpoint => 'http://xolator.com/',
+          :middleware => Proc.new{},
+          :identity_map => ::Hash
+        }
+      end
+
+      context "during initialization" do
+        it "overrides the module configuration" do
+          client = Wayback::Client.new(@configuration)
+          Wayback::Configurable.keys.each do |key|
+            expect(client.instance_variable_get(:"@#{key}")).to eq @configuration[key]
+          end
+        end
+      end
+
+      context "after initialization" do
+        it "overrides the module configuration after initialization" do
+          client = Wayback::Client.new
+          client.configure do |config|
+            @configuration.each do |key, value|
+              config.send("#{key}=", value)
+            end
+          end
+          Wayback::Configurable.keys.each do |key|
+            expect(client.instance_variable_get(:"@#{key}")).to eq @configuration[key]
+          end
+        end
+      end
+
+    end
+  end
+
+  describe "#delete" do
+    before do
+      stub_delete("/custom/delete").with(:query => {:deleted => "object"})
+    end
+    it "allows custom delete requests" do
+      subject.delete("/custom/delete", {:deleted => "object"})
+      expect(a_delete("/custom/delete").with(:query => {:deleted => "object"})).to have_been_made
+    end
+  end
+
+  describe "#put" do
+    before do
+      stub_put("/custom/put").with(:body => {:updated => "object"})
+    end
+    it "allows custom put requests" do
+      subject.put("/custom/put", {:updated => "object"})
+      expect(a_put("/custom/put").with(:body => {:updated => "object"})).to have_been_made
+    end
+  end
+
+  describe "#post" do
+    before do
+      stub_post("/custom/post").with(:body => {:updated => "object"})
+    end
+    it "allows custom post requests" do
+      subject.post("/custom/post", {:updated => "object"})
+      expect(a_post("/custom/post").with(:body => {:updated => "object"})).to have_been_made
+    end
+  end
+
+  describe "#connection" do
+    it "looks like Faraday connection" do
+      expect(subject.send(:connection)).to respond_to(:run_request)
+    end
+    it "memoizes the connection" do
+      c1, c2 = subject.send(:connection), subject.send(:connection)
+      expect(c1.object_id).to eq c2.object_id
+    end
+  end
+
+  describe "#request" do
+    it "catches Faraday errors" do
+      subject.stub!(:connection).and_raise(Faraday::Error::ClientError.new("Oops"))
+      expect{subject.send(:request, :get, "/path")}.to raise_error Wayback::Error::ClientError
+    end
+  end
+
+end

data/spec/wayback/error/client_error_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Wayback::Error::ClientError do
+
+  before do
+    @client = Wayback::Client.new
+  end
+
+  Wayback::Error::ClientError.errors.each do |status, exception|
+    [nil, "error"].each do |body|
+      context "when HTTP status is #{status} and body is #{body.inspect}" do
+        before do
+          body_message = '<wayback><error><title>Hrm.</title><message>Wayback Machine doesn&apos;t have that page archived.</message></error></wayback>' unless body.nil?
+          stub_get("/list/timemap/link/gleu.ch").to_return(:body => body_message, :status => status)
+        end
+        it "raises #{exception.name}" do
+          expect{@client.list('gleu.ch')}.to raise_error exception
+        end
+      end
+    end
+  end
+
+end

data/spec/wayback/error/server_error_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe Wayback::Error::ServerError do
+
+  before do
+    @client = Wayback::Client.new
+  end
+
+  Wayback::Error::ServerError.errors.each do |status, exception|
+    context "when HTTP status is #{status}" do
+      before do
+        stub_get("/list/timemap/link/gleu.ch").to_return(:status => status)
+      end
+      it "raises #{exception.name}" do
+        expect{@client.list('gleu.ch')}.to raise_error exception
+      end
+    end
+  end
+
+end

data/spec/wayback/error_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe Wayback::Error do
+
+  describe "#initialize" do
+    it "wraps another error class" do
+      begin
+        raise Faraday::Error::ClientError.new("Oops")
+      rescue Faraday::Error::ClientError
+        begin
+          raise Wayback::Error
+        rescue Wayback::Error => error
+          expect(error.message).to eq "Oops"
+          expect(error.wrapped_exception.class).to eq Faraday::Error::ClientError
+        end
+      end
+    end
+  end
+
+end

data/spec/wayback/identifiable_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+describe Wayback::Identity do
+
+  describe "#initialize" do
+    it "raises an ArgumentError when type is not specified" do
+      expect{Wayback::Identity.new}.to raise_error ArgumentError
+    end
+  end
+
+  context "identity map enabled" do
+    before do
+      Wayback.identity_map = Wayback::IdentityMap
+    end
+
+    after do
+      Wayback.identity_map = false
+    end
+
+    describe ".fetch" do
+      it "returns existing objects" do
+        Wayback::Identity.store(Wayback::Identity.new(:id => 1))
+        expect(Wayback::Identity.fetch(:id => 1)).to be
+      end
+
+      it "raises an error on objects that don't exist" do
+        expect{Wayback::Identity.fetch(:id => 6)}.to raise_error Wayback::Error::IdentityMapKeyError
+      end
+    end
+  end
+
+  describe "#==" do
+    it "returns true when objects IDs are the same" do
+      one = Wayback::Identity.new(:id => 1, :screen_name => "gleuch")
+      two = Wayback::Identity.new(:id => 1, :screen_name => "ohjia")
+      expect(one == two).to be_true
+    end
+    it "returns false when objects IDs are different" do
+      one = Wayback::Identity.new(:id => 1)
+      two = Wayback::Identity.new(:id => 2)
+      expect(one == two).to be_false
+    end
+    it "returns false when classes are different" do
+      one = Wayback::Identity.new(:id => 1)
+      two = Wayback::Base.new(:id => 1)
+      expect(one == two).to be_false
+    end
+  end
+
+end