helpema 3.0.210706 → 3.1.210909

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295a6ea0d195e0b52b4f0960d946e87975cbf73059c93e08c54b2aa797e4e17c
-  data.tar.gz: 65ee413650aaff19864215e8fe95f29f5aa0e898510b13ee436d737aacd535c1
+  metadata.gz: 06db87416d69a4ed736c20927d8f9d3c379d7654cbd3e85f57e6e44a5571098e
+  data.tar.gz: e0f8202e576a5ba7d7fb30ec1b045bc8da3bf1c696bf98874b30c032820e45a8
 SHA512:
-  metadata.gz: adbb195324d7f68fd7bb7033cbef3f9a925c7fe9866c834862779fdb9e306b4ecb4967aa2ad31cacad639b45a6555203c9bae7a049dadf552231b39efd43fdc1
-  data.tar.gz: 43d34fde681cdcbe0a2dbf4927402fd92c63eaae10d69a40894610fcea3b20c28622790829f585f22bbf9349206c62be4e344deb62bd76c72436cb55fe97759e
+  metadata.gz: 0e59e80e64f0c88ac0a0948ff773b9238f7334939231d70c70aec105217962cc4e3e68276b29013cb4e22eec57e392031b2f927c690d29d35999ca236860b1ee
+  data.tar.gz: aaddb40d73e6d372d50ff61244232dbc998076806dcc3903fefd1c46647e3f739bfd9b0b0d6d29ab4b56c8bfb0411d2314bee2505ceae11c90ffeb717b2cf781

data/README.md

@@ -1,6 +1,6 @@
 # Helpema
 
