Class: FileboundClient::Client

Inherits:

Object

• Object
• FileboundClient::Client

Includes:

Endpoints

Defined in:

lib/filebound_client.rb

Overview

This encapsulates all client/server communications

Defined Under Namespace

Classes: FileboundClientException

Instance Attribute Summary

• #connection ⇒ FileboundClient::Connection readonly

  The connection representing the currently logged on session with the Filebound API.

Class Method Summary

• .connect(config) ⇒ FileboundClient::Client

  Creates, initialize and logs into the Filebound API.

Instance Method Summary

• #delete(url, query_params = nil) ⇒ true, false

  Executes a DELETE request on the current Filebound client session.

• #get(url, query_params = nil) ⇒ Hash

  Executes a GET request on the current Filebound client session expecting JSON in the body of the response.

• #get_binary(url, query_params = nil) ⇒ String

  Executes a GET request on the current Filebound client session expecting binary in the body of the response.

• #initialize(connection) ⇒ FileboundClient::Client constructor

  Initializes the client with the supplied Connection.

• #post(url, query_params = nil, body = nil) ⇒ Hash

  Executes a POST request on the current Filebound client session expecting JSON in the body of the request/response.

• #put(url, query_params = nil, body = nil) ⇒ Hash

  Executes a PUT request on the current Filebound client session expecting JSON in the body of the request/response.

Methods included from Endpoints

included

Constructor Details

#initialize(connection) ⇒ FileboundClient::Client

Initializes the client with the supplied Connection

Parameters:

• connection (Connection) —

  the logged in Connection

# File 'lib/filebound_client.rb', line 36

def initialize(connection)
  @connection = connection
end

Instance Attribute Details

#connection ⇒ FileboundClient::Connection (readonly)

The connection representing the currently logged on session with the Filebound API

Returns:

• (FileboundClient::Connection) —

  the security token used in all requests made to the Filebound server

# File 'lib/filebound_client.rb', line 87

def connection
  @connection
end

Class Method Details

.connect(config) ⇒ FileboundClient::Client

Creates, initialize and logs into the Filebound API

Parameters:

• config (Hash) —

  a hash of configuration values

Returns:

• (FileboundClient::Client) —

  an instance of FileboundClient::Client

Raises:

• (FileboundClientException)

# File 'lib/filebound_client.rb', line 27

def self.connect(config)
  connection = FileboundClient::Connection.build_connection(config)
  raise FileboundClientException.new('Failed to login', 401) unless connection.login
  new(connection)
end

Instance Method Details

#delete(url, query_params = nil) ⇒ true, false

Executes a DELETE request on the current Filebound client session

Parameters:

• url (String) —

  the resource url to request

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

  the optional query parameters to pass to the DELETE request

Returns:

• (true, false) —

  true if resource was deleted successfully

# File 'lib/filebound_client.rb', line 80

def delete(url, query_params = nil)
  perform('delete', url, query: query_params)
  true
end

#get(url, query_params = nil) ⇒ Hash

Executes a GET request on the current Filebound client session expecting JSON in the body of the response

Parameters:

• url (String) —

  the resource url to request

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

  the optional query parameters to pass to the GET request

Returns:

• (Hash) —

  the JSON parsed hash of the response body

# File 'lib/filebound_client.rb', line 44

def get(url, query_params = nil)
  JSON.parse(perform('get', url, query: query_params), symbolize_names: true, quirks_mode: true)
end

#get_binary(url, query_params = nil) ⇒ String

Executes a GET request on the current Filebound client session expecting binary in the body of the response

Parameters:

• url (String) —

  the resource url to request

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

  the optional query parameters to pass to the GET request

Returns:

• (String) —

  Base64 encoded binary string

# File 'lib/filebound_client.rb', line 52

def get_binary(url, query_params = nil)
  perform('get', url, query: query_params)
end

#post(url, query_params = nil, body = nil) ⇒ Hash

Executes a POST request on the current Filebound client session expecting JSON in the body of the request/response

Parameters:

• url (String) —

  the resource url to request

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

  the optional query parameters to pass to the POST request

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

  the hash that will be converted to JSON when inserted in the body of the request

Returns:

• (Hash) —

  the JSON parsed hash of the response body

# File 'lib/filebound_client.rb', line 71

def post(url, query_params = nil, body = nil)
  params = { headers: { 'Content-Type' => 'application/json' }, query: query_params, body: body }
  JSON.parse(perform('post', url, params), symbolize_names: true, quirks_mode: true)
end

#put(url, query_params = nil, body = nil) ⇒ Hash

Executes a PUT request on the current Filebound client session expecting JSON in the body of the request/response

Parameters:

• url (String) —

  the resource url to request

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

  the optional query parameters to pass to the PUT request

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

  the hash that will be converted to JSON when inserted in the body of the request

Returns:

• (Hash) —

  the JSON parsed hash of the response body

# File 'lib/filebound_client.rb', line 61

def put(url, query_params = nil, body = nil)
  params = { headers: { 'Content-Type' => 'application/json' }, query: query_params, body: body }
  JSON.parse(perform('put', url, params), symbolize_names: true, quirks_mode: true)
end