Module: ZerigoDNS::Resource::Rest::ClassMethods

Defined in:
lib/zerigodns/resource/rest.rb

Instance Method Summary collapse

Instance Method Details

#all(params = {}) ⇒ Array

Lists all resources

Returns:

  • The resources as an array



27
28
29
 
# File 'lib/zerigodns/resource/rest.rb', line 27

def all params={}
  process_response get("#{base_path}.xml", params)
end

#create(params = {}) ⇒ Object

Creates a resource

Parameters:

  • (defaults to: {})

    Parameters to pass to create action

Returns:

  • the created resource

Raises:

  • if create does not succeed.



51
52
53
 
# File 'lib/zerigodns/resource/rest.rb', line 51

def create params={}
  process_response(post "#{base_path}.xml", convert(params))
end

#destroy(id_or_name, params = {}) ⇒ Object

Deletes a resource

Parameters:

  • (defaults to: {})

    Parameters to pass to delete action

Raises:

  • if destroy does not succeed.



58
59
60
 
# File 'lib/zerigodns/resource/rest.rb', line 58

def destroy id_or_name, params={}
  delete "#{base_path}/#{id_or_name}.xml", params
end

#find(id_or_name, params = {}) ⇒ Object

Find a single resource

Parameters:

  • The id or name of the resource to find

Returns:

  • The requested resource.

Raises:

  • if the find does not succeed.



35
36
37
 
# File 'lib/zerigodns/resource/rest.rb', line 35

def find id_or_name, params={}
  process_response get("#{base_path}/#{id_or_name}.xml", params)
end

#update(id_or_name, params = {}) ⇒ Faraday::Response

Updates a single resource

Parameters:

  • Id or name of the resource

Returns:

  • The response returned by the server.

Raises:

  • if update does not succeed.



43
44
45
 
# File 'lib/zerigodns/resource/rest.rb', line 43

def update id_or_name, params={}
  put "#{base_path}/#{id_or_name}.xml", convert(params)
end