Class: Uploadcare::Client::FilesAccessor

Inherits:
Object
  • Object
show all
Defined in:
lib/uploadcare/client/files_accessor.rb

Overview

High-level file operations scoped to a client instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ FilesAccessor

Returns a new instance of FilesAccessor.

Parameters:



8
9
10
 
# File 'lib/uploadcare/client/files_accessor.rb', line 8

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



5
6
7
 
# File 'lib/uploadcare/client/files_accessor.rb', line 5

def client
  @client
end

Instance Method Details

#batch_delete(uuids:, request_options: {}) ⇒ Uploadcare::BatchResult

Parameters:

  • uuids (Array<String>)
  • request_options (Hash) (defaults to: {})

Returns:

  • (Uploadcare::BatchResult) 


75
76
77
 
# File 'lib/uploadcare/client/files_accessor.rb', line 75

def batch_delete(uuids:, request_options: {})
  Uploadcare::Resources::File.batch_delete(uuids: uuids, client: client, request_options: request_options)
end

#batch_store(uuids:, request_options: {}) ⇒ Uploadcare::BatchResult

Parameters:

  • uuids (Array<String>)
  • request_options (Hash) (defaults to: {})

Returns:

  • (Uploadcare::BatchResult) 


68
69
70
 
# File 'lib/uploadcare/client/files_accessor.rb', line 68

def batch_store(uuids:, request_options: {})
  Uploadcare::Resources::File.batch_store(uuids: uuids, client: client, request_options: request_options)
end

#copy_to_local(source:, options: {}, request_options: {}) ⇒ Uploadcare::Resources::File

Parameters:

  • source (String)
  • options (Hash) (defaults to: {})
  • request_options (Hash) (defaults to: {})

Returns:



83
84
85
86
87
 
# File 'lib/uploadcare/client/files_accessor.rb', line 83

def copy_to_local(source:, options: {}, request_options: {})
  Uploadcare::Resources::File.local_copy(
    source: source, options: options, client: client, request_options: request_options
  )
end

#copy_to_remote(source:, target:, options: {}, request_options: {}) ⇒ Hash

Parameters:

  • source (String)
  • target (String)
  • options (Hash) (defaults to: {})
  • request_options (Hash) (defaults to: {})

Returns:

  • (Hash) 


94
95
96
97
98
 
# File 'lib/uploadcare/client/files_accessor.rb', line 94

def copy_to_remote(source:, target:, options: {}, request_options: {})
  Uploadcare::Resources::File.remote_copy(
    source: source, target: target, options: options, client: client, request_options: request_options
  )
end

#find(uuid:, params: {}, request_options: {}) ⇒ Uploadcare::Resources::File

Parameters:

  • uuid (String)
  • params (Hash) (defaults to: {})
  • request_options (Hash) (defaults to: {})

Returns:



16
17
18
19
20
 
# File 'lib/uploadcare/client/files_accessor.rb', line 16

def find(uuid:, params: {}, request_options: {})
  Uploadcare::Resources::File.find(
    uuid: uuid, params: params, client: client, request_options: request_options
  )
end

#list(request_options: {}, **options) ⇒ Uploadcare::Collections::Paginated

Parameters:

  • request_options (Hash) (defaults to: {})
  • options (Hash)

Returns:



25
26
27
28
29
 
# File 'lib/uploadcare/client/files_accessor.rb', line 25

def list(request_options: {}, **options)
  Uploadcare::Resources::File.list(
    options: options, client: client, request_options: request_options
  )
end

#search(request_options: {}, **options) ⇒ Uploadcare::Collections::FileSearchResult

Search files using full-text criteria and structured filters.

Examples:

Search PDFs and inspect highlighted matches

results = client.files.search(
  query: "invoice", exact: { detected_mime_type: ["application/pdf"] }, limit: 20
)
results.each { |file| puts file.highlight }

Parameters:

  • request_options (Hash) (defaults to: {})
  • options (Hash) —

    Search criteria plus limit, offset, and include

Returns:



42
43
44
45
46
 
# File 'lib/uploadcare/client/files_accessor.rb', line 42

def search(request_options: {}, **options)
  Uploadcare::Resources::File.search(
    options: options, client: client, request_options: request_options
  )
end

#upload(source, request_options: {}, **options) {|Hash| ... } ⇒ Uploadcare::Resources::File, ...

Parameters:

  • source (IO, Array<IO>, String)
  • request_options (Hash) (defaults to: {})
  • options (Hash)

Yields:

  • (Hash)

Returns:



53
54
55
 
# File 'lib/uploadcare/client/files_accessor.rb', line 53

def upload(source, request_options: {}, **options, &block)
  client.uploads.upload(source, request_options: request_options, **options, &block)
end

#upload_from_url(url, request_options: {}, **options) ⇒ Uploadcare::Resources::File, Hash

Parameters:

  • url (String)
  • request_options (Hash) (defaults to: {})
  • options (Hash)

Returns:



61
62
63
 
# File 'lib/uploadcare/client/files_accessor.rb', line 61

def upload_from_url(url, request_options: {}, **options)
  client.uploads.upload_from_url(url: url, request_options: request_options, **options)
end