paperback 0.0.3 → 0.0.5

data/sorbet/tapioca/config.yml

@@ -0,0 +1,13 @@
+gem:
+  # Add your `gem` command parameters here:
+  #
+  # exclude:
+  # - gem_name
+  # doc: true
+  # workers: 5
+dsl:
+  # Add your `dsl` command parameters here:
+  #
+  # exclude:
+  # - SomeGeneratorName
+  # workers: 5

data/sorbet/tapioca/require.rb

@@ -0,0 +1,4 @@
+# typed: true
+# frozen_string_literal: true
+
+# Add your extra requires here (`bin/tapioca require` can be used to bootstrap this list)

data/spec/functional/paperback/cli_spec.rb

@@ -0,0 +1,195 @@
+# typed: false
+# frozen_string_literal: true
+
+require 'digest/sha2'
+require 'fileutils'
+require 'tmpdir'
+
+require 'subprocess'
+
+RSpec.describe Paperback::CLI do
+  Executable = File.dirname(__FILE__) + '/../../bin/paperback'
+
+  SupportedPopplerVersions = [
+    /\A0\.86\..*\z/,
+    /\A22\.02\..*\z/,
+  ]
+
+  def get_pdftotext_version
+    output = Subprocess.check_output(
+      ['pdftotext', '-v'], stderr: Subprocess::STDOUT
+    )
+    first_line = output.lines(chomp: true)[0]
+    if first_line.nil?
+      raise Exception('Unexpected version line from pdftotext: ' + output.inspect)
+    end
+
+    parts = first_line.split(' ')
+    if parts[0] != 'pdftotext' || parts[1] != 'version'
+      raise Exception('Bad version line from pdftotext: ' + first_line.inspect)
+    end
+
+    return parts[2..].join(' ')
+  end
+
+  # pdftotext from poppler is a test dependency
+  it 'finds system pdftotext installed (test dependency)' do
+    expect(Subprocess.check_output(%w[which pdftotext])
+          ).to match(/pdftotext/)
+
+    version = get_pdftotext_version
+
+    expect(version).to match(/\A\d+\..*/)
+
+    unless SupportedPopplerVersions.any? {|regex| regex.match(version) }
+      Paperback.log.warn("#{File.basename(__FILE__)}: Unsupported poppler-utils pdftotext version #{version}, tests may fail!")
+    end
+  end
+
+  describe 'end-to-end test:' do
+    before(:each) do
+      @tmpdir = Dir.mktmpdir('paperback-rspec.')
+      @orig_cwd = Dir.pwd
+      Dir.chdir(@tmpdir)
+    end
+
+    after(:each) do
+      Dir.chdir(@orig_cwd) if @orig_cwd
+      FileUtils.rm_r(@tmpdir) if @tmpdir
+      @tmpdir = nil
+    end
+
+    it 'backs up unencrypted content correctly' do
+      secret = "The quick brown fox jumps over the lazy dog.\n"
+      sha = 'b47cc0f104b62d4c7c30bcd68fd8e67613e287dc4ad8c310ef10cbadea9c4380'
+
+      File.write('fox.txt', secret)
+
+      expect(Digest::SHA256.hexdigest(File.read('fox.txt'))).to eq(sha)
+
+      timestamp = Time.now.strftime('%F %T %z')
+
+      expected = <<-EOM
+This is a paper backup produced by `paperback`. https://github.com/ab/paperback
+
+Filename:      fox.txt
+Backed up:     #{timestamp}
+Mtime:         #{timestamp}
+Bytes:         45
+Comment:       Some comment
+SHA256:        b47cc0f104b62d4c7c30bcd68fd8e67613e287dc4ad8c310ef10cbadea9c4380
+Encrypted:     no
+
+
+ 1 of 2
+\fThis sixword text encodes 45 bytes in 6 six-word sentences. Decode with `sixword -d`.
+
+1: beak us ache sour bern lola
+2: core arc hulk slid drew due
+3: chub ends bog russ bess mast
+4: dime arm skew quit kim san
+5: coat mod hit need knew grim
+6: cave ella raft fir a act3
+
+
+This base64 text encodes 45 bytes in 61 characters. Decode with `base64 --decode`.
+
+VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4K
+
+
+ 2 of 2
+\f
+      EOM
+
+      # strip trailing newline and extra runs of spaces or newlines
+      expected = expected[0...-1].gsub(/  +/, ' ').gsub(/\n\n+/, "\n")
+
+      # create the backup file!
+      Paperback::CLI.create_backup(
+        input: 'fox.txt', output: 'fox.pdf', encrypt: false,
+        comment: 'Some comment'
+      )
+
+      # make sure we got a PDF
+      expect(File.size('fox.pdf')).to be > 2000
+      expect(File.read('fox.pdf', 20)).to start_with("%PDF-1.3\n")
+
+      # convert to text to see what's in it
+      Subprocess.check_call(%w[pdftotext -layout fox.pdf fox.pdftotext.txt])
+
+      expect(File.size('fox.pdftotext.txt')).to be > 100
+
+      # This test is likely to break given even minor changes to paperback or
+      # pdftotext, so it may not be particularly useful. However, it's nice to
+      # at least have some kind of end-to-end test.
+      converted_text = File.read('fox.pdftotext.txt')
+      converted_text_stripped = converted_text.gsub(/  +/, ' ').gsub(/\n\n+/, "\n")
+      expect(converted_text_stripped).to eq(expected)
+    end
+
+    it 'backs up encrypted content correctly' do
+      secret = 'Ey9V03Iuq/gKLH0aVf2aPTAULWydpWt6G/L+O7LJXHeK'
+      sha = '8675e6be1ae84a781b2a81c65b3300ee0611ccb3ad1e0b8e8dad5a94b6d4eef2'
+
+      File.write('2.txt', secret)
+      expect(Digest::SHA256.hexdigest(File.read('2.txt'))).to eq(sha)
+
+      # create the backup file!
+      Paperback::CLI.create_backup(
+        input: '2.txt', output: '2.pdf', encrypt: true,
+        passphrase_file: '2.passphrase.txt'
+      )
+
+      # make sure we got a PDF
+      expect(File.size('2.pdf')).to be > 2000
+      expect(File.read('2.pdf', 20)).to start_with("%PDF-1.3\n")
+
+      # make sure we got a passphrase
+      pass = File.read('2.passphrase.txt')
+      expect(pass.length).to eq 43
+      pass_sha = Digest::SHA256.hexdigest(pass)
+
+      # convert pdf to text
+      Subprocess.check_call(%w[pdftotext 2.pdf 2.pdftotext.txt])
+
+      expect(File.size('2.pdftotext.txt')).to be > 100
+
+      content = File.read('2.pdftotext.txt')
+
+      expect(content).to include('2.txt')
+      expect(content).to include(sha)
+      expect(content).to include(pass_sha[0...16])
+
+      # locate sixword content
+      expect(content).to include('This sixword text')
+      pages = content.split("\f")
+      pg2 = pages.fetch(1)
+      lines = pg2.split("\n")
+      expect(lines.fetch(0)).to start_with('This sixword text')
+
+      # pull sixword lines until blank line
+      sixword_lines = []
+      lines[1..-1].each do |line|
+        break if line.strip.empty?
+        expect(line).to match(/\A\d+: [a-z ]+[0-9]?\z/)
+        sixword_lines << line.split(':').fetch(1)
+      end
+
+      # decode sixword content
+      decoded = Sixword.decode(sixword_lines.join("\n"), padding_ok: true)
+
+      # decrypt data
+      File.write('2.sixword.gpg', decoded)
+      p = Subprocess::Process.new(
+        %w[gpg --batch --passphrase-fd 0 --decrypt 2.sixword.gpg],
+        stdin: Subprocess::PIPE, stdout: Subprocess::PIPE
+      )
+      decrypted, _ = p.communicate(pass)
+      expect(p.wait.exitstatus).to eq 0
+      expect(p.wait.success?).to eq true
+
+      expect(decrypted).to eq(secret)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require_relative '../lib/paperback'
 
 # Given that it is always loaded, you are encouraged to keep this file as

