invisible_ink 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c86e1e6ef511722eedcaa46277efa7967337e9261fc69c5bbf3038029fef88
-  data.tar.gz: 857ee8d11d96e89b1e27bd605c790d7a425934a0d3bed5b655890b5f81d3f7b3
+  metadata.gz: 8bd2253b21ddd6d79d6b1e604bcb55779c9293edad45856b09378dbecff481b0
+  data.tar.gz: b7e00aa59ddcba71d5e21752f2218db99cb8e93f2ec6832996c79300898675b1
 SHA512:
-  metadata.gz: a6ffcca4b895c8976506e457bf08d2616006a96656cb3fdfd01ad027f1e6a9d5866bda71af84675bd821234b5fe2466b402dbdebe6f9943d28547750147e8db6
-  data.tar.gz: 99edfecf2b9b5abde8c16c75552a5147786029ae41076cf66e2b704ee9d2098a088bf3d14a4f11735b3ad05b7fa50ca39c168d252fbfcc106b86c672aa18a839
+  metadata.gz: f11b44a64326320264eeb2f6b5114acddcf46b53fe4a97edf0fd5dea35f38c91d05fe016f788e83e5e8258bcbc84b056f9839b1bfbd1b2eb027f32aebca4f477
+  data.tar.gz: a794693278351dbd89c280c0c6013f2f11e4d1e6cc78d96911b4a128e1cc498221aefd357b71f8f20f6002df16677bb73d3a2b019f9e75521ec44bedc0fb4f75

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0 - 2023-03-19]
+
+- Proof of concept
 
 ## [0.1.0] - 2023-03-14
 

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "activesupport", "~> 7.0"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -1,15 +1,25 @@
 PATH
   remote: .
   specs:
