Class: TestRail::APIClient

Inherits:
Object
  • Object
show all
Defined in:
lib/testrail.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url) ⇒ APIClient

Returns a new instance of APIClient.



26
27
28
29
30
31
 
# File 'lib/testrail.rb', line 26

def initialize(base_url)
	if !base_url.match(/\/$/)
		base_url += '/'
	end
	@url = base_url + 'index.php?/api/v2/'
end

Instance Attribute Details

#password ⇒ Object

Returns the value of attribute password.



24
25
26
 
# File 'lib/testrail.rb', line 24

def password
  @password
end

#user ⇒ Object

Returns the value of attribute user.



23
24
25
 
# File 'lib/testrail.rb', line 23

def user
  @user
end

Instance Method Details

#send_get(uri) ⇒ Object

Send Get

Issues a GET request (read) against the API and returns the result (as Ruby hash).

Arguments:

uri The API method to call including parameters

(e.g. get_case/1)



44
45
46
 
# File 'lib/testrail.rb', line 44

def send_get(uri) 
	_send_request('GET', uri, nil)
end

#send_post(uri, data) ⇒ Object

Send POST

Issues a POST request (write) against the API and returns the result (as Ruby hash).

Arguments:

uri The API method to call including parameters

(e.g. add_case/1)

data The data to submit as part of the request (as

Ruby hash, strings must be UTF-8 encoded)



61
62
63
 
# File 'lib/testrail.rb', line 61

def send_post(uri, data)
	_send_request('POST', uri, data)
end