fog--fog/lib/fog/google/storage.rb

306 lines
10 KiB
Ruby

require 'fog/google/core'
module Fog
module Storage
class Google < Fog::Service
requires :google_storage_access_key_id, :google_storage_secret_access_key
recognizes :host, :port, :scheme, :persistent
model_path 'fog/google/models/storage'
collection :directories
model :directory
collection :files
model :file
request_path 'fog/google/requests/storage'
request :copy_object
request :delete_bucket
request :delete_object
request :get_bucket
request :get_bucket_acl
request :get_object
request :get_object_acl
request :get_object_torrent
request :get_object_http_url
request :get_object_https_url
request :get_object_url
request :get_service
request :head_object
request :put_bucket
request :put_bucket_acl
request :put_object
request :put_object_acl
request :put_object_url
module Utils
def http_url(params, expires)
"http://" << host_path_query(params, expires)
end
def https_url(params, expires)
"https://" << host_path_query(params, expires)
end
def url(params, expires)
Fog::Logger.deprecation("Fog::Storage::Google => #url is deprecated, use #https_url instead [light_black](#{caller.first})[/]")
https_url(params, expires)
end
private
def host_path_query(params, expires)
params[:headers]['Date'] = expires.to_i
params[:path] = CGI.escape(params[:path]).gsub('%2F', '/')
query = [params[:query]].compact
query << "GoogleAccessId=#{@google_storage_access_key_id}"
query << "Signature=#{CGI.escape(signature(params))}"
query << "Expires=#{params[:headers]['Date']}"
"#{params[:host]}/#{params[:path]}?#{query.join('&')}"
end
def request_params(params)
subdomain = params[:host].split(".#{@host}").first
unless subdomain =~ /^(?!goog)(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
if subdomain =~ /_/
# https://github.com/fog/fog/pull/1258#issuecomment-10248620.
Fog::Logger.warning("fog: the specified google storage bucket name (#{subdomain}) is not DNS compliant (only characters a through z, digits 0 through 9, and the hyphen).")
else
# - Bucket names must contain only lowercase letters, numbers, dashes (-), underscores (_), and dots (.). Names containing dots require verification.
# - Bucket names must start and end with a number or letter.
# - Bucket names must contain 3 to 63 characters. Names containing dots can contain up to 222 characters, but each dot-separated component can be no longer than 63 characters.
# - Bucket names cannot be represented as an IP address in dotted-decimal notation (for example, 192.168.5.4).
# - Bucket names cannot begin with the "goog" prefix.
# - Also, for DNS compliance, you should not have a period adjacent to another period or dash. For example, ".." or "-." or ".-" are not acceptable.
Fog::Logger.warning("fog: the specified google storage bucket name (#{subdomain}) is not a valid dns name. See: https://developers.google.com/storage/docs/bucketnaming")
end
params[:host] = params[:host].split("#{subdomain}.")[-1]
if params[:path]
params[:path] = "#{subdomain}/#{params[:path]}"
else
params[:path] = "#{subdomain}"
end
subdomain = nil
end
if subdomain && subdomain != @host
params[:subdomain] = subdomain
end
params[:scheme] ||= @scheme
params[:port] ||= @port
params
end
end
class Mock
include Utils
def self.acls(type)
case type
when 'private'
{
"AccessControlList"=> [
{
"Permission" => "FULL_CONTROL",
"Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
}
],
"Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
}
when 'public-read'
{
"AccessControlList"=> [
{
"Permission" => "FULL_CONTROL",
"Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
},
{
"Permission" => "READ",
"Scope" => {"type" => "AllUsers"}
}
],
"Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
}
when 'public-read-write'
{
"AccessControlList"=> [
{
"Permission" => "FULL_CONTROL",
"Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
},
{
"Permission" => "READ",
"Scope" => {"type" => "AllUsers"}
},
{
"Permission" => "WRITE",
"Scope" => {"type" => "AllUsers"}
}
],
"Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
}
when 'authenticated-read'
{
"AccessControlList"=> [
{
"Permission" => "FULL_CONTROL",
"Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
},
{
"Permission" => "READ",
"Scope" => {"type" => "AllAuthenticatedUsers"}
}
],
"Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
}
end
end
def self.data
@data ||= Hash.new do |hash, key|
hash[key] = {
:acls => {
:bucket => {},
:object => {}
},
:buckets => {}
}
end
end
def self.reset
@data = nil
end
def initialize(options={})
@google_storage_access_key_id = options[:google_storage_access_key_id]
end
def data
self.class.data[@google_storage_access_key_id]
end
def reset_data
self.class.data.delete(@google_storage_access_key_id)
end
def signature(params)
"foo"
end
end
class Real
include Utils
# Initialize connection to Google Storage
#
# ==== Notes
# options parameter must include values for :google_storage_access_key_id and
# :google_storage_secret_access_key in order to create a connection
#
# ==== Examples
# google_storage = Storage.new(
# :google_storage_access_key_id => your_google_storage_access_key_id,
# :google_storage_secret_access_key => your_google_storage_secret_access_key
# )
#
# ==== Parameters
# * options<~Hash> - config arguments for connection. Defaults to {}.
#
# ==== Returns
# * Storage object with connection to google.
def initialize(options={})
require 'fog/core/parser'
@google_storage_access_key_id = options[:google_storage_access_key_id]
@google_storage_secret_access_key = options[:google_storage_secret_access_key]
@connection_options = options[:connection_options] || {}
@hmac = Fog::HMAC.new('sha1', @google_storage_secret_access_key)
@host = options[:host] || 'storage.googleapis.com'
@persistent = options.fetch(:persistent, true)
@port = options[:port] || 443
@scheme = options[:scheme] || 'https'
end
def reload
@connection.reset if @connection
end
def signature(params)
string_to_sign =
<<-DATA
#{params[:method]}
#{params[:headers]['Content-MD5']}
#{params[:headers]['Content-Type']}
#{params[:headers]['Date']}
DATA
google_headers, canonical_google_headers = {}, ''
for key, value in params[:headers]
if key[0..6] == 'x-goog-'
google_headers[key] = value
end
end
google_headers = google_headers.sort {|x, y| x[0] <=> y[0]}
for key, value in google_headers
canonical_google_headers << "#{key}:#{value}\n"
end
string_to_sign << "#{canonical_google_headers}"
canonical_resource = "/"
if subdomain = params.delete(:subdomain)
canonical_resource << "#{CGI.escape(subdomain).downcase}/"
end
canonical_resource << "#{params[:path]}"
canonical_resource << '?'
for key in (params[:query] || {}).keys
if ['acl', 'cors', 'location', 'logging', 'requestPayment', 'torrent', 'versions', 'versioning'].include?(key)
canonical_resource << "#{key}&"
end
end
canonical_resource.chop!
string_to_sign << "#{canonical_resource}"
signed_string = @hmac.sign(string_to_sign)
Base64.encode64(signed_string).chomp!
end
def connection(scheme, host, port)
uri = "#{scheme}://#{host}:#{port}"
if @persistent
unless uri == @connection_uri
@connection_uri = uri
reload
@connection = nil
end
else
@connection = nil
end
@connection ||= Fog::Connection.new(uri, @persistent, @connection_options)
end
private
def request(params, &block)
params = request_params(params)
scheme = params.delete(:scheme)
host = params.delete(:host)
port = params.delete(:port)
params[:headers]['Date'] = Fog::Time.now.to_date_header
params[:headers]['Authorization'] = "GOOG1 #{@google_storage_access_key_id}:#{signature(params)}"
connection(scheme, host, port).request(params, &block)
end
end
end
end
end