-    invisible_ink (0.1.0)
+    invisible_ink (0.2.0)
+      activesupport (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    minitest (5.18.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
@@ -50,6 +60,8 @@ GEM
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.44.1)
       rubocop-performance (= 1.15.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
@@ -57,6 +69,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  activesupport (~> 7.0)
   invisible_ink!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,9 +1,13 @@
-# 🪄 Invisible Ink
+# 🔏 Invisible Ink
 
 Encrypt text files in your open source projects so that they can be committed to
 your repository without exposing sensitive information.
 
-## Installation
+## 📸 Demo
+
+![A demo showing how to use the Gem](.docs/demo.gif)
+
+## ✅ Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
@@ -13,11 +17,29 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install invisible_ink
 
-## Usage
 
-TODO: Write usage instructions here
+## ℹ️  Usage
+
+Once installed in your project's `Gemfile`, run `bundle exec invisible_ink
+--setup` to create an encryption key saved to `invisible_ink.key`. This will
+also update your `.gitignore` file to ensure the key is not saved to version
+control.
+
+Alternatively, you can set `ENV["INVISIBLE_INK_KEY"]` to the value of a 32
+character hash.
+
+### ⌨️ Commands
+
+```text
+Usage: invisible_ink COMMAND [options]
+    -w, --write FILE                 Encrypt a file using an encryption key and open it in the specified $EDITOR
+    -r, --read FILE                  Decrypt and display the content of an encrypted file
+    -s, --setup                      Generate an encryption key, save it to a file, and add it to .gitignore
+    -h, --help                       Display help message
+    -v, --version                    Display Gem version
+```
 
-## Development
+## 🔨 Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests. You can also run `bin/console` for an interactive
@@ -29,7 +51,7 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and the created tag, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
-## Contributing
+## 🙏 Contributing
 
 Bug reports and pull requests are welcome on GitHub at
 https://github.com/stevepolitodesign/invisible_ink. This project is intended to be a
@@ -37,12 +59,12 @@ safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [code of
 conduct](https://github.com/stevepolitodesign/invisible_ink/blob/main/CODE_OF_CONDUCT.md).
 
-## License
+## 📜 License
 
 The gem is available as open source under the terms of the [MIT
 License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## ❤️ Code of Conduct
 
 Everyone interacting in the InvisibleInk project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of

data/exe/invisible_ink

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+require_relative "../lib/invisible_ink"
+require "optparse"
+
+options = {}
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: invisible_ink COMMAND [options]"
+
+    opts.on("-w", "--write FILE", String, "Encrypt a file using an encryption key and open it in the specified $EDITOR") do |file|
+      options[:command] = "write"
+      options[:file] = file
+    end
+
+    opts.on("-r", "--read FILE", String, "Decrypt and display the content of an encrypted file") do |file|
+      options[:command] = "read"
+      options[:file] = file
+    end
+
+    opts.on("-s", "--setup", "Generate an encryption key, save it to a file, and add it to .gitignore") do
+      options[:command] = "setup"
+    end
+
+    opts.on("-h", "--help", "Display help message") do
+      puts opts
+      exit
+    end
+
+    opts.on("-v", "--version", "Display Gem version") do
+      puts InvisibleInk::VERSION
+      exit
+    end
+  end.parse!
+rescue OptionParser::MissingArgument => e
+  puts "ERROR: #{e.message}. The #{e.args.first} command requires a file argument."
+  puts ""
+  puts "EXAMPLE: invisible_ink #{e.args.first} path/to/file.txt"
+  exit 1
+end
+
+if options[:command].nil?
+  puts "Invalid command. Run 'invisible_ink --help' for a list of available commands."
+  exit 1
+end
+
+def build_encrypted_file(file_path)
+  ActiveSupport::EncryptedFile.new(
+    content_path: file_path,
+    key_path: "invisible_ink.key",
+    env_key: "INVISIBLE_INK_KEY",
+    raise_if_missing_key: true
+  )
+end
+
+def handle_missing_key_error(error)
+  puts "ERROR: #{error}"
+  puts ""
+  puts "Did you run 'invisible_ink setup'?"
+end
+
+case options[:command]
+when "write"
+  file_path = options[:file]
+  if ENV["EDITOR"].to_s.empty?
+    puts "No $EDITOR to open file in. Assign one like this:"
+    puts ""
+    puts %(EDITOR="mate --wait" exe/invisible_ink write #{file_path})
+    puts ""
+    puts "For editors that fork and exit immediately, it's important to pass a wait flag;"
+    puts "otherwise, the file will be saved immediately with no chance to edit."
+    exit 1
+  end
+  begin
+    dir_path = File.dirname(file_path)
+    FileUtils.mkdir_p(dir_path)
+
+    encrypted_file = build_encrypted_file(file_path)
+    encrypted_file.write(nil) unless File.exist?(file_path)
+
+    encrypted_file.change do |tmp_path|
+      system(*Shellwords.split(ENV["EDITOR"]), tmp_path.to_s)
+    rescue Interrupt
+      puts "File not saved"
+    end
+  rescue ActiveSupport::EncryptedFile::MissingKeyError => error
+    handle_missing_key_error(error)
+    exit 1
+  end
+when "read"
+  begin
+    encrypted_file = build_encrypted_file(options[:file])
+    puts encrypted_file.read
+  rescue ActiveSupport::EncryptedFile::MissingKeyError => error
+    handle_missing_key_error(error)
+    exit 1
+  end
+when "setup"
+  if File.exist?("invisible_ink.key")
+    puts "ERROR: invisible_ink.key already exists"
+    exit 1
+  else
+    ignore_key = if File.exist?(".gitignore") && !File.read(".gitignore").empty?
+      "\ninvisible_ink.key"
+    else
+      "invisible_ink.key"
+    end
+    File.open(".gitignore", "a") { |file| file.puts(ignore_key) }
+    key = ActiveSupport::EncryptedFile.generate_key
+    File.write("invisible_ink.key", key)
+    puts "invisible_ink.key generated"
+  end
+end

data/invisible_ink.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "activesupport", "~> 7.0"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/invisible_ink/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InvisibleInk
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/invisible_ink.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "invisible_ink/version"
+require "active_support/encrypted_file"
+require "securerandom"
+require "shellwords"
 
 module InvisibleInk
   class Error < StandardError; end

metadata

@@ -1,23 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: invisible_ink
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Polito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
-dependencies: []
+date: 2023-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: Encrypt text files in your open source projects so that they can be committed
   to your repository without exposing sensitive information.
 email:
 - stevepolito@hey.com
-executables: []
+executables:
+- invisible_ink
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docs/demo.gif"
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
@@ -27,6 +43,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/invisible_ink
 - invisible_ink.gemspec
 - lib/invisible_ink.rb
 - lib/invisible_ink/version.rb