-- WIP --

Author: remi Taylor

storage/files.rb

@@ -12,16 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# TODO use consistent wording : "object" | "blob" | file"
-
 def list_bucket_contents project_id:, bucket_name:
   # [START list_bucket_contents]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
 
@@ -31,75 +29,93 @@ def list_bucket_contents project_id:, bucket_name:
   # [END list_bucket_contents]
 end
 
-# TODO
-# def list_bucket_contents_with_prefix
-
-def upload_object project_id:, bucket_name:, local_path:
-  # [START upload_object]
+def list_bucket_contents_with_prefix project_id:, bucket_name:, prefix:
+  # [START list_bucket_contents]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
-  # local_path  = "Path to local file to upload"
+  # prefix      = "Filter results to files whose names begin with this prefix"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
+  files   = bucket.files prefix: prefix
 
-  file = bucket.create_file local_path
+  files.each do |file|
+    puts file.name
+  end
+  # [END list_bucket_contents]
+end
+
+def upload_file project_id:, bucket_name:, local_file_path:,
+                                             storage_file_path:
+  # [START upload_file]
+  # project_id        = "Your Google Cloud project ID"
+  # bucket_name       = "Your Google Cloud Storage bucket name"
+  # local_file_path   = "Path to local file to upload"
+  # storage_file_path = "Path to store the file in Google Cloud Storage"
+
+  require "google/cloud"
+
+  gcloud  = Google::Cloud.new project_id
+  storage = gcloud.storage
+  bucket  = storage.bucket bucket_name
+
+  file = bucket.create_file local_file_path, storage_file_path
 
   puts "Uploaded #{file.name}"
-  # [END upload_object]
+  # [END upload_file]
 end
 
-def download_object project_id:, bucket_name:, file_name:, local_path:
-  # [START download_object]
+def download_file project_id:, bucket_name:, file_name:, local_path:
+  # [START download_file]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
   # file_name   = "Name of file in Google Cloud Storage to download locally"
   # local_path  = "Path to local file to save"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
   file    = bucket.file file_name
 
   file.download local_path
 
   puts "Downloaded #{file.name}"
-  # [END download_object]
+  # [END download_file]
 end
 
-def delete_object project_id:, bucket_name:, file_name:
-  # [START delete_object]
+def delete_file project_id:, bucket_name:, file_name:
+  # [START delete_file]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
   # file_name   = "Name of file in Google Cloud Storage to delete"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
   file    = bucket.file file_name
 
   file.delete
 
   puts "Deleted #{file.name}"
-  # [END delete_object]
+  # [END delete_file]
 end
 
-def list_object_details project_id:, bucket_name:, file_name:
-  # [START list_object_details]
+def list_file_details project_id:, bucket_name:, file_name:
+  # [START list_file_details]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
   # file_name   = "Name of file in Google Cloud Storage"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
   file    = bucket.file file_name
@@ -126,41 +142,41 @@ def list_object_details project_id:, bucket_name:, file_name:
   file.metadata.each do |key, value|
     puts " - #{key} = #{value}"
   end
-  # [END list_object_details]
+  # [END list_file_details]
 end
 
-def make_object_public project_id:, bucket_name:, file_name:
-  # [START make_object_public]
+def make_file_public project_id:, bucket_name:, file_name:
+  # [START make_file_public]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
   # file_name   = "Name of file in Google Cloud Storage to make public"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
   file    = bucket.file file_name
 
   file.acl.public!
 
   puts "#{file.name} is publicly accessible at #{file.public_url}"
-  # [END make_object_public]
+  # [END make_file_public]
 end
 
 # TODO
 # def generate_signed_url
 
-def rename_object project_id:, bucket_name:, file_name:, new_name:
-  # [START rename_object]
+def rename_file project_id:, bucket_name:, file_name:, new_name:
+  # [START rename_file]
   # project_id  = "Your Google Cloud project ID"
   # bucket_name = "Your Google Cloud Storage bucket name"
   # file_name   = "Name of file in Google Cloud Storage to rename"
   # new_name    = "File will be renamed to this new name"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket bucket_name
   file    = bucket.file file_name
