undrive_google 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58c9336e4f2abce68e28de0d2d80f14470d309df90c5f786366745d3304975fd
-  data.tar.gz: 77071946f610d79e96346eacdb8c13998c744efe50b31f403241f680e74e6378
+  metadata.gz: 21db54609693c71de63f96619b5fa2d00b19d3bd1cd5ebe6c361b462c01159f6
+  data.tar.gz: a61c20ce99a83bdf0c73d982e8c91b6d9e8382e1047597e14872ee62a939c7bc
 SHA512:
-  metadata.gz: 12bc586b4099a125a19d82c258256f915ca69ddd125c5ceaf7b1949d660398e68dd7897c9e01af0541d0b158d18033727ccb414760a45f33ad6fe86c2cc3a411
-  data.tar.gz: a387a190061ef9f4df3d29e2a3aea5a116fafa0342c32972bcde91f4b4b3ccd13294139a9196e578d91b8288448cd5650ec40e663d0aef918af5ed6313414df4
+  metadata.gz: 6b127a2fbe3f90aac9aa13f97ef67a247f852cfc4bb141e103aa693833b3e5b71045f77661f0e4c663379dc5be0563e21bfdca9d37cfc808071c48f218238ec5
+  data.tar.gz: 211717e95caded549e29b6d89316abc1b32ee5ead71ebfd18b534a3c0b1c8b06bb3305e17f787e6284f7a957f42dde0a4ea7610540c35f22ef733b822d06af4f

data/CHANGELOG.md

