simple_gdrive 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2deb1b8f04443033e24dca718a8fda59d4a5121b5d5e1b48ac1cc7bf54c64bbf
+  data.tar.gz: edf2eb26eb05a6e6f150759a5e83fa8b6bf3a688f6d1fc4c96c7ba189b33e118
+SHA512:
+  metadata.gz: 927522cd800319aecbebbe3e22569a77faff86512e0d5720265cd8e584a9846a4d3432750951ed2023a90e31dd3617131674b32c425f38e3d7b5de2395fc0b9a
+  data.tar.gz: 69c8528403cbc6c836840c2bcd7982e9c031a5a58e1834246f19be38349a6d125fda8f0d191258cb01bd0346b2ce426586f2b414f126d72a11db0917149cd17b

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
+.idea
+Gemfile.lock
+spec/fixtures/client_secrets.json
+test
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.3
+before_install: gem install bundler
+before_script:
+  - bundle install
+script: bundle exec rspec
+notifications:
+  email:
+    on_success: never
+    on_failure: always

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 simple_gdrive.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Maxim Tretyakov
+
+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,83 @@
+[![Build Status](https://travis-ci.org/yamax2/simple_gdrive.svg?branch=master)](https://travis-ci.org/yamax2/simple_gdrive)
+
+# SimpleGdrive
+
+[from this example](https://developers.google.com/drive/v3/web/quickstart/ruby)
+
+Simple Google Drive file uploader
+
+Creates a required folder and all its parents like `mkdir_p`. For example:
+
+```
+MyMoney/<year>/<month>/<type>/money.csv
+```  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_gdrive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_gdrive
+
+## Usage with Rails
+
+1. Create `client_secrets.json` using [this wizard](https://console.developers.google.com/start/api?id=drive)
+
+2. Add the following initializer to `config/initializers`
+```ruby
+SimpleGdrive.configure do |config|  
+  config.client_secrets_file = Rails.root.join('config', 'client_secrets.json') # required
+  config.base_folder_id = '14lJD-WCxgCd9JxkBnsJktXhw0XrwrsLD' # required
+  
+  config.app_name = 'My app' # optional, default "GDrive Simple Uploader"
+  config.credential_file = Rails.root.join('config', 'credentials.yaml') # optional, default ~/.credentials/gdrive-uploader.yaml  
+end
+```
+3. Start uploading test file from rails console and follow instructions to create `credentials.yaml`.
+
+### File upload
+```ruby
+SimpleGdrive.upload '2018/01/MyMoney/money.csv', 'money.csv'
+```
+
+folder id:<br>
+![folder_id](https://mytm.tk/pcmsk/folder_id.png) 
+
+import local csv to google drive table:
+```ruby
+CSV.open(tempfile_path, 'w', col_sep: "\t") do |output|
+  output << ...
+  ...
+end
+
+SimpleGdrive.upload 'my/reports/folder/report', 
+                    tempfile_path, 
+                    content_type: 'text/csv',
+                    mime_type: 'application/vnd.google-apps.spreadsheet' 
+```
+
+### Folder clear
+removes all files and folders in 
+```ruby
+SimpleGdrive.clear
+```
+
+## Known issues
+
+* incorrect behaviour with cyrillic symbols in filenames:
+```ruby
+SimpleGdrive.upload 'Расходы/01/money.csv', 'money.csv'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_gdrive"
+
+# 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/simple_gdrive.rb

@@ -0,0 +1,48 @@
+require 'simple_gdrive/version'
+require 'simple_gdrive/base'
+require 'simple_gdrive/uploader'
+require 'simple_gdrive/cleaner'
+
+module SimpleGdrive
+  Config = Struct.new(
+    :base_folder_id,
+    :app_name,
+    :client_secrets_file,
+    :credential_file
+  )
+
+  def self.config
+    @config ||= Config.new.tap do |config|
+      config.base_folder_id = '14lJD-WCxgCd9JxkBnsJktXhw0XrwrsLD'
+      config.app_name = 'GDrive Simple Uploader'
+      config.client_secrets_file = 'client_secrets.json'
+      config.credential_file = File.join(
+        Dir.home,
+        '.credentials',
+        'gdrive-uploader.yaml'
+      )
+    end
+  end
+
+  def self.configure
+    yield config
+  end
+
+  def self.upload(full_filename, upload_source, content_type: 'text/plain', mime_type: nil)
+    Uploader.new(
+      app_name: config.app_name,
+      base_folder_id: config.base_folder_id,
+      credential_file: config.credential_file,
+      client_secrets_file: config.client_secrets_file
+    ).call(full_filename, upload_source, content_type: content_type, mime_type: mime_type)
+  end
+
+  def self.clear
+    Cleaner.new(
+      app_name: config.app_name,
+      base_folder_id: config.base_folder_id,
+      credential_file: config.credential_file,
+      client_secrets_file: config.client_secrets_file
+    ).call
+  end
+end

data/lib/simple_gdrive/base.rb

@@ -0,0 +1,63 @@
+require 'fileutils'
+
+require 'google/apis/drive_v3'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+
+module SimpleGdrive
+  class Base
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'.freeze
+    USER_ID = 'default'.freeze
+    FOLDER_MIME_TYPE = 'application/vnd.google-apps.folder'.freeze
+    OPTIONS = {retries: 5}.freeze
+
+    def initialize(app_name:, base_folder_id:, credential_file:, client_secrets_file:)
+      @app_name = app_name
+      @base_folder_id = base_folder_id
+      @credential_file = credential_file
+      @client_secrets_file = client_secrets_file
+    end
+
+    def service
+      @service ||= Google::Apis::DriveV3::DriveService.new.tap do |service|
+        service.client_options.application_name = @app_name
+        service.authorization = credentials
+      end
+    end
+
+    private
+
+    def auth_request(authorizer)
+      url = authorizer.get_authorization_url(base_url: OOB_URI)
+
+      puts 'Open the following URL in the browser and enter the '\
+            'resulting code after authorization'
+
+      puts url
+      code = gets
+
+      authorizer.get_and_store_credentials_from_code(
+        user_id: USER_ID,
+        code: code,
+        base_url: OOB_URI
+      )
+    end
+
+    def credentials
+      return @credentials if defined?(@credentials)
+
+      FileUtils.mkdir_p File.dirname(@credential_file)
+
+      client_id = Google::Auth::ClientId.from_file(@client_secrets_file)
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: @credential_file)
+
+      authorizer = Google::Auth::UserAuthorizer.new(
+        client_id,
+        Google::Apis::DriveV3::AUTH_DRIVE,
+        token_store
+      )
+
+      @credentials = authorizer.get_credentials(USER_ID) || auth_request(authorizer)
+    end
+  end
+end

data/lib/simple_gdrive/cleaner.rb

@@ -0,0 +1,36 @@
+module SimpleGdrive
+  # Cleans the directory
+  # Returns array of removed file names
+  class Cleaner < Base
+    def call
+      @page_token = nil
+      @files_to_remove = {}
+
+      begin
+        fetch_batch
+      end until @page_token.nil?
+
+      remove_files
+
+      @files_to_remove.values
+    end
+
+    private
+
+    def fetch_batch
+      response = service.list_files(
+        q: "'#{@base_folder_id}' in parents and not trashed",
+        fields: 'nextPageToken, files(id, name, parents)',
+        page_token: @page_token
+      )
+
+      @page_token = response.next_page_token
+
+      response.files.each_with_object(@files_to_remove) { |file, memo| memo[file.id] = file.name }
+    end
+
+    def remove_files
+      @files_to_remove.keys.each { |id| service.delete_file(id) }
+    end
+  end
+end

data/lib/simple_gdrive/uploader.rb

@@ -0,0 +1,47 @@
+module SimpleGdrive
+  # Uploads file
+  class Uploader < Base
+    def call(full_filename, upload_source, content_type:, mime_type: nil)
+      names = full_filename.split('/')
+      filename = names.pop
+      parent_id = find_folder(names)
+
+      meta = {name: filename, parents: [parent_id]}
+      meta[:mime_type] = mime_type if mime_type
+
+      file = service.create_file(
+        meta,
+        upload_source: upload_source,
+        content_type: content_type,
+        options: OPTIONS
+      )
+
+      {id: file.id, parent_id: parent_id}
+    end
+
+    private
+
+    def find_folder(names)
+      id = @base_folder_id
+
+      names.each { |folder_name| id = find_or_create_folder(folder_name, id) }
+
+      id
+    end
+
+    def find_or_create_folder(name, parent_id = nil)
+      folder_id = parent_id || @base_folder_id
+
+      res = service.list_files(
+        q: "mimeType='#{FOLDER_MIME_TYPE}' and name='#{name}' and '#{folder_id}' in parents and not trashed"
+      )
+
+      return res.files.first.id if res.files.any?
+
+      service.create_file(
+        {name: name, mime_type: FOLDER_MIME_TYPE, parents: [folder_id]},
+        options: OPTIONS
+      ).id
+    end
+  end
+end

data/lib/simple_gdrive/version.rb

@@ -0,0 +1,3 @@
+module SimpleGdrive
+  VERSION = '0.4.0'.freeze
+end

data/simple_gdrive.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_gdrive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_gdrive'
+  spec.version       = SimpleGdrive::VERSION
+  spec.authors       = ['Maxim Tretyakov']
+  spec.email         = ['max@tretyakov-ma.ru']
+
+  spec.summary       = %q{Simple Google Drive file uploader}
+  spec.description   = %q{Simple Google Drive file uploader with autocreating required folders}
+  spec.homepage      = 'https://github.com/yamax2/simple_gdrive'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_runtime_dependency 'google-api-client', '>= 0.24.3'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: simple_gdrive
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Maxim Tretyakov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.24.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.24.3
+- !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: pry-byebug
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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: vcr
+  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: webmock
+  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: Simple Google Drive file uploader with autocreating required folders
+email:
+- max@tretyakov-ma.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_gdrive.rb
+- lib/simple_gdrive/base.rb
+- lib/simple_gdrive/cleaner.rb
+- lib/simple_gdrive/uploader.rb
+- lib/simple_gdrive/version.rb
+- simple_gdrive.gemspec
+homepage: https://github.com/yamax2/simple_gdrive
+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.6
+signing_key: 
+specification_version: 4
+summary: Simple Google Drive file uploader
+test_files: []