Module: Files

Defined in:
lib/files.com.rb,
lib/files.com/api.rb,
lib/files.com/list.rb,
lib/files.com/util.rb,
lib/files.com/errors.rb,
lib/files.com/version.rb,
lib/files.com/response.rb,
lib/files.com/api_client.rb,
lib/files.com/models/app.rb,
lib/files.com/models/dir.rb,
lib/files.com/sizable_io.rb,
lib/files.com/models/auto.rb,
lib/files.com/models/file.rb,
lib/files.com/models/lock.rb,
lib/files.com/models/site.rb,
lib/files.com/models/user.rb,
lib/files.com/models/group.rb,
lib/files.com/models/image.rb,
lib/files.com/models/style.rb,
lib/files.com/models/action.rb,
lib/files.com/models/bundle.rb,
lib/files.com/models/errors.rb,
lib/files.com/models/folder.rb,
lib/files.com/models/status.rb,
lib/files.com/models/api_key.rb,
lib/files.com/models/as2_key.rb,
lib/files.com/models/history.rb,
lib/files.com/models/invoice.rb,
lib/files.com/models/message.rb,
lib/files.com/models/payment.rb,
lib/files.com/models/preview.rb,
lib/files.com/models/project.rb,
lib/files.com/models/request.rb,
lib/files.com/models/session.rb,
lib/files.com/models/behavior.rb,
lib/files.com/system_profiler.rb,
lib/files.com/models/clickwrap.rb,
lib/files.com/models/automation.rb,
lib/files.com/models/dns_record.rb,
lib/files.com/models/file_utils.rb,
lib/files.com/models/group_user.rb,
lib/files.com/models/ip_address.rb,
lib/files.com/models/permission.rb,
lib/files.com/models/public_key.rb,
lib/files.com/models/file_action.rb,
lib/files.com/models/file_comment.rb,
lib/files.com/models/notification.rb,
lib/files.com/models/sso_strategy.rb,
lib/files.com/models/user_request.rb,
lib/files.com/models/remote_server.rb,
lib/files.com/models/external_event.rb,
lib/files.com/models/history_export.rb,
lib/files.com/models/usage_snapshot.rb,
lib/files.com/models/bundle_download.rb,
lib/files.com/models/message_comment.rb,
lib/files.com/models/settings_change.rb,
lib/files.com/models/user_cipher_use.rb,
lib/files.com/models/bundle_recipient.rb,
lib/files.com/models/file_part_upload.rb,
lib/files.com/models/message_reaction.rb,
lib/files.com/models/account_line_item.rb,
lib/files.com/models/invoice_line_item.rb,
lib/files.com/models/payment_line_item.rb,
lib/files.com/models/public_ip_address.rb,
lib/files.com/models/bandwidth_snapshot.rb,
lib/files.com/models/usage_daily_snapshot.rb,
lib/files.com/models/file_comment_reaction.rb,
lib/files.com/models/history_export_result.rb,
lib/files.com/models/message_comment_reaction.rb

Defined Under Namespace

Modules: Util Classes: APIError, AccountLineItem, Action, Api, ApiClient, ApiKey, App, As2Key, AuthenticationError, Auto, Automation, BandwidthSnapshot, Behavior, Bundle, BundleDownload, BundleRecipient, Clickwrap, ConnectionError, DnsRecord, Error, Errors, ExternalEvent, File, FileAction, FileComment, FileCommentReaction, FilePartUpload, FileUtils, Folder, Group, GroupUser, History, HistoryExport, HistoryExportResult, Image, InvalidParameterError, InvalidRequestError, Invoice, InvoiceLineItem, IpAddress, List, Lock, Message, MessageComment, MessageCommentReaction, MessageReaction, MissingParameterError, NotImplementedError, Notification, Payment, PaymentLineItem, Permission, PermissionError, Preview, Project, PublicIpAddress, PublicKey, RateLimitError, RemoteServer, Request, Response, Session, SettingsChange, Site, SizableIO, SsoStrategy, Status, Style, SystemProfiler, TooManyRequestsError, UsageDailySnapshot, UsageSnapshot, User, UserCipherUse, UserRequest, ValidationError

Constant Summary collapse

LEVEL_DEBUG =

map to the same values as the standard library’s logger

