helpema 1.0.0 → 3.0.210706

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f825bd3e6b6e1b825a3a998e4571af1f0186a620
-  data.tar.gz: fc0978830f198cb1dc2876fc972d0ae7b3d04ba0
+SHA256:
+  metadata.gz: 295a6ea0d195e0b52b4f0960d946e87975cbf73059c93e08c54b2aa797e4e17c
+  data.tar.gz: 65ee413650aaff19864215e8fe95f29f5aa0e898510b13ee436d737aacd535c1
 SHA512:
-  metadata.gz: bdd8e438e980c9cb5189eb2490f72eff2033e120c0c653d5002b98afb720ef93b35c0515852b9cdaf0a495d5f0598288a6781ccbbb350bb42d720f58f96c7d39
-  data.tar.gz: 2bfd8fae64732d33d251fdb752c67f9d201e09280394c8ac713f3ee470ddef9b95f1ad0731b534f31039fca30f0a0dbd680c93e642f5a39881b7868ec7d9dcc0
+  metadata.gz: adbb195324d7f68fd7bb7033cbef3f9a925c7fe9866c834862779fdb9e306b4ecb4967aa2ad31cacad639b45a6555203c9bae7a049dadf552231b39efd43fdc1
+  data.tar.gz: 43d34fde681cdcbe0a2dbf4927402fd92c63eaae10d69a40894610fcea3b20c28622790829f585f22bbf9349206c62be4e344deb62bd76c72436cb55fe97759e

data/README.md

