wayback 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.2.0
+-----
+* Archive.org has changed their endpoint URLs to http://web.archive.org/web. Version 0.2.0 corrects this issue with the new ENDPOINT_PATH configuration for handling the /web path.
+
 0.1.0
 -----
 * [Initial release](https://github.com/XOlator/wayback_gem)

data/README.md

@@ -1,7 +1,13 @@
 # Wayback Gem
 
-![Build Status](https://secure.travis-ci.org/XOlator/wayback_gem.png?branch=master)
-![Coverage Status](https://coveralls.io/repos/XOlator/wayback_gem/badge.png?branch=master)
+[![Gem Version](https://badge.fury.io/rb/wayback.png)][gem]
+[![Build Status](https://secure.travis-ci.org/XOlator/wayback_gem.png?branch=master)][travis]
+[![Coverage Status](https://coveralls.io/repos/XOlator/wayback_gem/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/wayback
+[travis]: http://travis-ci.org/XOlator/wayback_gem
+[coveralls]: https://coveralls.io/r/XOlator/wayback_gem
+
 
 A Ruby interface to Archive.org's Wayback Machine Memento API.
 
@@ -9,22 +15,30 @@ A Ruby interface to Archive.org's Wayback Machine Memento API.
     gem install wayback
 
 ## Quick Start Guide
-So you want to get up and tweeting as fast as possible?
+Accessing the Wayback Machine is super-duper easy.
+
+```ruby
+require 'wayback'
+Wayback.page('http://www.xolator.com', :first)
+```
 
 
 ## Documentation
-COMING SOON! -- [documentation](http://rdoc.info/gems/wayback)
+You can browse the Rdoc [here][documentation].
+
+[documentation]: http://rdoc.info/github/XOlator/wayback_gem/master/frames
 
 
 ## Configuration
 
-There is no real configuration necessary for accessing Archive.org's Wayback Machine Memento API, however you can change endpoint and other basic connection options.
+There is no real configuration necessary for accessing the Wayback Machine Memento API, however you can change endpoint and other basic connection options.
 
-The current defaults for this gem are:
+The current defaults configurations for this gem are:
 
 ```ruby
 Wayback.configure do |c|
-  c.endpoint = 'http://api.wayback.archive.org'
+  c.endpoint = 'http://web.archive.org'
+  c.endpoint_path = '/web'
   c.connection_options = {
     :headers  => {:user_agent => "Wayback Ruby Gem #{Wayback::Version}"},
     :request  => {:open_timeout => 5, :timeout => 10},
@@ -68,14 +82,17 @@ Wayback.page('http://www.xolator.com', :last)
 
 
 ## Additional Notes
-Based heavily on the [Twitter gem](https://www.github.com/sferik/twitter). (Xie xie!)
+Based heavily on the [Twitter gem][twitter_gem]. (Xièxie!)
 
-More information on Archive's Wayback Machine memento API can be found [here](http://mementoweb.org/depot/native/ia/).
+More information on Archive's Wayback Machine memento API can be found [here][wayback_api].
 
+[twitter_gem]: https://www.github.com/sferik/twitter
+[wayback_api]: http://mementoweb.org/depot/native/ia/
 
 
 ## Copyright
-Copyright (c) 2013 XOlator.
-See [LICENSE][] for details.
+Copyright (c) 2013 [XOlator][xolator].
+See [LICENSE][license] for details.
 
+[xolator]: http://www.xolator.com
 [license]: LICENSE.md

data/lib/wayback/api/archive.rb

@@ -10,19 +10,20 @@ module Wayback
       # Return a list of archived pages
       #
       # @return [Wayback::Archive]
-      # @param url [String] The page that of which was archived.
+      # @param url [String] The page URI that of which was archived.
       # @param options [Hash] A customizable set of options.
       # @example Return the list of available archives for a web page.
       #   Wayback.list('http://gleu.ch')
       def list(url, options={})
-        object_from_response(Wayback::Archive, :get, "/list/timemap/link/#{url}", options)
+        object_from_response(Wayback::Archive, :get, "/timemap/link/#{url}", options)
       end
 
       # Returns the HTML contents of an archive page, fetched by date
       #
       # @raise [Wayback::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Wayback::Page]
-      # @param url [String] The page that of which was archived.
+      # @param url [String] The page URI that of which was archived.
+      # @param date [String, Symbol, Time, Fixnum, Integer] A date or symbol to describe which dated archive page. Symbols include :first and :last. Strings are converted to integer timestamps.
       # @param options [Hash] A customizable set of options.
       # @example Return the HTML archive for the page.
       #   Wayback.page('http://gleu.ch')
@@ -34,7 +35,7 @@ module Wayback
         date = 0 if date == :first
         date = Time.now if date == :last
         date = Time.parse(date).to_i unless [Fixnum,Time,Integer].include?(date.class)
-        object_from_response(Wayback::Page, :get, "/memento/#{date.to_i}/#{url}", options)
+        object_from_response(Wayback::Page, :get, "/#{date.to_i}/#{url}", options)
       end
 
     end

data/lib/wayback/client.rb

@@ -46,7 +46,7 @@ module Wayback
   private
 
     def request(method, path, params={}, signature_params=params)
-      connection.send(method.to_sym, path, params).env
+      connection.send(method.to_sym, path.insert(0, @endpoint_path), params).env
     rescue Faraday::Error::ClientError
       raise Wayback::Error::ClientError
     end

data/lib/wayback/configurable.rb

@@ -4,7 +4,7 @@ require 'wayback/error/configuration_error'
 module Wayback
   module Configurable
     extend Forwardable
-    attr_accessor :endpoint, :connection_options, :identity_map, :middleware
+    attr_accessor :endpoint, :endpoint_path, :connection_options, :identity_map, :middleware
     def_delegator :options, :hash
 
     class << self
@@ -12,6 +12,7 @@ module Wayback
       def keys
         @keys ||= [
           :endpoint,
+          :endpoint_path,
           :connection_options,
           :identity_map,
           :middleware

data/lib/wayback/default.rb

@@ -10,7 +10,8 @@ require 'wayback/version'
 
 module Wayback
   module Default
-    ENDPOINT = 'http://api.wayback.archive.org' unless defined? Wayback::Default::ENDPOINT
+    ENDPOINT = 'http://web.archive.org' unless defined? Wayback::Default::ENDPOINT
+    ENDPOINT_PATH = '/web' unless defined? Wayback::Default::ENDPOINT_PATH
     CONNECTION_OPTIONS = {
       :headers  => {:user_agent => "Wayback Ruby Gem #{Wayback::Version}"},
       :request  => {:open_timeout => 5, :timeout => 10},
@@ -47,6 +48,10 @@ module Wayback
         ENDPOINT
       end
 
+      def endpoint_path
+        ENDPOINT_PATH
+      end
+
       def connection_options
         CONNECTION_OPTIONS
       end

data/lib/wayback/version.rb

@@ -1,7 +1,7 @@
 module Wayback
   class Version
     MAJOR = 0 unless defined? Wayback::Version::MAJOR
-    MINOR = 1 unless defined? Wayback::Version::MINOR
+    MINOR = 2 unless defined? Wayback::Version::MINOR
     PATCH = 0 unless defined? Wayback::Version::PATCH
     PRE = nil unless defined? Wayback::Version::PRE
 

data/spec/fixtures/list.timemap

@@ -1,9 +1,9 @@
-<http://api.wayback.archive.org/list/timebundle/http://gleu.ch>; rel="timebundle",
+<http://web.archive.org/web/timebundle/http://gleu.ch>; rel="timebundle",
 <http://gleu.ch>; rel="original",
-<http://api.wayback.archive.org/list/timemap/link/http://gleu.ch>; rel="timemap"; type="application/link-format",
-<http://api.wayback.archive.org/list/timegate/http://gleu.ch>; rel="timegate",
-<http://api.wayback.archive.org/memento/20110417182251/http://gleu.ch/>; rel="first memento"; datetime="Sun, 17 Apr 2011 18:22:51 GMT",
-<http://api.wayback.archive.org/memento/20120117073306/http://gleu.ch/>; rel="memento"; datetime="Tue, 17 Jan 2012 07:33:06 GMT",
-<http://api.wayback.archive.org/memento/20130113125339/http://gleu.ch/>; rel="memento"; datetime="Sun, 13 Jan 2013 12:53:39 GMT",
-<http://api.wayback.archive.org/memento/20130120084303/http://gleu.ch/>; rel="memento"; datetime="Sun, 20 Jan 2013 08:43:03 GMT",
-<http://api.wayback.archive.org/memento/20130129170322/http://gleu.ch/>; rel="last memento"; datetime="Tue, 29 Jan 2013 17:03:22 GMT"
+<http://web.archive.org/web/timemap/link/http://gleu.ch>; rel="timemap"; type="application/link-format",
+<http://web.archive.org/web/timegate/http://gleu.ch>; rel="timegate",
+<http://web.archive.org/web/20110417182251/http://gleu.ch/>; rel="first memento"; datetime="Sun, 17 Apr 2011 18:22:51 GMT",
+<http://web.archive.org/web/20120117073306/http://gleu.ch/>; rel="memento"; datetime="Tue, 17 Jan 2012 07:33:06 GMT",
+<http://web.archive.org/web/20130113125339/http://gleu.ch/>; rel="memento"; datetime="Sun, 13 Jan 2013 12:53:39 GMT",
+<http://web.archive.org/web/20130120084303/http://gleu.ch/>; rel="memento"; datetime="Sun, 20 Jan 2013 08:43:03 GMT",
+<http://web.archive.org/web/20130129170322/http://gleu.ch/>; rel="last memento"; datetime="Tue, 29 Jan 2013 17:03:22 GMT"

data/spec/helper.rb

@@ -25,35 +25,35 @@ RSpec.configure do |config|
 end
 
 def a_delete(path)
-  a_request(:delete, Wayback::Default::ENDPOINT + path)
+  a_request(:delete, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def a_get(path)
-  a_request(:get, Wayback::Default::ENDPOINT + path)
+  a_request(:get, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def a_post(path)
-  a_request(:post, Wayback::Default::ENDPOINT + path)
+  a_request(:post, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def a_put(path)
-  a_request(:put, Wayback::Default::ENDPOINT + path)
+  a_request(:put, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def stub_delete(path)
-  stub_request(:delete, Wayback::Default::ENDPOINT + path)
+  stub_request(:delete, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def stub_get(path)
-  stub_request(:get, Wayback::Default::ENDPOINT + path)
+  stub_request(:get, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def stub_post(path)
-  stub_request(:post, Wayback::Default::ENDPOINT + path)
+  stub_request(:post, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def stub_put(path)
-  stub_request(:put, Wayback::Default::ENDPOINT + path)
+  stub_request(:put, Wayback::Default::ENDPOINT + Wayback::Default::ENDPOINT_PATH + path)
 end
 
 def fixture_path

data/spec/wayback/api/archive_spec.rb

@@ -10,11 +10,11 @@ describe Wayback::API::Archive do
 
   describe "#list" do
     before do
-      stub_get("/list/timemap/link/gleu.ch").to_return(:body => fixture("list.timemap"), :headers => {:content_type => "application/link-format"})
+      stub_get("/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
+      expect(a_get("/timemap/link/gleu.ch")).to have_been_made
     end
     it "returns the link data" do
       timemap = @client.list('gleu.ch')
@@ -27,11 +27,11 @@ describe Wayback::API::Archive do
 
   describe "#page" do
     before do
-      stub_get("/memento/20130129170322/gleu.ch").to_return(:body => fixture("page.html"), :headers => {:content_type => "text/html"})
+      stub_get("/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
+      expect(a_get("/20130129170322/gleu.ch")).to have_been_made
     end
     it "returns the desired page on date" do
       page = @client.page('gleu.ch', 20130129170322)
@@ -39,31 +39,31 @@ describe Wayback::API::Archive do
       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"})
+      stub_get("/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"})
+      stub_get("/#{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"})
+      stub_get("/#{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"})
+      stub_get("/#{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"})
+    #   stub_get("/#{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)

data/spec/wayback/client_spec.rb

@@ -33,6 +33,7 @@ describe Wayback::Client do
         @configuration = {
           :connection_options => {:timeout => 10},
           :endpoint => 'http://xolator.com/',
+          :endpoint_path => '',
           :middleware => Proc.new{},
           :identity_map => ::Hash
         }

data/spec/wayback/error/client_error_spec.rb

@@ -11,7 +11,7 @@ describe Wayback::Error::ClientError do
       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)
+          stub_get("/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

data/spec/wayback/error/server_error_spec.rb

@@ -9,7 +9,7 @@ describe Wayback::Error::ServerError do
   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)
+        stub_get("/timemap/link/gleu.ch").to_return(:status => status)
       end
       it "raises #{exception.name}" do
         expect{@client.list('gleu.ch')}.to raise_error exception

data/spec/wayback_spec.rb

@@ -10,12 +10,12 @@ describe Wayback do
 
   context "when delegating to a client" do
     before do
-      stub_get("/list/timemap/link/gleu.ch").to_return(:body => fixture("list.timemap"), :headers => {:content_type => "application/link-format"})
+      stub_get("/timemap/link/gleu.ch").to_return(:body => fixture("list.timemap"), :headers => {:content_type => "application/link-format"})
     end
   
     it "requests the correct resource" do
       Wayback.list('gleu.ch')
-      expect(a_get("/list/timemap/link/gleu.ch")).to have_been_made
+      expect(a_get("/timemap/link/gleu.ch")).to have_been_made
     end
   
     it "returns the same results as a client" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wayback
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the Archive.org's Wayback Machine Memento API.