bfs-gs 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 637ee81c056b08e88dea4194468a7cf88c749a93d5c74a76d53a2ebd33bbd538
+  data.tar.gz: 45de2c2033328feb46e7695a0a79a979bf7f6fdfa2332691098db1b9832329e9
+SHA512:
+  metadata.gz: 5a38e3c19acceba3f87c7db63414b67db0c249a977a2045d0a214467b756a8ebb4f5e9d12247868f81b8e3afb9564bb1db848f434ad9ab7478a722adc0e64529
+  data.tar.gz: e35c73ffcae6f8975aa1fb56df86b85e3a47550be62536981f38c70b3bfcf74648c95a548fb45f5a790325ba481265c4d64656c6b3b6ef601dd768081b5c7fa6

data/bfs-gs.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'bfs-gs'
+  s.version     = File.read(File.expand_path('../.version', __dir__)).strip
+  s.platform    = Gem::Platform::RUBY
+
+  s.licenses    = ['Apache-2.0']
+  s.summary     = 'GS bucket adapter for bfs'
+  s.description = 'https://github.com/bsm/bfs.rb'
+
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = 'dimitrij@blacksquaremedia.com'
+  s.homepage    = 'https://github.com/bsm/bfs.rb'
+
+  s.executables   = []
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.2.0'
+
+  s.add_dependency 'bfs', s.version
+  s.add_dependency 'google-cloud-storage'
+end

data/lib/bfs/bucket/gs.rb

@@ -0,0 +1,113 @@
+require 'bfs'
+require 'google/cloud/storage'
+require 'cgi'
+
+module BFS
+  module Bucket
+    # GS buckets are operating on Google Cloud Storage
+    class GS < Abstract
+      attr_reader :name
+
+      # Initializes a new GoogleCloudStorage bucket.
+      #
+      # @param [String] name the bucket name.
+      # @param [Hash] opts options.
+      # @option opts [String] :project_id project ID. Defaults to GCP_PROJECT  env var. Required.
+      # @option opts [String, Hash, Google::Auth::Credentials] :credentials
+      #   the path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
+      # @option opts [Integer] :retries number of times to retry requests. Default: 3.
+      # @option opts [Integer] :timeout request timeout, in seconds.
+      # @option opts [String] :acl set the default ACL.
+      # @option opts [Google::Cloud::Storage] :client custom client.
+      def initialize(name, opts={})
+        opts = opts.dup
+        opts.keys.each do |key|
+          val = opts.delete(key)
+          opts[key.to_sym] = val unless val.nil?
+        end
+        opts[:project_id] ||= ENV['GCP_PROJECT'] || ENV['GCLOUD_PROJECT']
+
+        acl    = opts.delete(:acl)
+        client = opts.delete(:client) || Google::Cloud::Storage.new(opts)
+
+        @name   = name.to_s
+        @bucket = client.bucket(@name)
+        @bucket.default_acl.send(:"#{acl}!") if @bucket.default_acl.respond_to?(:"#{acl}!")
+      end
+
+      # Lists the contents of a bucket using a glob pattern
+      def ls(pattern='**/*', opts={})
+        Enumerator.new do |y|
+          @bucket.files(opts).each do |file|
+            y << file.name if File.fnmatch?(pattern, file.name, File::FNM_PATHNAME)
+          end
+        end
+      end
+
+      # Info returns the object info
+      def info(path, _opts={})
+        path = norm_path(path)
+        file = @bucket.file(path)
+        raise BFS::FileNotFound, path unless file
+
+        BFS::FileInfo.new(path, file.size, file.updated_at)
+      end
+
+      # Creates a new file and opens it for writing
+      def create(path, opts={}, &block)
+        path = norm_path(path)
+        temp = BFS::TempWriter.new(path) do |t|
+          File.open(t, binmode: true) do |file|
+            @bucket.create_file(file, path, opts)
+          end
+        end
+        return temp unless block
+
+        begin
+          yield temp
+        ensure
+          temp.close
+        end
+      end
+
+      # Opens an existing file for reading
+      def open(path, opts={}, &block)
+        path = norm_path(path)
+        file = @bucket.file(path)
+        raise BFS::FileNotFound, path unless file
+
+        temp = Tempfile.new(File.basename(path), binmode: true)
+        temp.close
+        file.download temp.path, opts
+
+        File.open(temp.path, binmode: true, &block)
+      end
+
+      # Deletes a file.
+      def rm(path, opts={})
+        path = norm_path(path)
+        file = @bucket.file(path)
+        file.delete(opts) if file
+      end
+
+      # Copies a file.
+      def cp(src, dst, opts={})
+        src  = norm_path(src)
+        file = @bucket.file(src)
+        raise BFS::FileNotFound, src unless file
+
+        file.copy(norm_path(dst), opts)
+      end
+    end
+  end
+end
+
+BFS.register('gs') do |url|
+  params = CGI.parse(url.query.to_s)
+
+  BFS::Bucket::GS.new url.host,
+    project_id: params.key?('project_id') ? params['project_id'].first : nil,
+    acl: params.key?('acl') ? params['acl'].first : nil,
+    timeout: params.key?('timeout') ? params['timeout'].first.to_i : nil,
+    retries: params.key?('retries') ? params['retries'].first.to_i : nil
+end

data/lib/bfs/gs.rb

@@ -0,0 +1 @@
+require 'bfs/bucket/gs'

data/spec/bfs/bucket/gs_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::GS do
+  let(:contents)    { {} }
+  let(:mock_client) { double Google::Cloud::Storage, bucket: mock_bucket }
+
+  let :mock_bucket do
+    bucket = double Google::Cloud::Storage::Bucket,
+      default_acl: double(Google::Cloud::Storage::Bucket::Acl)
+    allow(bucket).to receive(:create_file) do |io, name, _|
+      contents[name] = double_file(name, io.read)
+    end
+    allow(bucket).to receive(:files) do |_|
+      contents.values
+    end
+    allow(bucket).to receive(:file) do |name|
+      contents[name]
+    end
+    bucket
+  end
+
+  def double_file(name, data)
+    file = double Google::Cloud::Storage::File,
+      name: name,
+      data: data,
+      size: data.bytesize,
+      updated_at: Time.now
+    allow(file).to receive(:download) do |path, _|
+      File.open(path, 'wb') {|f| f.write file.data }
+    end
+    allow(file).to receive(:delete) do |_|
+      contents.delete(file.name)
+      true
+    end
+    allow(file).to receive(:copy) do |dst, _|
+      contents[dst] = double_file(dst, file.data)
+    end
+    file
+  end
+
+  subject { described_class.new 'mock-bucket', client: mock_client }
+  it_behaves_like 'a bucket'
+
+  it 'should resolve from URL' do
+    expect(Google::Cloud::Storage).to receive(:new).with(project_id: 'my-project').and_return(mock_client)
+    expect(mock_client).to receive(:bucket).with('mock-bucket').and_return(mock_bucket)
+    expect(mock_bucket.default_acl).to receive(:private!).with(no_args)
+
+    bucket = BFS.resolve('gs://mock-bucket?acl=private&project_id=my-project')
+    expect(bucket).to be_instance_of(described_class)
+    expect(bucket.name).to eq('mock-bucket')
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: bfs-gs
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bfs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: https://github.com/bsm/bfs.rb
+email: dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bfs-gs.gemspec
+- lib/bfs/bucket/gs.rb
+- lib/bfs/gs.rb
+- spec/bfs/bucket/gs_spec.rb
+homepage: https://github.com/bsm/bfs.rb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: GS bucket adapter for bfs
+test_files:
+- spec/bfs/bucket/gs_spec.rb