@@ -0,0 +1,132 @@
+# Helpema
+
+* [VERSION 3.0.210706](https://github.com/carlosjhr64/helpema/releases)
+* [github](https://github.com/carlosjhr64/helpema)
+* [rubygems](https://rubygems.org/gems/helpema)
+
+## DESCRIPTION:
+
+Meant to be an eclectic collection of useful single functions and wrappers.
+
+Featured method: `requires "good ~>3.0", "bad ~>2.7", "ugly ~>1.8"`
+
+## INSTALL:
+
+```shell
+$ gem install helpema
+```
+
+## SYNOPSIS:
+
+```ruby
+require 'helpema'
+include Helpema
+using Helpema
+
+### requires ###
+# Ensure ruby's and helpema's version.
+# Returns the list of loaded gems.
+# For those quick little scripts one writes in one's bin
+# that annoyingly keep falling out of maintainance... right?
+requires'
+ruby          ~>3.0
+helpema       ~>3.0
+base_convert  ~>4.0
+entropia      ~>0.1'
+#=> ["base_convert", "entropia"]
+
+### String#satisfies? ###
+# Uses Gem::Requirement and Gem::Version to check version strings.
+'1.2.3'.satisfies? '~>1.1' #=> true
+'1.2.3'.satisfies? '~>1.3' #=> false
+
+### run_command ###
+# Automates pipe creation to a system command.
+# See the code for all available features.
+run_command('date',{d: 'Dec 31, 2020'}) #=> "Thu Dec 31 12:00:00 AM PST 2020\n"
+
+### define_command ###
+# Creates a method out of a system command.
+# See the code for all available features.
+define_command(:date, cmd: 'date', usage: {d: nil}, synonyms: {string: :d})
+date(string: 'Dec 31, 2020') #=> "Thu Dec 31 12:00:00 AM PST 2020\n"
+
+### to_arg ###
+# A helper function to do system command calls.
+to_arg :q, true             #=> "-q"
+to_arg :quiet, true         #=> "--quiet"
+to_arg :verbose, false      #=> nil
+to_arg :f, '/path-to/file'  #=> ["-f", "/path-to/file"]
+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", "--quiet", "-f", "/path-to/file", "--geo=10x20", "Hello World"]
+
+### Array#classify ###
+# Groups items in Array by class.
+[1, 2.0, :Three, 'Four', /Five/, :Six, 'Seven'].classify
+#=> {Integer=>[1], Float=>[2.0], Symbol=>[:Three, :Six], String=>["Four", "Seven"], Regexp=>[/Five/]}
+
+### SSSS.split ####
+SSSS.split(secret: "Top Secret!", threshold: 2, shares: 3)
+#~> ^\["1-\h+", "2-\h+", "3-\h+"\]$
+# Note that the split has random outputs on the same inputs.
+
+#### SSSS.combine ###
+# Pregenerated splits combine to reproduce the secret.
+SSSS.combine(secrets: ["3-055562917c41e68c6ab2c8", "1-27bf3cbfe8d2c25c7e8928"], threshold: 2)
+#=> "Top Secret!"
+
+### YouTubeDL.json ###
+list = []
+url = 'https://www.youtube.com/watch?v=u4oK3ZSccZI'
+YouTubeDL.json(url){|json| list.push json}
+# The url was for just one video
+list.length #=> 1
+json = list[0]
+json['title'] #=> "Fortnite Easy Last Ten"
+
+### ZBar.screen ###
+# Reads qrcodes on screen.
+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
+```
+
+## TROUBLESHOOTING:
+
+Command version mismatch
+: set `Helpema::WRAPPER.version = "your.version"` or just nil it.
+
+More documentation
+: see [sig/helpema.rb](sig/helpema.rbs) for the expected method signatures.
+
+## LICENSE:
+
+(The MIT License)
+
+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
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/helpema.rb

@@ -1,15 +1,18 @@
 module Helpema
-  VERSION = '1.0.0'
-end
+  VERSION = '3.0.210706'
+
+  require_relative     'helpema/helpema'
 
-# This Gem
-require 'helpema/ssss.rb'
-require 'helpema/zbar.rb'
-require 'helpema/youtubedl.rb'
+  autoload :SSSS,      'helpema/ssss.rb'
+  autoload :YouTubeDL, 'helpema/youtubedl.rb'
+  autoload :ZBar,      'helpema/zbar.rb'
+end
 
 # Requires:
 #`ruby`
+#`youtube-dl`
 #`ssss-split`
 #`ssss-combine`
 #`zbarcam`
+#`zbarimg`
 #`gnome-screenshot`

data/lib/helpema/helpema.rb

@@ -0,0 +1,112 @@
+module Helpema
+  refine ::String do
+    def satisfies?(*reqs)
+      Gem::Requirement.new(*reqs).satisfied_by? Gem::Version.new(self)
+    end
+  end
+  refine ::Hash do
+    def to_args(usage:nil, synonyms:nil)
+      # create separate args from self with the translated synonyms
+      args = self.transform_keys(synonyms.to_h)
+      # pad usage's defaults to args
+      usage&.each{|key,default| args[key]=default unless args.has_key? key}
+      # order might be important so enforce usage
+      args = usage&.map{|k,v|[k,args[k]]} || args.to_a
+      # convert key,value tuples to final list of args
+      args.map!(&:to_arg)
+      # get rid of nil
+      args.select!{_1}
+      # ...and finally flatten!
+      args.flatten!
+      return args
+    end
+  end
+  refine ::Array do
+    def classify(hash: Hash.new{|h,k|h[k]=[]})
+      self.each{|v| hash[v.class] << v}
+      return hash
+    end
+    def to_arg
+      Helpema.to_arg(*self)
+    end
+  end
+  refine ::Symbol do
+    def to_flag
+      return nil if self[-1].match?(/\d/) # like :arg0
+      (self.length > 1)? "--#{self}": "-#{self}" # like --verbose or -V
+    end
+  end
+  using Helpema
+
+  def to_arg(key,value)
+    # keep only keys with value(no false or nil)
+    return nil unless value
+    # assume nil0/--long/-short
+    key = key.to_flag
+    if key
+      return key if value==true # a flag
+      return "#{key}#{value}" if key[-1]=='=' # joined key=value
+      return [key,value.to_s]
+    end
+    # It's a Nth arg, like arg0...
+    return value.to_s
+  end
+
+  def run_command(cmd, options={},
+    usage:nil, synonyms:nil, mode:'r',
+    exception:nil, forward_pass:nil, **popt, &blk)
+    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
+    end
+    (exception.nil? or $?.exitstatus==0)? ret : raise(exception)
+  end
+
+  def define_command(name,
+    cmd: name.to_s, version: nil, v: nil,
+    usage: nil, synonyms: nil,
+    mode: 'r',exception: nil,
+    **popt, &forward_pass)
+
+    # which version? --version or -v
+    if version and not `#{cmd} --version`.strip.match?(version)
+      raise "`#{cmd} --version` !~ #{version}"
+    end
+    if v and not `#{cmd} -v`.strip.match?(v)
+      raise "`#{cmd} -v` !~ #{v}"
+    end
+
+    define_method(name) do |**options, &blk|
+      run_command(cmd, options,
+        usage:usage, synonyms:synonyms, mode:mode,
+        exception:exception, forward_pass:forward_pass, **popt, &blk)
+    end
+  end
+
+  def requires(*list)
+    loaded = []
+    list.each do |gems|
+      gems.lines.each do |gemname_reqs|
+        gemname, *reqs = gemname_reqs.split
+        next unless gemname
+        unless reqs.empty?
+          case gemname
+          when 'helpema'
+            raise "helpema #{VERSION} not #{reqs.join(', ')}" unless VERSION.satisfies?(*reqs)
+            next
+          when 'ruby'
+            raise "ruby #{RUBY_VERSION} not #{reqs.join(', ')}" unless RUBY_VERSION.satisfies?(*reqs)
+            next
+          else
+            gem gemname, *reqs
+          end
+        end
+        require gemname and loaded.push gemname
+      end
+    end
+    return loaded
+  end
+
+  extend self
+end

data/lib/helpema/ssss.rb

@@ -1,27 +1,37 @@
-require 'open3'
-
 module Helpema
-module SSSS
+  module SSSS
+    extend Helpema
+    class << self; attr_accessor :version; end
+    SSSS.version = 'Version: 0\.[567]\b' # version as of this writing is 0.5
 
-  def self.split(pwd, t, n)
-    pwds = nil
-    Open3.popen3("ssss-split -Q -t #{t} -n #{n}") do |stdin, stdout, stderr|
-      stdin.puts pwd
-      stdin.close
-      pwds = stdout.read.strip.split
+    SSSS.define_command(:_split,
+      cmd: 'ssss-split', v: SSSS.version,
+      usage: {Q:true,t:2,n:3,w:nil,s:nil,x:false},
+      synonyms: {threshold: :t, shares: :n, token: :w,  level: :s, hexmode: :x},
+      mode: 'w+', exception: 'ssss-split failed.',
+      err: [:child, :out]
+    ) do |pipe, options, blk|
+      pipe.puts options.fetch(:secret)
+      pipe.read.split.last(options[:shares])
     end
-    return pwds
-  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 self.combine(*pwds)
-    pwd = ''
-    Open3.popen3("ssss-combine -Q -t #{pwds.length}") do |stdin, stdout, stderr|
-      pwds.each{|p| stdin.puts p}
-      stdin.close
-      pwd = stderr.read.strip.split.last
+    SSSS.define_command(:_combine,
+      cmd: 'ssss-combine', v: SSSS.version,
+      usage: {Q:true,t:2,x:false}, synonyms: {threshold: :t, hexmode: :x},
+      mode: 'w+', exception: 'ssss-combine failed.',
+      err: [:child, :out]
+    ) do |pipe, options, blk|
+      secrets,n = options.fetch_values(:secrets,:threshold)
+      secrets.first(n).each{pipe.puts _1}
+      pipe.read.lines.last.chomp
+    end
+    def combine(secrets:, threshold:, hexmode:false)
+      raise 'Need threshold number of secrets.' unless secrets.size >= threshold
+      SSSS._combine(secrets:secrets, threshold:threshold, hexmode:hexmode)
     end
-    return pwd
-  end
 
-end
+    extend self
+  end
 end

data/lib/helpema/youtubedl.rb

@@ -1,22 +1,26 @@
 require 'json'
-require 'open3'
 
 module Helpema
-module YouTubeDL
+  module YouTubeDL
+    extend Helpema
+    class << self; attr_accessor :version; end
+    YouTubeDL.version = '^202\d\.[01]\d\.[0123]\d$'
 
-  def self.json(url, pwd=nil)
-    Open3.popen2e("youtube-dl -j '#{url}'") do |i, o|
-      i.puts pwd if pwd
-      i.close
-      o.each do |line|
+    YouTubeDL.define_command(:_json,
+      cmd: 'youtube-dl', version: YouTubeDL.version,
+      usage: {j:true, arg0:nil}, synonyms: {url: :arg0},
+      err: '/dev/null'
+    ) do |pipe, options, blk|
+      pipe.each do |data|
         begin
-          yield JSON.parse line
-        rescue JSON::ParserError
-          yield line
+          data = JSON.parse data
+        ensure
+          blk.call data
         end
       end
     end
-  end
+    def json(url, &blk) = YouTubeDL._json(url:url, &blk)
 
-end
+    extend self
+  end
 end

data/lib/helpema/zbar.rb

@@ -1,43 +1,46 @@
-require 'timeout'
 require 'tmpdir'
 
 module Helpema
-module ZBar
+  module ZBar
+    extend Helpema
+    class << self; attr_accessor :version, :screenshot; end
+    ZBar.version = '^0\.2[345]\b' # version as of this writing is 0.23
+    ZBar.screenshot = ['gnome-screenshot', '-f']
 
-  def self.cam(timeout=3)
-    raw = ''
-    IO.popen('zbarcam --nodisplay --raw --prescale=800x800', 'r') do |io|
+    def snapshot(filename)
+      system(*ZBar.screenshot, filename)
+    end
+
+    ZBar.define_command(:_cam,
+                        cmd: 'zbarcam',
+                        version: ZBar.version,
+                        usage: {raw:true,quiet:true,nodisplay:true, :prescale= => '800x800'},
+                        synonyms: {prescale: :prescale=}
+    ) do |pipe, kw, blk|
       begin
-        Timeout.timeout(timeout) do
-          raw << io.gets
-          while q = io.gets
-            break if q=="\n"
-            raw << q
-          end
-          raw.strip!
-        end
-      rescue Timeout::Error
-        raw = nil
-        $stderr.puts $!
+        pipe.gets.chomp # This is the return value!
       ensure
-        Process.kill('INT', io.pid)
+        Process.kill('TERM', pipe.pid)
       end
     end
-    raw
-  end
+    def cam() = ZBar._cam()
+
+    ZBar.define_command(:_img,
+                        cmd: 'zbarimg',
+                        version: ZBar.version,
+                        usage: {q:true,raw:true,arg0:nil},
+                        synonyms: {filename: :arg0})
+    def img(filename) = ZBar._img(filename:filename)
 
-  def self.screen
-    tmpdir = Dir.tmpdir()
-    screenshot = File.join(tmpdir, "#{$$}.#{Time.now.to_f}.png")
-    raw = nil
-    begin
-      system "gnome-screenshot -f #{screenshot}"
-      raw = `zbarimg -q --raw #{screenshot}`.strip
-    ensure
-      File.unlink screenshot if File.exist? screenshot
+    def screen
+      raw = nil
+      Dir.mktmpdir do |tmpdir|
+       _ = File.join(tmpdir, "#{$$}.#{Time.now.to_f}.png")
+       raw = _ if ZBar.snapshot(_) and not (_=ZBar.img(_).chomp).empty?
+      end
+      raw
     end
-    raw
-  end
 
-end
+    extend self
+  end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: helpema
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.210706
 platform: ruby
 authors:
 - carlosjhr64
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies: []
 description: |
-  Some wrappers on the following linux commands: ssss-split, ssss-combine, zbarcam, youtube-dl -j.
+  Meant to be an eclectic collection of useful single functions and wrappers.
 
-  More later.
+  Featured method: `requires "good ~>3.0", "bad ~>2.7", "ugly ~>1.8"`
 email: carlosjhr64@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - lib/helpema.rb
+- lib/helpema/helpema.rb
 - lib/helpema/ssss.rb
 - lib/helpema/youtubedl.rb
 - lib/helpema/zbar.rb
@@ -29,10 +29,8 @@ homepage: https://github.com/carlosjhr64/helpema
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
-rdoc_options:
-- "--main"
-- README.rdoc
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -46,15 +44,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-linux]'
+- 'ruby: ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-linux]'
+- 'youtube-dl: 2021.06.06'
 - 'ssss-split: 0.5'
 - 'ssss-combine: 0.5'
-- 'zbarcam: 0.20'
-- 'gnome-screenshot: gnome-screenshot 3.22.0'
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+- 'zbarcam: 0.23'
+- 'zbarimg: 0.23'
+- 'gnome-screenshot: gnome-screenshot 40.0'
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: 'Some wrappers on the following linux commands: ssss-split, ssss-combine,
-  zbarcam, youtube-dl -j.'
+summary: Meant to be an eclectic collection of useful single functions and wrappers.
 test_files: []

data/README.rdoc

@@ -1,54 +0,0 @@
-= helpema
-
-{<img src="https://badge.fury.io/rb/helpema.svg" alt="Gem Version" />}[http://badge.fury.io/rb/helpema]
-
-== DESCRIPTION:
-
-Some wrappers on the following linux commands: ssss-split, ssss-combine, zbarcam, youtube-dl -j.
-
-More later.
-
-== SYNOPSIS:
-
-=== Helpema::SSSS.split( secret, threshold, shares)
-
-=== Helpema::SSSS.combine( *shared_secrets )
-
-=== Helpema::ZBar.cam( timeout=3 )
-
-Reads qrcodes on camera.
-
-=== Helpema::ZBar.screen
-
-Reads qrcodes on screen.
-
-=== Helpema::YouTubeDL.json( url ){|obj| ... }
-
-== INSTALL:
-
-  $ sudo gem install helpema
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2017 carlosjhr64
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.