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 a 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

Constructor Details

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

Returns a new instance of GCSService.



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

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.



7
8
9
 
# File 'lib/active_storage/service/gcs_service.rb', line 7

def bucket
  @bucket
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



7
8
9
 
# File 'lib/active_storage/service/gcs_service.rb', line 7

def client
  @client
end

Instance Method Details

#delete(key) ⇒ Object 



33
34
35
36
37
 
# File 'lib/active_storage/service/gcs_service.rb', line 33

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

#download(key) ⇒ Object

FIXME: Add streaming when given a block



25
26
27
28
29
30
31
 
# File 'lib/active_storage/service/gcs_service.rb', line 25

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

#exist?(key) ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
43
44
45
 
# File 'lib/active_storage/service/gcs_service.rb', line 39

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 



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

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

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



14
15
16
17
18
19
20
21
22
 
# File 'lib/active_storage/service/gcs_service.rb', line 14

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:, disposition:, filename:, content_type:) ⇒ Object 



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

def url(key, expires_in:, disposition:, filename:, content_type:)
  instrument :url, key do |payload|
    generated_url = file_for(key).signed_url expires: expires_in, query: {
      "response-content-disposition" => "#{disposition}; filename=\"#{filename}\"",
      "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 



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

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