Files

CouchRest::RestAPI

CouchRest RestAPI

The basic low-level interface for all REST requests to the database. Everything must pass through here before it is sent to the server.

Six types of REST requests are supported: get, put, post, delete, copy and head.

Requests that do not have a payload, get, delete and copy, accept the URI and options parameters, where as put and post both expect a document as the second parameter.

The API will try to intelegently split the options between the JSON parser and RestClient API.

The following options will be recognised as header options and automatically added to the header hash:

The following request options are supported:

Any other remaining options will be sent to the MultiJSON backend except for the :raw option.

When :raw is true in PUT and POST requests, no attempt will be made to convert the document payload to JSON. This is not normally necessary as IO and Tempfile objects will not be parsed anyway. The result of the request will always be parsed.

For all other requests, mainly GET, the :raw option will make no attempt to parse the result. This is useful for receiving files from the database.

Public Instance Methods

copy(uri, destination, options = {}) click to toggle source

Send a COPY request to the URI provided.

# File lib/couchrest/rest_api.rb, line 64
def copy(uri, destination, options = {})
  opts = options.nil? ? {} : options.dup
  # also copy headers!
  opts[:headers] = options[:headers].nil? ? {} : options[:headers].dup
  opts[:headers]['Destination'] = destination
  execute(uri, :copy, opts)
end
default_headers() click to toggle source

The default RestClient headers used in each request.

# File lib/couchrest/rest_api.rb, line 78
def default_headers
  {
    :content_type => :json,
    :accept       => :json
  }
end
delete(uri, options = {}) click to toggle source

Send a DELETE request.

# File lib/couchrest/rest_api.rb, line 59
def delete(uri, options = {})
  execute(uri, :delete, options)
end
get(uri, options = {}) click to toggle source

Send a GET request.

# File lib/couchrest/rest_api.rb, line 44
def get(uri, options = {})
  execute(uri, :get, options)
end
head(uri, options = {}) click to toggle source

Send a HEAD request.

# File lib/couchrest/rest_api.rb, line 73
def head(uri, options = {})
  execute(uri, :head, options)
end
post(uri, doc = nil, options = {}) click to toggle source

Send a POST request.

# File lib/couchrest/rest_api.rb, line 54
def post(uri, doc = nil, options = {})
  execute(uri, :post, options, doc)
end
put(uri, doc = nil, options = {}) click to toggle source

Send a PUT request.

# File lib/couchrest/rest_api.rb, line 49
def put(uri, doc = nil, options = {})
  execute(uri, :put, options, doc)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.