Module: BrickFTP

Defined in:
lib/brick_ftp.rb,
lib/brick_ftp/api.rb,
lib/brick_ftp/cli.rb,
lib/brick_ftp/client.rb,
lib/brick_ftp/version.rb,
lib/brick_ftp/webhook.rb,
lib/brick_ftp/api/base.rb,
lib/brick_ftp/api/file.rb,
lib/brick_ftp/api/user.rb,
lib/brick_ftp/cli/main.rb,
lib/brick_ftp/cli/site.rb,
lib/brick_ftp/api/group.rb,
lib/brick_ftp/api/bundle.rb,
lib/brick_ftp/api/folder.rb,
lib/brick_ftp/cli/config.rb,
lib/brick_ftp/api/history.rb,
lib/brick_ftp/http_client.rb,
lib/brick_ftp/api/behavior.rb,
lib/brick_ftp/api_component.rb,
lib/brick_ftp/configuration.rb,
lib/brick_ftp/log_formatter.rb,
lib/brick_ftp/api/permission.rb,
lib/brick_ftp/api/public_key.rb,
lib/brick_ftp/api/site_usage.rb,
lib/brick_ftp/api_definition.rb,
lib/brick_ftp/webhook/request.rb,
lib/brick_ftp/api/history/file.rb,
lib/brick_ftp/api/history/site.rb,
lib/brick_ftp/api/history/user.rb,
lib/brick_ftp/api/notification.rb,
lib/brick_ftp/api/history/login.rb,
lib/brick_ftp/api/authentication.rb,
lib/brick_ftp/api/bundle_content.rb,
lib/brick_ftp/api/file_operation.rb,
lib/brick_ftp/api/history/folder.rb,
lib/brick_ftp/api/bundle_download.rb,
lib/brick_ftp/api/folder_behavior.rb,
lib/brick_ftp/api/file_operation/copy.rb,
lib/brick_ftp/api/file_operation/move.rb,
lib/brick_ftp/api/file_operation/upload.rb,
lib/brick_ftp/api/authentication/session.rb

Defined Under Namespace

Modules: API, APIDefinition, CLI, Webhook Classes: APIComponent, Client, Configuration, HTTPClient, LogFormatter

Constant Summary collapse

IP_ADDRESSES =

brickftp.com/redundancy/

%w(
  54.193.69.72
  54.193.69.200
  54.193.65.189
  54.193.69.198
  54.208.20.30
  54.209.242.244
  54.209.231.233
  54.208.198.60
  54.209.231.99
  54.209.246.178
  54.209.91.52
  54.208.63.151
  54.209.246.217
  54.209.222.205
  54.208.169.75
  52.8.210.89
  52.74.166.120
  52.64.2.88
  52.17.96.203
  52.28.101.76
  54.232.253.47
  54.64.240.152
  52.74.188.115
  52.64.6.120
  52.18.87.39
  52.29.176.178
  54.207.27.239
  52.68.4.44
).freeze
VERSION = 
'0.6.0'.freeze

Class Method Summary collapse

Class Method Details

.config ⇒ BrickFTP::Configuration

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

Returns:



80
81
82
 
# File 'lib/brick_ftp.rb', line 80

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

.config=(config) ⇒ BrickFTP::Configuration

Set configuration.

Parameters:

Returns:

Raises:

  • (TypeError) 


88
89
90
91
 
# File 'lib/brick_ftp.rb', line 88

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:



104
105
106
 
# File 'lib/brick_ftp.rb', line 104

def self.configure
  yield(config)
end

.logger ⇒ Logger

Return logger object.

Returns:

  • (Logger) 


110
111
112
 
# File 'lib/brick_ftp.rb', line 110

def self.logger
  config.logger
end