🏴☠️ UndriveGoogle
if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the 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.
👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️
I’ve summarized my thoughts in this blog post.
🌻 Synopsis
Toolkit for:
- Liberating variously formatted files from your Google Drive
- Applying a set of transformations to liberated files
- patterned rename
- unzip
- correct HTML errors
- 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.
- Give 🐭 your 🍪 for “safe-keeping”
- Recognizing this SPoF, you ask 🐭 to give back a 🍪 copy
- “I’ll run it through my 🍪 🖨”, says 🐭
- 🖨 replicates various 🍪 extensions:
pdf,odt,docx,txt,rtf,zip, andepub - Rename 🍪 for web (e.g. replace ` ` with
_) - Extract replicated
.zipformat to.html - Rename extracted HTML file for self-hosting
- Realize 🐭’s HTML is invalid
- Fix 🐭’s broke-ass (missing
langattribute andtitleelement) - Upload 🍪 to your website (you’re on your own for this part)
- Finally Finished!
- Find mistakes 😭
- Bake a new 🍪
- 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 |
|
|---|---|
| Works with JRuby |
|
| Works with Truffle Ruby |
|
| Works with MRI Ruby 4 |
|
| Works with MRI Ruby 3 |
|
| Support & Community |
|
| Source |
|
| Documentation |
|
| Compliance |
|
| Style |
|
| Maintainer 🎖️ |
|
... 💖 |
|
Compatibility
Compatible with MRI Ruby 3.1+, JRuby, and TruffleRuby.
CI workflows and Appraisals are generated for MRI Ruby 3.1+.
This test floor is configured by ruby.test_minimum in .kettle-jem.yml and
may be higher than the gem’s runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.
The amazing test matrix is powered by the kettle-dev stack.
How kettle-dev manages complexity in tests
| Gem | Source | Role | Total downloads |
|---|---|---|---|
| appraisal2 | GitHub | multi-dependency Appraisal matrix generation | |
| appraisal2-rubocop | GitHub | RuboCop Appraisal generator integration | |
| kettle-dev | GitHub | development, release, and CI workflow tooling | |
| kettle-jem | GitHub | Appraisals & CI workflow templates | |
| kettle-soup-cover | GitHub | SimpleCov coverage policy and reporting | |
| kettle-test | GitHub | standard test runner and coverage harness | |
| rubocop-lts | GitHub | Ruby-version-aware linting | |
| turbo_tests2 | GitHub | parallel test execution |
Federated DVCS
Find this repo on federated forges (Coming soon!)
| Federated DVCS Repository | Status | Issues | PRs | Wiki | CI |
|---|---|---|---|---|---|
| 🧪 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 |
Enterprise Support
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.
- 💡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:
✨ 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
⚙️ 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.
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
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. 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
🔐 Security
See SECURITY.md.
🤝 Contributing
If you need some ideas of where to help, you could work on adding more code coverage,
check issues or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
🚀 Release Instructions
See CONTRIBUTING.md.
Code Coverage
🪇 Code of Conduct
Everyone interacting with this project’s codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .
🌈 Contributors
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/galtzo-floss/undrive_google/-/graphs/main
📌 Versioning
This library follows for its public API where practical.
For most applications, prefer 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.
Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
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 .
© Copyright
See LICENSE.md for the official copyright notice.
Copyright holders
- Copyright (c) 2022, 2025-2026 Peter H. Boling
🤑 A request for help
Maintainers have teeth and need to pay their dentists.
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
I began spending most of my time 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, use the RubyForum or Discord.
To say “thanks!” ☝️ Join the community or 👇️ send money.
Please give the project a star ⭐ ♥.
Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.
Thanks for RTFM. ☺️
| Field | Value |
|—|—|
| Package | undrive_google |
| Description | 🏴☠️ Liberate files from your Google Drive with transformations |
| Homepage | https://github.com/galtzo-floss/undrive_google |
| Source | https://github.com/galtzo-floss/undrive_google |
| License | MIT |
| Funding | https://github.com/sponsors/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/galtzo-floss, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/undrive_google, https://www.buymeacoffee.com/pboling |
