Class: Testrail::Client::Request

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

Overview

Net:HTTP based interface for the Testrail API

Direct Known Subclasses

Api

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url, beta = false) ⇒ Request

Initialize Client

Parameters:

  • base_url (String) —

    Your Testrail URL



21
22
23
24
25
26
27
28
 
# File 'lib/testrail/client.rb', line 21

def initialize(base_url, beta=false)
  if !base_url.match(/\/$/)
    base_url += '/'
  end
  @url = base_url + 'index.php?/api/v2/'
  @content_type = "application/json"
  @beta = beta
end

Instance Attribute Details

#password ⇒ String

Your testrail password

Returns:

  • (String) —

    the current value of password



15
16
17
 
# File 'lib/testrail/client.rb', line 15

def password
  @password
end

#url ⇒ String

Your Test rail URL

Returns:

  • (String) —

    the current value of url



15
16
17
 
# File 'lib/testrail/client.rb', line 15

def url
  @url
end

#user ⇒ String

Your testrail user

Returns:

  • (String) —

    the current value of user



15
16
17
 
# File 'lib/testrail/client.rb', line 15

def user
  @user
end

Instance Method Details

#send_get(uri) ⇒ Hash

send GET to uri

Parameters:

  • uri (String) —

    Test rail API path

Returns:

  • (Hash) —

    Response from testrail API



32
33
34
35
 
# File 'lib/testrail/client.rb', line 32

def send_get(uri)
  request = _setup_request("GET",uri)
  _send_request(request)
end

#send_post(uri, data = nil) ⇒ Hash

send POST to uri

Parameters:

  • uri (String) —

    test rail API path

  • data (Enumerable) (defaults to: nil) —

    data to be sent in the POST request

Returns:

  • (Hash) —

    Response from testrail API



40
41
42
43
 
# File 'lib/testrail/client.rb', line 40

def send_post(uri, data = nil)
  request = _setup_request('POST', uri, data)
  _send_request(request)
end