gitlab-fog-google 1.13.0

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

@@ -0,0 +1,34 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Copy an object from one Google Storage bucket to another
+        #
+        # @param source_bucket [String] Name of source bucket
+        # @param source_object [String] Name of source object
+        # @param target_bucket [String] Name of bucket to create copy in
+        # @param target_object [String] Name of new copy of object
+        #
+        # @see https://cloud.google.com/storage/docs/json_api/v1/objects/copy
+        # @return [Google::Apis::StorageV1::Object] copy of object
+        def copy_object(source_bucket, source_object,
+                        target_bucket, target_object, options = {})
+          request_options = ::Google::Apis::RequestOptions.default.merge(options)
+
+          @storage_json.copy_object(source_bucket, source_object,
+                                    target_bucket, target_object,
+                                    request_options, **options)
+        end
+      end
+
+      class Mock
+        def copy_object(_source_bucket, _source_object,
+                        _target_bucket, _target_object, _options = {})
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Delete an Google Storage bucket
+        # https://cloud.google.com/storage/docs/json_api/v1/buckets/delete
+        #
+        # @param bucket_name [String] Name of bucket to delete
+        def delete_bucket(bucket_name)
+          @storage_json.delete_bucket(bucket_name)
+        end
+      end
+
+      class Mock
+        def delete_bucket(_bucket_name)
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Delete an object from Google Storage
+        # https://cloud.google.com/storage/docs/json_api/v1/objects/delete
+        #
+        # @param bucket_name [String] Name of bucket containing object to delete
+        # @param object_name [String] Name of object to delete
+        def delete_object(bucket_name, object_name)
+          @storage_json.delete_object(bucket_name, object_name)
+        end
+      end
+
+      class Mock
+        def delete_object(_bucket_name, _object_name)
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get an expiring object url from Google Storage for deleting an object
+        # https://cloud.google.com/storage/docs/access-control#Signed-URLs
+        #
+        # @param bucket_name [String] Name of bucket containing object
+        # @param object_name [String] Name of object to get expiring url for
+        # @param expires [Time] Expiry time for this URL
+        #
+        # @return [String] Expiring object https URL
+        def delete_object_url(bucket_name, object_name, expires)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          https_url({
+                      :headers  => {},
+                      :host     => @host,
+                      :method   => "DELETE",
+                      :path     => "#{bucket_name}/#{object_name}"
+                    }, expires)
+        end
+      end
+
+      class Mock
+        def delete_object_url(bucket_name, object_name, expires)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          https_url({
+                      :headers  => {},
+                      :host     => @host,
+                      :method   => "DELETE",
+                      :path     => "#{bucket_name}/#{object_name}"
+                    }, expires)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # List information about objects in an Google Storage bucket #
+        # https://cloud.google.com/storage/docs/json_api/v1/buckets#resource
+        #
+        # @param bucket_name [String]
+        #   Name of bucket to list
+        # @param [Fixnum] if_metageneration_match
+        #   Makes the return of the bucket metadata conditional on whether the bucket's
+        #   current metageneration matches the given value.
+        # @param [Fixnum] if_metageneration_not_match
+        #   Makes the return of the bucket metadata conditional on whether the bucket's
+        #   current metageneration does not match the given value.
+        # @param [String] projection
+        #   Set of properties to return. Defaults to noAcl.
+        # @return [Google::Apis::StorageV1::Bucket]
+        def get_bucket(bucket_name,
+                       if_metageneration_match: nil,
+                       if_metageneration_not_match: nil,
+                       projection: nil)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+
+          @storage_json.get_bucket(
+            bucket_name,
+            :if_metageneration_match => if_metageneration_match,
+            :if_metageneration_not_match => if_metageneration_not_match,
+            :projection => projection
+          )
+        end
+      end
+
+      class Mock
+        def get_bucket(_bucket_name, _options = {})
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get access control list entry for an Google Storage bucket
+        # @see https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls/get
+        #
+        # @param bucket_name [String]
+        #   Name of bucket
+        # @param entity [String]
+        #   The entity holding the permission. Can be user-userId,
+        #   user-emailAddress, group-groupId, group-emailAddress, allUsers,
+        #   or allAuthenticatedUsers.
+        # @return [Google::Apis::StorageV1::BucketAccessControls]
+        def get_bucket_acl(bucket_name, entity)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("entity is required") unless entity
+
+          @storage_json.get_bucket_access_control(bucket_name, entity)
+        end
+      end
+
+      class Mock
+        def get_bucket_acl(_bucket_name, _entity)
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+require "tempfile"
+
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get an object from Google Storage
+        # @see https://cloud.google.com/storage/docs/json_api/v1/objects/get
+        #
+        # @param bucket_name [String] Name of bucket to create object in
+        # @param object_name [String] Name of object to create
+        # @param generation [Fixnum]
+        #   If present, selects a specific revision of this object (as opposed to the latest version, the default).
+        # @param ifGenerationMatch [Fixnum]
+        #   Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
+        # @param ifGenerationNotMatch [Fixnum]
+        #   Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
+        # @param ifMetagenerationMatch [Fixnum]
+        #   Makes the operation conditional on whether the object's current metageneration matches the given value.
+        # @param ifMetagenerationNotMatch [Fixnum]
+        #   Makes the operation conditional on whether the object's current metageneration does not match the given value.
+        # @param projection [Fixnum]
+        #   Set of properties to return
+        # @param options [Hash]
+        #   Request-specific options
+        # @param &block [Proc]
+        #   Block to pass a streamed object response to. Expected format is
+        #   same as Excon :response_block ({ |chunk, remaining_bytes, total_bytes| ... })
+        # @return [Hash] Object metadata with :body attribute set to contents of object
+        def get_object(bucket_name, object_name,
+                       generation: nil,
+                       if_generation_match: nil,
+                       if_generation_not_match: nil,
+                       if_metageneration_match: nil,
+                       if_metageneration_not_match: nil,
+                       projection: nil,
+                       **options, &_block)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+
+          buf = Tempfile.new("fog-google-storage-temp")
+
+          # Two requests are necessary, first for metadata, then for content.
+          # google-api-ruby-client doesn't allow fetching both metadata and content
+          request_options = ::Google::Apis::RequestOptions.default.merge(options)
+          all_opts = {
+            :generation => generation,
+            :if_generation_match => if_generation_match,
+            :if_generation_not_match => if_generation_not_match,
+            :if_metageneration_match => if_metageneration_match,
+            :if_metageneration_not_match => if_metageneration_not_match,
+            :projection => projection,
+            :options => request_options
+          }
+
+          object = @storage_json.get_object(bucket_name, object_name, all_opts).to_h
+          @storage_json.get_object(
+            bucket_name,
+            object_name,
+            all_opts.merge(:download_dest => buf.path)
+          )
+
+          if block_given?
+            yield buf.read, nil, nil
+          else
+            object[:body] = buf.read
+            buf.unlink
+          end
+
+          object
+        ensure
+          buf.close! rescue nil
+        end
+      end
+
+      class Mock
+        def get_object(_bucket_name, _object_name, _options = {})
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get access control list for an Google Storage object
+        # https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls/get
+        #
+        # @param bucket_name [String] Name of bucket object is in
+        # @param object_name [String] Name of object to add ACL to
+        # @param entity [String] The entity holding the permission.
+        #   Can be user-userId, user-emailAddress, group-groupId,
+        #   group-emailAddress, allUsers, or allAuthenticatedUsers.
+        # @param generation [Hash] Specify a particular version to retrieve
+        # @return [Google::Apis::StorageV1::ObjectAccessControls]
+        def get_object_acl(bucket_name, object_name, entity, generation: nil)
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+
+          @storage_json.get_object_access_control(
+            bucket_name, object_name, entity,
+            :generation => generation
+          )
+        end
+      end
+
+      class Mock
+        def get_object_acl(_bucket_name, _object_name)
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      module GetObjectHttpUrl
+        def get_object_http_url(bucket_name, object_name, expires, options = {})
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+          http_url(options.merge(:headers  => {},
+                                 :host     => @host,
+                                 :method   => "GET",
+                                 :path     => "#{bucket_name}/#{object_name}"),
+                   expires)
+        end
+      end
+
+      class Real
+        # Get an expiring object http url from Google Storage
+        # https://cloud.google.com/storage/docs/access-control#Signed-URLs
+        #
+        # @param bucket_name [String] Name of bucket to read from
+        # @param object_name [String] Name of object to read
+        # @param expires [Time] Expiry time for this URL
+        # @return [String] Expiring object http URL
+        include GetObjectHttpUrl
+      end
+
+      class Mock # :nodoc:all
+        include GetObjectHttpUrl
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      module GetObjectHttpsUrl
+        def get_object_https_url(bucket_name, object_name, expires, options = {})
+          raise ArgumentError.new("bucket_name is required") unless bucket_name
+          raise ArgumentError.new("object_name is required") unless object_name
+
+          https_url(options.merge(:headers  => {},
+                                  :host     => @host,
+                                  :method   => "GET",
+                                  :path     => "#{bucket_name}/#{object_name}"),
+                    expires)
+        end
+      end
+
+      class Real
+        # Get an expiring object https url from Google Storage
+        # https://cloud.google.com/storage/docs/access-control#Signed-URLs
+        #
+        # @param bucket_name [String] Name of bucket to read from
+        # @param object_name [String] Name of object to read
+        # @param expires [Time] Expiry time for this URL
+        # @return [String] Expiring object https URL
+        include GetObjectHttpsUrl
+      end
+
+      class Mock # :nodoc:all
+        include GetObjectHttpsUrl
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Fetch metadata for an object in Google Storage
+        #
+        # @param bucket_name [String] Name of bucket to read from
+        # @param object_name [String] Name of object to read
+        # @param options [Hash] Optional parameters
+        # @see https://cloud.google.com/storage/docs/json_api/v1/objects/get
+        #
+        # @return [Google::Apis::StorageV1::Object]
+        def get_object_metadata(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
+
+          request_options = ::Google::Apis::RequestOptions.default.merge(options)
+          @storage_json.get_object(bucket_name, object_name,
+                                   :options => request_options)
+        end
+      end
+
+      class Mock
+        def get_object_metadata(_bucket_name, _object_name, _options = {})
+          # :no-coverage:
+          Fog::Mock.not_implemented
+          # :no-coverage:
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Fog
+  module Storage
+    class GoogleJSON
+      class Real
+        # Get an expiring object url from GCS
+        # Deprecated, redirects to get_object_https_url.rb
+        def get_object_url(bucket_name, object_name, expires, options = {})
+          Fog::Logger.deprecation("Fog::Storage::Google => #get_object_url is deprecated, use #get_object_https_url instead[/] [light_black](#{caller(0..0)})")
+          get_object_https_url(bucket_name, object_name, expires, options)
+        end
+      end
+
+      class Mock # :nodoc:all
+        def get_object_url(bucket_name, object_name, expires, options = {})
+          Fog::Logger.deprecation("Fog::Storage::Google => #get_object_url is deprecated, use #get_object_https_url instead[/] [light_black](#{caller(0..0)})")
+          get_object_https_url(bucket_name, object_name, expires, options)
+        end
+      end
+    end
+  end
+end