Module: Webmachine::Resource::Callbacks

Included in:

Webmachine::Resource

Defined in:

lib/webmachine/resource/callbacks.rb

Overview

Instance Method Summary (collapse)

• - (true, false) allow_missing_post?

  If the resource accepts POST requests to nonexistent resources, then this should return true.

• - (Array<String>) allowed_methods

  HTTP methods that are allowed on this resource.

• - (String, ...) base_uri

  This will be called after #create_path but before setting the Location response header, and is used to determine the root URI of the new resource.

• - (nil, Array) charsets_provided

  If this is anything other than nil, it must be an array of pairs where each pair is of the form Charset, Converter where Charset is a string naming a charset and Converter is an arity-1 method in the resource which will be called on the produced body in a GET and ensure that it is in Charset.

• - (Object) content_types_accepted

  Similarly to content_types_provided, this should return an array of mediatype/handler pairs, except that it is for incoming resource representations -- for example, PUT requests.

• - (Object) content_types_provided

  This should return an array of pairs where each pair is of the form [mediatype, :handler] where mediatype is a String of Content-Type format and :handler is a Symbol naming the method which can provide a resource representation in that media type.

• - (String, URI) create_path

  This will be called on a POST request if post_is_create? returns true.

• - (true, false) delete_completed?

  This method is called after a successful call to #delete_resource and should return false if the deletion was accepted but cannot yet be guaranteed to have finished.

• - (true, false) delete_resource

  This method is called when a DELETE request should be enacted, and should return true if the deletion succeeded.

• - (Hash) encodings_provided

  This should return a hash of encodings mapped to encoding methods for Content-Encodings your resource wants to provide.

• - (Time, ...) expires

  If the resource expires, this method should return the date/time it expires.

• - (Object) finish_request

  This method is called just before the final response is constructed and sent.

• - (true, false) forbidden?

  Is the request or client forbidden? Returning a truthy value (true or non-nil) will result in a '403 Forbidden' response.

• - (String^?) generate_etag

  If this returns a value, it will be used as the value of the ETag header and for comparison in conditional requests.

• - (true, ...) is_authorized?(authorization_header = nil)

  Is the client or request authorized? Returning anything other than true will result in a '401 Unauthorized' response.

• - (true, false) is_conflict?

  If this returns true, the client will receive a '409 Conflict' response.

• - (true, false) known_content_type?(content_type = nil)

  If the Content-Type on PUT or POST is unknown, this should return false, which will result in a '415 Unsupported Media Type' response.

• - (Array<String>) known_methods

  HTTP methods that are known to the resource.

• - (true, false) language_available?(accept_lang)

  This should return true or false if the requested language(s) is available.

• - (Time, ...) last_modified

  This method should return the last modified date/time of the resource which will be added as the Last-Modified header in the response and used in negotiating conditional requests.

• - (true, false) malformed_request?

  If the request is malformed, this should return true, which will result in a '400 Malformed Request' response.

• - (String, ...) moved_permanently?

  If this resource has moved to a new location permanently, this method should return the new location as a String or URI.

• - (String, ...) moved_temporarily?

  If this resource has moved to a new location temporarily, this method should return the new location as a String or URI.

• - (true, false) multiple_choices?

  If this returns true, then it is assumed that multiple representations of the response are possible and a single one cannot be automatically chosen, so a 300 Multiple Choices will be sent instead of a 200.

• - (Hash) options

  If the OPTIONS method is supported and is used, this method should return a Hash of headers that should appear in the response.

• - (true, false) post_is_create?

  If POST requests should be treated as a request to put content into a (potentially new) resource as opposed to a generic submission for processing, then this method should return true.

• - (true, false) previously_existed?

  If this resource is known to have existed previously, this method should return true.

• - (true, ...) process_post

  If post_is_create? returns false, then this will be called to process any POST request.

• - (true, false) resource_exists?

  Does the resource exist? Returning a falsey value (false or nil) will result in a '404 Not Found' response.

• - (true, false) service_available?

  Is the resource available? Returning a falsey value (false or nil) will result in a '503 Service Not Available' response.

• - (true, false) uri_too_long?(uri = nil)

  If the URI is too long to be processed, this should return true, which will result in a '414 Request URI Too Long' response.

• - (true, false) valid_content_headers?(content_headers = nil)

  If the request includes any invalid Content-* headers, this should return false, which will result in a '501 Not Implemented' response.

• - (true, false) valid_entity_length?(length = nil)

  If the entity length on PUT or POST is invalid, this should return false, which will result in a '413 Request Entity Too Large' response.

