asset_cloud 2.2.6 → 2.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8da870cd7f0377f18b1ae46d7a4e8e69c2e4549f224e28df123f565d9e454d3
-  data.tar.gz: 190fea72f1ef76ffa7aad5931324be4cfc172903f41826a1485c2e859fae50dc
+  metadata.gz: d356abcae5568be4981cdcbb779ba94471a67f942f048ee96119e9b9260cf366
+  data.tar.gz: 3923b527fe0e5c7e670641f53c6397723465a02877431b50e8e7da20bc67ee74
 SHA512:
-  metadata.gz: fb1dff12c4fb90328182f23c96daf17f3f9fddbc13c42dd569b0855545c4be0621aa8bd218c43fc57eb44716f27026e1ca703fea67cd214231ee654853decca6
-  data.tar.gz: e29ebc045b6eeac9705f5f758aca3fce768c6e9f8085ecc0502cbdecf1037621b504ab0c3c175f61e8faa912d16d5abef16f79c90941c02bbce865e8cc50cae1
+  metadata.gz: e8f3a5c2252c2cd574fc55e4feb4aa205a3340e8a43cb945414740be9f6313d422ecc241a8cb8279e48f7b32b6695817576f95779107dd072543c0024d69b33f
+  data.tar.gz: 480ada19cbcddae3f9acc2fc46d1022d82b3ba7582534b91aa9f0fe6dc0bbae9efa70f09f5fafd64b95be3e39601ec2b88d2d3bb34b10fe0fe8b7c540f5d0603

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 before_install:
   - gem install bundler
 rvm:
-  - '2.2'
   - '2.3'
+  - '2.6'

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'aws-sdk', '~> 1.34.0', :require => nil
+gem 'google-cloud-storage'
 
 gemspec

data/README.rdoc

@@ -18,6 +18,10 @@ With S3 Remote test:
 
     AWS_ACCESS_KEY_ID="<s3_key>" AWS_SECRET_ACCESS_KEY="<s3_secret_key>" S3_BUCKET_NAME="<bucket_name>" bundle exec rake spec
 
+With GCS Remote test:
+
+    GCS_PROJECT_ID="<project_id>" GCS_KEY_FILEPATH="<path_to_key>" GCS_BUCKET="<bucket_name>" bundle exec rake spec
+
 == Copyright
 
 Copyright (c) 2008-2014 Tobias Lütke & Shopify, Inc. Released under the MIT license (see LICENSE for details).

data/asset_cloud.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{asset_cloud}
-  s.version = "2.2.6"
+  s.version = "2.2.7"
 
   s.authors = %w(Shopify)
   s.summary = %q{An abstraction layer around arbitrary and diverse asset stores.}

data/lib/asset_cloud.rb

@@ -16,6 +16,9 @@ require 'asset_cloud/base'
 # S3
 require 'asset_cloud/buckets/s3_bucket'
 
+# GCS
+require 'asset_cloud/buckets/gcs_bucket'
+
 # Extensions
 require 'asset_cloud/free_key_locator'
 require 'asset_cloud/callbacks'

data/lib/asset_cloud/buckets/gcs_bucket.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module AssetCloud
+  class GCSBucket < Bucket
+    def ls(key = nil)
+      key ? find_by_key!(key) : bucket.files
+    end
+
+    def read(key)
+      file = find_by_key!(key)
+      downloaded = file.download
+      downloaded.rewind
+      downloaded.read
+    end
+
+    def write(key, data)
+      bucket.create_file(data, absolute_key(key))
+    end
+
+    def delete(key)
+      file = find_by_key!(key)
+      file.delete
+    end
+
+    def clear
+      bucket.files.each(&:delete)
+    end
+
+    def stat(key)
+      begin
+        file = find_by_key!(key)
+        Metadata.new(true, file.size, file.created_at, file.updated_at)
+      rescue AssetCloud::AssetNotFoundError
+        Metadata.new(false)
+      end
+    end
+
+    private
+
+    def bucket
+      @bucket ||= cloud.gcs_bucket
+    end
+
+    def absolute_key(key = nil)
+      if key.to_s.starts_with?(path_prefix)
+        return key
+      else
+        args = [path_prefix]
+        args << key.to_s if key
+        args.join('/')
+      end
+    end
+
+    def path_prefix
+      @path_prefix ||= "s#{@cloud.url}"
+    end
+
+    def find_by_key!(key)
+      file = bucket.file(absolute_key(key))
+
+      raise AssetCloud::AssetNotFoundError, key unless file
+
+      file
+    end
+  end
+end

