diffcrypt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd41bfcd4f86767e1d8b98d4c161c38983962e273a6e5b486c0f6465f159d80
-  data.tar.gz: fecb2bda4f1f7cbd53fea2fd333f723bd3c1ac9e8c206930c6783795a6260d10
+  metadata.gz: 6055430f063cb4f1c161ca44b65e2d3a0a15d134546152c2e9e0b39486737f08
+  data.tar.gz: 4332842bbef701c1b775e1de410391f07e5bf477318727e0412afb29d0ba00a5
 SHA512:
-  metadata.gz: 7fe1aedc3eec0f98370479a8a813e15a9458213e70d49345ae90234cead04e47b880a602af54ff8d43a1a6e4d54e7bef4a2955eb3f88fde68762bb08de16a555
-  data.tar.gz: 6a020043e24b13d22414de6f810bde69bb578adc0041d34e33c8f3d220d68903ed8b3726bc7302138fbdc00ebfe8c2e7a59bca4e776519a3d898fc4cd4d51845
+  metadata.gz: 5d9b0a443e3d2521ba45385a57522d289fad5c9fa88707e5d6272ac0b23dcc4ee8dee9fc6c1831794468399917dccf95747ab0ac5c391c40ebcb991bbc7ebb22
+  data.tar.gz: '038974890091043cec270fb775b94705522445c1185fe07856d5558cbb970d96cfc86dfedfba8081f83a6ccc593e863b32df08f59a3916dc0a1c6e1fa4ceaf45'

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+## [0.3.0] - 2020-06-30
+
+## Added
+
+- CLI: Use diffcrypt from command line of any project without requiring ruby integration
+- CLI: `diffcrypt encrypt` Directly encrypt any file and output the contents
+- CLI: `diffcrypt decrypt` Directly decrypt any file and output the contents
+
+
+
+## [0.2.0] - 2020-06-28
+
+### Added
+
+- Store client, cipher and checksum in file metadata
+
+### Fixed
+
+- Only attenpt to decrypt original content if it exists
+
+
+
+## [0.1.1] - 2020-06-28
+
+### Fixed
+
+- Converting rails native credentials files would fail on first run
+
+
+
+## [0.1.0] - 2020-06-28
+
+### Added
+
+- First release!
+- Rails support via monkey patch

data/README.md

@@ -1,5 +1,9 @@
 # Diffcrypt
 
+[![Gem Version](https://badge.fury.io/rb/diffcrypt.svg)](https://rubygems.org/gems/diffcrypt)
+[![CircleCI](https://circleci.com/gh/marcqualie/diffcrypt.svg?style=svg)](https://circleci.com/gh/marcqualie/diffcrypt)
+
+
 Diffable encrypted files that you can safely commit into your repo.
 
 
@@ -16,7 +20,7 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it globally (to use the CLI from any project):
 
     $ gem install diffcrypt
 
@@ -24,8 +28,24 @@ Or install it yourself as:
 
 ## Usage
 
+There are a few ways to use the library, depending on how advanced your use case is.
+
 
-### Encrypt existing file
+### CLI
+
+The easiest way to get started is to use the CLI.
+
+```shell
+diffcrypt decrypt -k $(cat test/fixtures/master.key) test/fixtures/example.yml.enc
+diffcrypt encrypt -k $(cat test/fixtures/master.key) test/fixtures/example.yml
+```
+
+
+### Ruby
+
+A direct API is exposed so `Diffcrypt::Encryptor` can be used in any ruby project.
+
+**NOTE:** This API may change any time until v1.0
 
 ```ruby
 encryptor = Diffcrypt::Encryptor.new('99e1f86b9e61f24c56ff4108dd415091')
@@ -34,18 +54,16 @@ encrypted = encryptor.encrypt(yaml)
 File.write('tmp/example.yml.enc', encrypted)
 ```
 
-### Decrypt a file
-
 ```ruby
 encryptor = Diffcrypt::Encryptor.new('99e1f86b9e61f24c56ff4108dd415091')
 yaml = File.read('test/fixtures/example.yml.enc')
 config = YAML.safe_load(encryptor.decrypt(yaml))
 ```
 
-### Rails
+### Ruby on Rails
 
 Currently there is not native support for rails, but ActiveSupport can be monkeypatched to override
-the built in encrypter.
+the built in encrypter. All existing `rails credentials:edit` also work with this method.
 
 ```ruby
 require 'diffcrypt/rails/encrypted_configuration'

data/bin/diffcrypt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+
+require_relative '../lib/diffcrypt/cli'
+
+Diffcrypt::CLI.start(ARGV)

data/diffcrypt.gemspec

@@ -25,9 +25,10 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'bin'
+  spec.executables = %w[diffcrypt]
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '~> 6.0.0'
+  spec.add_runtime_dependency 'thor', '~> 1.0.1'
 end

data/lib/diffcrypt/cli.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative './encryptor'
+require_relative './version'
+
+module Diffcrypt
+  class CLI < Thor
+    desc 'decrypt <path>', 'Decrypt a file'
+    method_option :key, aliases: %i[k], required: true
+    def decrypt(path)
+      ensure_file_exists(path)
+      contents = File.read(path)
+      puts encryptor.decrypt(contents)
+    end
+
+    desc 'encrypt <path>', 'Encrypt a file'
+    method_option :key, aliases: %i[k], required: true
+    def encrypt(path)
+      ensure_file_exists(path)
+      contents = File.read(path)
+      puts encryptor.encrypt(contents)
+    end
+
+    desc 'version', 'Show client version'
+    def version
+      say Diffcrypt::VERSION
+    end
+
+    no_commands do
+      def key
+        options[:key]
+      end
+
+      def encryptor
+        @encryptor ||= Encryptor.new(key)
+      end
+
+      def ensure_file_exists(path)
+        abort('[ERROR] File does not exist') unless File.exist?(path)
+      end
+    end
+  end
+end

data/lib/diffcrypt/encryptor.rb

@@ -8,6 +8,8 @@ require 'yaml'
 
 require 'active_support/message_encryptor'
 
+require_relative './version'
+
 module Diffcrypt
   class Encryptor
     CIPHER = 'aes-128-gcm'

data/lib/diffcrypt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diffcrypt
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffcrypt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Qualie
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,11 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Diffable encrypted configuration files that can be safely committed into
   a git repository
 email:
 - marc@marcqualie.com
-executables: []
+executables:
+- diffcrypt
 extensions: []
 extra_rdoc_files: []
 files:
@@ -36,14 +51,17 @@ files:
 - ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/diffcrypt
 - bin/setup
 - diffcrypt.gemspec
 - lib/diffcrypt.rb
+- lib/diffcrypt/cli.rb
 - lib/diffcrypt/encryptor.rb
 - lib/diffcrypt/rails/encrypted_configuration.rb
 - lib/diffcrypt/version.rb