Class: Zero::Request
- Inherits:
-
Object
- Object
- Zero::Request
- Defined in:
- lib/zero/request.rb,
lib/zero/request/server.rb,
lib/zero/request/client.rb,
lib/zero/request/accept.rb,
lib/zero/request/parameter.rb,
lib/zero/request/accept_type.rb
Overview
This class wraps around a rack environment for easier access to all data.
Defined Under Namespace
Classes: Accept, AcceptType, Client, Parameter, Server
Constant Summary
Instance Attribute Summary (collapse)
-
- (Hash) env
readonly
get the environment.
Class Method Summary (collapse)
Instance Method Summary (collapse)
-
- (Accept) accept
get the media types.
-
- (Client) client
return all information about the client.
-
- (String) content_type
return the content type of the request TODO change into its own object?.
-
- (Boolean) delete?
is the method 'DELETE'?.
-
- (Boolean) get?
is the method 'GET'?.
-
- (Boolean) head?
is the method 'HEAD'?.
-
- (Request) initialize(env)
constructor
create a new request object.
-
- (Symbol) method
get the method of the request.
-
- (Parameter) params
get an object representing the parameters of the request.
-
- (Boolean) patch?
is the method 'PATCH'?.
-
- (String) path
get the requested path.
-
- (Boolean) post?
is the method 'POST'?.
-
- (Boolean) put?
is the method 'PUT'?.
-
- (Server) server
get the information on the server.
Constructor Details
- (Request) initialize(env)
create a new request object
15 16 17 18 |
# File 'lib/zero/request.rb', line 15 def initialize(env) @env = env @env['zero.request'] = self end |
Instance Attribute Details
- (Hash) env (readonly)
get the environment
22 23 24 |
# File 'lib/zero/request.rb', line 22 def env @env end |
Class Method Details
+ (Object) create(environment)
9 10 11 12 |
# File 'lib/zero/request.rb', line 9 def self.create(environment) return environment['zero.request'] if environment.has_key?('zero.request') new(environment) end |
Instance Method Details
- (Accept) accept
get the media types
57 58 59 |
# File 'lib/zero/request.rb', line 57 def accept @accept ||= Request::Accept.new(@env) end |
- (Client) client
return all information about the client
32 33 34 |
# File 'lib/zero/request.rb', line 32 def client @client ||= Request::Client.new(@env) end |
- (String) content_type
return the content type of the request TODO change into its own object?
51 52 53 |
# File 'lib/zero/request.rb', line 51 def content_type @env[CONST_CONTENT_TYPE] if @env.has_key?(CONST_CONTENT_TYPE) end |
- (Boolean) delete?
is the method 'DELETE'?
77 |
# File 'lib/zero/request.rb', line 77 def delete?; method == :delete end |
- (Boolean) get?
is the method 'GET'?
68 |
# File 'lib/zero/request.rb', line 68 def get?; method == :get end |
- (Boolean) head?
is the method 'HEAD'?
80 |
# File 'lib/zero/request.rb', line 80 def head?; method == :head end |
- (Symbol) method
get the method of the request
63 64 65 |
# File 'lib/zero/request.rb', line 63 def method @method ||= @env[CONST_REQUEST_METHOD].downcase.to_sym end |
- (Parameter) params
get an object representing the parameters of the request
44 45 46 |
# File 'lib/zero/request.rb', line 44 def params @params ||= Request::Parameter.new(@env) end |
- (Boolean) patch?
is the method 'PATCH'?
83 |
# File 'lib/zero/request.rb', line 83 def patch?; method == :patch end |
- (String) path
get the requested path
26 27 28 |
# File 'lib/zero/request.rb', line 26 def path @path ||= @env[CONST_PATH_INFO] end |
- (Boolean) post?
is the method 'POST'?
71 |
# File 'lib/zero/request.rb', line 71 def post?; method == :post end |
- (Boolean) put?
is the method 'PUT'?
74 |
# File 'lib/zero/request.rb', line 74 def put?; method == :put end |
- (Server) server
get the information on the server
38 39 40 |
# File 'lib/zero/request.rb', line 38 def server @server ||= Request::Server.new(@env) end |