Class: ActiveStorage::Service::GCSService

Inherits:
ActiveStorage::Service show all
Defined in:
activestorage/lib/active_storage/service/gcs_service.rb

Overview

Wraps the Google Cloud Storage as an Active Storage service. See ActiveStorage::Service for the generic API documentation that applies to all services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ActiveStorage::Service

build, configure

Methods included from ActiveSupport::Autoload

#autoload, #autoload_at, #autoload_under, #autoloads, #eager_autoload, #eager_load!, extended

Constructor Details

#initialize(project:, keyfile:, bucket:) ⇒ GCSService

Returns a new instance of GCSService.



12
13
14
15
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 12

def initialize(project:, keyfile:, bucket:)
  @client = Google::Cloud::Storage.new(project: project, keyfile: keyfile)
  @bucket = @client.bucket(bucket)
end

Instance Attribute Details

#bucket ⇒ Object (readonly)

Returns the value of attribute bucket.



10
11
12
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 10

def bucket
  @bucket
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 10

def client
  @client
end

Instance Method Details

#delete(key) ⇒ Object 



36
37
38
39
40
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 36

def delete(key)
  instrument :delete, key do
    file_for(key).try(:delete)
  end
end

#download(key) ⇒ Object

FIXME: Add streaming when given a block



28
29
30
31
32
33
34
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 28

def download(key)
  instrument :download, key do
    io = file_for(key).download
    io.rewind
    io.read
  end
end

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
46
47
48
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 42

def exist?(key)
  instrument :exist, key do |payload|
    answer = file_for(key).present?
    payload[:exist] = answer
    answer
  end
end

#headers_for_direct_upload(key, content_type:, checksum:) ⇒ Object 



74
75
76
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 74

def headers_for_direct_upload(key, content_type:, checksum:, **)
  { "Content-Type" => content_type, "Content-MD5" => checksum }
end

#upload(key, io, checksum: nil) ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 17

def upload(key, io, checksum: nil)
  instrument :upload, key, checksum: checksum do
    begin
      bucket.create_file(io, key, md5: checksum)
    rescue Google::Cloud::InvalidArgumentError
      raise ActiveStorage::IntegrityError
    end
  end
end

#url(key, expires_in:, filename:, content_type:, disposition:) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 50

def url(key, expires_in:, filename:, content_type:, disposition:)
  instrument :url, key do |payload|
    generated_url = file_for(key).signed_url expires: expires_in, query: {
      "response-content-disposition" => disposition,
      "response-content-type" => content_type
    }

    payload[:url] = generated_url

    generated_url
  end
end

#url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'activestorage/lib/active_storage/service/gcs_service.rb', line 63

def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
  instrument :url, key do |payload|
    generated_url = bucket.signed_url key, method: "PUT", expires: expires_in,
      content_type: content_type, content_md5: checksum

    payload[:url] = generated_url

    generated_url
  end
end