Class: RemoveBg::ApiClient

Inherits:

Object

• Object
• RemoveBg::ApiClient

Includes:

Api

Defined in:

lib/remove_bg/api_client.rb

Constant Summary

Constants included from Api

RemoveBg::Api::URL

Instance Method Summary

• #account_info(options) ⇒ RemoveBg::AccountInfo

  Fetches account information.

• #initialize(connection: RemoveBg::HttpConnection.build) ⇒ ApiClient constructor

  A new instance of ApiClient.

• #remove_from_file(image_path, options) ⇒ RemoveBg::Result|RemoveBg::CompositeResult

  Removes the background from an image on the local file system.

• #remove_from_url(image_url, options) ⇒ RemoveBg::Result|RemoveBg::CompositeResult

  Removes the background from the image at the URL specified.

Constructor Details

#initialize(connection: RemoveBg::HttpConnection.build) ⇒ ApiClient

Returns a new instance of ApiClient.

Parameters:

• connection (Faraday::Connection) (defaults to: RemoveBg::HttpConnection.build)

# File 'lib/remove_bg/api_client.rb', line 23

def initialize(connection: RemoveBg::HttpConnection.build)
  @connection = connection
end

Instance Method Details

#account_info(options) ⇒ RemoveBg::AccountInfo

Fetches account information

Parameters:

• options (RemoveBg::BaseRequestOptions)

Returns:

• (RemoveBg::AccountInfo)

Raises:

• (RemoveBg::Error)

# File 'lib/remove_bg/api_client.rb', line 55

def account_info(options)
  request_account_info(options.api_key)
end

#remove_from_file(image_path, options) ⇒ RemoveBg::Result|RemoveBg::CompositeResult

Removes the background from an image on the local file system

Parameters:

• image_path (String)
• options (RemoveBg::RequestOptions)

Returns:

• (RemoveBg::Result|RemoveBg::CompositeResult)

Raises:

• (RemoveBg::Error)

# File 'lib/remove_bg/api_client.rb', line 33

def remove_from_file(image_path, options)
  data = options.data.merge(image_file: Upload.for_file(image_path))
  request_remove_bg(data, options.api_key)
end

#remove_from_url(image_url, options) ⇒ RemoveBg::Result|RemoveBg::CompositeResult

Removes the background from the image at the URL specified

Parameters:

• image_url (String)
• options (RemoveBg::RequestOptions)

Returns:

• (RemoveBg::Result|RemoveBg::CompositeResult)

Raises:

• (RemoveBg::Error)

# File 'lib/remove_bg/api_client.rb', line 44

def remove_from_url(image_url, options)
  RemoveBg::UrlValidator.validate(image_url)
  data = options.data.merge(image_url:)
  request_remove_bg(data, options.api_key)
end