fog-google 0.1.3 → 0.2.0

data/lib/fog/storage/google_json/requests/head_object.rb

@@ -0,0 +1,54 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get headers for an object from Google Storage
+        # https://cloud.google.com/storage/docs/json_api/v1/objects/get
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - Name of bucket to read from
+        # * object_name<~String> - Name of object to read
+        # * options<~Hash>:
+        #   * 'If-Match'<~String> - Returns object only if its etag matches this value, otherwise returns 412 (Precondition Failed).
+        #   * 'If-Modified-Since'<~Time> - Returns object only if it has been modified since this time, otherwise returns 304 (Not Modified).
+        #   * 'If-None-Match'<~String> - Returns object only if its etag differs from this value, otherwise returns 304 (Not Modified)
+        #   * 'If-Unmodified-Since'<~Time> - Returns object only if it has not been modified since this time, otherwise returns 412 (Precodition Failed).
+        #   * 'Range'<~String> - Range of object to download
+        #   * 'versionId'<~String> - specify a particular version to retrieve
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~String> - Contents of object
+        #   * headers<~Hash>:
+        #     * 'Content-Length'<~String> - Size of object contents
+        #     * 'Content-Type'<~String> - MIME type of object
+        #     * 'ETag'<~String> - Etag of object
+        #     * 'Last-Modified'<~String> - Last modified timestamp for object
+        def head_object(bucket_name, object_name, _options = {})
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+
+          api_method = @storage_json.objects.get
+          parameters = {
+            "bucket" => bucket_name,
+            "object" => object_name,
+            "projection" => "full"
+          }
+
+          object = request(api_method, parameters)
+          object.headers = object.body
+          object.body = nil
+          object
+        end
+      end
+
+      class Mock
+        def head_object(bucket_name, object_name, options = {})
+          response = get_object(bucket_name, object_name, options)
+          response.body = nil
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/google_json/requests/put_bucket.rb

