Remove unused / unimplemented references to Storage samples

Author: remi Taylor

storage/files.rb

@@ -164,9 +164,6 @@ def make_file_public project_id:, bucket_name:, file_name:
   # [END make_file_public]
 end
 
-# TODO
-# def generate_signed_url
-
 def rename_file project_id:, bucket_name:, file_name:, new_name:
   # [START rename_file]
   # project_id  = "Your Google Cloud project ID"
@@ -220,8 +217,6 @@ def run_sample arguments
   when "list"
     list_bucket_contents project_id:  ENV["GCLOUD_PROJECT"],
                          bucket_name: arguments.shift
-  when "list_prefix"
-    raise NotImplementedError, "list_prefix"
   when "upload"
     upload_file project_id:      ENV["GCLOUD_PROJECT"],
                   bucket_name:     arguments.shift,
@@ -243,8 +238,6 @@ def run_sample arguments
     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_file project_id:  ENV["GCLOUD_PROJECT"],
                   bucket_name: arguments.shift,
@@ -262,13 +255,11 @@ def run_sample arguments
 
 Commands:
   list        <bucket>                List all files in the bucket
-  list_prefix <bucket> <prefix>       List all files with prefix in bucket
   upload      <bucket> <file>         Upload local file to a bucket
   download    <bucket> <file> <path>  Download a file from a bucket
   delete      <bucket> <file>         Delete a file from a bucket
   metadata    <bucket> <file>         Display metadata for a file in a bucket
   make_public <bucket> <file>         Make a file in a bucket public
-  signed_url  <bucket> <file>         Generate a signed URL to access a file
   rename      <bucket> <file> <new>   Rename a file in a bucket
   copy <srcBucket> <srcFile> <destBucket> <destFile>  Copy file to other bucket
 

storage/spec/files_spec.rb

@@ -26,10 +26,6 @@
     @storage         = @gcloud.storage
     @bucket          = @storage.bucket @bucket_name
     @local_file_path = File.expand_path "resources/file.txt", __dir__
-
-    # TODO: Delete all files in bucket before each test.
-    #       These tests work well when the default state
-    #       is an existing bucket with no files.
   end
 
   # Delete given file in Cloud Storage test bucket if it exists
@@ -138,252 +134,4 @@ def capture &block
       local_file.unlink
     end
   end
