Class: OData4::Service::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/odata4/service/request.rb

Overview

Encapsulates a single request to an OData service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service, url_chunk, options = {}) ⇒ Request

Create a new request

Parameters:

  • service (OData4::Service) —

    Where the request will be sent

  • url_chunk (String) —

    Request path, relative to the service URL, including query params

  • options (Hash) (defaults to: {}) —

    Additional request options



18
19
20
21
22
23
24
 
# File 'lib/odata4/service/request.rb', line 18

def initialize(service, url_chunk, options = {})
  @service = service
  @url_chunk = url_chunk
  @method = options[:method] || :get
  @format = options[:format] || :auto
  @query  = options[:query]
end

Instance Attribute Details

#format ⇒ Object

The request format (‘:atom`, `:json`, or `:auto`)



12
13
14
 
# File 'lib/odata4/service/request.rb', line 12

def format
  @format
end

#method ⇒ Object

The HTTP method for this request



10
11
12
 
# File 'lib/odata4/service/request.rb', line 10

def method
  @method
end

#query ⇒ Object (readonly)

The OData4::Query that generated this request (optional)



8
9
10
 
# File 'lib/odata4/service/request.rb', line 8

def query
  @query
end

#service ⇒ Object (readonly)

The OData service against which the request is performed



6
7
8
 
# File 'lib/odata4/service/request.rb', line 6

def service
  @service
end

Instance Method Details

#content_type ⇒ String

The content type for this request. Depends on format.

Returns:

  • (String) 


34
35
36
37
38
39
40
41
42
 
# File 'lib/odata4/service/request.rb', line 34

def content_type
  if format == :auto
    MIME_TYPES.values.join(',')
  elsif MIME_TYPES.has_key? format
    MIME_TYPES[format]
  else
    raise ArgumentError, "Unknown format '#{format}'"
  end
end

#execute(additional_options = {}) ⇒ OData4::Service::Response

Execute the request

Parameters:

  • additional_options (Hash) (defaults to: {}) —

    options to pass to Typhoeus

Returns:



48
49
50
51
52
53
54
55
 
# File 'lib/odata4/service/request.rb', line 48

def execute(additional_options = {})
  options = request_options(additional_options)
  request = ::Typhoeus::Request.new(url, options)
  logger.info "Requesting #{method.to_s.upcase} #{url}..."
  request.run

  Response.new(service, request.response, query)
end

#url ⇒ String

Return the full request URL (including service base)

Returns:

  • (String) 


28
29
30
 
# File 'lib/odata4/service/request.rb', line 28

def url
  ::URI.join("#{service.service_url}/", ::URI.escape(url_chunk)).to_s
end