@@ -0,0 +1,68 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Create an Google Storage bucket
+        # https://cloud.google.com/storage/docs/json_api/v1/buckets/insert
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to create
+        # * options<~Hash> - config arguments for bucket.  Defaults to {}.
+        #   * 'LocationConstraint'<~Symbol> - sets the location for the bucket
+        #   * 'x-amz-acl'<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * status<~Integer> - 200
+        def put_bucket(bucket_name, options = {})
+          location = options["LocationConstraint"] if options["LocationConstraint"]
+
+          api_method = @storage_json.buckets.insert
+          parameters = {
+            "project" => @project,
+            "projection" => "full"
+          }
+          body_object = {
+            "name" => bucket_name,
+            "location" => location
+          }
+          parameters.merge! options
+
+          request(api_method, parameters, body_object = body_object)
+        end
+      end
+
+      class Mock
+        def put_bucket(bucket_name, options = {})
+          acl = options["x-goog-acl"] || "private"
+          if !%w(private publicRead publicReadWrite authenticatedRead).include?(acl)
+            raise Excon::Errors::BadRequest.new("invalid x-goog-acl")
+          else
+            data[:acls][:bucket][bucket_name] = self.class.acls(options[acl])
+          end
+          response = Excon::Response.new
+          response.status = 200
+          bucket = {
+            :objects        => {},
+            "Name"          => bucket_name,
+            "CreationDate"  => Time.now,
+            "Owner"         => { "DisplayName" => "owner", "ID" => "some_id" },
+            "Payer"         => "BucketOwner"
+          }
+          if options["LocationConstraint"]
+            bucket["LocationConstraint"] = options["LocationConstraint"]
+          else
+            bucket["LocationConstraint"] = ""
+          end
+          if data[:buckets][bucket_name].nil?
+            data[:buckets][bucket_name] = bucket
+          else
+            response.status = 409
+            raise(Excon::Errors.status_error({ :expects => 200 }, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/google_json/requests/put_bucket_acl.rb

@@ -0,0 +1,34 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Mock
+        def put_bucket_acl(_bucket_name, _acl)
+          Fog::Mock.not_implemented
+        end
+      end
+
+      class Real
+        # Change access control list for an Google Storage bucket
+        # https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls/insert
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket to create
+        # * acl<~Hash> - ACL hash to add to bucket, see GCS documentation above
+        #    * entity
+        #    * role
+        def put_bucket_acl(bucket_name, acl)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("acl is required") unless acl
+
+          api_method = @storage_json.bucket_access_controls.insert
+          parameters = {
+            "bucket" => bucket_name
+          }
+          body_object = acl
+
+          request(api_method, parameters, body_object = body_object)
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/google_json/requests/put_object.rb

@@ -0,0 +1,118 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Create an object in an Google Storage bucket
+        # https://cloud.google.com/storage/docs/json_api/v1/objects/insert
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - Name of bucket to create object in
+        # * object_name<~String> - Name of object to create
+        # * data<~File> - File or String to create object from
+        # * options<~Hash>:
+        #   * 'Cache-Control'<~String> - Caching behaviour
+        #   * 'Content-Disposition'<~String> - Presentational information for the object
+        #   * 'Content-Encoding'<~String> - Encoding of object data
+        #   * 'Content-Length'<~String> - Size of object in bytes (defaults to object.read.length)
+        #   * 'Content-MD5'<~String> - Base64 encoded 128-bit MD5 digest of message (defaults to Base64 encoded MD5 of object.read)
+        #   * 'Content-Type'<~String> - Standard MIME type describing contents (defaults to MIME::Types.of.first)
+        #   * 'x-goog-acl'<~String> - Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
+        #   * "x-goog-meta-#{name}" - Headers to be returned with object, note total size of request without body must be less than 8 KB.
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'ETag'<~String> - etag of new object
+        def put_object(bucket_name, object_name, data, options = {})
+          if options["contentType"]
+            mime_type = options["contentType"]
+            if data.is_a? String
+              data = StringIO.new(data)
+            end
+          elsif data.is_a? String
+            data = StringIO.new(data)
+            mime_type = "text/plain"
+          elsif data.is_a? File
+            mime_type = Fog::Storage.parse_data(data)[:headers]["Content-Type"]
+          end
+
+          media = ::Google::APIClient::UploadIO.new(data, mime_type, object_name)
+          api_method = @storage_json.objects.insert
+          parameters = {
+            "uploadType" => "multipart",
+            "bucket" => bucket_name,
+            "name" => object_name
+          }
+
+          body_object = {
+            :contentType => mime_type,
+            :contentEncoding => options["contentEncoding"],
+          }
+          body_object.merge! options
+
+          acl = []
+          case options["predefinedAcl"]
+          when "publicRead"
+            acl.push({ "entity" => "allUsers", "role" => "READER" })
+          when "publicReadWrite"
+            acl.push({ "entity" => "allUsers", "role" => "OWNER" })
+          when "authenticatedRead"
+            acl.push({ "entity" => "allAuthenticatedUsers", "role" => "READER" })
+          end
+
+          unless acl.empty?
+            body_object[:acl] = acl
+          end
+
+          request(api_method, parameters, body_object = body_object, media = media)
+        end
+      end
+
+      class Mock
+        def put_object(bucket_name, object_name, data, options = {})
+          acl = options["x-goog-acl"] || "private"
+          if !%w(private publicRead publicReadWrite authenticatedRead).include?(acl)
+            raise Excon::Errors::BadRequest.new("invalid x-goog-acl")
+          else
+            self.data[:acls][:object][bucket_name] ||= {}
+            self.data[:acls][:object][bucket_name][object_name] = self.class.acls(acl)
+          end
+
+          data = Fog::Storage.parse_data(data)
+          data[:body] = data[:body].read unless data[:body].is_a?(String)
+          response = Excon::Response.new
+          if (bucket = self.data[:buckets][bucket_name])
+            response.status = 200
+            object = {
+              :body             => data[:body],
+              "Content-Type"    => options["Content-Type"] || data[:headers]["Content-Type"],
+              "ETag"            => Fog::Google::Mock.etag,
+              "Key"             => object_name,
+              "Last-Modified"   => Fog::Time.now.to_date_header,
+              "Content-Length"  => options["Content-Length"] || data[:headers]["Content-Length"]
+            }
+
+            for key, value in options
+              case key
+              when "Cache-Control", "Content-Disposition", "Content-Encoding", "Content-MD5", "Expires", /^x-goog-meta-/
+                object[key] = value
+              end
+            end
+
+            bucket[:objects][object_name] = object
+            response.headers = {
+              "Content-Length"  => object["Content-Length"],
+              "Content-Type"    => object["Content-Type"],
+              "ETag"            => object["ETag"],
+              "Last-Modified"   => object["Last-Modified"]
+            }
+          else
+            response.status = 404
+            raise(Excon::Errors.status_error({ :expects => 200 }, response))
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/google_json/requests/put_object_acl.rb

@@ -0,0 +1,31 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Change access control list for an Google Storage object
+        # https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls/insert
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - name of bucket object is in
+        # * object_name<~String> - name of object to add ACL to
+        # * acl<~Hash> - ACL hash to add to bucket, see GCS documentation above
+        #    * entity
+        #    * role
+        def put_object_acl(bucket_name, object_name, acl)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          raise ArgumentError.new("acl is required") unless acl
+
+          api_method = @storage_json.object_access_controls.insert
+          parameters = {
+            "bucket" => bucket_name,
+            "object" => object_name
+          }
+          body_object = acl
+
+          request(api_method, parameters, body_object = body_object)
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/google_json/requests/put_object_url.rb

@@ -0,0 +1,45 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get an expiring object url from Google Storage for putting an object
+        #
+        # ==== Parameters
+        # * bucket_name<~String> - Name of bucket containing object
+        # * object_name<~String> - Name of object to get expiring url for
+        # * expires<~Time> - An expiry time for this url
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~String> - url for object
+        #
+        # ==== See Also
+        # https://cloud.google.com/storage/docs/access-control#Signed-URLs
+        #
+        def put_object_url(bucket_name, object_name, headers = {})
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          https_url({
+                      :headers  => headers,
+                      :host     => @host,
+                      :method   => "PUT",
+                      :path     => "#{bucket_name}/#{object_name}"
+                    }, expires)
+        end
+      end
+
+      class Mock
+        def put_object_url(bucket_name, object_name, expires, headers = {})
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          https_url({
+                      :headers  => headers,
+                      :host     => @host,
+                      :method   => "PUT",
+                      :path     => "#{bucket_name}/#{object_name}"
+                    }, expires)
+        end
+      end
+    end
+  end
+end

data/lib/fog/{google/storage.rb → storage/google_xml.rb}

@@ -1,16 +1,16 @@
 module Fog
   module Storage
-    class Google < Fog::Service
+    class GoogleXML < Fog::Service
       requires :google_storage_access_key_id, :google_storage_secret_access_key
       recognizes :host, :port, :scheme, :persistent, :path_style
 
-      model_path 'fog/google/models/storage'
-      collection  :directories
-      model       :directory
-      collection  :files
-      model       :file
+      model_path "fog/storage/google_xml/models"
+      collection :directories
+      model :directory
+      collection :files
+      model :file
 
-      request_path 'fog/google/requests/storage'
+      request_path "fog/storage/google_xml/requests"
       request :copy_object
       request :delete_bucket
       request :delete_object
@@ -47,8 +47,8 @@ module Fog
         private
 
         def host_path_query(params, expires)
-          params[:headers]['Date'] = expires.to_i
-          params[:path] = CGI.escape(params[:path]).gsub('%2F', '/')
+          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))}"
@@ -58,7 +58,7 @@ module Fog
 
         def request_params(params)
           subdomain = params[:host].split(".#{@host}").first