@@ -10,8 +10,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
+## 1.1.0 - 2022-11-29
+### Added
+- Integration test for unzip transformation with complex zip file (Peter's Resume!)
+### Changed
+- rename_proc now defaults to `nil` (meaning not renaming)
+  - Set it you need files renamed according to a pattern
+### Fixed
+- Support HTML zip archives that have assets (e.g. /images/*)
+
+## 1.0.3 - 2022-11-01
+### Added
+- Support for sweep option
+### Fixed
+- Documentation for how to use CLI (with config file, Gemfile, etc. See README)
+
 ## 1.0.2 - 2022-10-27
-###
+### Fixed
 - Fixed typo in warning when wrong version of google_drive is loaded
 
 ## 1.0.1 - 2022-10-27

data/README.md

@@ -33,12 +33,52 @@ Therefore, if you need to unzip to HTML add another line to the `Gemfile` from a
 gem "rubyzip", github: "rubyzip/rubyzip", branch: "master"
 ```
 
-When liberating your files, ensure the script will use the Gemfile:
+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:
 ```shell
 BUNDLE_GEMFILE=path/to/Gemfile bundle update
-BUNDLE_GEMFILE=path/to/Gemfile undrive_google -c path/to/config
+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:
+```shell
+bundle exec undrive_google
+```
+
+My complete `Gemfile` looks like this:
+```ruby
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+git_source(:gitlab) { |repo_name| "https://gitlab.com/#{repo_name}" }
+
+gem "undrive_google", "~> 1.0.3"
+
+# See: https://github.com/gimite/google-drive-ruby/pull/427
+gem "google_drive", github: "pboling/google-drive-ruby", branch: "pboling-epub-mimetype"
+
+# See: https://github.com/rubyzip/rubyzip#updating-to-version-30
+gem "rubyzip", github: "rubyzip/rubyzip", branch: "master"
 ```
 
+My `undrive_google.yml` config file looks like this (sanitized a bit):
+```yaml
+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](https://railsbling.com/cv).
+
 ## Story Time
 
 Imagine Google Drive is a 🐭
@@ -145,9 +185,10 @@ keep_zip: true
 # 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])
-rename_pattern:
-  - "_"
-  - " "
+# By default, no renaming, must be specified
+# rename_pattern:
+#   - "_"
+#   - " "
 
 # [PATH]
 dir: '' # defaults to current working directory

data/exe/undrive_google

@@ -3,11 +3,7 @@
 
 DEBUG = ENV["UNDRIVE_DEBUG"] == "true"
 
-# Std-lib
-require "optparse"
-
 # Gems
-require "bundler/setup"
 require "byebug" if DEBUG
 
 # This library

data/lib/undrive_google/actions/liberate.rb

@@ -25,7 +25,7 @@ module UndriveGoogle
 
         if Options.instance.unzip
           @tr.unzip = Transformations::Unzip.new(@file_path)
-          @tr.fix_html = Transformations::FixHtml.new(@tr.unzip)
+          @tr.fix_html = Transformations::FixHtml.new(@tr.unzip) if Options.instance.lang || Options.instance.title
           @tr.rename_html = Transformations::RenameHtml.new(@tr.unzip) if Options.instance.rename[:html]
         end
 
@@ -41,8 +41,9 @@ module UndriveGoogle
       def rename
         exact_name = Options.instance.rename[extension]
         return exact_name if exact_name
+        return file.title unless Options.instance.rename_proc
 
-        Options.instance.rename_proc.call(file.title)
+        Options.instance.rename[extension] = Options.instance.rename_proc.call(file.title)
       end
 
       # The zip is an HTML file packaged in a .zip archive

data/lib/undrive_google/actions/sweep.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module UndriveGoogle
+  module Actions
+    # Empty the directory before putting liberated files into it?
+    class Sweep
+      attr_accessor :dir
+
+      def initialize
+        @dir = Options.instance.dir
+      end
+
+      def sweep!
+        return if !dir || dir.length.zero? || dir == "/"
+        return unless Dir.exist?(dir)
+        return if Dir.empty?(dir)
+
+        puts "Sweeping directory clean #{dir}" if Options.instance.verbose
+        FileUtils.rm_rf Dir.glob("#{dir}/*")
+      end
+    end
+  end
+end

data/lib/undrive_google/captive_file.rb

@@ -8,10 +8,11 @@ module UndriveGoogle
 
     # @return nil
     def liberate!
+      sweep! if Options.instance.sweep
       @exports = []
       extensions.each do |format|
         liberate = Actions::Liberate.new(format)
-        exports << liberate.file_path
+        @exports << liberate.file_path
         liberate.liberate!
       end
 
@@ -20,6 +21,11 @@ module UndriveGoogle
 
     private
 
+    def sweep!
+      sweep = Actions::Sweep.new
+      sweep.sweep!
+    end
+
     def extensions
       Options.instance.extensions
     end

data/lib/undrive_google/config_file.rb

@@ -21,6 +21,9 @@ module UndriveGoogle
           rename[key.to_sym] = @args.delete(k.to_sym)
         end
       end
+      @args[:dir] = @args[:dir].strip if key?(:dir)
+      @args[:lang] = @args[:lang].strip if key?(:lang)
+      @args[:title] = @args[:title].strip if key?(:title)
       @args[:extensions] = Helpers::Parse.extensions(@args[:extensions]) if key?(:extensions)
       rename_pattern = @args.delete(:rename_pattern)
       @args[:rename_proc] = Helpers::Parse.rename_proc(rename_pattern) if rename_pattern
@@ -48,7 +51,7 @@ module UndriveGoogle
 
     def validate(config)
       unknown = config.keys - YAML_KEYS
-      unknown.reject! { |key| key.start_with?("rename") }
+      unknown -= ALL_FILE_TYPES.map { |f| "rename_#{f}".to_sym }
       return if unknown.empty?
 
       raise UndriveGoogle::Error, "Unhandled config keys #{unknown.inspect}"

data/lib/undrive_google/helpers/parse.rb

@@ -8,13 +8,13 @@ module UndriveGoogle
 
       def extensions(val)
         if val.is_a?(Array)
-          unknown = val.map(&:to_sym) - FILE_TYPES
+          unknown = val.map(&:to_sym) - DL_FILE_TYPES
           raise UndriveGoogle::Error, "Unknown extensions: #{unknown}" if unknown.any?
 
           val
         elsif val == "all"
-          FILE_TYPES
-        elsif FILE_TYPES.include?(val.to_sym)
+          DL_FILE_TYPES
+        elsif DL_FILE_TYPES.include?(val.to_sym)
           [val]
         else
           raise UndriveGoogle::Error, "Unknown extensions: #{val}"

data/lib/undrive_google/options.rb

@@ -7,7 +7,7 @@ module UndriveGoogle
 
     attr_accessor :config_yaml, :key_file, :file_id, :file_by, :extensions, :unzip,
                   :keep_zip, :rename, :rename_proc, :lang, :title,
-                  :dir, :verbose
+                  :dir, :sweep, :verbose
 
     def initialize
       load_yaml(true)
@@ -31,6 +31,7 @@ module UndriveGoogle
       dir_option(parser)
       lang_option(parser)
       title_option(parser)
+      sweep_option(parser)
       verbose_option(parser)
 
       parser.separator ""
@@ -96,7 +97,7 @@ module UndriveGoogle
     end
 
     def rename_options(parser)
-      (FILE_TYPES + [:html]).each do |ft|
+      ALL_FILE_TYPES.each do |ft|
         parser.on("--rename-#{ft} [FILENAME]", "Rename #{ft} to FILENAME") do |rename|
           self.rename[ft] = rename
         end
@@ -109,19 +110,27 @@ module UndriveGoogle
     def dir_option(parser)
       parser.on("-d", "--dir PATH", String,
                 "Path to directory where liberated files will go") do |dir|
-        self.dir = dir
+        self.dir = dir.strip
       end
     end
 
     def lang_option(parser)
       parser.on("-l", "--lang LANG", String, 'Add lang="LANG" attribute to <html> tag of unzipped HTML') do |lang|
-        self.lang = lang
+        self.lang = lang.strip
       end
     end
 
     def title_option(parser)
       parser.on("-t", "--title TITLE", String, "Add <title>TITLE</title> element to unzipped HTML") do |title|
-        self.title = title
+        self.title = title.strip
+      end
+    end
+
+    def sweep_option(parser)
+      # Boolean switch.
+      parser.on("-s", "--[no-]sweep",
+                "Delete all files from directory specified by -d or --dir prior to liberation") do |sweep|
+        self.sweep = sweep
       end
     end
 
@@ -138,14 +147,15 @@ module UndriveGoogle
         self.key_file = KEY_FILE_PATH
         self.file_id = nil
         self.file_by = :key
-        self.extensions = FILE_TYPES # On the command line, "all" expands to FILE_TYPES
+        self.extensions = DL_FILE_TYPES # "all" expands to FILE_TYPES
         self.unzip = true
         self.keep_zip = true
         self.rename = {}
-        self.rename_proc = RENAME_PROC
+        self.rename_proc = nil
         self.title = nil
         self.dir = nil
         self.lang = "en"
+        self.sweep = false
         self.verbose = false
       end
 

data/lib/undrive_google/transformation.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module UndriveGoogle
-  class Transformation < Struct.new(:download,
-                                    :unzip,
-                                    :fix_html,
-                                    :rename_html,
-                                    :delete_zip,
-                                    keyword_init: true)
+  Transformation = Struct.new(:download,
+                              :unzip,
+                              :fix_html,
+                              :rename_html,
+                              :delete_zip,
+                              keyword_init: true) do
     def liberate!
       each(&:process)
     end

data/lib/undrive_google/transformations/fix_html.rb

@@ -17,6 +17,7 @@ module UndriveGoogle
 
       def_delegator :@unzip, :html_path
 
+      # @param unzip [UndriveGoogle::Transformations::Unzip]
       def initialize(unzip)
         @unzip = unzip
         @lang = Options.instance.lang
@@ -25,20 +26,29 @@ module UndriveGoogle
 
       # @return nil
       def process
-        return unless lang || title
+        return unless lang_valid? || title_valid?
+        raise UndriveGoogle::Error, "No file at #{html_path}" unless File.exist?(html_path)
 
         puts "Checking html in #{html_path}" if Options.instance.verbose
         file = File.open(html_path)
         html = file.read
-        return unless html
+        return unless html.length >= 12 # open & close <html> or <head> is at least 12 chars
 
         puts "Fixing html in #{html_path}" if Options.instance.verbose
-        html.sub!("<html>", "<html lang=\"#{lang}\">") if lang
-        html.sub!("<head>", "<head><title>#{title}</title>") if title
+        html.sub!("<html>", "<html lang=\"#{lang}\">") if lang_valid?
+        html.sub!("<head>", "<head><title>#{title}</title>") if title_valid?
         File.write(html_path, html)
 
         nil
       end
+
+      def lang_valid?
+        lang && lang.length >= 2
+      end
+
+      def title_valid?
+        title && title.length >= 1
+      end
     end
   end
 end

data/lib/undrive_google/transformations/rename_html.rb

@@ -10,6 +10,7 @@ module UndriveGoogle
 
       def_delegator :@unzip, :html_path
 
+      # @param unzip [UndriveGoogle::Transformations::Unzip]
       def initialize(unzip)
         @unzip = unzip
       end

data/lib/undrive_google/transformations/unzip.rb

@@ -4,10 +4,11 @@ module UndriveGoogle
   module Transformations
     # Download a particular version of the file.
     class Unzip
-      attr_accessor :file_path, :html_path
+      attr_accessor :file_path, :html_path, :destination
 
-      def initialize(file_path)
+      def initialize(file_path, destination = nil)
         @file_path = file_path
+        @destination = destination || File.dirname(file_path)
       end
 
       # @return nil
@@ -23,16 +24,11 @@ module UndriveGoogle
 
       private
 
-      def destination
-        File.dirname(file_path)
-      end
-
       def extract_zip(file, destination)
-        FileUtils.mkdir_p(destination)
-
         Zip::File.open(file) do |zip_file|
           zip_file.each do |f|
             @html_path = File.join(destination, f.name)
+            FileUtils.mkdir_p(File.dirname(@html_path))
             zip_file.extract(f, @html_path) unless File.exist?(@html_path)
           end
         end

data/lib/undrive_google/version.rb

@@ -2,6 +2,6 @@
 
 module UndriveGoogle
   module Version
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
   end
 end

data/lib/undrive_google.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 # Std-lib
-require "psych" # The Ruby YAML library
+require "fileutils" # The Ruy File Utilities Library
 require "forwardable" # The Ruby Delegation library
+require "optparse" # The Ruby CLI Options Parsing library
+require "psych" # The Ruby YAML library
 require "singleton" # The Ruby Singleton library
 
 # third party gems
@@ -13,13 +15,16 @@ rescue LoadError
 end
 require "version_gem"
 require "google_drive"
-gd_fixed = GoogleDrive::Util::EXT_TO_CONTENT_TYPE.key?('.epub')
-warn "[WARN] Your version of google_drive does not support .epub. If you need .epub support see: https://sr.ht/~galtzo/undrive_google/#note-export-epub-amp-unzip-html" unless gd_fixed
+HAS_EPUB = GoogleDrive::Util::EXT_TO_CONTENT_TYPE.key?(".epub")
+unless HAS_EPUB
+  warn "[WARN] Your version of google_drive does not support .epub. If you need .epub support see: https://sr.ht/~galtzo/undrive_google/#note-export-epub-amp-unzip-html"
+end
 
 require_relative "undrive_google/version"
 
 require_relative "undrive_google/helpers/parse"
 require_relative "undrive_google/actions/liberate"
+require_relative "undrive_google/actions/sweep"
 require_relative "undrive_google/transformations/delete_zip"
 require_relative "undrive_google/transformations/download"
 require_relative "undrive_google/transformations/fix_html"
@@ -39,7 +44,15 @@ module UndriveGoogle
     title: :title,
     key: :key
   }.freeze
-  FILE_TYPES = %i[docx odt rtf pdf txt zip epub].freeze
+  # epub is conditionally in DL_FILE_TYPES depending on the google_drive gem used.
+  DL_FILE_TYPES = if HAS_EPUB
+                    %i[docx odt rtf pdf txt zip epub].freeze
+                  else
+                    %i[docx odt rtf pdf txt zip].freeze
+                  end
+  # html is not in DL_FILE_TYPES because you can't download it directly.
+  # html is downloaded as zip, and must then be unzipped.
+  ALL_FILE_TYPES = DL_FILE_TYPES + %i[html].freeze
   RENAME_PROC = ->(orig) { orig.tr(" ", "_") }
   YAML_KEYS = %i[
     key_file
@@ -52,6 +65,7 @@ module UndriveGoogle
     title
     dir
     lang
+    sweep
     verbose
   ].freeze
   CONFIG_YAML_PATH = "undrive_google.yaml"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: undrive_google
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Boling
@@ -36,7 +36,7 @@ cert_chain:
   gwGrEXGQGDZ0NIgBcmvMOqlXjkGQwQvugKycJ024z89+fz2332vdZIKTrSxJrXGk
   4/bR9A==
   -----END CERTIFICATE-----
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -117,6 +117,7 @@ files:
 - exe/undrive_google
 - lib/undrive_google.rb
 - lib/undrive_google/actions/liberate.rb
+- lib/undrive_google/actions/sweep.rb
 - lib/undrive_google/captive_file.rb
 - lib/undrive_google/cli.rb
 - lib/undrive_google/config_file.rb
@@ -138,7 +139,7 @@ metadata:
   source_code_uri: https://git.sr.ht/~galtzo/undrive_google
   changelog_uri: https://git.sr.ht/~galtzo/undrive_google
   bug_tracker_uri: https://todo.sr.ht/~galtzo/undrive_google
-  documentation_uri: https://www.rubydoc.info/gems/undrive_google/1.0.2
+  documentation_uri: https://www.rubydoc.info/gems/undrive_google/1.1.0
   wiki_uri: https://man.sr.ht/~galtzo/undrive_google/
   funding_uri: https://liberapay.com/pboling
   mailing_list_uri: https://lists.sr.ht/~galtzo/undrive_google-devel
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: "\U0001F3F4 Liberate files from your Google Drive"