0.0
No release in over 3 years
๐Ÿดโ€โ˜ ๏ธ Liberate files from your Google Drive with transformations
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.0, >= 1.0.3
~> 1.0, >= 1.0.6
~> 13.0
~> 1.0, >= 1.0.4
~> 1.0, >= 1.0.2
>= 4

Runtime

~> 1.1, >= 1.1.9
~> 3.0, >= 3.0.7
 Project Readme
๐Ÿ“ NOTE
RubyGems (the GitHub org, not the website) suffered a hostile takeover in September 2025.
Ultimately 4 maintainers were hard removed and a reason has been given for only 1 of those, while 2 others resigned in protest.
It is a complicated story which is difficult to parse quickly.
I'm adding notes like this to gems because I don't condone theft of repositories or gems from their rightful owners.
If a similar theft happened with my repos/gems, I'd hope some would stand up for me.
Disenfranchised former-maintainers have started gem.coop.
Once available I will publish there exclusively; unless RubyCentral makes amends with the community.
The "Technology for Humans: Joel Draper" podcast episode by reinteractive is the most cogent summary I'm aware of.
See here, here and here for more info on what comes next.
What I'm doing: A (WIP) proposal for bundler/gem scopes, and a (WIP) proposal for a federated gem server.

Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5

๐Ÿดโ€โ˜ ๏ธ UndriveGoogle

Version GitHub tag (latest SemVer) License: MIT Downloads Rank Open Source Helpers CodeCov Test Coverage Coveralls Test Coverage QLTY Test Coverage QLTY Maintainability CI Heads CI Runtime Dependencies @ HEAD CI Current CI Truffle Ruby CI JRuby Deps Locked Deps Unlocked CI Supported CI Legacy CI Test Coverage CI Style CodeQL Apache SkyWalking Eyes License Compatibility Check

if ci_badges.map(&:color).detect { it != "green"} โ˜๏ธ let me know, as I may have missed the discord notification.


if ci_badges.map(&:color).all? { it == "green"} ๐Ÿ‘‡๏ธ send money so I can do more of this. FLOSS maintenance is now my full-time job.

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate at ko-fi.com

๐ŸŒป Synopsis

Toolkit for:

  1. Liberating variously formatted files from your Google Drive
  2. Applying a set of transformations to liberated files
    • patterned rename
    • unzip
    • correct HTML errors
  3. Profit

Want to link directly to the Google-Drive-hosted alternate format of a file? If yes, DO NOT use this gem. Instead follow these instructions.

OTOH, if you want to "own", host, track, etc your 'own' files (e.g. your resume), DO use this gem.

Story Time

Imagine Google Drive is a ๐Ÿญ Imagine your file (e.g. resume) is a ๐Ÿช ๐Ÿญ's ๐Ÿช exporter: ๐Ÿ–จ

