secret_keys 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d291d004402b3197d72a0210d4586770c7f63e9f1baf70dfb14c5d6d848b52a5
-  data.tar.gz: bbd6e6d3f8e625a31a0502c5099004e9ebbe278d21c39f674ed8a4d0d4c822b5
+  metadata.gz: 637787c84aaeb9fc38f77ac00f67f38ee4094b0a42ac5fe714a9c10285c65ed7
+  data.tar.gz: c57ed55617d13bee4d988d9c0283fff89534ccddd7980f8fa1afe81b5b7b61a4
 SHA512:
-  metadata.gz: 1d1dae102dd23919a34187b5d6c1c89c8722635aa3937c56777b9dca19cf6a8a765b291bb3c33c792d4c258dc44eb9cf2aa858559171cacc716e73da8d29b24e
-  data.tar.gz: 527a4ab4a67eb63424dae4a284fe9a398efe2d98cf405184eaacfcfbd4f51140d0ffcf389ee35fa3d31202e14aab85ea88df886b3e782f933414fd6ae3de5cd0
+  metadata.gz: bfb75203d78bfe74c6c394175cd08a775f3f9415d206f60df941c77ab38c74413cf4e2854a2af3c0208e1e580d0dc3e35f70fd2b59c1d7cd4a7d215a53441efd
+  data.tar.gz: b9b1e6ee2be772b78fe9da0ed4768455ce6249e12ff37b6328b9bc197c4ded8638764810a1a23ffcc1820bcfb696f0ed3723b61cdb6af116723e0030068f988a

data/CHANGE_LOG.md

@@ -1,3 +1,22 @@
-# 1.0.0
+# Changelog
 
-Initial release
+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).
+
+## [1.0.2] - 2023-04-04
+
+- Follow [RFC 4648](https://www.ietf.org/rfc/rfc4648.txt) base 64 encoding, removing line-feeds from the encoded data.
+
+## [1.0.1] - 2020-06-01
+
+### Fixed
+
+- Fix missing documentation links
+
+## [1.0.0] 2020-05-31
+
+### Added
+
+- Initial release

data/README.md

@@ -73,6 +73,8 @@ Note that since the hash must be serialized to JSON, only JSON compatible keys a
 }
 ```
 
+This gem is documented using yard. More specific documentation can be found on [rubydoc.info](https://www.rubydoc.info/gems/secret_keys).
+
 ## Command Line Tool
 
 You can use the `secret_keys` command line tool to manage your JSON files.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.2

data/lib/secret_keys/cli.rb

@@ -3,7 +3,7 @@
 require "optparse"
 require "io/console"
 
-require_relative "../secret_keys.rb"
+require_relative "../secret_keys"
 
 module SecretKeys::CLI
   class Base
@@ -47,7 +47,7 @@ module SecretKeys::CLI
 
     def encrypted_file_contents
       encrypted = secrets.encrypted_hash
-      string = (format == :yaml ? YAML.dump(encrypted) : JSON.pretty_generate(encrypted))
+      string = ((format == :yaml) ? YAML.dump(encrypted) : JSON.pretty_generate(encrypted))
       string << $/ unless string.end_with?($/) # ensure file ends with system dependent new line
       string
     end
@@ -166,8 +166,8 @@ module SecretKeys::CLI
       @secrets = SecretKeys.new({}, secret_key)
       if input.is_a?(String)
         if File.exist?(input)
-          STDERR.puts "Error: Cannot init preexisting file '#{input}'"
-          STDERR.puts "You may want to try calling `secret_keys encrypt/edit` instead"
+          warn "Error: Cannot init preexisting file '#{input}'"
+          warn "You may want to try calling `secret_keys encrypt/edit` instead"
           exit 1
         end
 
@@ -220,9 +220,7 @@ module SecretKeys::CLI
         raise ArgumentError, "Cannot perform in place editing on streams" unless @input.is_a?(String)
         # make sure we read the file **before** writing to it.
         contents = encrypted_file_contents
-        File.open(@input, "w") do |file|
-          file.write(contents)
-        end
+        File.write(@input, contents)
       else
         $stdout.write(encrypted_file_contents)
         $stdout.flush
@@ -237,7 +235,7 @@ module SecretKeys::CLI
 
     def run!
       decrypted = secrets.to_h
-      string = (format == :yaml ? YAML.dump(decrypted) : JSON.pretty_generate(decrypted))
+      string = ((format == :yaml) ? YAML.dump(decrypted) : JSON.pretty_generate(decrypted))
       string << $/ unless string.end_with?($/) # ensure file ends with system dependent new line
       $stdout.write(string)
       $stdout.flush

data/lib/secret_keys/encryptor.rb

@@ -2,7 +2,6 @@
 
 require "securerandom"
 require "openssl"
-require "base64"
 
 # Encyption helper for encrypting and decrypting values using AES-256-GCM and returning
 # as Base64 encoded strings. The encrypted values also include a prefix that can be used
@@ -138,13 +137,13 @@ class SecretKeys::Encryptor
   # Receive a cipher object (initialized with key) and data
   def encode_aes(params)
     encoded = params.values.pack(ENCODING_FORMAT)
-    # encode base64 and get rid of trailing newline and unnecessary =
-    Base64.encode64(encoded).chomp.tr("=", "")
+    # encode base64 and get rid of unnecessary '=' padding
+    [encoded].pack("m0").tr("=", "")
   end
 
   # Passed in an aes encoded string and returns a cipher object
   def decode_aes(str)
-    unpacked_data = Base64.decode64(str).unpack(ENCODING_FORMAT)
+    unpacked_data = str.unpack1("m").unpack(ENCODING_FORMAT)
     # Splat the data array apart
     # nonce, auth_tag, encrypted_data = unpacked_data
     CipherParams.new(*unpacked_data)

data/lib/secret_keys.rb

@@ -44,7 +44,7 @@ class SecretKeys < DelegateClass(Hash)
   def to_h
     @values
   end
-  alias to_hash to_h
+  alias_method :to_hash, :to_h
 
   # Mark the key as being encrypted when the JSON is saved.
   #
@@ -94,11 +94,9 @@ class SecretKeys < DelegateClass(Hash)
     format ||= @format
     format = format.to_s.downcase
 
-    output = (format == "yaml" ? YAML.dump(encrypted) : JSON.pretty_generate(encrypted))
+    output = ((format == "yaml") ? YAML.dump(encrypted) : JSON.pretty_generate(encrypted))
     output << $/ unless output.end_with?($/) # ensure file ends with system dependent new line
-    File.open(path, "w") do |file|
-      file.write(output)
-    end
+    File.write(path, output)
     nil
   end
 

data/secret_keys.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/bdurand/secret_keys/tree/v#{spec.version}"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/secret_keys"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: secret_keys
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Brian Durand
 - Winston Durand
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 - me@winstondurand.com
@@ -49,8 +49,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/bdurand/secret_keys
-  source_code_uri: https://github.com/bdurand/secret_keys/tree/v1.0.0
-post_install_message: 
+  source_code_uri: https://github.com/bdurand/secret_keys/tree/v1.0.2
+  documentation_uri: https://www.rubydoc.info/gems/secret_keys
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Simple mechanism for loading JSON file with encrypted values.
 test_files: []