Class: Eipiai::ApiResource

Inherits:
Webmachine::Resource show all
Includes:
Resource
Defined in:
lib/eipiai/resources/api.rb

Overview

ApiResource

The API resource handles the /api endpoint, which is the main entrypoint for all HyperMedia based API requests.

Instance Method Summary collapse

Methods included from Resource

#base_uri, #content_types_accepted, #content_types_provided, #create_uri, #finish_request, included, #malformed_request?, #new_object, #params, #post_is_create?, #query_keys, #resource_relation, #to_h, #to_hal_json, #to_json, #unprocessable_entity?

Instance Method Details

#allowed_methods ⇒ Object 



43
44
45
 
# File 'lib/eipiai/resources/api.rb', line 43

def allowed_methods
  %w(GET)
end

#cache_control_header_value ⇒ Object 



47
48
49
 
# File 'lib/eipiai/resources/api.rb', line 47

def cache_control_header_value
  'public, max-age=600, s-maxage=86400'
end

#generate_etag ⇒ Object 



39
40
41
 
# File 'lib/eipiai/resources/api.rb', line 39

def generate_etag
  self.class.etag ||= Digest::MD5.hexdigest(to_json)
end

#object ⇒ Object 



51
52
53
 
# File 'lib/eipiai/resources/api.rb', line 51

def object
  Api.new
end

#service_available? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/eipiai/resources/api.rb', line 35

def service_available?
  true
end

#top_level_relation? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/eipiai/resources/api.rb', line 31

def top_level_relation?
  true
end