open-gcs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5bd0665602d92ae4d880849bd975fe1451e661d1480dee9a1c2f57f4f8f5e13
+  data.tar.gz: 7276cb5c8e8cd9189630be034983df5782f1843d173bddae2c3f0c74a022c4d3
+SHA512:
+  metadata.gz: 52f8f17a7ad1313e812032714ce65f1c529eace8699e7afa6c756462b65e2f2d61d9cb59c1384f9dd3ec7ea4502088e996b6f5e9794550d92406ac47e540c9db
+  data.tar.gz: c6c7892f033ba01adff2fded91d3acc4a256ce10df8fd976d85e9e6a7550fdb5fdc4980e5d0efb214f544d982484c76f7146c322899ff3f9d147366fcc14ff96

data/.github/workflows/ruby-ci.yaml

@@ -0,0 +1,27 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0', '2.7', '2.6', '2.5']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open-gcs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tomohiro Ogoke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# OpenGCS
+
+OpenGCS is a wrapper to open files from Google Cloud Storage (GCS), inspired by [OpenURI](https://github.com/ruby/open-uri).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open-gcs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open-gcs
+
+## Usage
+
+### Basic Usage
+
+```ruby
+OpenGCS.open_gcs('gs://your-bucket/your-file') { |file|
+  file.each_line { |line| puts line }
+}
+```
+
+### Wrapping to `File::Open`
+
+```ruby
+class YourClass
+  using OpenGCSExt
+
+  File::Open('gs://your-bucket/your-file') { |file|
+    file.each_line { |line| puts line }
+  }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomog105/open-gcs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "open-gcs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/open-gcs/ext.rb

@@ -0,0 +1,13 @@
+require "open-gcs"
+
+module OpenGCSExt
+  refine File.singleton_class do
+    def open(uri, *rest, **options, &block)
+      if OpenGCS.get_path_info(uri).first == OpenGCS::TARGET_SCHEME
+        OpenGCS.open_gcs(uri, *rest, **options, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/open-gcs/file.rb

@@ -0,0 +1,33 @@
+require "google/cloud/storage"
+require "tempfile"
+
+module OpenGCS
+  module File
+    STORAGE_OPTION_KEYS = %i(
+      project_id
+      credentials
+      scope
+      retries
+      timeout
+      endpoint
+      project
+      keyfile
+    )
+    DOWNLOAD_OPTION_KEYS = %i(
+      verify
+      encryption_key
+      range
+      skip_decompress
+    )
+    OPTION_KEYS = STORAGE_OPTION_KEYS + DOWNLOAD_OPTION_KEYS
+
+    def self.download(bucket, filename, **options)
+      storage = Google::Cloud::Storage.new(**options.select { |o, v| v && STORAGE_OPTION_KEYS.include?(o) })
+      file = storage.bucket(bucket, skip_lookup: true).file(filename, skip_lookup: true)
+
+      tf = Tempfile.open(["open-gcs"])
+      file.download(tf.path, **options.select { |o, v| v && DOWNLOAD_OPTION_KEYS.include?(o) })
+      tf
+    end
+  end
+end

data/lib/open-gcs/version.rb

@@ -0,0 +1,3 @@
+module OpenGCS
+  VERSION = "0.1.0"
+end

data/lib/open-gcs.rb

@@ -0,0 +1,49 @@
+require "uri"
+require "open-gcs/file"
+require "open-gcs/version"
+
+module OpenGCS
+  TARGET_SCHEME = "gs"
+
+  def self.open_gcs(uri, *rest, **options, &block)
+    scheme, bucket, path = get_path_info(uri)
+
+    unless scheme == TARGET_SCHEME
+      raise(ArgumentError, "Invalid uri: #{uri} (This method is only support for gcs object uri.")
+    end
+
+    if String === rest.first || Integer === rest.first
+      mode = rest.first
+    else
+      mode = options[:mode]
+    end
+    if !mode.nil? && !mode.match?(/\Ar[bt]?(?:\Z|:([^:]+))/) && mode != ::File::RDONLY
+      raise(ArgumentError, "Invalid access mode: #{mode}. (This method is only support for read mode.)")
+    end
+
+    begin
+      tf = File.download(bucket, path, **options.select { |key| File::OPTION_KEYS.include?(key) })
+      file = ::File.open(tf.path, *rest, **options.reject { |key| File::OPTION_KEYS.include?(key) })
+      if block_given?
+        begin
+          yield file
+        ensure
+          tf.close!
+        end
+      else
+        file
+      end
+    ensure
+      tf&.close if tf&.path
+    end
+  end
+
+  def self.get_path_info(uri)
+    unless String === uri
+      []
+    else
+      parsed_uri = URI.parse(uri)
+      [*parsed_uri.select(:scheme, :host), parsed_uri&.path.delete_prefix("/")]
+    end
+  end
+end

data/open-gcs.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open-gcs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open-gcs"
+  spec.version       = OpenGCS::VERSION
+  spec.authors       = ["tomog105"]
+  spec.email         = ["knowide@gmail.com"]
+
+  spec.summary       = %q{GCS file open wrapper.}
+  spec.description   = %q{GCS file open wrapper.}
+  spec.homepage      = "https://github.com/tomog105/open-gcs"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency "google-cloud-storage", "~> 1.9"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit", '~> 3.2', ">= 3.2.7"
+  spec.add_development_dependency "test-unit-rr"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: open-gcs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tomog105
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GCS file open wrapper.
+email:
+- knowide@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby-ci.yaml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open-gcs.rb
+- lib/open-gcs/ext.rb
+- lib/open-gcs/file.rb
+- lib/open-gcs/version.rb
+- open-gcs.gemspec
+homepage: https://github.com/tomog105/open-gcs
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: GCS file open wrapper.
+test_files: []