ezid-client 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aadca7c8873de91162829915f9f1eb4a071505a2
-  data.tar.gz: ded517161bf42799607d34c27caf5297baa60f24
+  metadata.gz: 06c4a2e03acdbef8b3da067ca693fd51f8a5ba1e
+  data.tar.gz: 5347307f3892f3beaac5ea59e2a8d091b2ad12ac
 SHA512:
-  metadata.gz: a8bc419ec35cbd1b0b467c3ea1e71c01066b4b0aa604bd0ac3d5e9339c91b5a74693171cd6c0a478284986fbcb6cdc3659fc6d902a77b9e2d9a601356dc1185b
-  data.tar.gz: 3a20ac6400849df2dd6ce85c422e693627357f16c54de512c812a73a886545599c328d10ae38bff7a02a15f9d307f4d4d05d104ece70e05675ad039f7974396e
+  metadata.gz: acb785db04eaae33f870c1dd7ab1e292ca58b5b4dab7647b2ac15cb0daae37c3d82b4065f60380efb6530353e83c204d25d7206ec506636c19d77d751549293e
+  data.tar.gz: 34a9362e2dc610bf0a03c14d4174726556286d8e892a04b4eee9e4a06d9f916802bd668a64679f9e4b67402e66c1613948ed2487859301f01bf4160140aef99b

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 
 [Mint an identifier on a shoulder](http://ezid.cdlib.org/doc/apidoc.html#operation-mint-identifier)
 
-```ruby
+```
 >> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4")
 I, [2014-12-04T15:06:02.428445 #86655]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4rx9d523
 I, [2014-12-04T15:06:03.249793 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
@@ -58,7 +58,7 @@ end
 
 New identifiers will then be minted on the default shoulder when a shoulder is not specified:
 
-```ruby
+```
 >> identifier = Ezid::Identifier.create
 I, [2014-12-09T11:22:34.499860 #32279]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk43f4wd4v
 I, [2014-12-09T11:22:35.317181 #32279]  INFO -- : EZID GET ark:/99999/fk43f4wd4v -- success: ark:/99999/fk43f4wd4v
@@ -67,7 +67,7 @@ I, [2014-12-09T11:22:35.317181 #32279]  INFO -- : EZID GET ark:/99999/fk43f4wd4v
 
 [Create a specific identifier](http://ezid.cdlib.org/doc/apidoc.html#operation-create-identifier)
 
-```ruby
+```
 >> identifier = Ezid::Identifier.create(id: "ark:/99999/fk4rx9d523/12345")
 I, [2014-12-09T11:21:42.077297 #32279]  INFO -- : EZID CREATE ark:/99999/fk4rx9d523/12345 -- success: ark:/99999/fk4rx9d523/12345
 I, [2014-12-09T11:21:42.808534 #32279]  INFO -- : EZID GET ark:/99999/fk4rx9d523/12345 -- success: ark:/99999/fk4rx9d523/12345
@@ -76,7 +76,7 @@ I, [2014-12-09T11:21:42.808534 #32279]  INFO -- : EZID GET ark:/99999/fk4rx9d523
 
 **Retrieve** (Get Metadata)
 
-```ruby
+```
 >> identifier = Ezid::Identifier.find("ark:/99999/fk4rx9d523")
 I, [2014-12-04T15:07:00.648676 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
 => #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523" created="2014-12-04 20:06:02 UTC">
@@ -84,7 +84,7 @@ I, [2014-12-04T15:07:00.648676 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523
 
 **Update** (Modify)
 
-```ruby
+```
 >> identifier.target
 => "http://ezid.cdlib.org/id/ark:/99999/fk43f4wd4v"
 >> identifier.target = "http://example.com"
@@ -101,7 +101,7 @@ I, [2014-12-09T11:24:27.039288 #32279]  INFO -- : EZID GET ark:/99999/fk43f4wd4v
 
 *Identifier status must be "reserved" to delete.* http://ezid.cdlib.org/doc/apidoc.html#operation-delete-identifier
 
-```ruby
+```
 >> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4", status: "reserved")
 I, [2014-12-04T15:12:39.976930 #86734]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4n58pc0r
 I, [2014-12-04T15:12:40.693256 #86734]  INFO -- : EZID GET ark:/99999/fk4n58pc0r -- success: ark:/99999/fk4n58pc0r
@@ -117,7 +117,7 @@ Accessors are provided to ease the use of EZID [reserved metadata elements](http
 
 **Reserved elements** can be read and written using the name of the element without the leading underscore:
 
-```ruby
+```
 >> identifier.status                 # reads "_status" element
 => "public"
 >> identifier.status = "unavailable" # writes "_status" element
@@ -131,7 +131,7 @@ Notes:
 
 **Metadata profile elements** can be read and written using the name of the element, replacing the dot (".") with an underscore:
 
-```ruby
+```
 >> identifier.dc_type           # reads "dc.type" element
 => "Collection"
 >> identifier.dc_type = "Image" # writes "dc.type" element
@@ -167,7 +167,7 @@ end
 
 Then new identifiers will receive the defaults:
 
-```ruby
+```
 >> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4")
 I, [2014-12-09T11:38:37.335136 #32279]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4zs2w500
 I, [2014-12-09T11:38:38.153546 #32279]  INFO -- : EZID GET ark:/99999/fk4zs2w500 -- success: ark:/99999/fk4zs2w500
@@ -204,15 +204,16 @@ end
 client = Ezid::Client.new(user: "eziduser", password: "ezidpass")
 ```
 
-## Alternate Host and Disabling SSL
+## Alternate Host and Port
 
-By default `Ezid::Client` connects over SSL to the EZID host at [ezid.cdlib.org](http://ezid.cdlib.org), but the host and SSL settings may be overridden:
+By default `Ezid::Client` connects via SSL over port 443 to the EZID host at [ezid.cdlib.org](https://ezid.cdlib.org), but the host, port and SSL settings may be overridden:
 
 - By environment variables:
 
 ```sh
 export EZID_HOST="localhost"
-export EZID_USE_SSL="false" # "false" disables SSL for all requests
+export EZID_PORT=8443
+export EZID_USE_SSL="true"
 ```
 
 - Client configuration:
@@ -220,14 +221,15 @@ export EZID_USE_SSL="false" # "false" disables SSL for all requests
 ```ruby
 Ezid::Client.configure do |config|
   config.host = "localhost"
-  config.use_ssl = false
+  config.port = 8443
+  config.use_ssl = true
 end
 ```
 
 - At client initialization (only if explicitly instantiating `Ezid::Client`):
 
 ```ruby
-client = Ezid::Client.new(host: "localhost", use_ssl: false)
+client = Ezid::Client.new(host: "localhost", port: 80)
 ```
 
 ## Test Helper
@@ -244,13 +246,14 @@ The module provides constants:
 - `TEST_DOI_SHOULDER` => "doi:10.5072/FK2"
 - `TEST_USER` => "apitest"
 - `TEST_HOST` => "ezid.cdlib.org"
+- `TEST_PORT` => 443
 
 The test user password is not provided - contact EZID and configure as above - or use your own EZID credentials, since all accounts can mint/create on the test shoulders.
 
 A convenience method `ezid_test_mode!` is provided to configure the client to:
 
 - authenticate as `TEST_USER`
-- use `TEST_HOST` as the host
+- use `TEST_HOST` as the host and `TEST_PORT` as the port
 - use `TEST_ARK_SHOULDER` as the default shoulder
 - log to the null device (instead of default STDERR)
 

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0

data/lib/ezid/client.rb

@@ -1,13 +1,13 @@
-require "uri"
+require "net/http"
 
 require_relative "configuration"
-require_relative "request"
-require_relative "response"
 require_relative "session"
 require_relative "metadata"
 require_relative "identifier"
 require_relative "error"
-require_relative "status"
+
+Dir[File.expand_path("../responses/*.rb", __FILE__)].each { |m| require m }
+Dir[File.expand_path("../requests/*.rb", __FILE__)].each { |m| require m }
 
 module Ezid
   #
@@ -42,16 +42,14 @@ module Ezid
       end
     end
 
-    attr_reader :session, :user, :password, :host, :use_ssl
+    attr_reader :user, :password, :host, :port, :use_ssl
 
     def initialize(opts = {})
-      @session = Session.new
       @host = opts[:host] || config.host
-      @use_ssl = opts.fetch(:use_ssl, config.use_ssl)
+      @port = (opts[:port] || config.port).to_i
+      @use_ssl = opts[:use_ssl] || config.use_ssl
       @user = opts[:user] || config.user
-      raise Error, "User name is required." unless user
       @password = opts[:password] || config.password
-      raise Error, "Password is required." unless password
       if block_given?
         login
         yield self
@@ -60,7 +58,8 @@ module Ezid
     end
 
     def inspect
-      "#<#{self.class.name} host=\"#{host}\" user=\"#{user}\" session=#{logged_in? ? 'OPEN' : 'CLOSED'}>"
+      "#<#{self.class.name} connection=#{connection.inspect} " \
+        "user=\"#{user}\" session=#{logged_in? ? 'OPEN' : 'CLOSED'}>"
     end
 
     # The client configuration
@@ -75,6 +74,12 @@ module Ezid
       @logger ||= config.logger
     end
 
+    # The client session
+    # @return [Ezid::Session] the session
+    def session
+      @session ||= Session.new
+    end
+
     # Open a session
     # @raise [Ezid::Error]
     # @return [Ezid::Client] the client
@@ -82,10 +87,7 @@ module Ezid
       if logged_in?
         logger.info("Already logged in, skipping login request.")
       else
-        response = Request.execute(:Get, build_uri("/login")) do |request|
-          add_authentication(request)
-        end
-        handle_response(response, "LOGIN")
+        response = execute LoginRequest
         session.open(response.cookie)
       end
       self
@@ -95,8 +97,7 @@ module Ezid
     # @return [Ezid::Client] the client
     def logout
       if logged_in?
-        response = Request.execute(:Get, build_uri("/logout"))
-        handle_response(response, "LOGOUT")
+        execute LogoutRequest
         session.close
       else
         logger.info("Not logged in, skipping logout request.")
@@ -109,18 +110,18 @@ module Ezid
       session.open?
     end
 
+    # Create an identifier (PUT an existing identifier)
+    # @see http://ezid.cdlib.org/doc/apidoc.html#operation-create-identifier
     # @param identifier [String] the identifier string to create
     # @param metadata [String, Hash, Ezid::Metadata] optional metadata to set
     # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def create_identifier(identifier, metadata=nil)
-      response = Request.execute(:Put, build_uri("/id/#{identifier}")) do |request|
-        add_authentication(request)
-        add_metadata(request, metadata)
-      end
-      handle_response(response, "CREATE #{identifier}")
+      execute CreateIdentifierRequest, identifier, metadata
     end
 
+    # Mint an identifier
+    # @see http://ezid.cdlib.org/doc/apidoc.html#operation-mint-identifier
     # @param shoulder [String] the shoulder on which to mint a new identifier
     # @param metadata [String, Hash, Ezid::Metadata] metadata to set
     # @raise [Ezid::Error]
@@ -128,83 +129,76 @@ module Ezid
     def mint_identifier(shoulder=nil, metadata=nil)
       shoulder ||= config.default_shoulder
       raise Error, "Shoulder missing -- cannot mint identifier." unless shoulder
-      response = Request.execute(:Post, build_uri("/shoulder/#{shoulder}")) do |request|
-        add_authentication(request)
-        add_metadata(request, metadata)
-      end
-      handle_response(response, "MINT #{shoulder}")
+      execute MintIdentifierRequest, shoulder, metadata
     end
 
+    # Modify an identifier
+    # @see http://ezid.cdlib.org/doc/apidoc.html#operation-modify-identifier
     # @param identifier [String] the identifier to modify
     # @param metadata [String, Hash, Ezid::Metadata] metadata to set
     # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def modify_identifier(identifier, metadata)
-      response = Request.execute(:Post, build_uri("/id/#{identifier}")) do |request|
-        add_authentication(request)
-        add_metadata(request, metadata)
-      end
-      handle_response(response, "MODIFY #{identifier}")
+      execute ModifyIdentifierRequest, identifier, metadata
     end
 
+    # Get the metadata for an identifier
+    # @see http://ezid.cdlib.org/doc/apidoc.html#operation-get-identifier-metadata
     # @param identifier [String] the identifier to retrieve
     # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def get_identifier_metadata(identifier)
-      response = Request.execute(:Get, build_uri("/id/#{identifier}")) do |request|
-        add_authentication(request)
-      end
-      handle_response(response, "GET #{identifier}")
+      execute GetIdentifierMetadataRequest, identifier
     end
 
+    # Delete an identifier (only reserved identifier can be deleted)
+    # @see http://ezid.cdlib.org/doc/apidoc.html#operation-delete-identifier
     # @param identifier [String] the identifier to delete
     # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
     def delete_identifier(identifier)
-      response = Request.execute(:Delete, build_uri("/id/#{identifier}")) do |request|
-        add_authentication(request)
-      end
-      handle_response(response, "DELETE #{identifier}")
+      execute DeleteIdentifierRequest, identifier
     end
 
+    # Get the EZID server status (and the status of one or more subsystems)
+    # @see http://ezid.cdlib.org/doc/apidoc.html#server-status
     # @param subsystems [Array]
     # @raise [Ezid::Error]
-    # @return [Ezid::Status] the status response
+    # @return [Ezid::StatusResponse] the status response
     def server_status(*subsystems)
-      response = Request.execute(:Get, build_uri("/status?subsystems=#{subsystems.join(',')}"))
-      handle_response(Status.new(response), "STATUS")
+      execute ServerStatusRequest, *subsystems
+    end
+
+    # The Net::HTTP object used to connect to EZID
+    # @return [Net::HTTP] the connection
+    def connection
+      @connection ||= build_connection
     end
 
     private
 
-      def build_uri(path)
-        scheme = use_ssl ? "https" : "http"
-        URI([scheme, "://", host, path].join)
-      end
+    def use_ssl?
+      use_ssl || port == 443
+    end
 
-      # Adds authentication data to the request
-      def add_authentication(request)
-        if session.open?
-          request["Cookie"] = session.cookie
-        else
-          request.basic_auth(user, password)
-        end
-      end
+    def build_connection
+      conn = Net::HTTP.new(host, port)
+      conn.use_ssl = use_ssl?
+      conn
+    end
 
-      # Adds EZID metadata (if any) to the request body
-      def add_metadata(request, metadata)
-        return if metadata.nil? || metadata.empty?
-        metadata = Metadata.new(metadata) unless metadata.is_a?(Metadata)
-        request.body = metadata.to_anvl(false)
-      end
+    def handle_response(response, request_name)
+      log_level = response.error? ? Logger::ERROR : Logger::INFO
+      message = "EZID #{request_name} -- #{response.status_line}"
+      logger.log(log_level, message)
+      raise response.exception if response.exception
+      response      
+    end
 
-      def handle_response(response, request_info)
-        log_level = response.error? ? Logger::ERROR : Logger::INFO
-        message = "EZID #{request_info} -- #{response.status_line}"
-        logger.log(log_level, message)
-        raise response.exception if response.exception
-        response
-      end
+    def execute(request_class, *args)
+      response = request_class.execute(self, *args)
+      handle_response(response, request_class.short_name)
+    end
 
   end
 end

data/lib/ezid/configuration.rb

@@ -11,15 +11,20 @@ module Ezid
   class Configuration
 
     HOST = "ezid.cdlib.org"
+    PORT = 443
 
     # EZID host name
     #   Default: value of `EZID_HOST` environment variable, if present, or
     #   the EZID service host "ezid.cdlib.org".
     attr_accessor :host
 
+    # EZID TCP/IP port
+    #   Default: value of `EZID_PORT` variable
+    attr_accessor :port
+
     # Use HTTPS?
-    #   Default: `true`, unless `EZID_USE_SSL` environment variable is set
-    #   to the string "false".
+    #   Default: `nil`; `true` if `EZID_USE_SSL` environment variable is set
+    #   to the string "true".
     attr_accessor :use_ssl
 
     # EZID user name
@@ -42,7 +47,8 @@ module Ezid
       @user             = ENV["EZID_USER"]
       @password         = ENV["EZID_PASSWORD"]
       @host             = ENV["EZID_HOST"] || HOST
-      @use_ssl          = ENV["EZID_USE_SSL"] != false.to_s
+      @port             = ENV["EZID_PORT"] || PORT
+      @use_ssl          = true if ENV["EZID_USE_SSL"] == true.to_s
       @default_shoulder = ENV["EZID_DEFAULT_SHOULDER"]
     end
 

data/lib/ezid/metadata.rb

@@ -4,9 +4,7 @@ module Ezid
   #
   # EZID metadata collection for an identifier.
   #
-  # @note Although this API is not private, its direct use is discouraged.
-  #   Instead use the metadata element accessors through Ezid::Identifier.
-  # @api public
+  # @api private
   #
   class Metadata < SimpleDelegator
 

data/lib/ezid/requests/create_identifier_request.rb

@@ -0,0 +1,15 @@
+require_relative "identifier_with_metadata_request"
+require_relative "../responses/create_identifier_response"
+
+module Ezid
+  #
+  # A request to create (PUT) an identifier in EZID
+  # @api private
+  #
+  class CreateIdentifierRequest < IdentifierWithMetadataRequest
+
+    self.http_method = PUT
+    self.response_class = CreateIdentifierResponse
+
+  end
+end

data/lib/ezid/requests/delete_identifier_request.rb

@@ -0,0 +1,11 @@
+require_relative "identifier_request"
+require_relative "../responses/delete_identifier_response"
+
+module Ezid
+  class DeleteIdentifierRequest < IdentifierRequest
+
+    self.http_method = DELETE
+    self.response_class = DeleteIdentifierResponse
+
+  end
+end

data/lib/ezid/requests/get_identifier_metadata_request.rb

@@ -0,0 +1,15 @@
+require_relative "identifier_request"
+require_relative "../responses/get_identifier_metadata_response"
+
+module Ezid
+  #
+  # A request to get the metadata of an identifier
+  # @api private
+  #
+  class GetIdentifierMetadataRequest < IdentifierRequest
+
+    self.http_method = GET
+    self.response_class = GetIdentifierMetadataResponse
+
+  end
+end

data/lib/ezid/requests/identifier_request.rb

@@ -0,0 +1,22 @@
+require_relative "request"
+
+module Ezid
+  #
+  # @abstract
+  # @api private
+  #
+  class IdentifierRequest < Request
+
+    attr_reader :identifier
+
+    def initialize(client, identifier)
+      @identifier = identifier
+      super
+    end
+
+    def path
+      "/id/#{identifier}"
+    end
+
+  end
+end

data/lib/ezid/requests/identifier_with_metadata_request.rb

@@ -0,0 +1,18 @@
+require_relative "identifier_request"
+
+module Ezid
+  #
+  # @abstract
+  # @api private
+  #
+  class IdentifierWithMetadataRequest < IdentifierRequest
+
+    attr_reader :metadata
+
+    def initialize(client, identifier, metadata)
+      @metadata = Metadata.new(metadata)
+      super(client, identifier)
+    end
+
+  end
+end

data/lib/ezid/requests/login_request.rb

@@ -0,0 +1,16 @@
+require_relative "request"
+require_relative "../responses/login_response"
+
+module Ezid
+  #
+  # A request to login to EZID
+  # @api private
+  #
+  class LoginRequest < Request
+
+    self.http_method = GET
+    self.path = "/login"
+    self.response_class = LoginResponse
+
+  end
+end

data/lib/ezid/requests/logout_request.rb

@@ -0,0 +1,20 @@
+require_relative "request"
+require_relative "../responses/logout_response"
+
+module Ezid
+  #
+  # A request to logout of EZID
+  # @api private
+  #
+  class LogoutRequest < Request
+
+    self.http_method = GET
+    self.path = "/logout"
+    self.response_class = LogoutResponse
+
+    def authentication_required?
+      false
+    end
+
+  end
+end

data/lib/ezid/requests/mint_identifier_request.rb

@@ -0,0 +1,29 @@
+require_relative "request"
+require_relative "../metadata"
+require_relative "../responses/mint_identifier_response"
+
+module Ezid
+  #
+  # A request to EZID to mint a new identifier
+  # @api private
+  # @see http://ezid.cdlib.org/doc/apidoc.html#operation-modify-identifier
+  #
+  class MintIdentifierRequest < Request
+
+    self.http_method = POST
+    self.response_class = MintIdentifierResponse
+
+    attr_reader :shoulder, :metadata
+    
+    def initialize(client, shoulder, metadata)
+      @shoulder = shoulder
+      @metadata = Metadata.new(metadata)
+      super
+    end
+
+    def path
+      "/shoulder/#{shoulder}"
+    end
+
+  end
+end

data/lib/ezid/requests/modify_identifier_request.rb

@@ -0,0 +1,15 @@
+require_relative "identifier_with_metadata_request"
+require_relative "../responses/modify_identifier_response"
+
+module Ezid
+  #
+  # A request to modify the metadata of an identifier
+  # @api private
+  #
+  class ModifyIdentifierRequest < IdentifierWithMetadataRequest
+
+    self.http_method = POST
+    self.response_class = ModifyIdentifierResponse
+
+  end
+end

data/lib/ezid/requests/request.rb

@@ -0,0 +1,130 @@
+require "delegate"
+require "uri"
+require "net/http"
+require "forwardable"
+
+require_relative "../responses/response"
+
+module Ezid
+  #
+  # A request to the EZID service.
+  #
+  # @api private
+  # @abstract
+  #
+  class Request < SimpleDelegator
+    extend Forwardable
+
+    CHARSET = "UTF-8"
+    CONTENT_TYPE = "text/plain"
+
+    # HTTP methods
+    GET = Net::HTTP::Get
+    PUT = Net::HTTP::Put
+    POST = Net::HTTP::Post
+    DELETE = Net::HTTP::Delete
+
+    class << self
+      attr_accessor :http_method, :path, :response_class
+
+      def execute(client, *args)
+        request = new(client, *args)
+        yield request if block_given?
+        request.execute
+      end
+
+      def short_name
+        name.split("::").last.sub("Request", "")
+      end      
+    end
+
+    attr_reader :client
+    def_delegators :client, :connection, :user, :password, :session
+
+    # @param client [Ezid::Client] the client
+    def initialize(client, *args)
+      @client = client
+      super build_request
+    end
+
+    # Executes the request and returns the response
+    # @return [Ezid::Response] the response
+    def execute
+      response_class.new(get_response_for_request)
+    end
+
+    # The request URI
+    # @return [URI] the URI
+    def uri
+      @uri ||= build_uri
+    end
+
+    # HTTP request path
+    # @return [String] the path
+    def path
+      self.class.path
+    end
+
+    # Class to wrap Net::HTTPResponse
+    # @return [Class]
+    def response_class
+      self.class.response_class || Response
+    end
+
+    # HTTP request query string
+    # @return [String] the query string
+    def query; end
+
+    def authentication_required?
+      true
+    end
+
+    def has_metadata?
+      !metadata.empty? rescue false
+    end
+
+    def handle_response(http_response)
+      response_class.new(http_response).tap do |response|
+        yield response if block_given?
+      end
+    end
+
+    private
+
+    def get_response_for_request
+      connection.start do |conn| 
+        set_content_type(CONTENT_TYPE, charset: CHARSET)
+        add_authentication if authentication_required?
+        add_metadata if has_metadata?
+        conn.request(__getobj__) 
+      end
+    end
+
+    def build_request
+      self.class.http_method.new(uri)
+    end
+
+    def host
+      connection.address
+    end
+
+    def build_uri
+      uri_klass = connection.use_ssl? ? URI::HTTPS : URI::HTTP
+      uri_klass.build(host: host, path: path, query: query)
+    end
+
+    # Adds authentication data to the request
+    def add_authentication
+      if session.open?
+        self["Cookie"] = session.cookie
+      else
+        basic_auth(user, password)
+      end
+    end
+
+    def add_metadata
+      self.body = metadata.to_anvl(false)
+    end
+
+  end
+end

data/lib/ezid/requests/server_status_request.rb

@@ -0,0 +1,31 @@
+require_relative "request"
+require_relative "../responses/server_status_response"
+
+module Ezid
+  #
+  # A request for the EZID server status
+  # @api private
+  #
+  class ServerStatusRequest < Request
+
+    self.http_method = GET
+    self.path = "/status"
+    self.response_class = ServerStatusResponse
+
+    attr_reader :subsystems
+
+    def initialize(client, *args)
+      @subsystems = args
+      super
+    end
+
+    def query
+      "subsystems=#{subsystems.join(',')}"
+    end
+
+    def authentication_required?
+      false
+    end
+
+  end
+end

data/lib/ezid/responses/create_identifier_response.rb

@@ -0,0 +1,11 @@
+require_relative "new_identifier_response"
+
+module Ezid
+  #
+  # Response to a create identifier request
+  # @api private
+  #
+  class CreateIdentifierResponse < NewIdentifierResponse
+
+  end
+end

data/lib/ezid/responses/delete_identifier_response.rb

@@ -0,0 +1,11 @@
+require_relative "identifier_response"
+
+module Ezid
+  # 
+  # Response to a delete identifier request
+  # @api private
+  #
+  class DeleteIdentifierResponse < IdentifierResponse
+
+  end
+end

data/lib/ezid/responses/get_identifier_metadata_response.rb

@@ -0,0 +1,15 @@
+require_relative "identifier_response"
+
+module Ezid
+  # 
+  # Response to a get identifier metadata request
+  # @api private
+  #
+  class GetIdentifierMetadataResponse < IdentifierResponse
+
+    def metadata
+      content[1]
+    end
+
+  end
+end

data/lib/ezid/responses/identifier_response.rb

@@ -0,0 +1,13 @@
+require_relative "response"
+
+module Ezid
+  class IdentifierResponse < Response
+
+    IDENTIFIER_RE = /^(doi|ark|urn):[^\s]+/
+
+    def id
+      @id ||= IDENTIFIER_RE.match(message)[0]
+    end
+
+  end
+end

data/lib/ezid/responses/login_response.rb

@@ -0,0 +1,15 @@
+require_relative "response"
+
+module Ezid
+  # 
+  # Response to a login request
+  # @api private
+  #
+  class LoginResponse < Response
+
+    def cookie
+      self["Set-Cookie"].split(";").first rescue nil
+    end
+
+  end
+end

data/lib/ezid/responses/logout_response.rb

@@ -0,0 +1,11 @@
+require_relative "response"
+
+module Ezid
+  #
+  # Response to logout request
+  # @api private
+  #
+  class LogoutResponse < Response
+
+  end
+end

data/lib/ezid/responses/mint_identifier_response.rb

@@ -0,0 +1,11 @@
+require_relative "new_identifier_response"
+
+module Ezid
+  # 
+  # Response to a mint identifier request
+  # @api private
+  #
+  class MintIdentifierResponse < NewIdentifierResponse
+
+  end
+end

data/lib/ezid/responses/modify_identifier_response.rb

@@ -0,0 +1,11 @@
+require_relative "identifier_response"
+
+module Ezid
+  #
+  # Response to a Ezid::ModifyIdentifierRequest
+  # @api private
+  #
+  class ModifyIdentifierResponse < IdentifierResponse
+
+  end
+end

data/lib/ezid/responses/new_identifier_response.rb

@@ -0,0 +1,17 @@
+require_relative "identifier_response"
+
+module Ezid
+  #
+  # A response to a mint or create request to make a new identifier in EZID
+  # @api private
+  #
+  class NewIdentifierResponse < IdentifierResponse
+
+    SHADOW_ARK_RE = /\| (ark:[^\s]+)/
+
+    def shadow_ark
+      @shadow_ark ||= SHADOW_ARK_RE.match(message)[1]
+    end
+
+  end
+end

data/lib/ezid/{response.rb → responses/response.rb}

@@ -14,21 +14,6 @@ module Ezid
     # 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
@@ -83,9 +68,5 @@ module Ezid
       __getobj__.uri.path
     end
 
-    def cookie
-      self["Set-Cookie"].split(";").first rescue nil
-    end
-
   end
 end

data/lib/ezid/{status.rb → responses/server_status_response.rb}

@@ -1,11 +1,11 @@
+require_relative "response"
+
 module Ezid
   #
   # A response to an EZID status request
-  #
-  # @see Ezid::Response
   # @api private
   #
-  class Status < SimpleDelegator
+  class ServerStatusResponse < Response
 
     SUBSYSTEMS = %w( noid ldap datacite )
 

data/lib/ezid/session.rb

@@ -8,8 +8,8 @@ module Ezid
 
     attr_reader :cookie
 
-    def initialize(response=nil)
-      open(response) if response
+    def initialize(cookie=nil)
+      open(cookie) if cookie
     end
 
     def inspect

data/lib/ezid/test_helper.rb

@@ -8,6 +8,7 @@ module Ezid
 
     TEST_USER = "apitest"
     TEST_HOST = Configuration::HOST
+    TEST_PORT = Configuration::PORT
     TEST_SHOULDER = TEST_ARK_SHOULDER
 
     def ezid_test_mode!
@@ -15,7 +16,7 @@ module Ezid
         config.user     = ENV["EZID_TEST_USER"] || TEST_USER
         config.password = ENV["EZID_TEST_PASSWORD"]
         config.host     = ENV["EZID_TEST_HOST"] || TEST_HOST
-        config.use_ssl  = true
+        config.port     = ENV["EZID_TEST_PORT"] || TEST_PORT
         config.logger   = Logger.new(File::NULL)
         config.default_shoulder = ENV["EZID_TEST_SHOULDER"] || TEST_SHOULDER
       end

data/spec/integration/client_spec.rb

@@ -9,6 +9,7 @@ module Ezid
         modified = client.modify_identifier(@id, "dc.title" => "Test")
         expect(modified).to be_success
         retrieved = client.get_identifier_metadata(@id)
+        puts retrieved.class.to_s
         expect(retrieved).to be_success
         expect(retrieved.metadata).to match(/dc.title: Test/)
         deleted = client.delete_identifier(@id)

data/spec/unit/client_spec.rb

@@ -1,9 +1,6 @@
 module Ezid
   RSpec.describe Client do
 
-    let(:stub_response) { Response.new(http_response) }
-    let(:stub_uri) { double }
-
     describe "initialization without a block" do
       it "should not login" do
         expect_any_instance_of(described_class).not_to receive(:login)
@@ -14,9 +11,9 @@ module Ezid
     describe "#create_identifier" do
       let(:id) { "ark:/99999/fk4fn19h88" }
       let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
+      let(:stub_response) { CreateIdentifierResponse.new(http_response) }
       before do
-        allow(subject).to receive(:build_uri).with("/id/#{id}") { stub_uri }
-        allow(Request).to receive(:execute).with(:Put, stub_uri) { stub_response }
+        allow(CreateIdentifierRequest).to receive(:execute).with(subject, id, nil) { stub_response }
       end
       it "should be a success" do
         response = subject.create_identifier(id)
@@ -26,14 +23,12 @@ module Ezid
     end
 
     describe "#mint_identifier" do
+      let(:stub_response) { MintIdentifierResponse.new(http_response) }
       before do
-        allow(Request).to receive(:execute).with(:Post, stub_uri) { stub_response }
+        allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_ARK_SHOULDER, nil) { stub_response }
       end
       describe "which is an ARK" do
         let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
-        before do
-          allow(subject).to receive(:build_uri).with("/shoulder/#{TEST_ARK_SHOULDER}") { stub_uri }
-        end
         it "should be a success" do
           response = subject.mint_identifier(TEST_ARK_SHOULDER)
           expect(response).to be_success
@@ -52,7 +47,7 @@ datacite.resourcetype: Other
 EOS
         end
         before do
-          allow(subject).to receive(:build_uri).with("/shoulder/#{TEST_DOI_SHOULDER}") { stub_uri }
+          allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_DOI_SHOULDER, metadata) { stub_response }
         end
         it "should be a sucess" do
           response = subject.mint_identifier(TEST_DOI_SHOULDER, metadata)
@@ -65,7 +60,7 @@ EOS
         let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
         context "and the :default_shoulder config option is set" do
           before do
-            allow(subject).to receive(:build_uri).with("/shoulder/#{TEST_ARK_SHOULDER}") { stub_uri }
+            allow(MintIdentifierRequest).to receive(:execute).with(subject, TEST_ARK_SHOULDER, nil) { stub_response } 
             allow(Client.config).to receive(:default_shoulder) { TEST_ARK_SHOULDER }
           end
           it "should use the default shoulder" do
@@ -98,9 +93,9 @@ _status: public
 EOS
                                      )
       end
+      let(:stub_response) { GetIdentifierMetadataResponse.new(http_response) }
       before do
-        allow(subject).to receive(:build_uri).with("/id/#{id}") { stub_uri }
-        allow(Request).to receive(:execute).with(:Get, stub_uri) { stub_response }
+        allow(GetIdentifierMetadataRequest).to receive(:execute).with(subject, id) { stub_response }
       end
       it "should retrieve the metadata" do
         response = subject.get_identifier_metadata(id)
@@ -119,6 +114,7 @@ EOS
     end
 
     describe "server status" do
+      let(:stub_response) { ServerStatusResponse.new(http_response) }
       let(:http_response) do
         double(body: <<-EOS
 success: EZID is up
@@ -128,8 +124,7 @@ EOS
                )
       end
       before do
-        allow(subject).to receive(:build_uri).with("/status?subsystems=*") { stub_uri }
-        allow(Request).to receive(:execute).with(:Get, stub_uri) { stub_response }
+        allow(ServerStatusRequest).to receive(:execute).with(subject, "*") { stub_response }
       end
       it "should report the status of EZID and subsystems" do
         response = subject.server_status("*")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,10 +74,29 @@ files:
 - lib/ezid/error.rb
 - lib/ezid/identifier.rb
 - lib/ezid/metadata.rb
-- lib/ezid/request.rb
-- lib/ezid/response.rb
+- lib/ezid/requests/create_identifier_request.rb
+- lib/ezid/requests/delete_identifier_request.rb
+- lib/ezid/requests/get_identifier_metadata_request.rb
+- lib/ezid/requests/identifier_request.rb
+- lib/ezid/requests/identifier_with_metadata_request.rb
+- lib/ezid/requests/login_request.rb
+- lib/ezid/requests/logout_request.rb
+- lib/ezid/requests/mint_identifier_request.rb
+- lib/ezid/requests/modify_identifier_request.rb
+- lib/ezid/requests/request.rb
+- lib/ezid/requests/server_status_request.rb
+- lib/ezid/responses/create_identifier_response.rb
+- lib/ezid/responses/delete_identifier_response.rb
+- lib/ezid/responses/get_identifier_metadata_response.rb
+- lib/ezid/responses/identifier_response.rb
+- lib/ezid/responses/login_response.rb
+- lib/ezid/responses/logout_response.rb
+- lib/ezid/responses/mint_identifier_response.rb
+- lib/ezid/responses/modify_identifier_response.rb
+- lib/ezid/responses/new_identifier_response.rb
+- lib/ezid/responses/response.rb
+- lib/ezid/responses/server_status_response.rb
 - lib/ezid/session.rb
-- lib/ezid/status.rb
 - lib/ezid/test_helper.rb
 - spec/integration/client_spec.rb
 - spec/integration/identifier_spec.rb

data/lib/ezid/request.rb

@@ -1,44 +0,0 @@
-require "delegate"
-require "uri"
-require "net/http"
-
-module Ezid
-  #
-  # A request to the EZID service.
-  #
-  # @api private
-  #
-  class Request < SimpleDelegator
-
-    CHARSET = "UTF-8"
-    CONTENT_TYPE = "text/plain"
-
-    def self.execute(*args)
-      request = new(*args)
-      yield request if block_given?
-      request.execute
-    end
-
-    # @param method [Symbol] the Net::HTTP constant for the request method
-    # @param uri [URI] the uri
-    def initialize(method, uri)
-      http_method = Net::HTTP.const_get(method)
-      super(http_method.new(uri))
-      set_content_type(CONTENT_TYPE, charset: CHARSET)
-    end
-
-    # Executes the request and returns the response
-    # @return [Ezid::Response] the response
-    def execute
-      http_response = Net::HTTP.start(uri.host, use_ssl: use_ssl?) do |http|
-        http.request(__getobj__)
-      end
-      Response.new(http_response)
-    end
-
-    def use_ssl?
-      uri.is_a?(URI::HTTPS)
-    end
-
-  end
-end