• - (true, ...) validate_content_checksum

  This method is called when verifying the Content-MD5 header against the request body.

• - (Array<String>) variances

  If this method is implemented, it should return a list of strings with header names that should be included in a given response's Vary header.

51
52
53

# File 'lib/webmachine/resource/callbacks.rb', line 51

def allow_missing_post?
  false
end

121
122
123

# File 'lib/webmachine/resource/callbacks.rb', line 121

def allowed_methods
  ['GET', 'HEAD']
end

183
184
185

# File 'lib/webmachine/resource/callbacks.rb', line 183

def base_uri
  nil
end

229
230
231

# File 'lib/webmachine/resource/callbacks.rb', line 229

def charsets_provided
  nil
end

217
218
219

# File 'lib/webmachine/resource/callbacks.rb', line 217

def content_types_accepted
  []
end

206
207
208

# File 'lib/webmachine/resource/callbacks.rb', line 206

def content_types_provided
  [['text/html', :to_html]]
end

173
174
175

# File 'lib/webmachine/resource/callbacks.rb', line 173

def create_path
  nil
end

150
151
152

# File 'lib/webmachine/resource/callbacks.rb', line 150

def delete_completed?
  true
end

140
141
142

# File 'lib/webmachine/resource/callbacks.rb', line 140

def delete_resource
  false
end

250
251
252

# File 'lib/webmachine/resource/callbacks.rb', line 250

def encodings_provided
  {"identity" => :encode_identity }
end

329
330
331

# File 'lib/webmachine/resource/callbacks.rb', line 329

def expires
  nil
end

346

# File 'lib/webmachine/resource/callbacks.rb', line 346

def finish_request; end

42
43
44

# File 'lib/webmachine/resource/callbacks.rb', line 42

def forbidden?
  false
end

338
339
340

# File 'lib/webmachine/resource/callbacks.rb', line 338

def generate_etag
  nil
end

33
34
35

# File 'lib/webmachine/resource/callbacks.rb', line 33

def is_authorized?(authorization_header = nil)
  true
end

272
273
274

# File 'lib/webmachine/resource/callbacks.rb', line 272

def is_conflict?
  false
end

81
82
83

# File 'lib/webmachine/resource/callbacks.rb', line 81

def known_content_type?(content_type = nil)
  true
end

132
133
134

# File 'lib/webmachine/resource/callbacks.rb', line 132

def known_methods
  ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'CONNECT', 'OPTIONS']
end

237
238
239

# File 'lib/webmachine/resource/callbacks.rb', line 237

def language_available?(accept_lang)
  true
end

321
322
323

# File 'lib/webmachine/resource/callbacks.rb', line 321

def last_modified
  nil
end

59
60
61

# File 'lib/webmachine/resource/callbacks.rb', line 59

def malformed_request?
  false
end

301
302
303

# File 'lib/webmachine/resource/callbacks.rb', line 301

def moved_permanently?
  false
end

311
312
313

# File 'lib/webmachine/resource/callbacks.rb', line 311

def moved_temporarily?
  false
end

283
284
285

# File 'lib/webmachine/resource/callbacks.rb', line 283

def multiple_choices?
  false
end

113
114
115

# File 'lib/webmachine/resource/callbacks.rb', line 113

def options
  {}
end

162
163
164

# File 'lib/webmachine/resource/callbacks.rb', line 162

def post_is_create?
  false
end

291
292
293

# File 'lib/webmachine/resource/callbacks.rb', line 291

def previously_existed?
  false
end

192
193
194

# File 'lib/webmachine/resource/callbacks.rb', line 192

def process_post
  false
end

9
10
11

# File 'lib/webmachine/resource/callbacks.rb', line 9

def resource_exists?
  true
end

20
21
22

# File 'lib/webmachine/resource/callbacks.rb', line 20

def service_available?
  true
end

69
70
71

# File 'lib/webmachine/resource/callbacks.rb', line 69

def uri_too_long?(uri = nil)
  false
end

93
94
95

# File 'lib/webmachine/resource/callbacks.rb', line 93

def valid_content_headers?(content_headers = nil)
  true
end

104
105
106

# File 'lib/webmachine/resource/callbacks.rb', line 104

def valid_entity_length?(length = nil)
  true
end

356
357
358

# File 'lib/webmachine/resource/callbacks.rb', line 356

def validate_content_checksum
  nil
end

263
264
265

# File 'lib/webmachine/resource/callbacks.rb', line 263

def variances
  []
end