-          if @path_style or subdomain !~ /^(?!goog)(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
+          if @path_style || 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).")
@@ -81,12 +81,10 @@ module Fog
             subdomain = nil
           end
 
-          if subdomain && subdomain != @host
-            params[:subdomain] = subdomain
-          end
+          params[:subdomain] = subdomain if subdomain && subdomain != @host
 
           params[:scheme] ||= @scheme
-          params[:port]   ||= @port
+          params[:port] ||= @port
           params
         end
       end
@@ -96,61 +94,61 @@ module Fog
 
         def self.acls(type)
           case type
-          when 'private'
+          when "private"
             {
-              "AccessControlList"=> [
+              "AccessControlList" => [
                 {
                   "Permission" => "FULL_CONTROL",
-                  "Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
+                  "Scope" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById" }
                 }
               ],
-              "Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+              "Owner" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0" }
             }
-          when 'public-read'
+          when "public-read"
             {
-              "AccessControlList"=> [
+              "AccessControlList" => [
                 {
                   "Permission" => "FULL_CONTROL",
-                  "Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
+                  "Scope" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById" }
                 },
                 {
                   "Permission" => "READ",
-                  "Scope" => {"type" => "AllUsers"}
+                  "Scope" => { "type" => "AllUsers" }
                 }
               ],
-              "Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+              "Owner" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0" }
             }
