backup-googledrive 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6909a4f268118492f668382203b3c332e19a80c8
+  data.tar.gz: eac80a0ce6a50a9314f253a86f93c9c2b9b083ae
+SHA512:
+  metadata.gz: c0b37e31e8bf83fde792b284d30b564426425b3603596b73c89ef71426574b5e99b25d5bb058a73b1a9b865d20d5688d8e0a93bacf795675d34abda55c3fb116
+  data.tar.gz: 9a3693d57cb08c8d594b0903a075e919db6184f00196a56ab26118a16cd1e73d9abbbeda94739827af671b5239d3d3047e7c301b719702b79bb3f450c39fb078

data/lib/backup-googledrive.rb

@@ -0,0 +1,6 @@
+module Backup
+  module Storage
+    autoload :GoogleDrive, File.join(File.dirname(__FILE__), 'storage', 'googledrive')
+    Backup::Config::DSL.const_set('GoogleDrive', Module.new)
+  end
+end

data/lib/storage/googledrive.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+
+module Backup
+  module Storage
+    class GoogleDrive < Base
+
+      include Storage::Cycler
+      class Error < Backup::Error; end
+
+      # This adapter uses gdrive (https://github.com/prasmussen/gdrive) to handle all API interactions.
+      # Fortunately for us gdrive handles things like timeouts, error retries and large file chunking, too!
+      # I found gdrive's defaults to be acceptable, but should be easy to add accessors to customize if needed
+
+      # Path to gdrive executable
+      attr_accessor :gdrive_exe
+
+      # Use the gdrive executable to obtain a refresh token. Add that token to your backup model.
+      # The gdrive exe will handle refresing the access tokens
+      attr_accessor :refresh_token
+
+      ##
+      # Creates a new instance of the storage object
+      def initialize(model, storage_id = nil)
+        super
+
+        @path           ||= 'backups'
+        path.sub!(/^\//, '')
+
+        required = %w{ refresh_token }
+        raise Error, "Configuration Error: a refresh_token is required" if refresh_token.nil?
+
+        raise Error, "Configuration Error: gdrive executable is required." if gdrive_exe.nil?
+      end
+
+      # private
+
+
+      ##
+      # Transfer each of the package files to Dropbox in chunks of +chunk_size+.
+      # Each chunk will be retried +chunk_retries+ times, pausing +retry_waitsec+
+      # between retries, if errors occur.
+      def transfer!
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ dest }'..."
+
+          parent_id = find_id_from_path(remote_path)
+          gdrive_upload(src, parent_id)
+        end
+      end
+
+      # # Called by the Cycler.
+      # # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+        id = find_id_from_path(remote_path_for(package), false)
+        if id.to_s.empty?
+          raise Error, "Backup packge #{ package.time } not found in Google Drive"
+        else
+          gdrive_delete(id)
+        end
+      end
+
+      def find_id_from_path(path = remote_path, create = true)
+        parent = nil
+        path.split('/').each do |path_part|
+          id = get_folder_id(path_part, parent)
+          if id.to_s.empty? && create
+            id = gdrive_mkdir(path_part, parent)
+          end
+          parent = id
+        end
+        return parent
+      end
+
+
+      def get_folder_id(name, parent = nil)
+        parent = parent ? parent : 'root'
+        gdrive_list("name = '#{name}' and '#{parent}' in parents")
+      end
+
+      def gdrive_list(query)
+        unless query.empty?
+          cmd = "gdrive --refresh-token '#{refresh_token}' list --no-header -q \"#{query}\""
+          output = `#{cmd}`
+          if output.downcase.include? "error"
+            raise Error, "Could not list or find the object with query string '#{query}'. gdrive output: #{output}"
+          elsif output.empty?
+            return nil
+          else
+            begin
+              return /^([^ ]*).*/.match(output)[1] # will return an empty string on no match
+            rescue => err
+              return nil
+            end
+          end
+        else
+          raise Error, "A search query is required to list/find a file or folder"
+        end
+      end
+
+      def gdrive_mkdir(name, parent = nil)
+        unless name.empty?
+          parent = parent ? parent : 'root'
+          cmd = "gdrive --refresh-token '#{refresh_token}' mkdir -p '#{parent}' '#{name}'"
+          output = `#{cmd}`
+          if output.downcase.include? "error"
+            raise Error, "Could not create the directory '#{name}' with parent '#{parent}'. gdrive output: #{output}"
+          else
+            id = /^Directory (.*?) created/.match(output)[1]
+            raise Error, "Could not determine ID of newly created folder. See gdrive output: #{output}" if id.to_s.empty?
+            Logger.info "Created folder #{name} successfully with id '#{id}'"
+            return id
+          end
+        else
+          raise Error, "Name parameter is required to make a directory"
+        end
+      end
+
+      def gdrive_upload(src, parent = nil)
+        parent = parent ? parent : 'root'
+        cmd = "gdrive --refresh-token '#{refresh_token}' upload -p '#{parent}' '#{src}'"
+        output = `#{cmd}`
+        if ( ["error", "failed"].any? {|s| output.downcase.include? s } )
+          raise Error, "Could not upload file. See gdrive output: #{output}"
+        else
+          begin
+            id = /.*Uploaded (.*?) .*/.match(output)[1]
+            raise Error, "empty id" if id.to_s.empty?
+            Logger.info "Uploaded #{src} into parent folder '#{parent}' successfully. Google Drive file_id: #{ id }"
+          rescue => err
+            raise Error.wrap(err, "Could not determine ID of newly created folder. See gdrive output: #{output}")
+          end
+        end
+      end
+
+      def gdrive_delete(id, recursive = true)
+        cmd = "gdrive --refresh-token '#{refresh_token}' delete #{'-r' if recursive} '#{id}'"
+        output = `#{cmd}`
+        if output.downcase.include? "error"
+          raise Error, "Could not delete object with id: #{id}. See gdrive output: #{output}"
+        else
+          Logger.info output
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: backup-googledrive
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joseph Rafferty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-10 00:00:00.000000000 Z
+dependencies: []
+description: Adds the GoogleDrive storage engine to the Backup ruby gem.
+email: oraff@gmail.comj
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/backup-googledrive.rb
+- lib/storage/googledrive.rb
+homepage: http://github.com/joraff/backup-googledrive
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: GoogleDrive storage engine to Backup
+test_files: []
+has_rdoc: