google-cloud-storage 0.20.2 → 0.21.0

data/lib/google/cloud/storage/file.rb

@@ -37,10 +37,9 @@ module Google
       #   and Techniques
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/storage"
       #
-      #   gcloud = Google::Cloud.new
-      #   storage = gcloud.storage
+      #   storage = Google::Cloud::Storage.new
       #
       #   bucket = storage.bucket "my-bucket"
       #
@@ -276,10 +275,9 @@ module Google
         # @yield [file] a block yielding a delegate object for updating the file
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -336,10 +334,9 @@ module Google
         # @return [File] Returns a `::File` object on the local file system
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -347,10 +344,9 @@ module Google
         #   file.download "path/to/downloaded/file.ext"
         #
         # @example Use the CRC32c digest by passing :crc32c.
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -358,10 +354,9 @@ module Google
         #   file.download "path/to/downloaded/file.ext", verify: :crc32c
         #
         # @example Use the MD5 and CRC32c digests by passing :all.
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -369,10 +364,9 @@ module Google
         #   file.download "path/to/downloaded/file.ext", verify: :all
         #
         # @example Disable the download verification by passing :none.
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -433,10 +427,9 @@ module Google
         # @return [Google::Cloud::Storage::File]
         #
         # @example The file can be copied to a new path in the current bucket:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -444,10 +437,9 @@ module Google
         #   file.copy "path/to/destination/file.ext"
         #
         # @example The file can also be copied to a different bucket:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -479,10 +471,9 @@ module Google
         # @return [Boolean] Returns `true` if the file was deleted.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -508,20 +499,18 @@ module Google
         #   `HTTPS`.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
         #   public_url = file.public_url
         #
         # @example Generate the URL with a protocol other than HTTPS:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
@@ -571,20 +560,18 @@ module Google
         #   Private Key.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
         #   shared_url = file.signed_url
         #
         # @example Any of the option parameters may be specified:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
@@ -610,7 +597,7 @@ module Google
                       content_type: content_type, content_md5: content_md5,
                       issuer: issuer, client_email: client_email,
                       signing_key: signing_key, private_key: private_key }
-          signer = File::Signer.new self
+          signer = File::Signer.from_file self
           signer.signed_url options
         end
 
@@ -625,10 +612,9 @@ module Google
         #   Control guide
         #
         # @example Grant access to a user by prepending `"user-"` to an email:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
@@ -637,10 +623,9 @@ module Google
         #   file.acl.add_reader "user-#{email}"
         #
         # @example Grant access to a group by prepending `"group-"` to an email:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
@@ -649,10 +634,9 @@ module Google
         #   file.acl.add_reader "group-#{email}"
         #
         # @example Or, grant access via a predefined permissions list:
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-todo-app"
         #   file = bucket.file "avatars/heidi/400x400.png"
@@ -731,14 +715,24 @@ module Google
         ##
         # @private Create a signed_url for a file.
         class Signer
-          def initialize file
-            @file = file
+          def initialize bucket, path, service
+            @bucket = bucket
+            @path = path
+            @service = service
+          end
+
+          def self.from_file file
+            new file.bucket, file.name, file.service
+          end
+
+          def self.from_bucket bucket, path
+            new bucket.name, path, bucket.service
           end
 
           ##
           # The external path to the file.
           def ext_path
-            URI.escape "/#{@file.bucket}/#{@file.name}"
+            URI.escape "/#{@bucket}/#{@path}"
           end
 
           ##
@@ -762,12 +756,12 @@ module Google
 
           def determine_signing_key options = {}
             options[:signing_key] || options[:private_key] ||
-              @file.service.credentials.signing_key
+              @service.credentials.signing_key
           end
 
           def determine_issuer options = {}
             options[:issuer] || options[:client_email] ||
-              @file.service.credentials.issuer
+              @service.credentials.issuer
           end
 
           def signed_url options

data/lib/google/cloud/storage/file/acl.rb

@@ -23,10 +23,9 @@ module Google
         # Represents a File's Access Control List.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/storage"
         #
-        #   gcloud = Google::Cloud.new
-        #   storage = gcloud.storage
+        #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
@@ -66,10 +65,9 @@ module Google
           # Reloads all Access Control List data for the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -79,9 +77,7 @@ module Google
           def reload!
             gapi = @service.list_file_acls @bucket, @file
             acls = Array(gapi.items).map do |acl|
-              if acl.is_a? Google::Apis::StorageV1::ObjectAccessControl
-                return acl
-              end
+              next acl if acl.is_a? Google::Apis::StorageV1::ObjectAccessControl
               fail "Unknown ACL format: #{acl.class}" unless acl.is_a? Hash
               Google::Apis::StorageV1::ObjectAccessControl.from_json acl.to_json
             end
@@ -96,10 +92,9 @@ module Google
           # @return [Array<String>]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -117,10 +112,9 @@ module Google
           # @return [Array<String>]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -151,10 +145,9 @@ module Google
           #   revision of this object. Default is the latest version.
           #
           # @example Grant access to a user by prepending `"user-"` to an email:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -163,10 +156,9 @@ module Google
           #   file.acl.add_owner "user-#{email}"
           #
           # @example Grant access to a group by prepending `"group-"` to email:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -202,10 +194,9 @@ module Google
           #   revision of this object. Default is the latest version.
           #
           # @example Grant access to a user by prepending `"user-"` to an email:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -214,10 +205,9 @@ module Google
           #   file.acl.add_reader "user-#{email}"
           #
           # @example Grant access to a group by prepending `"group-"` to email:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -253,10 +243,9 @@ module Google
           #   revision of this object. Default is the latest version.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -284,10 +273,9 @@ module Google
           # rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -307,10 +295,9 @@ module Google
           # ACL rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -327,10 +314,9 @@ module Google
           # rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -347,10 +333,9 @@ module Google
           # rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -366,10 +351,9 @@ module Google
           # rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #
@@ -386,10 +370,9 @@ module Google
           # rule to the file.
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #

data/lib/google/cloud/storage/file/list.rb

@@ -44,10 +44,9 @@ module Google
           # @return [Boolean]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #   files = bucket.files
@@ -65,10 +64,9 @@ module Google
           # @return [File::List]
           #
           # @example
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #   files = bucket.files
@@ -107,10 +105,9 @@ module Google
           # @return [Enumerator]
           #
           # @example Iterating each file by passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #   files = bucket.files
@@ -119,10 +116,9 @@ module Google
           #   end
           #
           # @example Using the enumerator by not passing a block:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #   files = bucket.files
@@ -132,10 +128,9 @@ module Google
           #   end
           #
           # @example Limit the number of API calls made:
-          #   require "google/cloud"
+          #   require "google/cloud/storage"
           #
-          #   gcloud = Google::Cloud.new
-          #   storage = gcloud.storage
+          #   storage = Google::Cloud::Storage.new
           #
           #   bucket = storage.bucket "my-bucket"
           #   files = bucket.files