-* [VERSION 3.0.210706](https://github.com/carlosjhr64/helpema/releases)
+* [VERSION 3.1.210909](https://github.com/carlosjhr64/helpema/releases)
 * [github](https://github.com/carlosjhr64/helpema)
 * [rubygems](https://rubygems.org/gems/helpema)
 
@@ -12,7 +12,7 @@ Featured method: `requires "good ~>3.0", "bad ~>2.7", "ugly ~>1.8"`
 
 ## INSTALL:
 
-```shell
+```console
 $ gem install helpema
 ```
 
@@ -30,7 +30,7 @@ using Helpema
 # that annoyingly keep falling out of maintainance... right?
 requires'
 ruby          ~>3.0
-helpema       ~>3.0
+helpema       ~>3.1
 base_convert  ~>4.0
 entropia      ~>0.1'
 #=> ["base_convert", "entropia"]
@@ -61,7 +61,12 @@ to_arg :geo=, '10x20'       #=> "--geo=10x20"
 to_arg :arg0, 'Hello World' #=> "Hello World"
 
 ### Hash#to_args ###
-{q: true, quiet: true, verbose: false, f: '/path-to/file', :geo= => '10x20', arg0: 'Hello World'}.to_args
+{ q:       true,
+  quiet:   true,
+	verbose: false,
+	f:       '/path-to/file',
+	:geo= => '10x20',
+  arg0:    'Hello World' }.to_args
 #=> ["-q", "--quiet", "-f", "/path-to/file", "--geo=10x20", "Hello World"]
 
 ### Array#classify ###
@@ -76,7 +81,8 @@ SSSS.split(secret: "Top Secret!", threshold: 2, shares: 3)
 
 #### SSSS.combine ###
 # Pregenerated splits combine to reproduce the secret.
-SSSS.combine(secrets: ["3-055562917c41e68c6ab2c8", "1-27bf3cbfe8d2c25c7e8928"], threshold: 2)
+SSSS.combine(secrets: ["3-055562917c41e68c6ab2c8", "1-27bf3cbfe8d2c25c7e8928"],
+             threshold: 2)
 #=> "Top Secret!"
 
 ### YouTubeDL.json ###
@@ -95,7 +101,34 @@ string_or_nil = ZBar.screen
 ### ZBar.cam ###
 # Reads qrcodes from camera.
 # You may want to wrap this one in a Timeout block.
-string = ZBar.cam
+#     string = ZBar.cam
+
+### GPG Symmetric ###
+## String to String
+encrypted = GPG.encrypt(passphrase: '<Secret>', string: '<Plain Text>')
+decrypted = GPG.decrypt(passphrase: '<Secret>', string: encrypted)
+#=> "<Plain Text>"
+## File to File
+# Got a text file...
+`md5sum tmp/text.txt` #~> ^d27b3111fdeb72f2862909c216214bc1
+# gpg wont overwrite, so need to remove existing...
+File.exist?(_='tmp/text.enc') and File.unlink(_)
+File.exist?(_='tmp/text.dec') and File.unlink(_)
+# Encrypt text file...
+GPG.encrypt(passphrase: '<Secret>', input: 'tmp/text.txt', output: 'tmp/text.enc') #=> ""
+# Decrypt encrypted file...
+GPG.decrypt(passphrase: '<Secret>', input: 'tmp/text.enc', output: 'tmp/text.dec') #=> ""
+# Decrypted file should match...
+`md5sum tmp/text.dec` #~> ^d27b3111fdeb72f2862909c216214bc1
+## IO to IO
+require 'stringio'
+pio = StringIO.new '<Plain>'
+eio = StringIO.new ''
+dio = StringIO.new ''
+GPG.encrypt(passphrase: '<Secret>', ioin: pio, ioout: eio)
+eio.rewind
+GPG.decrypt(passphrase: '<Secret>', ioin: eio, ioout: dio)
+dio.string #=> "<Plain>"
 ```
 
 ## TROUBLESHOOTING:
@@ -110,7 +143,7 @@ More documentation
 
 (The MIT License)
 
-Copyright (c) 2021 carlosjhr64
+Copyright (c) 2021 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/helpema/gpg.rb

@@ -0,0 +1,86 @@
+module Helpema
+  module GPG
+    extend Helpema
+    class << self; attr_accessor :version; end
+    GPG.version = '^gpg \\(GnuPG\\) 2\.[234]\.' # version as of this writing is 2.2.27
+
+    GPG.define_command(:cryptor,
+      cmd: 'gpg', version: GPG.version,
+      usage: {
+        quiet: true,
+        batch: true,
+        'passphrase-fd': 0,
+        output: nil,
+        symmetric: nil,
+        decrypt: nil,
+        arg0: nil,
+      },
+      synonyms: {
+        input: :arg0,
+      },
+      mode: 'w+',
+      exception: 'gpg failed'
+    ) do |pipe, options, blk|
+      passphrase, string, ioin, ioout =
+        options.fetch_values(:passphrase, :string, :ioin, :ioout)
+      pipe.puts passphrase
+      Thread.new do
+        if string
+          pipe.write string
+        elsif ioin
+          while c = ioin.getbyte
+            pipe.putc c
+          end
+        end
+        pipe.close_write
+      end
+      if ioout
+        while c = pipe.getbyte
+          ioout.putc c
+        end
+      else
+        pipe.read
+      end
+    end
+
+    def encrypt(passphrase:,
+                string:nil,
+                output:nil,
+                input:nil,
+                ioin:nil,
+                ioout:nil)
+      unless [string,input,ioin].count{_1} == 1
+        raise "Need only one of string, input, or ioin"
+      end
+      raise "Can't have both output and ioout" if output and ioout
+      GPG.cryptor(symmetric:  true,
+                  passphrase: passphrase,
+                  string:     string,
+                  input:      input,
+                  output:     output,
+                  ioin:       ioin,
+                  ioout:      ioout)
+    end
+
+    def decrypt(passphrase:,
+                string:nil,
+                output:nil,
+                input:nil,
+                ioin:nil,
+                ioout:nil)
+      unless [string,input,ioin].count{_1} == 1
+       raise "Need only one of string, input, or ioin"
+      end
+      raise "Can't have both output and ioout" if output and ioout
+      GPG.cryptor(decrypt:    true,
+                  passphrase: passphrase,
+                  string:     string,
+                  input:      input,
+                  output:     output,
+                  ioin:       ioin,
+                  ioout:      ioout)
+    end
+
+    extend self
+  end
+end

data/lib/helpema/helpema.rb

@@ -15,7 +15,7 @@ module Helpema
       # convert key,value tuples to final list of args
       args.map!(&:to_arg)
       # get rid of nil
-      args.select!{_1}
+      args.compact!
       # ...and finally flatten!
       args.flatten!
       return args
@@ -58,7 +58,9 @@ module Helpema
     args,ret = options.to_args(usage:usage,synonyms:synonyms),nil
     $stderr.puts "#{cmd} #{args.join(' ')}" if $DEBUG
     IO.popen([cmd, *args], mode, **popt) do |pipe|
-      ret = (forward_pass)? forward_pass.call(pipe, options, blk): (blk)? blk.call(pipe): pipe.read
+      ret = forward_pass ? forward_pass.call(pipe, options, blk) :
+                     blk ? blk.call(pipe) :
+                           pipe.read
     end
     (exception.nil? or $?.exitstatus==0)? ret : raise(exception)
   end
@@ -93,10 +95,14 @@ module Helpema
         unless reqs.empty?
           case gemname
           when 'helpema'
-            raise "helpema #{VERSION} not #{reqs.join(', ')}" unless VERSION.satisfies?(*reqs)
+            unless VERSION.satisfies?(*reqs)
+              raise "helpema #{VERSION} not #{reqs.join(', ')}"
+            end
             next
           when 'ruby'
-            raise "ruby #{RUBY_VERSION} not #{reqs.join(', ')}" unless RUBY_VERSION.satisfies?(*reqs)
+            unless RUBY_VERSION.satisfies?(*reqs)
+              raise "ruby #{RUBY_VERSION} not #{reqs.join(', ')}"
+            end
             next
           else
             gem gemname, *reqs

data/lib/helpema/ssss.rb

@@ -14,9 +14,18 @@ module Helpema
       pipe.puts options.fetch(:secret)
       pipe.read.split.last(options[:shares])
     end
-    def split(secret:, threshold:, shares:, token:nil, level:nil, hexmode:false) =
-      SSSS._split(secret:secret, threshold:threshold, shares:shares, token:token, level:level, hexmode:hexmode)
-
+    def split(
+      secret:, threshold:,
+      shares:, token:nil,
+      level:nil,
+      hexmode:false
+    ) = SSSS._split(
+      secret:secret,
+      threshold:threshold,
+      shares:shares,
+      token:token,
+      level:level,
+      hexmode:hexmode)
     SSSS.define_command(:_combine,
       cmd: 'ssss-combine', v: SSSS.version,
       usage: {Q:true,t:2,x:false}, synonyms: {threshold: :t, hexmode: :x},

data/lib/helpema.rb

@@ -1,11 +1,12 @@
 module Helpema
-  VERSION = '3.0.210706'
+  VERSION = '3.1.210909'
 
   require_relative     'helpema/helpema'
 
   autoload :SSSS,      'helpema/ssss.rb'
   autoload :YouTubeDL, 'helpema/youtubedl.rb'
   autoload :ZBar,      'helpema/zbar.rb'
+  autoload :GPG,       'helpema/gpg.rb'
 end
 
 # Requires:
@@ -16,3 +17,4 @@ end
 #`zbarcam`
 #`zbarimg`
 #`gnome-screenshot`
+#`gpg`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helpema
 version: !ruby/object:Gem::Version
-  version: 3.0.210706
+  version: 3.1.210909
 platform: ruby
 authors:
-- carlosjhr64
+- CarlosJHR64
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies: []
 description: |
   Meant to be an eclectic collection of useful single functions and wrappers.
@@ -21,6 +21,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/helpema.rb
+- lib/helpema/gpg.rb
 - lib/helpema/helpema.rb
 - lib/helpema/ssss.rb
 - lib/helpema/youtubedl.rb
@@ -44,14 +45,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-linux]'
+- 'ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]'
 - 'youtube-dl: 2021.06.06'
 - 'ssss-split: 0.5'
 - 'ssss-combine: 0.5'
 - 'zbarcam: 0.23'
 - 'zbarimg: 0.23'
 - 'gnome-screenshot: gnome-screenshot 40.0'
-rubygems_version: 3.2.15
+- 'gpg: gpg (GnuPG) 2.2.27'
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Meant to be an eclectic collection of useful single functions and wrappers.