Class: Cloudxls

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudxls.rb,
lib/cloudxls/version.rb

Defined Under Namespace

Modules: BaseRequest, BaseResponse Classes: ApiError, ReadRequest, ReadResponse, WriteRequest, WriteResponse

Constant Summary collapse

VERSION = 
'2.0.3'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_base ⇒ Object 



41
42
43
 
# File 'lib/cloudxls.rb', line 41

def api_base
  @api_base ||= ENV.fetch("CLOUDXLS_API_BASE", "api.cloudxls.com")
end

.api_key ⇒ Object 



37
38
39
 
# File 'lib/cloudxls.rb', line 37

def api_key
  @api_key ||= ENV["CLOUDXLS_API_KEY"]
end

.api_version ⇒ Object

Returns the value of attribute api_version.



22
23
24
 
# File 'lib/cloudxls.rb', line 22

def api_version
  @api_version
end

.port ⇒ Object

Returns the value of attribute port.



22
23
24
 
# File 'lib/cloudxls.rb', line 22

def port
  @port
end

.sandbox_base ⇒ Object

Returns the value of attribute sandbox_base.



22
23
24
 
# File 'lib/cloudxls.rb', line 22

def sandbox_base
  @sandbox_base
end

.use_ssl ⇒ Object

Returns the value of attribute use_ssl.



22
23
24
 
# File 'lib/cloudxls.rb', line 22

def use_ssl
  @use_ssl
end

Class Method Details

.client_options ⇒ Object 



27
28
29
30
31
32
33
34
35
 
# File 'lib/cloudxls.rb', line 27

def client_options
  {
    api_key: api_key,
    api_version: api_version,
    api_base: api_base,
    port: port,
    use_ssl: use_ssl
  }
end

.read(params = nil) ⇒ WriteRequest

Initializes a Read request

Parameters:

  • params (Hash) (defaults to: nil) —

    request parameters as

Returns:



68
69
70
 
# File 'lib/cloudxls.rb', line 68

def read(params = nil)
  ReadRequest.new(self.client_options).add_data(params)
end

.write(params = nil) ⇒ WriteRequest

Initializes a Write request

Parameters:

  • params (Hash) (defaults to: nil) —

    request parameters as

Returns:



59
60
61
 
# File 'lib/cloudxls.rb', line 59

def write(params = nil)
  WriteRequest.new(self.client_options).add_data(params)
end