Module: Uploadcare

Defined in:
lib/uploadcare/version.rb,
lib/uploadcare.rb

Overview

Root namespace for the Uploadcare Ruby SDK.

Defined Under Namespace

Classes: Client, CnameGenerator, Configuration, Result, WebhookSignatureVerifier

Constant Summary collapse

File =

Top-level aliases for the public resource classes.

Resources::File
Group =

Alias for the group resource.

Resources::Group
Project =

Alias for the project resource.

Resources::Project
Webhook =

Alias for the webhook resource.

Resources::Webhook
FileMetadata =

Alias for the file metadata resource.

Resources::FileMetadata
AddonExecution =

Alias for the add-on execution resource.

Resources::AddonExecution
DocumentConversion =

Alias for the document conversion resource.

Resources::DocumentConversion
VideoConversion =

Alias for the video conversion resource.

Resources::VideoConversion
VERSION =

Gem version.

'5.0.0.rc1'

Class Method Summary collapse

Class Method Details

.client(config: nil, **options) ⇒ Uploadcare::Client

Access a global client instance, or create one with overrides.

Parameters:

  • config (Uploadcare::Configuration, nil) (defaults to: nil) —

    Custom configuration

  • options (Hash) —

    Configuration overrides

Returns:



36
37
38
39
40
41
42
 
# File 'lib/uploadcare.rb', line 36

def client(config: nil, **options)
  if options.empty? && (config.nil? || config.equal?(configuration))
    return (@client ||= Client.new(config: configuration))
  end

  Client.new(config: config || configuration, **options)
end

.configuration ⇒ Uploadcare::Configuration

Access the global configuration.

Returns:



27
28
29
 
# File 'lib/uploadcare.rb', line 27

def configuration
  @configuration ||= Configuration.new
end

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

Configure the global Uploadcare instance.

Yields:

  • (config) —

    Configuration block

Yield Parameters:



18
19
20
21
22
 
# File 'lib/uploadcare.rb', line 18

def configure
  yield configuration if block_given?
ensure
  @client = nil
end

.eager_load! ⇒ void

This method returns an undefined value.

Eager-load the gem namespace through Zeitwerk.



67
68
69
 
# File 'lib/uploadcare.rb', line 67

def eager_load!
  @loader.eager_load
end

.files ⇒ Uploadcare::Client::FilesAccessor

Returns:



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

def files
  client.files
end

.groups ⇒ Uploadcare::Client::GroupsAccessor

Returns:



50
51
52
 
# File 'lib/uploadcare.rb', line 50

def groups
  client.groups
end

.project ⇒ Uploadcare::Client::ProjectAccessor

Returns:



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

def project
  client.project
end

.uploads ⇒ Uploadcare::Operations::UploadRouter

Returns:



55
56
57
 
# File 'lib/uploadcare.rb', line 55

def uploads
  client.uploads
end