shrine-google_cloud_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 900ee63b1a59397ff36fe30add0c7efbca93e07f
+  data.tar.gz: 8fcf629cbd6f125ad18c30c5d135f4b39d20c771
+SHA512:
+  metadata.gz: d8e8f6e0b56adf09b010edfcaedac63769a9e6c5d3d096e7e78cfd6f71faee1e1774604e847d7360f29b365b80ac41d8d20f55cd0ec464adc1e4b8c31261dad9
+  data.tar.gz: 58f5b6adabf36e897ab6f475aa589744ff4aaf5031d961296a2407d17c41770220bb9ef2a0e65f79f98db9ffc04c40a4be9e011ddd8ef4426fec3439561355b7

data/README.md

@@ -0,0 +1,63 @@
+# Shrine::Storage::GoogleCloudStorage
+
+Provides [Google Cloud Storage] (GCS) storage for [Shrine].
+
+## Installation
+
+```ruby
+gem "shrine-google_cloud_storage"
+```
+
+## Authentication
+
+The GCS plugin uses Google's [Application Default Credentials]. Please check
+documentation for the various ways to provide credentials.
+
+## Usage
+
+```rb
+require "shrine/storage/gcs"
+
+Shrine.storages = {
+  cache: Shrine::Storage::GoogleCloudStorage.new(bucket: "cache"),
+  store: Shrine::Storage::GoogleCloudStorage.new(bucket: "store"),
+}
+```
+
+You can set a predefined ACL on created objects, as well as custom headers using the `object_options` parameter:
+
+```rb
+Shrine::Storage::GoogleCloudStorage.new(
+  bucket: "store",
+  default_acl: 'publicRead',
+  object_options: {
+    cache_control: 'public, max-age: 7200'
+  },
+)
+```
+
+
+## Contributing
+
+Firstly you need to create an `.env` file with a dedicated GCS bucket:
+
+```sh
+# .env
+GCS_BUCKET="..."
+```
+
+Warning: all content of the bucket is cleared between tests, create a new one only for this usage!
+
+Afterwards you can run the tests:
+
+```sh
+$ bundle exec rake test
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+[Google Cloud Storage]: https://cloud.google.com/storage/
+[Shrine]: https://github.com/janko-m/shrine
+[Application Default Credentials]: https://developers.google.com/identity/protocols/application-default-credentials

data/lib/shrine/storage/google_cloud_storage.rb

@@ -0,0 +1,175 @@
+require "shrine"
+require "googleauth"
+require "google/apis/storage_v1"
+
+class Shrine
+  module Storage
+    class GoogleCloudStorage
+      attr_reader :bucket, :prefix, :host
+
+      def initialize(bucket:, prefix: nil, host: nil, default_acl: nil, object_options: {})
+        @bucket = bucket
+        @prefix = prefix
+        @host = host
+        @default_acl = default_acl
+        @object_options = object_options
+      end
+
+      def upload(io, id, shrine_metadata: {}, **_options)
+        # uploads `io` to the location `id`
+
+        object = Google::Apis::StorageV1::Object.new @object_options.merge(bucket: @bucket, name: object_name(id))
+
+        if copyable?(io)
+          storage_api.copy_object(
+            io.storage.bucket,
+            io.storage.object_name(io.id),
+            @bucket,
+            object_name(id),
+            object,
+            destination_predefined_acl: @default_acl,
+          )
+        else
+          storage_api.insert_object(
+            @bucket,
+            object,
+            content_type: shrine_metadata["mime_type"],
+            upload_source: io.to_io,
+            options: { uploadType: 'multipart' },
+            predefined_acl: @default_acl,
+          )
+        end
+      end
+
+      def url(id, **_options)
+        # URL to the remote file, accepts options for customizing the URL
+        host = @host || "storage.googleapis.com/#{@bucket}"
+
+        "https://#{host}/#{object_name(id)}"
+      end
+
+      def download(id)
+        tempfile = Tempfile.new(["googlestorage", File.extname(id)], binmode: true)
+        storage_api.get_object(@bucket, object_name(id), download_dest: tempfile)
+        tempfile.tap(&:open)
+      end
+
+      def open(id)
+        # returns the remote file as an IO-like object
+        io = storage_api.get_object(@bucket, object_name(id), download_dest: StringIO.new)
+        io.rewind
+        io
+      end
+
+      def exists?(id)
+        # checks if the file exists on the storage
+        storage_api.get_object(@bucket, object_name(id)) do |_, err|
+          if err
+            if err.status_code == 404
+              false
+            else
+              raise err
+            end
+          else
+            true
+          end
+        end
+      end
+
+      def delete(id)
+        # deletes the file from the storage
+        storage_api.delete_object(@bucket, object_name(id))
+
+      rescue Google::Apis::ClientError => e
+        # The object does not exist, Shrine expects us to be ok
+        return true if e.status_code == 404
+
+        raise e
+      end
+
+      def multi_delete(ids)
+        batch_delete(ids.map { |i| object_name(i) })
+      end
+
+      def clear!
+        ids = []
+
+        storage_api.fetch_all do |token, s|
+          prefix = "#{@prefix}/" if @prefix
+          s.list_objects(
+            @bucket,
+            prefix: prefix,
+            fields: "items/name",
+            page_token: token,
+          )
+        end.each do |object|
+          ids << object.name
+
+          if ids.size >= 100
+            # Batches are limited to 100, so we execute it and reset the ids
+            batch_delete(ids)
+            ids = []
+          end
+        end
+
+        # We delete the remaining ones
+        batch_delete(ids) unless ids.empty?
+      end
+
+      def presign(id, **options)
+        method = options[:method] || "GET"
+        content_md5 = options[:content_md5] || ""
+        content_type = options[:content_type] || ""
+        expires = (Time.now.utc + (options[:expires] || 300)).to_i
+        headers = nil
+        path = "/#{@bucket}/" + object_name(id)
+
+        to_sign = [method, content_md5, content_type, expires, headers, path].compact.join("\n")
+
+        signing_key = options[:signing_key]
+        signing_key = OpenSSL::PKey::RSA.new(signing_key) unless signing_key.respond_to?(:sign)
+        signature = Base64.strict_encode64(signing_key.sign(OpenSSL::Digest::SHA256.new, to_sign)).delete("\n")
+
+        signed_url = "https://storage.googleapis.com#{path}?GoogleAccessId=#{options[:issuer]}" \
+          "&Expires=#{expires}&Signature=#{CGI.escape(signature)}"
+
+        OpenStruct.new(
+          url: signed_url,
+          fields: {},
+        )
+      end
+
+      def object_name(id)
+        @prefix ? "#{@prefix}/#{id}" : id
+      end
+
+      private
+
+      def copyable?(io)
+        io.is_a?(UploadedFile) &&
+          io.storage.is_a?(Storage::GoogleCloudStorage)
+        # TODO: add a check for the credentials
+      end
+
+      def batch_delete(object_names)
+        storage_api.batch do |storage|
+          object_names.each do |name|
+            storage.delete_object(@bucket, name)
+          end
+        end
+      end
+
+      def storage_api
+        if !@storage_api || @storage_api.authorization.expired?
+          service = Google::Apis::StorageV1::StorageService.new
+          scopes = ['https://www.googleapis.com/auth/devstorage.read_write']
+          authorization = Google::Auth.get_application_default(scopes)
+          authorization.fetch_access_token!
+          service.authorization = authorization
+          @storage_api = service
+        end
+        @storage_api
+      end
+    end
+  end
+end

data/shrine-google_cloud_storage.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |gem|
+  gem.name          = "shrine-google_cloud_storage"
+  gem.version       = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides Google Cloud Storage storage for Shrine."
+  gem.homepage     = "https://github.com/renchap/shrine-google_cloud_storage"
+  gem.authors      = ["Renaud Chaput"]
+  gem.email        = ["renchap@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-google_cloud_storage.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_dependency "shrine", "~> 2.0"
+  gem.add_dependency "google-api-client", "~> 0.11.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: shrine-google_cloud_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renaud Chaput
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.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: minitest
+  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: dotenv
+  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: 
+email:
+- renchap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shrine/storage/google_cloud_storage.rb
+- shrine-google_cloud_storage.gemspec
+homepage: https://github.com/renchap/shrine-google_cloud_storage
+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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Provides Google Cloud Storage storage for Shrine.
+test_files: []