ngdrive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a4afdda6630b12086cdd0d88508ec56a53ffc9643ed67a4723942920193a58b
+  data.tar.gz: e75b8ccf10c32323272a63c0df8903c3dbce267270300823b65fdb1db27cd6fe
+SHA512:
+  metadata.gz: 448dfc9db3622061745d34279d44f4f7adf01dac6b853eac2340866f86db310d14af590b0c960c25b98a389fa03bda95f3a3f0e315b50ccb363585f4f2de7e14
+  data.tar.gz: 90afcfbaefdc9a3dbeb27548ef233afb073bead9eedc755f7578d68ab80ff76a5b684a288aa3020a1b9b0f8526af046457cef7e838fde312d5d4089fa5d80a4d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nchikkam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ngdrive.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# ngdrive
+
+A simple ngdrive utitily to download files from gdrive folders recursively into local machine.
+
+Google allows/supports accessing google drive files via API.
+Below steps are pre-requisites to do the same.
+
+1. First a gmail account is needed.
+2. An app must be created via console.developers.google.com eg: app-name: 'gdrive-syncher'. This can be 'Desktop App'.
+3. credentials.json file from above app must be placed in the config/ folder.
+4. 'Google Drive API' must be enabled for the above app via 'APIs & Services' -> 'Enable API & Services'.
+5. Above app must be registered with:
+    - OAuth consent screen
+        - App Info:
+            - app name: gdrive-syncher
+            - support email: email given in point 1 above
+            - app logo optional
+        - App Domain:
+            - application home page: https://gmail.com
+
+        - Authorized domains:
+            - gmail.com
+        - Developer contact information
+            - email given in point 1 above
+
+    - Scope
+        - Google Drive API
+
+    - Test users
+        - email given in point 1 must be added as test user
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'googledrive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install googledrive
+
+## Usage
+
+```ruby
+require 'googledrive'
+gd = Ngdrive::GdriveUtil.new
+gd.download_files
+```
+Above lines will pickup the files/folders present in the gdrive.folder_id value in settings.yml and download all files
+recursively into ./downloads folder along with their respective folder names.
+
+- Notes:
+    - google drive maintains a session (via token) valid for a certain amount of time. This session is based on a token
+      and will expire after the duration.
+    - each time a request is made to google drive via API, it needs this token to allow google drive to continue
+      accessing.
+    - First time when 'Ngdrive::GdriveUtil.new' is run, the gem does below steps:
+
+        - it prompts user with a url to copy and enter in the browser. This is OAuthentication request asking the user
+          to allow the access to drive via gmail account. This consent is mandatory as per google rules and
+          regulations.
+        - When prompted with url on console, user has to enter the url in the browser, allow access, continue.
+        - once confirmed, google returns a url with format similar to below:
+        - 'https://....code=<<abce...xyz>>&aa=...' code received between << and >> is what is needed as initial token.
+        - users have to copy this and enter in the console to allow gem to create config/token.yaml to keep the token
+          for subsequent calls.
+        - This token will expire after certain time, in which case, users have to do the url copy paste each time they
+          need to access drive via API.
+    - once token.yaml file is created, accessing and downloading googledrive files is as simple as running:
+      gd.download_files

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ngdrive'
+
+# 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/ngdrive/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ngdrive
+  VERSION = '0.1.0'
+end

data/lib/ngdrive.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'ngdrive/version'
+require 'fileutils'
+require 'google/apis/drive_v3'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'json'
+require 'net/http'
+
+module Ngdrive
+  # google drive util to download files from folder recursively
+  class GdriveUtil # rubocop:disable Metrics/ClassLength
+    SCOPE = Google::Apis::DriveV3::AUTH_DRIVE_READONLY
+
+    attr_reader :drive_service
+
+    def initialize
+      @config = YAML.load_file('./settings.yml')
+      @drive_service = Google::Apis::DriveV3::DriveService.new
+      @drive_service.client_options.application_name = @config['app']['name']
+      @drive_service.authorization = authorize
+    end
+
+    def get_entries(folder_id)
+      all_files = fetch_files(folder_id)
+      folders = get_folders(all_files['items'])
+      files = get_files(all_files['items'])
+
+      entries = {}
+      entries[:files] = files.map { |x| { id: x['id'], name: x['title'] } }
+      folders.each do |folder|
+        title = folder['title']
+        entries[title] = get_entries(folder['id'])
+      end
+
+      entries
+    end
+
+    def root_folder_id
+      @config['gdrive']['folder_id']
+    end
+
+    def download_folder
+      @config['app']['download_dir']
+    end
+
+    def download_files
+      entries = get_entries(root_folder_id)
+      download!(entries)
+    end
+
+    def download!(root, path = [])
+      return unless root
+
+      folder = create_folder!(path)
+
+      root[:files].each do |file|
+        file_path = "#{folder}/#{file[:name]}"
+        drive_service.get_file(file[:id], download_dest: file_path)
+      end
+
+      folders = root.keys.reject { |x| x == :files }
+      folders.each do |folder_key|
+        download!(root[folder_key], path + [folder_key])
+      end
+    end
+
+    private
+
+    def create_folder!(path)
+      folder = "#{download_folder}/#{path.join('/')}"
+      Dir.mkdir(folder) unless File.exist?(folder)
+      folder
+    end
+
+    def authorize # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      client_id = Google::Auth::ClientId.from_file(
+        @config['app']['credentials']
+      )
+      token_store = Google::Auth::Stores::FileTokenStore.new(
+        file: @config['app']['token']
+      )
+      authorizer = Google::Auth::UserAuthorizer.new(
+        client_id,
+        SCOPE,
+        token_store
+      )
+      user_id = 'default'
+      credentials = authorizer.get_credentials user_id
+      if credentials.nil?
+        url = authorizer.get_authorization_url(
+          base_url: @config['app']['oob_uri']
+        )
+        puts 'Allow Authorization (Pair User Credentials) on Consent Form ' \
+         'Open the following URL in the browser and enter the ' \
+         "resulting code after authorization:\n" + url
+        code = gets
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id, code: code, base_url: @config['app']['oob_uri']
+        )
+      end
+      credentials
+    end
+
+    def fetch_files(folder_id) # rubocop:disable Metrics/MethodLength
+      prefix = 'https://www.googleapis.com/drive/v2/files?q='
+      uri = URI("#{prefix}'#{folder_id}'+in+parents")
+      req = Net::HTTP::Get.new(uri)
+
+      token = drive_service.request_options.authorization.access_token
+      req['Authorization'] = "Bearer #{token}"
+
+      res = Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: uri.scheme == 'https'
+      ) do |http|
+        http.request(req)
+      end
+
+      resp = JSON.parse(res.body)
+      resp
+    end
+
+    def get_folders(collection)
+      collection.select(&method(:folder?))
+    end
+
+    def get_files(collection)
+      collection.reject(&method(:folder?))
+    end
+
+    def folder?(param)
+      param['mimeType'] == 'application/vnd.google-apps.folder'
+    end
+
+    def get_only_pdf_files(collection)
+      collection.select { |x| x['mimeType'] == 'application/pdf' }
+    end
+  end
+end

data/ngdrive.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ngdrive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ngdrive'
+  spec.version       = Ngdrive::VERSION
+  spec.authors       = ['narayana']
+  spec.email         = ['nchikkam@gmail.com']
+
+  spec.summary       = 'Simple gem to download google drive files into local'
+  spec.description   = 'Gem to download google drive files into local \
+                        Inspiration: https://console.cloud.google.com/apis/'
+  spec.homepage      = 'https://github.com'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com'
+    spec.metadata['changelog_uri'] = 'https://github.com'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'google-apis-drive_v3', '~>0.19.0'
+  spec.add_development_dependency 'google_drive', '~>2.1.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_development_dependency 'faraday', '~>1.10.0'
+  spec.add_development_dependency 'mechanize', '~>2.7.7'
+  spec.add_development_dependency 'nokogiri', '~> 1.12.5'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: ngdrive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- narayana
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: google-apis-drive_v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+description: |-
+  Gem to download google drive files into local \
+                          Inspiration: https://console.cloud.google.com/apis/
+email:
+- nchikkam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ngdrive.rb
+- lib/ngdrive/version.rb
+- ngdrive.gemspec
+homepage: https://github.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com
+  source_code_uri: https://github.com
+  changelog_uri: https://github.com
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Simple gem to download google drive files into local
+test_files: []