Class: ActiveStorage::Service::GCSService

Inherits:
ActiveStorage::Service show all
Defined in:
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 Method Summary collapse

Methods inherited from ActiveStorage::Service

build, configure

Constructor Details

#initialize(**config) ⇒ GCSService

Returns a new instance of GCSService.



15
16
17
 
# File 'lib/active_storage/service/gcs_service.rb', line 15

def initialize(**config)
  @config = config
end

Instance Method Details

#delete(key) ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/active_storage/service/gcs_service.rb', line 59

def delete(key)
  instrument :delete, key: key do
    begin
      file_for(key).delete
    rescue Google::Cloud::NotFoundError
      # Ignore files already deleted
    end
  end
end

#delete_prefixed(prefix) ⇒ Object 



69
70
71
72
73
 
# File 'lib/active_storage/service/gcs_service.rb', line 69

def delete_prefixed(prefix)
  instrument :delete_prefixed, prefix: prefix do
    bucket.files(prefix: prefix).all(&:delete)
  end
end

#download(key) ⇒ Object

FIXME: Download in chunks when given a block.



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/active_storage/service/gcs_service.rb', line 36

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

    if block_given?
      yield io.read
    else
      io.read
    end
  end
end

#download_chunk(key, range) ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/active_storage/service/gcs_service.rb', line 49

def download_chunk(key, range)
  instrument :download_chunk, key: key, range: range do
    uri = URI(url(key, expires_in: 30.seconds, filename: ActiveStorage::Filename.new(""), content_type: "application/octet-stream", disposition: "inline"))

    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |client|
      client.get(uri, "Range" => "bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}").body
    end
  end
end

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
78
79
80
81
 
# File 'lib/active_storage/service/gcs_service.rb', line 75

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

#headers_for_direct_upload(key, checksum:) ⇒ Object 



106
107
108
 
# File 'lib/active_storage/service/gcs_service.rb', line 106

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

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/active_storage/service/gcs_service.rb', line 19

def upload(key, io, checksum: nil)
  instrument :upload, key: key, checksum: checksum do
    begin
      # The official GCS client library doesn't allow us to create a file with no Content-Type metadata.
      # We need the file we create to have no Content-Type so we can control it via the response-content-type
      # param in signed URLs. Workaround: let the GCS client create the file with an inferred
      # Content-Type (usually "application/octet-stream") then clear it.
      bucket.create_file(io, key, md5: checksum).update do |file|
        file.content_type = nil
      end
    rescue Google::Cloud::InvalidArgumentError
      raise ActiveStorage::IntegrityError
    end
  end
end

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



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/active_storage/service/gcs_service.rb', line 83

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

    payload[:url] = generated_url

    generated_url
  end
end

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



96
97
98
99
100
101
102
103
104
 
# File 'lib/active_storage/service/gcs_service.rb', line 96

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

    payload[:url] = generated_url

    generated_url
  end
end