shrine-gdrive_storage 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b50c4075747d9d678d02aa8229881451080bb97f4284cb5f0359d8cf1784f24
+  data.tar.gz: c5a5f67ea5caf04e2956d7a34a4c68beea5702eefa285162d7ac8d7b2f9bec57
+SHA512:
+  metadata.gz: 92be70dfbdab6ed3d5fde41222318eef3283385d60744da6bad375e6acd66bf365290a25fe59404943b01782eb4f298da6a7dd49b324681616be78356fc4be0d
+  data.tar.gz: 3b62fb0f1d8491c3e7c588c6fff1d51b4edc7579d12e55729e22319983a8a9c92452d43568f04ea41b07d78bd5e855ea966bf9b9d340d0b2886e45e97bfc67f2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Scott Near
+
+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,120 @@
+# Shrine::Storage::GoogleDriveStorage
+
+Provides [Google Drive Storage] for [Shrine].
+
+shout-outz to:  
+https://github.com/verynear/shrine-google_drive_storage &&  
+https://github.com/renchap/shrine-google_cloud_storage
+
+_note:_
+This gem uses a Google API "Service Account" to upload files to Google Drive (or a particular Drive folder). You might want to dig into [shrine-google_drive_storage](https://github.com/verynear/shrine-google_drive_storage) if you want to upload to your user's various Google Drives via oAuth. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shrine-gdrive_storage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shrine-gdrive_storage
+
+## Google Drive Setup
+
+In order to use this storage you need a Google (or Google Apps) user which will own the files, and a Google API `client_secrets.json` file.
+
+1. Go to the [Google Developers console](https://console.developers.google.com/project) and create a new project, this option is on the top, next to the Google APIs logo.
+
+2. Go to "API Manager > Library" in the section "Google Apps APIs" and enable "Drive API". 
+
+3. Go to "API Manager > Credentials" and create a new "Service Account Key".
+
+4. Download the client_secret_XXXXX.json file and rename it to client_secret.json.
+
+5. Create a google drive folder in which the files will be uploaded. 
+
+_note:_ find the `drive_public_folder_id` by browsing to the folder via web at https://drive.google.com and get the id from the url, like such: `https://drive.google.com/drive/u/0/folders/AAAARRRRGGGBBBFFFFadsasdX`
+
+## Environment variables
+
+ (`cache: Shrine::Storage::GoogleDriveStorage.new(drive_public_folder_id: 'AAAARRRRGGGBBBFFFFadsasdX')`)  
+
+use the [dotenv](https://rubygems.org/gems/dotenv) gem and add `require 'dotenv/load` to easily load values from your .env file  
+
+Create an `.env` file with these values:
+
+```sh
+# .env
+APPLICATION_NAME = "yourapp-12345"
+GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/client_secret.json
+GOOGLE_PUBLIC_FOLDER_ID=AAAARRRRGGGBBBFFFFadsasdX
+```
+
+__-or-__ set the environment variables however you like.
+
+The application name in the above cases is the project name you chose in the [Google Developers console](https://console.developers.google.com/project)
+
+
+## Usage
+
+```rb
+require "dotenv/load" #optional, load environment variables from .env file
+require "shrine/storage/google_drive_storage"
+
+Shrine.storages = {
+  store: Shrine::Storage::GoogleDriveStorage.new,
+}
+```
+
+you can use this for cache storage, too.
+
+## Configuration
+
+set the `drive_public_folder_id` here (instead of via environment variable) if you'd like
+
+```rb
+Shrine::Storage::GoogleDriveStorage.new(
+  drive_public_folder_id: 'AAAARRRRGGGBBBFFFFadsasdX',
+)
+```
+
+## Helpful info
+
+If you are getting an "Access Not Configured" error while uploading files, this is due to this API not being enabled or, perhaps, your drive folder not having the correct permissions. 
+
+Try sharing your folder (`drive_public_folder_id`) with the google service account user (see https:// or client_secret.json) something like: yourapp@yourapp-12345.iam.gserviceaccount.com. You might want to make your folder public.
+
+or maybe use "Enable G Suite Domain-wide Delegation" via https://console.developers.google.com/iam-admin/serviceaccounts/project?project=yourapp-12345
+
+
+## Miscellaneous
+
+rtfm: http://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/DriveV3
+
+## Testing
+
+a quick way to make sure your client_secret.json is working: 
+
+    $ ruby test/gdrive_quickstart.rb
+
+and then run this against the nifty shrinerb linters:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/edwardsharp/shrine-gdrive_storage. 
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT).
+
+
+[Google Drive Storage]: https://drive.google.com/drive/
+[Shrine]: https://github.com/janko-m/shrine

data/lib/shrine/storage/google_drive_storage.rb

@@ -0,0 +1,86 @@
+require 'shrine'
+require 'google/apis/drive_v3'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'down/chunked_io'
+require 'fileutils'
+
+class Shrine
+  module Storage
+    class GoogleDriveStorage
+      
+      def initialize(drive_public_folder_id: nil, google_drive_options: {})
+        @drive_public_folder_id = drive_public_folder_id || ENV["GOOGLE_PUBLIC_FOLDER_ID"]
+      end
+
+      def upload(io, id, shrine_metadata: {}, **_options)
+        mime_type = io.metadata['mime_type'] rescue 'image/jpeg'
+
+        s = StringIO.new
+        s.write(io.read)
+        s.rewind
+        google_api_client.create_file(
+          { name: id,
+            mime_type: mime_type,
+            parents: [@drive_public_folder_id]
+          },
+          fields: 'id, name',
+          upload_source: s,
+          content_type: shrine_metadata['mime_type']
+        )
+
+        message = "Uploaded file #{id}"
+      end
+
+      def exists?(id)
+        get_drive_file_id(id)
+      end
+
+      def open(id)
+        sio = StringIO.new
+        google_api_client.get_file(
+          get_drive_file_id(id),
+          download_dest: sio
+        )
+        sio.rewind
+        sio
+      end
+
+      def url(id, **_options)
+        begin
+          metadata = google_api_client.get_file(
+            get_drive_file_id(id),
+            fields: 'webViewLink'
+          )
+          metadata.web_view_link
+        rescue Exception => e
+          # p "URL ERR! #{e}"
+          #TODO: something meaningful?
+        end
+      end
+
+      def delete(id)
+        google_api_client.delete_file(get_drive_file_id(id)) rescue nil        
+      end
+
+      private
+
+      def get_drive_file_id(id)
+        google_api_client.list_files(q: "name contains '#{id}'").files[0].id rescue nil
+      end
+
+      def google_api_client
+        if !@google_api_client || @google_api_client.authorization.expired?
+          service = Google::Apis::DriveV3::DriveService.new
+          service.client_options.application_name = ENV['APPLICATION_NAME']
+          service.authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+            json_key_io: File.open(ENV['GOOGLE_APPLICATION_CREDENTIALS']),
+            scope: Google::Apis::DriveV3::AUTH_DRIVE)
+          @google_api_client = service
+        end
+        @google_api_client
+      end
+
+    end
+  end
+end

data/shrine-gdrive_storage.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |spec|
+  spec.name          = "shrine-gdrive_storage"
+  spec.version       = "0.5.0"
+  spec.authors       = ["edwardsharp"]
+  spec.email         = ["edward@edwardsharp.net"]
+  spec.date          = '2018-04-04'
+  spec.summary       = "Provides Google Drive Storage for Shrine."
+  spec.description   = "Provides Google Drive Storage for Shrine. Fork & improvemnet on Scott Near's version (https://github.com/verynear/shrine-google_drive_storage)."
+  spec.homepage      = "https://github.com/edwardsharp/shrine-gdrive_storage"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+
+  spec.files         = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-gdrive_storage.gemspec"]
+  
+  spec.require_paths = "lib"
+
+  spec.add_dependency 'shrine', '~> 2.1'
+  spec.add_dependency 'googleauth', '~> 0.5'
+  spec.add_dependency 'google-api-client', '~> 0.20.0'
+  spec.add_development_dependency 'httparty', '~> 0.16'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'dotenv'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: shrine-gdrive_storage
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- edwardsharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !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: Provides Google Drive Storage for Shrine. Fork & improvemnet on Scott
+  Near's version (https://github.com/verynear/shrine-google_drive_storage).
+email:
+- edward@edwardsharp.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/storage/google_drive_storage.rb
+- shrine-gdrive_storage.gemspec
+homepage: https://github.com/edwardsharp/shrine-gdrive_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Provides Google Drive Storage for Shrine.
+test_files: []