Logger::DEBUG
LEVEL_ERROR = 
Logger::ERROR
LEVEL_INFO = 
Logger::INFO
VERSION = 
"1.0"
Dir = 
Folder

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



107
108
109
 
# File 'lib/files.com.rb', line 107

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



107
108
109
 
# File 'lib/files.com.rb', line 107

def base_url
  @base_url
end

.initial_network_retry_delay ⇒ Object

Returns the value of attribute initial_network_retry_delay.



107
108
109
 
# File 'lib/files.com.rb', line 107

def initial_network_retry_delay
  @initial_network_retry_delay
end

.max_network_retry_delay ⇒ Object

Returns the value of attribute max_network_retry_delay.



107
108
109
 
# File 'lib/files.com.rb', line 107

def max_network_retry_delay
  @max_network_retry_delay
end

.open_timeout ⇒ Object

Returns the value of attribute open_timeout.



107
108
109
 
# File 'lib/files.com.rb', line 107

def open_timeout
  @open_timeout
end

.proxy ⇒ Object

Returns the value of attribute proxy.



107
108
109
 
# File 'lib/files.com.rb', line 107

def proxy
  @proxy
end

.read_timeout ⇒ Object

Returns the value of attribute read_timeout.



107
108
109
 
# File 'lib/files.com.rb', line 107

def read_timeout
  @read_timeout
end

.session_id ⇒ Object

Returns the value of attribute session_id.



107
108
109
 
# File 'lib/files.com.rb', line 107

def session_id
  @session_id
end

Class Method Details

.app_info ⇒ Object 



182
183
184
 
# File 'lib/files.com.rb', line 182

def self.app_info
  @app_info
end

.app_info=(info) ⇒ Object 



186
187
188
 
# File 'lib/files.com.rb', line 186

def self.app_info=(info)
  @app_info = info
end

.log_level ⇒ Object

When set prompts the library to log some extra information to $stdout and $stderr about what it’s doing. For example, it’ll produce information about requests, responses, and errors that are received. Valid log levels are ‘debug` and `info`, with `debug` being a little more verbose in places.

Use of this configuration is only useful when ‘.logger` is not set. When it is, the decision what levels to print is entirely deferred to the logger.



122
123
124
 
# File 'lib/files.com.rb', line 122

def self.log_level
  @log_level
end

.log_level=(val) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/files.com.rb', line 126

def self.log_level=(val)
  # Backwards compatibility for values that we briefly allowed
  if val == "debug"
    val = LEVEL_DEBUG
  elsif val == "info"
    val = LEVEL_INFO
  end

  if !val.nil? && ![ LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO ].include?(val)
    raise ArgumentError,
          "log_level should only be set to `nil`, `debug` or `info`"
  end
  @log_level = val
end

.logger ⇒ Object

Sets a logger to which logging output will be sent. The logger should support the same interface as the ‘Logger` class that’s part of Ruby’s standard library (hint, anything in ‘Rails.logger` will likely be suitable).

If ‘.logger` is set, the value of `.log_level` is ignored. The decision on what levels to print is entirely deferred to the logger.



148
149
150
 
# File 'lib/files.com.rb', line 148

def self.logger
  @logger
end

.logger=(val) ⇒ Object 



152
153
154
 
# File 'lib/files.com.rb', line 152

def self.logger=(val)
  @logger = val
end

.max_network_retries ⇒ Object 



156
157
158
 
# File 'lib/files.com.rb', line 156

def self.max_network_retries
  @max_network_retries
end

.max_network_retries=(val) ⇒ Object 



160
161
162
 
# File 'lib/files.com.rb', line 160

def self.max_network_retries=(val)
  @max_network_retries = val.to_i
end

.session=(session) ⇒ Object 



164
165
166
167
 
# File 'lib/files.com.rb', line 164

def self.session=(session)
  session.save unless session.id
  self.session_id = session.id
end

.set_app_info(name, partner_id: nil, url: nil, version: nil) ⇒ Object

Sets some basic information about the running application that’s sent along with API requests.

Takes a name and optional partner program ID, plugin URL, and version.



173
174
175
176
177
178
179
180
 
# File 'lib/files.com.rb', line 173

def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
  @app_info = {
    name: name,
    partner_id: partner_id,
    url: url,
    version: version,
  }
end