Class: Ezid::Request Abstract Private
- Inherits:
-
SimpleDelegator
- Object
- SimpleDelegator
- Ezid::Request
- Extended by:
- Forwardable
- Defined in:
- lib/ezid/requests/request.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
A request to the EZID service.
Direct Known Subclasses
BatchDownloadRequest, IdentifierRequest, LoginRequest, LogoutRequest, MintIdentifierRequest, ServerStatusRequest
Constant Summary collapse
- GET =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
HTTP methods
Net::HTTP::Get
- PUT =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
Net::HTTP::Put
- POST =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
Net::HTTP::Post
- DELETE =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
Net::HTTP::Delete
Class Attribute Summary collapse
- .http_method ⇒ Object private
- .path ⇒ Object private
- .response_class ⇒ Object private
Instance Attribute Summary collapse
- #client ⇒ Object readonly private
Class Method Summary collapse
Instance Method Summary collapse
- #authentication_required? ⇒ Boolean private
-
#execute ⇒ Ezid::Response
private
Executes the request and returns the response.
- #handle_response(http_response) ⇒ Object private
- #has_metadata? ⇒ Boolean private
-
#initialize(client, *args) ⇒ Request
constructor
private
A new instance of Request.
-
#path ⇒ String
private
HTTP request path.
-
#query ⇒ String
private
HTTP request query string.
-
#response_class ⇒ Class
private
Class to wrap Net::HTTPResponse.
-
#uri ⇒ URI
private
The request URI.
Constructor Details
#initialize(client, *args) ⇒ Request
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of Request.
43 44 45 46 47 |
# File 'lib/ezid/requests/request.rb', line 43 def initialize(client, *args) @client = client super build_request set_content_type('text/plain', charset: 'UTF-8') end |
Class Attribute Details
.http_method ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
26 27 28 |
# File 'lib/ezid/requests/request.rb', line 26 def http_method @http_method end |
.path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
26 27 28 |
# File 'lib/ezid/requests/request.rb', line 26 def path @path end |
.response_class ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
26 27 28 |
# File 'lib/ezid/requests/request.rb', line 26 def response_class @response_class end |
Instance Attribute Details
#client ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
39 40 41 |
# File 'lib/ezid/requests/request.rb', line 39 def client @client end |
Class Method Details
.execute(client, *args) {|request| ... } ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
28 29 30 31 32 |
# File 'lib/ezid/requests/request.rb', line 28 def execute(client, *args) request = new(client, *args) yield request if block_given? request.execute end |
.short_name ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
34 35 36 |
# File 'lib/ezid/requests/request.rb', line 34 def short_name name.split('::').last.sub('Request', '') end |
Instance Method Details
#authentication_required? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
88 89 90 |
# File 'lib/ezid/requests/request.rb', line 88 def authentication_required? true end |
#execute ⇒ Ezid::Response
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Executes the request and returns the response
51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/ezid/requests/request.rb', line 51 def execute retries = 0 begin response_class.new(get_response_for_request) rescue Net::HTTPServerException, UnexpectedResponseError => e if retries < 2 sleep client.config.retry_interval retries += 1 retry else raise end end end |
#handle_response(http_response) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
96 97 98 99 100 |
# File 'lib/ezid/requests/request.rb', line 96 def handle_response(http_response) response_class.new(http_response).tap do |response| yield response if block_given? end end |
#has_metadata? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
92 93 94 |
# File 'lib/ezid/requests/request.rb', line 92 def !.empty? rescue false end |
#path ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
HTTP request path
74 75 76 |
# File 'lib/ezid/requests/request.rb', line 74 def path self.class.path end |
#query ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
HTTP request query string
86 |
# File 'lib/ezid/requests/request.rb', line 86 def query; end |
#response_class ⇒ Class
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Class to wrap Net::HTTPResponse
80 81 82 |
# File 'lib/ezid/requests/request.rb', line 80 def response_class self.class.response_class || Response end |
#uri ⇒ URI
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
The request URI
68 69 70 |
# File 'lib/ezid/requests/request.rb', line 68 def uri @uri ||= build_uri end |