Tell me if you've heard this one already.

  1. Give ๐Ÿญ your ๐Ÿช for "safe-keeping"
  2. Recognizing this SPoF, you ask ๐Ÿญ to give back a ๐Ÿช copy
  3. "I'll run it through my ๐Ÿช ๐Ÿ–จ", says ๐Ÿญ
  4. ๐Ÿ–จ replicates various ๐Ÿช extensions: pdf, odt, docx, txt, rtf, zip, and epub
  5. Rename ๐Ÿช for web (e.g. replace with _)
  6. Extract replicated .zip format to .html
  7. Rename extracted HTML file for self-hosting
  8. Realize ๐Ÿญ's HTML is invalid
  9. Fix ๐Ÿญ's broke-ass (missing lang attribute and title element)
  10. Upload ๐Ÿช to your website (you're on your own for this part)
  11. Finally Finished!
  12. Find mistakes ๐Ÿ˜ญ
  13. Bake a new ๐Ÿช
  14. GOTO 1

This gem solves the classic ๐Ÿญ-๐Ÿช problem by automating steps 3-9. Will save at least 15 minutes each loop.

Note that it doesn't have to be a resume. There are likely other use cases that apply.

๐Ÿ’ก Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby 9.1 Compat JRuby 9.2 Compat JRuby 9.3 Compat
JRuby 9.4 Compat JRuby 10.0 Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 22.3 Compat Truffle Ruby 23.0 Compat
Truffle Ruby 23.1 Compat Truffle Ruby 24.1 Compat
Works with MRI Ruby 3 Ruby 3.1 Compat Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat Ruby HEAD Compat
Support & Community Join Me on Daily.dev's RubyFriends Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog GitLab Wiki GitHub Wiki
Compliance License: MIT Compatible with Apache Software Projects: Verified by SkyWalking Eyes ๐Ÿ“„ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Maintainer ๐ŸŽ–๏ธ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... ๐Ÿ’– Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me ๐ŸงŠ ๐Ÿ™ ๐Ÿ›– ๐Ÿงช

Compatibility

Compatible with MRI Ruby 3.1+, and concordant releases of JRuby, and TruffleRuby.

๐Ÿšš Amazing test matrix was brought to you by ๐Ÿ”Ž appraisal2 ๐Ÿ”Ž and the color ๐Ÿ’š green ๐Ÿ’š
๐Ÿ‘Ÿ Check it out! โœจ github.com/appraisal-rb/appraisal2 โœจ

Federated DVCS

Find this repo on federated forges (Coming soon!)
Federated DVCS Repository Status Issues PRs Wiki CI Discussions
๐Ÿงช galtzo-floss/undrive_google on GitLab The Truth ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿญ Tiny Matrix โž–
๐ŸงŠ galtzo-floss/undrive_google on CodeBerg An Ethical Mirror (Donate) ๐Ÿ’š ๐Ÿ’š โž– โญ•๏ธ No Matrix โž–
๐Ÿ™ galtzo-floss/undrive_google on GitHub Another Mirror ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿ’ฏ Full Matrix ๐Ÿ’š
๐ŸŽฎ๏ธ Discord Server Live Chat on Discord Let's talk about this library!

Enterprise Support Tidelift

Available as part of the Tidelift Subscription.

Need enterprise-level guarantees?

The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.

Get help from me on Tidelift

  • ๐Ÿ’กSubscribe for support guarantees covering all your FLOSS dependencies
  • ๐Ÿ’กTidelift is part of Sonar
  • ๐Ÿ’กTidelift pays maintainers to maintain the software you depend on!
    ๐Ÿ“Š@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

  • Live Chat on Discord
  • Get help from me on Upwork
  • Get help from me on Codementor

โœจ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add undrive_google

If bundler is not being used to manage dependencies, install the gem by executing:

gem install undrive_google

๐Ÿ”’ Secure Installation

For Medium or High Security Installations

This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasnโ€™t been tampered with by following the instructions below.

Add my public key (if you havenโ€™t already, expires 2045-04-29) as a trusted certificate:

gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)

You only need to do that once. Then proceed to install with:

gem install undrive_google -P HighSecurity

The HighSecurity trust profile will verify signed gems, and not allow the installation of unsigned dependencies.

If you want to up your security game full-time:

bundle config set --global trust-policy MediumSecurity

MediumSecurity instead of HighSecurity is necessary if not all the gems you use are signed.

NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.

โš™๏ธ Configuration

You'll probably want to follow these (outdated) steps to create a service account.

At the end of the process a [siteid]-[first-12-chars-of-key].json file will be downloaded to your computer. DO NOT EXPOSE THE KEY, i.e. do not push it to any public source repository.

When you run the undrive_google command this JSON key file should be in the current directory.

Additionally, an optional undrive_google.yml file in the current directory can give you control over the behavior.

What goes in the undrive_google.yml file?

Default: Liberate All Formats

All non-commented values shown are default.

# [PATH] Path to the JSON file with Google Service Account Key
key_file: 'service_account_private_key.json'

# ID of file to liberate, as key or title
file_id: '<actual-key-or-title>'
file_by: 'key' # or 'title'

# [String, Array<String>] Which extensions to download?
extensions: 'all'

# [Boolean] The HTML format download comes as a .zip archive.
# Want the .zip unzipped? (only relevant if extensions is `all`, or includes `zip`)
unzip: true
# [Boolean] Keep the .zip after extracting the `.html`?
keep_zip: true

# Rename downloaded files?
# rename_<type>, where type is:
#   1. a downloadable format name, like `odt`, `docx`, `pdf`, etc
#   2. html (which isn't downloadable, has to be unzipped from .zip)
# e.g.
# rename_html: 'resume.html'

# Rename downloaded files following a pattern?
# Only applies to files not explicitly specified with rename-<type>
# Will never apply to the html file unzipped from the .zip
# Used as: file_name.gsub(rename_pattern[0], rename_pattern[1])
# By default, no renaming, must be specified
# rename_pattern:
#   - "_"
#   - " "

# [PATH]
dir: '' # defaults to current working directory

verbose: true # or false

# [String] Set inner text of missing title element, if unzipping `.zip` to `.html`.
title: '' # When empty, defaults to the title of the file.

# [String] Adds lang attribute to html tag, If unzipping `.zip` to `.html`,
#            value is like `fr`, `es`, etc.
lang: 'en'

Example: Liberate Specific Formats (keeping other defaults)

In this example we choose to download only the odt, txt, and epub extensions, and leave the remaining settings as default, except for title.