-          when 'public-read-write'
+          when "public-read-write"
             {
-              "AccessControlList"=> [
+              "AccessControlList" => [
                 {
                   "Permission" => "FULL_CONTROL",
-                  "Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
+                  "Scope" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById" }
                 },
                 {
                   "Permission" => "READ",
-                  "Scope" => {"type" => "AllUsers"}
+                  "Scope" => { "type" => "AllUsers" }
                 },
                 {
                   "Permission" => "WRITE",
-                  "Scope" => {"type" => "AllUsers"}
+                  "Scope" => { "type" => "AllUsers" }
                 }
               ],
-              "Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+              "Owner" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0" }
             }
-          when 'authenticated-read'
+          when "authenticated-read"
             {
-              "AccessControlList"=> [
+              "AccessControlList" => [
                 {
                   "Permission" => "FULL_CONTROL",
-                  "Scope" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById"}
+                  "Scope" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0", "type" => "UserById" }
                 },
                 {
                   "Permission" => "READ",
-                  "Scope" => {"type" => "AllAuthenticatedUsers"}
+                  "Scope" => { "type" => "AllAuthenticatedUsers" }
                 }
               ],
-              "Owner" => {"ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0"}
+              "Owner" => { "ID" => "2744ccd10c7533bd736ad890f9dd5cab2adb27b07d500b9493f29cdc420cb2e0" }
             }
           end
         end
@@ -171,7 +169,7 @@ module Fog
           @data = nil
         end
 
-        def initialize(options={})
+        def initialize(options = {})
           @google_storage_access_key_id = options[:google_storage_access_key_id]
         end
 
@@ -183,7 +181,7 @@ module Fog
           self.class.data.delete(@google_storage_access_key_id)
         end
 
-        def signature(params)
+        def signature(_params)
           "foo"
         end
       end
@@ -208,17 +206,16 @@ module Fog
         #
         # ==== Returns
         # * Storage object with connection to google.
-        def initialize(options={})
-
+        def initialize(options = {})
           @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'
+          @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'
-          @path_style = options[:path_style]  || false
+          @port       = options[:port] || 443
+          @scheme     = options[:scheme] || "https"
+          @path_style = options[:path_style] || false
         end
 
         def reload
@@ -234,27 +231,26 @@ module Fog
 #{params[:headers]['Date']}
 DATA
 
-          google_headers, canonical_google_headers = {}, ''
+          google_headers = {}
+          canonical_google_headers = ""
           for key, value in params[:headers]
-            if key[0..6] == 'x-goog-'
-              google_headers[key] = value
-            end
+            google_headers[key] = value if key[0..6] == "x-goog-"
           end
 
-          google_headers = google_headers.sort {|x, y| x[0] <=> y[0]}
+          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  = "/"
+          canonical_resource = "/"
           if subdomain = params.delete(:subdomain)
             canonical_resource << "#{CGI.escape(subdomain).downcase}/"
           end
           canonical_resource << "#{params[:path]}"
-          canonical_resource << '?'
+          canonical_resource << "?"
           for key in (params[:query] || {}).keys
-            if ['acl', 'cors', 'location', 'logging', 'requestPayment', 'torrent', 'versions', 'versioning'].include?(key)
+            if %w(acl cors location logging requestPayment torrent versions versioning).include?(key)
               canonical_resource << "#{key}&"
             end
           end
@@ -287,8 +283,8 @@ DATA
           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)}"
+          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