wayback 0.1.0

data/lib/wayback/configurable.rb

@@ -0,0 +1,48 @@
+require 'forwardable'
+require 'wayback/error/configuration_error'
+
+module Wayback
+  module Configurable
+    extend Forwardable
+    attr_accessor :endpoint, :connection_options, :identity_map, :middleware
+    def_delegator :options, :hash
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :endpoint,
+          :connection_options,
+          :identity_map,
+          :middleware
+        ]
+      end
+
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    #
+    # @raise [Wayback::Error::ConfigurationError] Error is raised when supplied
+    #   wayback credentials are not a String or Symbol.
+    def configure
+      yield self
+      self
+    end
+
+    def reset!
+      Wayback::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Wayback::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def options
+      Hash[Wayback::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+  end
+end

data/lib/wayback/default.rb

@@ -0,0 +1,68 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'wayback/configurable'
+require 'wayback/error/client_error'
+require 'wayback/error/server_error'
+require 'wayback/response/raise_error'
+require 'wayback/response/parse_memento'
+require 'wayback/response/parse_memento_page'
+require 'wayback/version'
+
+module Wayback
+  module Default
+    ENDPOINT = 'http://api.wayback.archive.org' unless defined? Wayback::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers  => {:user_agent => "Wayback Ruby Gem #{Wayback::Version}"},
+      :request  => {:open_timeout => 5, :timeout => 10},
+      :ssl      => {:verify => false},
+    } unless defined? Wayback::Default::CONNECTION_OPTIONS
+    IDENTITY_MAP = false unless defined? Wayback::Default::IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      # Convert request params to "www-form-urlencoded"
+      builder.use Faraday::Request::UrlEncoded
+      # Follow redirects
+      builder.use FaradayMiddleware::FollowRedirects
+      # Handle 4xx server responses
+      builder.use Wayback::Response::RaiseError, Wayback::Error::ClientError
+      # Handle 5xx server responses
+      builder.use Wayback::Response::RaiseError, Wayback::Error::ServerError
+      # Parse memento page
+      builder.use Wayback::Response::ParseMementoPage
+      # Parse link-format with custom memento parser
+      builder.use Wayback::Response::ParseMemento
+      # Set Faraday's HTTP adapter
+      builder.adapter Faraday.default_adapter
+    end unless defined? Wayback::Default::MIDDLEWARE
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[Wayback::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @note This is configurable in case you want to use a Wayback Machine-compatible endpoint.
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/wayback/error.rb

@@ -0,0 +1,31 @@
+module Wayback
+  # Custom error class for rescuing from all Wayback errors
+  class Error < StandardError
+    attr_reader :wrapped_exception
+
+    # @return [Hash]
+    def self.errors
+      @errors ||= Hash[descendants.map{|klass| [klass.const_get(:HTTP_STATUS_CODE), klass]}]
+    end
+
+    # @return [Array]
+    def self.descendants
+      ObjectSpace.each_object(::Class).select{|klass| klass < self}
+    end
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @param response_headers [Hash]
+    # @return [Wayback::Error]
+    def initialize(exception=$!, response_headers={})
+      @wrapped_exception = exception
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+
+  end
+end

data/lib/wayback/error/already_favorited.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/forbidden'
+
+module Wayback
+  class Error
+    # Raised when a Tweet has already been favorited
+    class AlreadyFavorited < Wayback::Error
+      MESSAGE = "You have already favorited this status"
+    end
+  end
+end

data/lib/wayback/error/already_retweeted.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/forbidden'
+
+module Wayback
+  class Error
+    # Raised when a Tweet has already been retweeted
+    class AlreadyRetweeted < Wayback::Error
+      MESSAGE = "sharing is not permissible for this status (Share validations failed)"
+    end
+  end
+end

data/lib/wayback/error/bad_gateway.rb

@@ -0,0 +1,11 @@
+require 'wayback/error/server_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 502
+    class BadGateway < Wayback::Error::ServerError
+      HTTP_STATUS_CODE = 502
+      MESSAGE = "Wayback is down or being upgraded."
+    end
+  end
+end

data/lib/wayback/error/bad_request.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 400
+    class BadRequest < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 400
+    end
+  end
+end

data/lib/wayback/error/client_error.rb

@@ -0,0 +1,28 @@
+require 'wayback/error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < Wayback::Error
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [Wayback::Error]
+      def self.from_response(response={})
+        new(parse_error(response[:body]), response[:response_headers])
+      end
+
+    private
+
+      def self.parse_error(body)
+        if body.nil? || body.is_a?(String)
+          ''
+        # elsif body[:error]
+        #   body[:error]
+        end
+      end
+
+    end
+  end
+end

data/lib/wayback/error/configuration_error.rb

@@ -0,0 +1,8 @@
+require 'wayback/error'
+
+module Wayback
+  class Error
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/wayback/error/decode_error.rb

@@ -0,0 +1,9 @@
+require 'wayback/error'
+
+module Wayback
+  class Error
+    # Raised when JSON parsing fails
+    class DecodeError < Wayback::Error
+    end
+  end
+end

data/lib/wayback/error/forbidden.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 403
+    class Forbidden < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 403
+    end
+  end
+end

data/lib/wayback/error/gateway_timeout.rb

@@ -0,0 +1,11 @@
+require 'wayback/error/server_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 504
+    class GatewayTimeout < Wayback::Error::ServerError
+      HTTP_STATUS_CODE = 504
+      MESSAGE = "The Wayback servers are up, but the request couldn't be serviced due to some failure within our stack. Try again later."
+    end
+  end
+end

data/lib/wayback/error/identity_map_key_error.rb

@@ -0,0 +1,9 @@
+require 'wayback/error'
+
+module Wayback
+  class Error
+    # Inherit from KeyError when Ruby 1.8 compatibility is removed
+    class IdentityMapKeyError < ::IndexError
+    end
+  end
+end

data/lib/wayback/error/internal_server_error.rb

@@ -0,0 +1,11 @@
+require 'wayback/error/server_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 500
+    class InternalServerError < Wayback::Error::ServerError
+      HTTP_STATUS_CODE = 500
+      MESSAGE = "Something is technically wrong."
+    end
+  end
+end

data/lib/wayback/error/not_acceptable.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 406
+    class NotAcceptable < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 406
+    end
+  end
+end

data/lib/wayback/error/not_found.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 404
+    class NotFound < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 404
+    end
+  end
+end

data/lib/wayback/error/server_error.rb

@@ -0,0 +1,28 @@
+require 'wayback/error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns a 5xx HTTP status code
+    class ServerError < Wayback::Error
+      MESSAGE = "Server Error"
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [Wayback::Error]
+      def self.from_response(response={})
+        new(nil, response[:response_headers])
+      end
+
+      # Initializes a new ServerError object
+      #
+      # @param message [String]
+      # @param response_headers [Hash]
+      # @return [Wayback::Error::ServerError]
+      def initialize(message=nil, response_headers={})
+        super((message || self.class.const_get(:MESSAGE)), response_headers)
+      end
+
+    end
+  end
+end

data/lib/wayback/error/service_unavailable.rb

@@ -0,0 +1,11 @@
+require 'wayback/error/server_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 503
+    class ServiceUnavailable < Wayback::Error::ServerError
+      HTTP_STATUS_CODE = 503
+      MESSAGE = "(__-){ Wayback is over capacity."
+    end
+  end
+end

data/lib/wayback/error/too_many_requests.rb

@@ -0,0 +1,12 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 429
+    class TooManyRequests < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 429
+    end
+    EnhanceYourCalm = TooManyRequests
+    RateLimited = TooManyRequests
+  end
+end

data/lib/wayback/error/unauthorized.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 401
+    class Unauthorized < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 401
+    end
+  end
+end

data/lib/wayback/error/unprocessable_entity.rb

@@ -0,0 +1,10 @@
+require 'wayback/error/client_error'
+
+module Wayback
+  class Error
+    # Raised when Wayback returns the HTTP status code 404
+    class UnprocessableEntity < Wayback::Error::ClientError
+      HTTP_STATUS_CODE = 422
+    end
+  end
+end

data/lib/wayback/factory.rb

@@ -0,0 +1,21 @@
+module Wayback
+  class Factory
+
+    # Instantiates a new action object
+    #
+    # @param attrs [Hash]
+    # @raise [ArgumentError] Error raised when supplied argument is missing an :action key.
+    # @return [Wayback::Action::Favorite, Wayback::Action::Follow, Wayback::Action::ListMemberAdded, Wayback::Action::Mention, Wayback::Action::Reply, Wayback::Action::Retweet]
+    def self.fetch_or_new(method, klass, attrs={})
+      return unless attrs
+      type = attrs.delete(method.to_sym)
+      if type
+        const_name = type.gsub(/\/(.?)/){"::#{$1.upcase}"}.gsub(/(?:^|_)(.)/){$1.upcase}
+        klass.const_get(const_name.to_sym).fetch_or_new(attrs)
+      else
+        raise ArgumentError, "argument must have :#{method} key"
+      end
+    end
+
+  end
+end

data/lib/wayback/identity.rb

@@ -0,0 +1,50 @@
+require 'wayback/base'
+require 'wayback/error/identity_map_key_error'
+
+module Wayback
+  class Identity < Wayback::Base
+
+    def self.fetch(attrs)
+      return unless identity_map
+
+      id = attrs[:id]
+      if id  && object = identity_map.fetch(id)
+        return object.update(attrs)
+      end
+
+      return yield if block_given?
+      raise Wayback::Error::IdentityMapKeyError, "key not found"
+    end
+
+    # Stores an object in the identity map.
+    #
+    # @param object [Object]
+    # @return [Wayback::Identity]
+    def self.store(object)
+      return object unless identity_map
+      identity_map.store(object.id, object)
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @raise [ArgumentError] Error raised when supplied argument is missing an :id key.
+    # @return [Wayback::Identity]
+    def initialize(attrs={})
+      super
+      raise ArgumentError, "argument must have an :id key" unless id
+    end
+
+    # @param other [Wayback::Identity]
+    # @return [Boolean]
+    def ==(other)
+      super || attr_equal(:id, other) || attrs_equal(other)
+    end
+
+    # @return [Integer]
+    def id
+      @attrs[:id]
+    end
+
+  end
+end