data/spec/unit/paperback_spec.rb

@@ -1,3 +1,4 @@
+# typed: false
 RSpec.describe Paperback do
   it 'should have a version number' do
     expect(Paperback::VERSION).to be_a(String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperback
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Andy Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: subprocess
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +202,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop-disables.yml"
@@ -177,6 +220,47 @@ files:
 - lib/paperback/preparer.rb
 - lib/paperback/version.rb
 - paperback.gemspec
+- sorbet/config
+- sorbet/rbi/annotations/rainbow.rbi
+- sorbet/rbi/gems/ast@2.4.2.rbi
+- sorbet/rbi/gems/chunky_png@1.4.0.rbi
+- sorbet/rbi/gems/coderay@1.1.3.rbi
+- sorbet/rbi/gems/diff-lcs@1.5.0.rbi
+- sorbet/rbi/gems/method_source@1.0.0.rbi
+- sorbet/rbi/gems/netrc@0.11.0.rbi
+- sorbet/rbi/gems/parallel@1.22.1.rbi
+- sorbet/rbi/gems/parser@3.2.0.0.rbi
+- sorbet/rbi/gems/pdf-core@0.4.0.rbi
+- sorbet/rbi/gems/prawn@1.3.0.rbi
+- sorbet/rbi/gems/pry@0.14.1.rbi
+- sorbet/rbi/gems/rainbow@3.1.1.rbi
+- sorbet/rbi/gems/rake@13.0.6.rbi
+- sorbet/rbi/gems/rbi@0.0.16.rbi
+- sorbet/rbi/gems/regexp_parser@2.6.1.rbi
+- sorbet/rbi/gems/rexml@3.2.5.rbi
+- sorbet/rbi/gems/rqrcode@0.10.1.rbi
+- sorbet/rbi/gems/rspec-core@3.12.0.rbi
+- sorbet/rbi/gems/rspec-expectations@3.12.1.rbi
+- sorbet/rbi/gems/rspec-mocks@3.12.1.rbi
+- sorbet/rbi/gems/rspec-support@3.12.0.rbi
+- sorbet/rbi/gems/rspec@3.12.0.rbi
+- sorbet/rbi/gems/rubocop-ast@1.24.1.rbi
+- sorbet/rbi/gems/rubocop@0.93.1.rbi
+- sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi
+- sorbet/rbi/gems/sixword@0.4.0.rbi
+- sorbet/rbi/gems/spoom@1.1.15.rbi
+- sorbet/rbi/gems/subprocess@1.5.6.rbi
+- sorbet/rbi/gems/tapioca@0.10.5.rbi
+- sorbet/rbi/gems/thor@1.2.1.rbi
+- sorbet/rbi/gems/ttfunk@1.4.0.rbi
+- sorbet/rbi/gems/unicode-display_width@1.8.0.rbi
+- sorbet/rbi/gems/unparser@0.6.7.rbi
+- sorbet/rbi/gems/webrick@1.7.0.rbi
+- sorbet/rbi/gems/yard-sorbet@0.8.0.rbi
+- sorbet/rbi/gems/yard@0.9.28.rbi
+- sorbet/tapioca/config.yml
+- sorbet/tapioca/require.rb
+- spec/functional/paperback/cli_spec.rb
 - spec/spec_helper.rb
 - spec/unit/paperback_spec.rb
 homepage: https://github.com/ab/paperback
@@ -191,18 +275,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Create paper backups of sensitive data
 test_files:
+- spec/functional/paperback/cli_spec.rb
 - spec/spec_helper.rb
 - spec/unit/paperback_spec.rb