Contents

require "delegate"

module Ezid
  #
  # A response from the EZID service.
  #
  # @api private
  class Response < SimpleDelegator

    # Success response status
    SUCCESS = "success"

    # Error response status
    ERROR = "error"

    IDENTIFIER_RE = /^(doi|ark|urn):[^\s]+/
    SHADOW_ARK_RE = /\| (ark:[^\s]+)/

    def id
      @id ||= IDENTIFIER_RE.match(message)[0]
    end

    def shadow_ark
      @shadow_ark ||= SHADOW_ARK_RE.match(message)[1]
    end

    def metadata
      content[1]
    end

    # The response status -- "success" or "error"
    # @return [String] the status
    def status
      @status ||= status_line.split(/: /)
    end

    # The status line of the response
    # @return [String] the status line
    def status_line
      content[0]
    end

    # The body of the response split into: status line and rest of body
    # @return [Array] status line, rest of body
    def content
      @content ||= body.split(/\r?\n/, 2)
    end

    # The outcome of the request - "success" or "error"
    # @return [String] the outcome
    def outcome
      status.first
    end

    # The EZID status message
    # @return [String] the message
    def message
      status.last
    end

    # Whether the outcome was an error
    # @return [Boolean]
    def error?
      outcome == ERROR
    end

    # Whether the outcome was a success
    # @return [Boolean]
    def success?
      outcome == SUCCESS
    end

    # Returns an exception instance if there was an error
    # @return [Ezid::Error] the exception
    def exception
      @exception ||= (error? && Error.new(message))
    end

    # The URI path of the request
    # @return [String] the path
    def uri_path
      __getobj__.uri.path
    end

    def cookie
      self["Set-Cookie"].split(";").first rescue nil
    end

  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ezid-client-0.4.2	lib/ezid/response.rb
ezid-client-0.4.1	lib/ezid/response.rb
ezid-client-0.4.0	lib/ezid/response.rb