googledriver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3faab8a54083aaa61627247349a97ef48b725687
+  data.tar.gz: da7832b7385d3681c243e279c10343550bb15d47
+SHA512:
+  metadata.gz: 03675c73e61060c1515e12a4ee1ad4521e60aaf98801965e2bd0871a61432aeb3b0090fe4a4f8e4b25fd228fe6774774ed9c1552c408a136b713ca06b9979f58
+  data.tar.gz: 24a986d20f2a878456bf36a21f7165ce225a1e54bcc632c13e68e95deabf733cc76f8167da6fdceb3521afc47de1282c9c7cee32dc462fa7adcba1a2c514bb9d

data/lib/googledriver/authorizer.rb

@@ -0,0 +1,90 @@
+module Googledriver
+  # Authorizes a user to Google Drive and generates access tokens
+  class Authorizer
+    # Authorization scope which only allows program to manipulate files it
+    # created.
+    SCOPE = 'https://www.googleapis.com/auth/drive.file'.freeze
+
+    # Standard redirect uri for authorization.
+    REDIRECT_URI = 'urn:ietf:wg:oauth:2.0:oob'.freeze # standard redirect uri
+
+    # The access token created during authorization which is needed to perform
+    # uploads to Google Drive.
+    attr_reader :access_token
+
+    # The lifetime of an access token in seconds which dictates how often a
+    # token needs to be refreshed.
+    attr_reader :token_lifetime
+
+    # The time of birth of the current access token.
+    attr_reader :token_tob
+
+    # Constructs a new Authorizer by reading client data from a file and
+    # creating a REST resource.
+    def initialize(client_secrets_path)
+      @client_secrets_path = client_secrets_path
+      update_client_data
+      create_refresh_resource
+    end
+
+    # Generates an authorization url for the user in order to obtain an initial
+    # refresh token.
+    def create_refresh_token
+      client = OAuth2::Client.new(@client_id, @client_secret,
+                                  authorize_url: '/o/oauth2/auth',
+                                  token_url: '/o/oauth2/token',
+                                  site: 'https://accounts.google.com')
+      url = client.auth_code.authorize_url(redirect_uri: REDIRECT_URI,
+                                           scope: SCOPE, access_type: 'offline')
+      puts "Open the following link and follow the onscreen instructions #{url}"
+      code = gets
+      token = client.auth_code.get_token(code, redirect_uri: REDIRECT_URI)
+      @refresh_token = token.refresh_token
+    end
+
+    # Refreshes the access token and updates resources appropriately.
+    def refresh_access_token
+      @token_tob = Time.now
+
+      begin
+        refresh = @refresh_manager.post(
+          build_refresh_payload
+        )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{@refresh_manager}"
+        retry
+      end
+
+      update_refresh_data(refresh)
+    end
+
+    private
+
+    def update_client_data
+      file_content = File.read(@client_secrets_path)
+      client_data = JSON.parse(file_content)['installed']
+      @client_id = client_data['client_id']
+      @client_secret = client_data['client_secret']
+    end
+
+    def create_refresh_resource
+      @refresh_manager = RestClient::Resource.new(
+        'https://www.googleapis.com/oauth2/v4/token',
+        headers: { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      )
+    end
+
+    def build_refresh_payload
+      payload = { 'refresh_token' => @refresh_token, 'client_id' => @client_id,
+                  'client_secret' => @client_secret,
+                  'grant_type' => 'refresh_token' }
+      payload
+    end
+
+    def update_refresh_data(refresh_data)
+      processed_data = JSON.parse(refresh_data)
+      @token_lifetime = processed_data['expires_in']
+      @access_token = processed_data['access_token']
+    end
+  end
+end

data/lib/googledriver/uploader.rb

@@ -0,0 +1,194 @@
+module Googledriver
+
+  # Uploads a filesystem to Google Drive and saves file ids
+  class Uploader
+    # Constructs a new Uploader by building an empty hash for file ids and
+    # making an Authorizer object to handle the creation of REST resources.
+    def initialize(client_secrets_path)
+      @file_ids = {}
+      @authorizer = Googledriver::Authorizer.new(client_secrets_path)
+      @authorizer.create_refresh_token
+      @authorizer.refresh_access_token
+      @access_token = @authorizer.access_token
+      @token_tob = @authorizer.token_tob
+      create_manager_resource
+      @token_lifetime = @authorizer.token_lifetime
+      create_uploader_resource
+    end
+
+    # Recursively uploads a local filesystem specified by a file path to a given
+    # folder in Google Drive.
+    def upload_filesystem(directory: '', upload_dest: 'root')
+      directory = "#{directory}/" unless directory[-1] == '/'
+
+      Dir[directory + '*'].each do |object|
+        if File.directory?(object)
+          folder_name = File.basename(object)
+          folder_id = upload_folder(folder_name, location: upload_dest)
+          upload_filesystem(upload_dest: folder_id,
+                            directory: "#{directory}#{folder_name}/")
+        else
+          file_name = File.basename(object)
+          file_id = upload_file(object, file_name, location: upload_dest)
+          @file_ids[object] = file_id
+        end
+      end
+    end
+
+    # Uploads a local folder specified by a file path to a given folder in
+    # Google Drive.
+    def upload_folder(folder_name, location: 'root')
+      begin
+        update_refresh_token if refresh_due?
+        upload = @drive_manager.post(
+          { 'name' => folder_name,
+            'mimeType' => 'application/vnd.google-apps.folder' }.to_json
+        )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{folder_name}"
+        retry
+      end
+
+      folder_id = JSON.parse(upload)['id']
+
+      if location != 'root'
+        begin
+          update_refresh_token if refresh_due?
+          @drive_manager[folder_id + '?addParents=' + location +
+                         '&removeParents=root&alt=json'].patch(
+                           { 'uploadType' => 'resumable' }.to_json
+                         )
+        rescue StandardError => error
+          warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{folder_name}"
+          retry
+        end
+      end
+
+      folder_id
+    end
+
+    # Uploads a local file specified by a file path to a given folder in
+    # Google Drive.
+    def upload_file(file_path, file_name, location: 'root')
+      begin
+        payload = File.open(file_path)
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        return
+      end
+
+      begin
+        update_refresh_token if refresh_due?
+        upload = @drive_uploader.post(
+          payload
+        )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        retry
+      end
+
+      file_id = JSON.parse(upload)['id']
+      @file_ids[file_path] = file_id
+
+      begin
+        update_refresh_token if refresh_due?
+        @drive_manager[file_id + '?addParents=' + location +
+                       '&removeParents=root&alt=json'].patch(
+                         { 'uploadType' => 'resumable',
+                           'name' => file_name }.to_json
+                       )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        retry
+      end
+
+      payload.close
+      file_id
+    end
+
+    # Saves the file ids hash to a json file in the working directory.
+    def archive_file_ids
+      archive = File.open('drive_file_ids.json', 'w')
+      File.write('drive_file_ids.json', @file_ids.to_json)
+      archive.close
+    end
+
+    # Returns the metadata of a given file.
+    def obtain_file_metadata(file_id)
+      begin
+        metadata = @drive_manager[file_id].get
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        return
+      end
+
+      metadata = JSON.parse(metadata)
+      metadata
+    end
+
+    # Updates a piece of metadata for a given file.
+    def update_file_metadata(file_id, element, new_data)
+      payload = { 'uploadType' => 'resumable', element => new_data }.to_json
+
+      begin
+        update = @drive_manager[file_id].patch(
+          payload
+        )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        return
+      end
+
+      update
+    end
+
+    # Shares a given file with an individual or group email address.
+    def update_file_permission(file_id, email)
+      payload = { 'role' => 'writer', 'type' => 'group',
+                  'emailAddress' => email }.to_json
+
+      begin
+        update = @drive_manager[file_id + '/permissions'].post(
+          payload
+        )
+      rescue StandardError => error
+        warn "#{error};  METHOD  #{__callee__};  RESOURCE  #{file_path}"
+        return
+      end
+
+      update
+    end
+
+    private
+
+    def create_manager_resource
+      @drive_manager = RestClient::Resource.new(
+        'https://www.googleapis.com/drive/v3/files/',
+        headers: { 'Authorization' => "Bearer #{@access_token}",
+                   'Content-Type' => 'application/json' }
+      )
+    end
+
+    def create_uploader_resource
+      @drive_uploader = RestClient::Resource.new(
+        'https://www.googleapis.com/upload/drive/v3/files',
+        headers: { 'Authorization' => "Bearer #{@access_token}" }
+      )
+    end
+
+    def update_refresh_token
+      @authorizer.refresh_access_token
+      @access_token = @authorizer.access_token
+      @token_lifetime = @authorizer.token_lifetime
+      @token_tob = @authorizer.token_tob
+      create_manager_resource
+      create_uploader_resource
+    end
+
+    def refresh_due?
+      token_timer = Time.now - @token_tob
+      return false unless token_timer > @token_lifetime * 0.9
+      true
+    end
+  end
+end

data/lib/googledriver.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'oauth2'
+require 'rest-client'
+require File.dirname(__FILE__) + '/googledriver/uploader.rb'
+require File.dirname(__FILE__) + '/googledriver/authorizer.rb'
+
+# This module is used to authorize a Google account and upload files to its
+# Drive. It also supports the management of uploaded files through changing the
+# permissions and metadata of a file. Before use, a secrets file must be
+# downloaded by following the wizard here
+# https://console.developers.google.com/start/api?id=drive. See README.md for
+# usage guide.
+module Googledriver; end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: googledriver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Giordano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: 
+email: pgg505@york.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/googledriver.rb
+- lib/googledriver/authorizer.rb
+- lib/googledriver/uploader.rb
+homepage: http://rubygems.org/gems/googledriver
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Authorize a Google account and upload files to its Drive.
+test_files: []