Module: BrickFTP

Defined in:
lib/brick_ftp.rb,
lib/brick_ftp/api.rb,
lib/brick_ftp/client.rb,
lib/brick_ftp/version.rb,
lib/brick_ftp/api/file.rb,
lib/brick_ftp/api/user.rb,
lib/brick_ftp/api/base.rb,
lib/brick_ftp/api/group.rb,
lib/brick_ftp/api/folder.rb,
lib/brick_ftp/api/bundle.rb,
lib/brick_ftp/api/history.rb,
lib/brick_ftp/http_client.rb,
lib/brick_ftp/api/behavior.rb,
lib/brick_ftp/api/file_move.rb,
lib/brick_ftp/api/file_copy.rb,
lib/brick_ftp/configuration.rb,
lib/brick_ftp/api/permission.rb,
lib/brick_ftp/api/public_key.rb,
lib/brick_ftp/api/file_upload.rb,
lib/brick_ftp/api/notification.rb,
lib/brick_ftp/api/history/file.rb,
lib/brick_ftp/api/history/user.rb,
lib/brick_ftp/api/history/site.rb,
lib/brick_ftp/api/history/login.rb,
lib/brick_ftp/api/bundle_content.rb,
lib/brick_ftp/api/authentication.rb,
lib/brick_ftp/api/history/folder.rb,
lib/brick_ftp/api/behavior_folder.rb,
lib/brick_ftp/api/bundle_download.rb,
lib/brick_ftp/api/authentication/session.rb

Defined Under Namespace

Modules: API, APi Classes: Client, Configuration, HTTPClient

Constant Summary collapse

VERSION =
"0.2.0"

Class Method Summary collapse

Class Method Details

.configBrickFTP::Configuration

Return configuration. If it has not been configured yet, initialize configuration.

Returns:


36
37
38
# File 'lib/brick_ftp.rb', line 36

def self.config
  @config ||= BrickFTP::Configuration.new
end

.config=(config) ⇒ BrickFTP::Configuration

Set configuration.

Parameters:

Returns:

Raises:

  • (TypeError)

44
45
46
47
# File 'lib/brick_ftp.rb', line 44

def self.config=(config)
  raise TypeError unless config.is_a?(BrickFTP::Configuration)
  @config = config
end

.configure {|config| ... } ⇒ Object

Configure some settings.

Examples:

BrickFTP.configure do |c|
  c.subdomain = 'koshigoe'
  c.api_key = 'xxxxxxxxxx'
end

Yields:

  • (config)

    Given configuration object.

Yield Parameters:


60
61
62
# File 'lib/brick_ftp.rb', line 60

def self.configure
  yield(config)
end