# [String, Array<String>] Which extensions to download?
extensions:
   - 'odt'
   - 'txt'
   - 'epub'

title: 'My Cool HTML'

๐Ÿ”ง Basic Usage

Example: Export epub & Unzip html

NOTE: There is a bug (missing feature) in google_drive gem preventing export of epub format. You can use my patched branch if you need epub:

Create a Gemfile:

source "https://gem.coop"

gem "google_drive", github: "pboling/google-drive-ruby", branch: "pboling-epub-mimetype"

Please upvote this PR #427!

When liberating your files, ensure the script will use the Gemfile if it isn't in the same directory where you are running the undrive_google command:

BUNDLE_GEMFILE=path/to/Gemfile bundle update
BUNDLE_GEMFILE=path/to/Gemfile bundle exec undrive_google -c path/to/config

NOTE: If the Gemfile and the config are in the same, current, directory, you can simply run:

bundle exec undrive_google

My complete Gemfile looks like this:

# frozen_string_literal: true

source "https://gem.coop"

gem "undrive_google", "~> 1.1"

# See: https://github.com/gimite/google-drive-ruby/pull/427
gem "google_drive", github: "pboling/google-drive-ruby", branch: "pboling-epub-mimetype"

My undrive_google.yml config file looks like this (sanitized a bit):

file_id: "the-key-to-my-google-drive-file(find-in-the-url)"
key_file: serviceid-1234567890.json
dir: /my/path/to/my/cv
rename_html: resume.html
rename_pattern:
  - " "
  - "_"
extensions: zip
keep_zip: true
unzip: true
verbose: true
sweep: true

The liberated files get published at https://railsbling.com/cv.

๐Ÿฆท FLOSS Funding

While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).

If you're working in a company that's making significant use of galtzo-floss tools we'd appreciate it if you suggest to your company to become a galtzo-floss sponsor.

You can support the development of galtzo-floss tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.

๐Ÿ“ NOTE
If doing a sponsorship in the form of donation is problematic for your company
from an accounting standpoint, we'd recommend the use of Tidelift,
where you can get a support-like subscription instead.

Open Collective for Individuals

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Open Collective for Organizations

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

Another way to support open-source

How wonderful it is that nobody need wait a single moment before starting to improve the world.
โ€”Anne Frank

Iโ€™m driven by a passion to foster a thriving open-source community โ€“ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions โ€” totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโ€™m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐Ÿ” chickens, 2 ๐Ÿถ dogs, 3 ๐Ÿฐ rabbits, 8 ๐Ÿˆโ€ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

Iโ€™m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: ๐Ÿ‘‰๏ธ No network calls. ๐Ÿ‘‰๏ธ No tracking. ๐Ÿ‘‰๏ธ No oversight. ๐Ÿ‘‰๏ธ Minimal crypto hashing. ๐Ÿ’ก Easily disabled nags

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate to my FLOSS or refugee efforts at ko-fi.com Donate to my FLOSS or refugee efforts using Patreon

๐Ÿ” Security

See SECURITY.md.

๐Ÿค Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already ๐Ÿ’ฏ (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

๐Ÿš€ Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage Graph

Coveralls Test Coverage

QLTY Test Coverage

๐Ÿช‡ Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

๐ŸŒˆ Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/undrive_google/-/graphs/main

โญ๏ธ Star History Star History Chart

๐Ÿ“Œ Versioning

This Library adheres to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

dropping support for a platform is both obviously and objectively a breaking change
โ€”Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716

I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("undrive_google", "~> 1.0")
๐Ÿ“Œ Is "Platform Support" part of the public API? More details inside.

SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

See CHANGELOG.md for a list of releases.

๐Ÿ“„ License

The gem is available as open source under the terms of the MIT License License: MIT. See LICENSE.txt for the official Copyright Notice.

ยฉ Copyright

  • Copyright (c) 2022, 2025 Peter H.ย Boling, of Galtzo.com Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0 , and undrive_google contributors.

๐Ÿค‘ A request for help

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March and filled with many dozens of rejections, I'm now spending ~60+ hours a week building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.

To join the community or get help ๐Ÿ‘‡๏ธ Join the Discord.

Live Chat on Discord

To say "thanks!" โ˜๏ธ Join the Discord or ๐Ÿ‘‡๏ธ send money.

Sponsor galtzo-floss/undrive_google on Open Source Collective ๐Ÿ’Œ Sponsor me on GitHub Sponsors ๐Ÿ’Œ Sponsor me on Liberapay ๐Ÿ’Œ Donate on PayPal

Please give the project a star โญ โ™ฅ.

Thanks for RTFM. โ˜บ๏ธ