data/spec/gcs_bucket_remote_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+# rubocop:disable RSpec/FilePath, Lint/MissingCopEnableDirective
+
+require 'spec_helper'
+require 'google/cloud/storage'
+
+class RemoteGCSCloud < AssetCloud::Base
+  attr_accessor :gcs_connection
+  bucket :tmp, AssetCloud::GCSBucket
+
+  def gcs_bucket
+    gcs_connection.bucket(ENV['GCS_BUCKET'])
+  end
+end
+
+describe AssetCloud::GCSBucket, if: ENV['GCS_PROJECT_ID'] && ENV['GCS_KEY_FILEPATH'] && ENV['GCS_BUCKET'] do
+  directory = File.dirname(__FILE__) + '/files'
+
+  before(:all) do
+    @cloud = RemoteGCSCloud.new(directory, 'assets/files')
+
+    @cloud.gcs_connection = Google::Cloud::Storage.new(
+        project_id: ENV['GCS_PROJECT_ID'],
+        credentials: ENV['GCS_KEY_FILEPATH']
+      )
+    @bucket = @cloud.buckets[:tmp]
+  end
+
+  after(:all) do
+    @bucket.clear
+  end
+
+  it "#ls with no arguments returns all files in the bucket" do
+    expect_any_instance_of(Google::Cloud::Storage::Bucket).to receive(:files).with(no_args)
+    expect do
+      @bucket.ls
+    end.not_to raise_error
+  end
+
+  it "#ls with arguments returns the file" do
+    local_path = "#{directory}/products/key.txt"
+    key = 'test/ls.txt'
+
+    @bucket.write(key, local_path)
+
+    file = @bucket.ls(key)
+    expect(file.name).to eq("s#{@cloud.url}/#{key}")
+  end
+
+  it "#write writes a file into the bucket" do
+    local_path = "#{directory}/products/key.txt"
+    key = 'test/key.txt'
+
+    @bucket.write(key, local_path)
+  end
+
+  it "#delete removes the file from the bucket" do
+    key = 'test/key.txt'
+
+    expect do
+      @bucket.delete(key)
+    end.not_to raise_error
+  end
+
+  it "#delete raises AssetCloud::AssetNotFoundError if the file is not found" do
+    key = 'tmp/not_found.txt'
+    expect do
+      @bucket.delete(key)
+    end.to raise_error(AssetCloud::AssetNotFoundError)
+  end
+
+  it "#read returns the data of the file" do
+    value = 'hello world'
+    key = 'tmp/new_file.txt'
+    @bucket.write(key, StringIO.new(value))
+
+    data = @bucket.read(key)
+    data.should == value
+  end
+
+  it "#read raises AssetCloud::AssetNotFoundError if the file is not found" do
+    key = 'tmp/not_found.txt'
+    expect do
+      @bucket.read(key)
+    end.to raise_error(AssetCloud::AssetNotFoundError)
+  end
+
+  it "#stats returns metadata of the asset" do
+    value = 'hello world'
+    key = 'tmp/new_file.txt'
+    @bucket.write(key, StringIO.new(value))
+
+    stats = @bucket.stat(key)
+
+    expect(stats.size).not_to be_nil
+    expect(stats.created_at).not_to be_nil
+    expect(stats.updated_at).not_to be_nil
+  end
+end