@@ -170,21 +186,21 @@ def rename_object project_id:, bucket_name:, file_name:, new_name:
   file.delete
 
   puts "my-file.txt has been renamed to #{renamed_file.name}"
-  # [END rename_object]
+  # [END rename_file]
 end
 
-def copy_object project_id:, source_bucket_name:, source_file_name:,
+def copy_file project_id:, source_bucket_name:, source_file_name:,
                              dest_bucket_name:,   dest_file_name:
-  # [START copy_object]
+  # [START copy_file]
   # project_id         = "Your Google Cloud project ID"
   # source_bucket_name = "Source bucket to copy file from"
   # source_file_name   = "Source file name"
   # dest_bucket_name   = "Destination bucket to copy file to"
   # dest_file_name     = "Destination file name"
 
-  require "gcloud"
+  require "google/cloud"
 
-  gcloud  = Gcloud.new project_id
+  gcloud  = Google::Cloud.new project_id
   storage = gcloud.storage
   bucket  = storage.bucket source_bucket_name
   file    = bucket.file source_file_name
@@ -194,7 +210,7 @@ def copy_object project_id:, source_bucket_name:, source_file_name:,
 
   puts "#{file.name} in #{bucket.name} copied to " +
        "#{copied_file.name} in #{destination_bucket.name}"
-  # [END copy_object]
+  # [END copy_file]
 end
 
 def run_sample arguments
@@ -207,35 +223,35 @@ def run_sample arguments
   when "list_prefix"
     raise NotImplementedError, "list_prefix"
   when "upload"
-    upload_object project_id:  ENV["GCLOUD_PROJECT"],
-                  bucket_name: arguments.shift,
-                  local_path:  arguments.shift
+    upload_file project_id:      ENV["GCLOUD_PROJECT"],
+                  bucket_name:     arguments.shift,
+                  local_file_path: arguments.shift
   when "download"
-    download_object project_id:  ENV["GCLOUD_PROJECT"],
+    download_file project_id:  ENV["GCLOUD_PROJECT"],
                     bucket_name: arguments.shift,
                     file_name:   arguments.shift,
                     local_path:  arguments.shift
   when "delete"
-    delete_object project_id:  ENV["GCLOUD_PROJECT"],
+    delete_file project_id:  ENV["GCLOUD_PROJECT"],
                   bucket_name: arguments.shift,
                   file_name:   arguments.shift
   when "metadata"
-    list_object_details project_id:  ENV["GCLOUD_PROJECT"],
+    list_file_details project_id:  ENV["GCLOUD_PROJECT"],
                         bucket_name: arguments.shift,
                         file_name:   arguments.shift
   when "make_public"
-    make_object_public project_id:  ENV["GCLOUD_PROJECT"],
+    make_file_public project_id:  ENV["GCLOUD_PROJECT"],
                        bucket_name: arguments.shift,
                        file_name:   arguments.shift
   when "signed_url"
     raise NotImplementedError, "signed_url"
   when "rename"
-    rename_object project_id:  ENV["GCLOUD_PROJECT"],
+    rename_file project_id:  ENV["GCLOUD_PROJECT"],
                   bucket_name: arguments.shift,
                   file_name:   arguments.shift,
                   new_name:    arguments.shift
   when "copy"
-    copy_object project_id:         ENV["GCLOUD_PROJECT"],
+    copy_file project_id:         ENV["GCLOUD_PROJECT"],
                 source_bucket_name: arguments.shift,
                 source_file_name:   arguments.shift,
                 dest_bucket_name:   arguments.shift,

storage/spec/buckets_spec.rb

@@ -1,8 +1,22 @@
+# Copyright 2016 Google, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require_relative "../buckets"
 require "rspec"
 require "google/cloud"
 
-RSpec.describe "Google Cloud Storage bucket management" do
+RSpec.describe "Google Cloud Storage buckets sample" do
 
   before :all do
     @project_id  = ENV["GOOGLE_PROJECT_ID"]