Class: Zuora::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(username, password, sandbox = false) ⇒ Zuora::Client

Creates a connection instance. Makes an initial HTTP request to fetch session token. Subsequent requests made with .get, .post, and .put contain the authenticated session id in their headers.

Parameters:

  • username (String)
  • password (String)
  • sandbox (Boolean) (defaults to: false) 


24
25
26
27
28
29
30
31
 
# File 'lib/zuora/client.rb', line 24

def initialize(username, password, sandbox = false)
  base_url = api_url sandbox
  conn = connection base_url

  response = auth_request conn, username, password

  handle_response response, conn
end

Instance Method Details

#get(url) ⇒ Faraday::Response

Returns A response, with .headers, .status & .body.

Parameters:

  • url (String) —

    • URL of request

Returns:

  • (Faraday::Response) —

    A response, with .headers, .status & .body



35
36
37
38
39
 
# File 'lib/zuora/client.rb', line 35

def get(url)
  @connection.get do |req|
    set_request_headers! req, url
  end
end

#post(url, params) ⇒ Faraday::Response

Returns A response, with .headers, .status & .body.

Parameters:

  • url (String) —

    • URL for HTTP POST request

  • params (Params) —

    • Data to be sent in request body

Returns:

  • (Faraday::Response) —

    A response, with .headers, .status & .body



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/zuora/client.rb', line 44

def post(url, params)
  response = @connection.post do |req|
    set_request_headers! req, url
    req.body = JSON.generate params
  end

  response
  # if response.body['success']
  #  return response
  # else
  #  raise ErrorResponse.new(response)
  # end
end

#put(url, params) ⇒ Faraday::Response

Returns A response, with .headers, .status & .body.

Parameters:

  • url (String) —

    • URL for HTTP PUT request

  • params (Params) —

    • Data to be sent in request body

Returns:

  • (Faraday::Response) —

    A response, with .headers, .status & .body



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zuora/client.rb', line 61

def put(url, params)
  response = @connection.put do |request|
    set_request_headers! request, url
    request.body = JSON.generate params
  end

  response
  # if response.body['success']
  #  return response
  # else
  #  raise ErrorResponse.new(response)
  # end
end