data/spec/gcs_bucket_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'google/cloud/storage'
+
+class GCSCloud < AssetCloud::Base
+end
+
+class MockGCSBucket < AssetCloud::GCSBucket
+  def files(prefix: nil)
+  end
+
+  def file(key)
+  end
+
+  def create_file(data, key)
+  end
+end
+
+describe AssetCloud::GCSBucket do
+  directory = File.dirname(__FILE__) + '/files'
+
+  before(:all) do
+    @cloud = GCSCloud.new(directory, '/assets/files')
+    @bucket = MockGCSBucket.new(@cloud, '')
+  end
+
+  it "#ls with no arguments returns all files in the bucket" do
+    expect_any_instance_of(GCSCloud).to receive(:gcs_bucket).and_return(@bucket)
+    expect_any_instance_of(MockGCSBucket).to receive(:files).with(no_args).and_return(nil)
+    @bucket.ls
+  end
+
+  it "#ls with arguments returns the file" do
+    key = 'test/ls.txt'
+    expect_any_instance_of(MockGCSBucket).to receive(:file).with("s#{@cloud.url}/#{key}").and_return(Google::Cloud::Storage::File.new)
+
+    file = @bucket.ls(key)
+    expect(file.class).to eq(Google::Cloud::Storage::File)
+  end
+
+  it "#write writes a file into the bucket" do
+    local_path = "#{directory}/products/key.txt"
+    key = 'test/key.txt'
+    expect_any_instance_of(MockGCSBucket).to receive(:create_file).with(local_path, "s#{@cloud.url}/#{key}")
+
+    @bucket.write(key, local_path)
+  end
+
+  it "#delete removes the file from the bucket" do
+    key = 'test/key.txt'
+    expect_any_instance_of(MockGCSBucket).to receive(:file).with("s#{@cloud.url}/#{key}").and_return(Google::Cloud::Storage::File.new)
+    expect_any_instance_of(Google::Cloud::Storage::File).to receive(:delete).with(no_args)
+
+    expect do
+      @bucket.delete(key)
+    end.not_to raise_error
+  end
+
+  it "#read returns the data of the file" do
+    value = 'hello world'
+    key = 'tmp/new_file.txt'
+    expect_any_instance_of(MockGCSBucket).to receive(:file).with("s#{@cloud.url}/#{key}").and_return(Google::Cloud::Storage::File.new)
+    expect_any_instance_of(Google::Cloud::Storage::File).to receive(:download).and_return(StringIO.new(value))
+
+    data = @bucket.read(key)
+    data.should == value
+  end
+
+  it "#read raises AssetCloud::AssetNotFoundError if the file is not found" do
+    key = 'tmp/not_found.txt'
+    expect_any_instance_of(MockGCSBucket).to receive(:file).with("s#{@cloud.url}/#{key}").and_return(nil)
+    expect do
+      @bucket.read(key)
+    end.to raise_error(AssetCloud::AssetNotFoundError)
+  end
+
+  it "#stat returns information on the asset" do
+    value = 'hello world'
+    key = 'tmp/new_file.txt'
+    expected_time = Time.now
+    expected_size = 1
+
+    expect_any_instance_of(MockGCSBucket).to receive(:file).with("s#{@cloud.url}/#{key}").and_return(Google::Cloud::Storage::File.new)
+    expect_any_instance_of(Google::Cloud::Storage::File).to receive(:size).and_return(expected_size)
+    expect_any_instance_of(Google::Cloud::Storage::File).to receive(:created_at).and_return(expected_time)
+    expect_any_instance_of(Google::Cloud::Storage::File).to receive(:updated_at).and_return(expected_time)
+
+    stats = @bucket.stat(key)
+    expect(stats.size).to eq(expected_size)
+    expect(stats.created_at).to eq(expected_time)
+    expect(stats.updated_at).to eq(expected_time)
+  end
+end

data/spec/spec_helper.rb

@@ -5,3 +5,4 @@ require 'active_support/all'
 $:<< File.dirname(__FILE__) + "/../lib"
 require 'asset_cloud'
 require 'asset_cloud/buckets/s3_bucket'
+require 'asset_cloud/buckets/gcs_bucket'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asset_cloud
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.2.7
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,7 @@ files:
 - lib/asset_cloud/buckets/blackhole_bucket.rb
 - lib/asset_cloud/buckets/bucket_chain.rb
 - lib/asset_cloud/buckets/file_system_bucket.rb
+- lib/asset_cloud/buckets/gcs_bucket.rb
 - lib/asset_cloud/buckets/invalid_bucket.rb
 - lib/asset_cloud/buckets/memory_bucket.rb
 - lib/asset_cloud/buckets/s3_bucket.rb
@@ -140,6 +141,8 @@ files:
 - spec/files/products/key.txt
 - spec/files/versioned_stuff/foo
 - spec/find_free_key_spec.rb
+- spec/gcs_bucket_remote_spec.rb
+- spec/gcs_bucket_spec.rb
 - spec/memory_bucket_spec.rb
 - spec/mock_s3_interface.rb
 - spec/remote_s3_bucket_spec.rb
@@ -165,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An abstraction layer around arbitrary and diverse asset stores.
@@ -183,6 +185,8 @@ test_files:
 - spec/files/products/key.txt
 - spec/files/versioned_stuff/foo
 - spec/find_free_key_spec.rb
+- spec/gcs_bucket_remote_spec.rb
+- spec/gcs_bucket_spec.rb
 - spec/memory_bucket_spec.rb
 - spec/mock_s3_interface.rb
 - spec/remote_s3_bucket_spec.rb