-
-  it "can delete a file in a bucket"
-  it "can print metadata for a file in a bucket"
-  it "can make a file in a bucket public"
-  it "can generate a signed URL to access a file"
-  it "can rename a file in a bucket"
-  it "can copy a file to another bucket"
-
-end
-
-__END__
-
-require "net/http"
-require "tempfile"
-
-describe "Google Cloud Storage sample" do
-
-  # Returns the text content of a given Gcloud storage file
-  def content_of storage_file
-    temp_file = Tempfile.new
-    storage_file.download temp_file.path
-    File.read temp_file.path
-  end
-
-  # Capture and return STDOUT output by block
-  def capture &block
-    real_stdout = $stdout
-    $stdout = StringIO.new
-    block.call
-    $stdout.string
-  ensure
-    $stdout = real_stdout
-  end
-
-  # Tests require environment variables:
-  #
-  #   GCLOUD_PROJECT   ID of your Google Cloud Platform project
-  #   BUCKET           Name of Google Cloud Storage bucket to use for tests
-  #   ALT_BUCKET       Name of an alternative bucket to also use for tests
-  #
-  before :all do
-    @project_id     = ENV["GCLOUD_PROJECT"]
-    @gcloud         = Gcloud.new @project_id
-    @storage        = @gcloud.storage
-    @bucket         = @storage.bucket ENV["BUCKET"]
-    @alt_bucket     = @storage.bucket ENV["ALT_BUCKET"]
-    @test_file_path = File.expand_path "test-file.txt", __dir__
-  end
-
-  # Sample code uses project ID "my-gcp-project-id" and bucket "my-bucket"
-  #
-  # Stub calls to Gcloud library to use our test project and storage buckets
-  before :each do
-    allow(Gcloud).to receive(:new).with("my-project-id").and_return(@gcloud)
-    allow(@gcloud).to receive(:storage).and_return(@storage)
-    allow(@storage).to receive(:bucket).with("my-bucket-name").
-                       and_return(@bucket)
-    allow(@storage).to receive(:bucket).with("other-bucket-name").
-                       and_return(@alt_bucket)
-
-    # File uploads use the fake path "/path/to/my-file.txt"
-    # When samples upload files, upload the spec/test-file.txt
-    # file instead for testing
-    allow(@bucket).to receive(:create_file).
-                      with("/path/to/my-file.txt", "my-file.txt").
-                      and_wrap_original do |create_file, file_path, obj_path|
-                        create_file.call @test_file_path, obj_path
-                      end
-
-    cleanup!
-  end
-
-  # Delete files in bucket used for tests
-  def cleanup!
-    @bucket.file("my-file.txt").delete      if @bucket.file "my-file.txt"
-    @bucket.file("renamed-file.txt").delete if @bucket.file "renamed-file.txt"
-    @alt_bucket.file("my-file.txt").delete  if @alt_bucket.file "my-file.txt"
-  end
-
-  it "list buckets"
-
-  it "create bucket"
-  # it "create bucket" do
-  #   # Google Cloud Storage bucket IDs are unique
-  #   #
-  #   # To prevent creating unique buckets, this test simply verifies
-  #   # that the correct `#create_bucket` method is called by the sample
-  #   expect(@storage).to receive(:create_bucket).with("my-bucket-name").
-  #                       and_return(@bucket)
-
-  #   expect { create_bucket }.to output("Created bucket: #{@bucket.name}\n").
-  #                               to_stdout
-  # end
-
-  it "upload file" do
-    expect(@bucket.file "my-file.txt").to be nil
-
-    expect { upload_file }.to output("Uploaded my-file.txt\n").to_stdout
-
-    expect(@bucket.file "my-file.txt").not_to be nil
-
-    expect(content_of @bucket.file("my-file.txt")).to eq(
-      "Content of test file\n"
-    )
-  end
-
-  it "download file" do
-    upload_file
-
-    # This sample downloads to the fake path "/path/to/my-file.txt"
-    # When the file download method is called, download to a
-    # temporary file instead
-    uploaded_file = @bucket.file "my-file.txt"
-    temp_file     = Tempfile.new
-
-    expect(@bucket).to receive(:file).with("my-file.txt").
-                       and_return(uploaded_file)
-
-    expect(uploaded_file).to receive(:download).with("/path/to/my-file.txt").
-                             and_wrap_original do |download, path|
-                               download.call temp_file.path
-                             end
-
-    expect(File.read temp_file).to eq ""
-
-    expect { download_file }.to output("Downloaded my-file.txt\n").to_stdout
-
-    expect(File.read temp_file).to eq "Content of test file\n"
-  end
-
-  it "make file public" do
-    upload_file
-    uploaded_file = @bucket.file "my-file.txt"
-
-    response = Net::HTTP.get_response URI.parse(uploaded_file.public_url)
-    expect(response).to be_a Net::HTTPForbidden
-    expect(response.code.to_i).to eq 403
-
-    expect { make_file_public }.to output(
-      "my-file.txt is publicly accessible at #{uploaded_file.public_url}\n"
-    ).to_stdout
-
-    response = Net::HTTP.get_response URI.parse(uploaded_file.public_url)
-    expect(response).to be_a Net::HTTPOK
-    expect(response.code.to_i).to eq 200
-    expect(response.body).to eq "Content of test file\n"
-  end
-
-  it "rename file" do
-    upload_file
-
-    expect(@bucket.file "my-file.txt").not_to be nil
-    expect(@bucket.file "renamed-file.txt").to be nil
-
-    expect { rename_file }.to output(
-      "my-file.txt has been renamed to renamed-file.txt\n"
-    ).to_stdout
-
-    expect(@bucket.file "my-file.txt").to be nil
-    expect(@bucket.file "renamed-file.txt").not_to be nil
-
-    expect(content_of @bucket.file("renamed-file.txt")).to eq(
-      "Content of test file\n"
-    )
-  end
-
-  it "copy file between buckets" do
-    upload_file
-
-    expect(@alt_bucket.file "my-file.txt").to be nil
-
-    expect { copy_file_between_buckets }.to output(
-      "my-file.txt in #{@bucket.name} copied to " +
-      "my-file.txt in #{@alt_bucket.name}\n"
-    ).to_stdout
-
-    expect(@alt_bucket.file "my-file.txt").not_to be nil
-    expect(content_of @alt_bucket.file("my-file.txt")).to eq(
-      "Content of test file\n"
-    )
-  end
-
-  it "list bucket contents" do
-    upload_file
-
-    expect { list_bucket_contents }.to output(/my-file\.txt/).to_stdout
-  end
-
-  it "list file details" do
-    upload_file
-    uploaded_file = @bucket.file "my-file.txt"
-
-    uploaded_file.cache_control       = "Cache-Control:public, max-age=3600"
-    uploaded_file.content_disposition = "attachment; filename=my-file.txt"
-    uploaded_file.content_language    = "en"
-    uploaded_file.metadata            = { foo: "bar" }
-
-    output = capture { list_file_details }
-    
-    expect(output).to include("Name: my-file.txt")
-    expect(output).to include("Bucket: #{@bucket.name}")
-    expect(output).to include("Storage class: STANDARD")
-    expect(output).to include("ID: #{uploaded_file.id}")
-    expect(output).to include("Size: 23 bytes")
-    expect(output).to match(/Created: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/)
-    expect(output).to match(/Updated: \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/)
-    expect(output).to include("Generation: #{uploaded_file.generation}")
-    expect(output).to include(
-      "Metageneration: #{uploaded_file.metageneration}"
-    )
-    expect(output).to include("Etag: #{uploaded_file.etag}")
-    expect(output).to include("Owners: #{uploaded_file.acl.owners.join ","}")
-    expect(output).to include("Crc32c: #{uploaded_file.crc32c}")
-    expect(output).to include("md5_hash: #{uploaded_file.md5}")
-    expect(output).to include(
-      "Cache-control: Cache-Control:public, max-age=3600"
-    )
-    expect(output).to include("Content-type: text/plain")
-    expect(output).to include(
-      "Content-disposition: attachment; filename=my-file.txt"
-    )
-    expect(output).to include("Content-encoding:")
-    expect(output).to include("Content-language: en")
-    expect(output).to include("Metadata:\n - foo = bar")
-  end
-
-  it "delete file" do
-    upload_file
-
-    expect(@bucket.file "my-file.txt").not_to be nil
-
-    expect { delete_file }.to output("Deleted my-file.txt\n").to_stdout
-
-    expect(@bucket.file "my-file.txt").to be nil
-  end
-
-  it "delete bucket"
-  # it "delete bucket" do
-  #   # Google Cloud Storage bucket IDs are unique
-  #   #
-  #   # To prevent deleting the bucket that is used for testing,
-  #   # this test simply verifies that the correct `#delete_bucket`
-  #   # method is called by the sample
-  #   expect(@bucket).to receive(:delete)
-
-  #   expect { delete_bucket }.to output("Deleted bucket: #{@bucket.name}\n").
-  #                               to_stdout
-  # end
 end