skn_utils 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2822f2d8bb83e07b5b099fe277285948dc0e687f
-  data.tar.gz: 28ae0ca8c94fbc7998ce696d3424345976588ff8
+  metadata.gz: '01339ef95f65037a1a9951185b69a8ee2fb9160c'
+  data.tar.gz: fd2bd2b6b3ae66f17b268f6f23abd2d1a8c0e69b
 SHA512:
-  metadata.gz: 951ff479251217472626d4e8c4dca4bf8e40d59be6606ecefc7ee21b9eb5150f2ff080a9edb8e02b003d2d5cc59cca194cd63a57fc8b5c19dd36a6f4fe334671
-  data.tar.gz: a7919693b23911d56a4c3411e5f8c89e62142921a507ecae61357d49e8f7a4eda5e1df65ecf0abf1516f4d3c47fead9820568d1fb2aeaf95972c83f3cfa58f36
+  metadata.gz: cb6089054a1e97e7e21d03df41c6622e253487fee45e9799217c8cff211dcb8ca63c39776e15c89876edd88e22a9a22c099a133328bb5786801a0d53ce682924
+  data.tar.gz: 288b6c71971afd3f0b84b5524d0c96ceec28b7db93a8183ea6c9e31e0a00a974b0eb11f8acbcda03f7b3d0b5160de6e244ec78b7fca13d43f75a63951765e72c

data/README.md

@@ -8,6 +8,7 @@ dependencies, to augment the development of Ruby applications.  Examples of thes
 utilities in action can be found in my related projects `SknServices`, `SknWebApp`, 
 and `SknBase`.
 
+* Most classes are standalone modules, or cleary documented, and can be copy/pasted into your project.
 *   The exchange or handoff of values between objects is addressed via the `NestedResults` 
 class which implements dot-notation and nesting over a concurrent hash: A ruby Hash can 
 use any valid ruby object as a key or value. 
@@ -31,7 +32,8 @@ classname, symbol, or string as needed
 * `ConcurrentJobs` is a feature implemented to allow concurrent/multi-threaded execution of jobs.  The included 
 companion classes focus on HTTP GET,PUT,POST, and DELETE jobs as an example of how to use the `ConcurrentJobs` feature. 
 
-All classes and modules have RSpec test coverage (90+) of their originally intended use-cases.   
+All classes and modules have RSpec test coverage (90+) of their originally intended 
+use-cases.    
 
 
 ### Available Classes
@@ -65,8 +67,19 @@ All classes and modules have RSpec test coverage (90+) of their originally inten
 * SknUtils.as_human_size()
 * SknUtils.duration(start_time=nil)
 
+### Available RSpec Helpers
+* spec/support/xml_matchers.rb
+    * expect(bundle).to have_xpath('//witnesses/witness/role')
+    * expect(bundle).to have_nodes('//witnesses/witness/role', 3)
+    * expect(bundle).to match_xpath('//lossInformation/date', "2020-01-28")
+ 
 
 ## History
+    2/3/2030 V5.7.0
+    Added
+    * RSpec XML_Matchers to spec/support folders
+    * Update ConcurrentJobs JobCommands to support HTTP Headers
+    
     2/24/2019 V5.5.0
     Added
     * ConcurrentJobs feature set  

data/lib/skn_utils/concurrent_jobs.rb

@@ -15,6 +15,8 @@ module SknUtils
 
     def call
       @blk.call
+    rescue => ex
+      SknFailure.(ex.class.name, { cause: ex.message, backtrace: ex.backtrace[0..8]})
     end
   end
 
@@ -25,6 +27,8 @@ module SknUtils
 
     def call
       @blk.value
+    rescue => ex
+      SknFailure.(ex.class.name, { cause: ex.message, backtrace: ex.backtrace[0..8]})
     end
   end
 
@@ -50,7 +54,7 @@ module SknUtils
     def self.call(command, callable)
       callable.call(command)
     rescue => ex
-      SknFailure.(ex.class.name, "#{ex.message}; #{ex.backtrace[0]}")
+      SknFailure.(ex.class.name, { cause: ex.message, backtrace: ex.backtrace[0..8]})
     end
   end
 
@@ -85,7 +89,12 @@ module SknUtils
     def render_jobs
       stime = SknUtils.duration
       merged = @workers.each_with_object([]) do |worker, acc|
-        acc.push( worker.call )
+        begin
+          res = worker.call
+          acc.push( res.nil? ? SknFailure.("Unknown", {cause: "Nil Return Value to render Jobs", backtrace: []}) : res )
+        rescue => ex
+          acc.push SknFailure.(ex.class.name, { cause: ex.message, backtrace: ex.backtrace[0..8]})
+        end
       end
       @elapsed_time_string = SknUtils.duration(stime)
       Result.new(merged)

data/lib/skn_utils/configurable.rb

@@ -59,6 +59,10 @@ module SknUtils
   # - env      =  string value from RACK_ENV
   # - registry =  SknRegistry instance
   # - logger   =  Assigned Logger instance
+  # - romDB    =  var for Rom-DB if used or Any Platform Database
+  # - metadata =  platform metadata container
+  # - userdata =  user area
+  # - metrics  =  platform metrics container
   # #with(*user_attrs, enable_root: true|false) - defaults to enable of Main Class Attrs
   # ##
   # User-Defined Attrs
@@ -131,6 +135,38 @@ module SknUtils
           def logger=(obj)
             @__logger = obj
           end
+
+          # Any Platform Database
+          def romDB
+            @__db ||= nil
+          end
+          def romDB(obj)
+            @__db = obj
+          end
+
+          # Maybe Platform Metadata
+          def metadata
+            @__metadata ||= nil
+          end
+          def metadata=(obj)
+            @__metadata = obj
+          end
+
+          # Userdata container for any use
+          def userdata
+            @__userdata ||= nil
+          end
+          def userdata=(obj)
+            @__userdata = obj
+          end
+
+          # Metrics container for any use
+          def metrics
+            @__metrics ||= nil
+          end
+          def metrics=(obj)
+            @__metrics = obj
+          end
         end
       end
 

data/lib/skn_utils/job_commands.rb

@@ -7,7 +7,7 @@ module SknUtils
   # #################################################
   #
   class CommandJSONPost
-    def self.call(options)  # {full_url:,username:,userpass:,payload:}
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
       new(options)
     end
 
@@ -20,7 +20,7 @@ module SknUtils
     end
 
     def request
-      req = Net::HTTP::Post.new(uri.path)        # Generate HTTPRequest object
+      req = @_headers.nil? ? Net::HTTP::Post.new(uri.path) : Net::HTTP::Post.new(uri.path, @_headers)        # Generate HTTPRequest object
       req.basic_auth(@_username, @_userpass) if credentials?
       req.content_type = 'application/json'
       req.body = formatted_data
@@ -32,6 +32,7 @@ module SknUtils
     def initialize(opts={})
       @_username = opts[:username]
       @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
       @_uri      = URI.parse( opts[:full_url])
       @_data     = opts[:payload]
     end
@@ -49,7 +50,7 @@ module SknUtils
   # #################################################
   #
   class CommandFORMPost
-    def self.call(options)  # {full_url:,username:,userpass:,payload:}
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
       new(options)
     end
 
@@ -62,7 +63,7 @@ module SknUtils
     end
 
     def request
-      req = Net::HTTP::Post.new(uri.path)        # Generate HTTPRequest object
+      req = @_headers.nil? ? Net::HTTP::Post.new(uri.path) : Net::HTTP::Post.new(uri.path, @_headers)        # Generate HTTPRequest object
       req.basic_auth(@_username, @_userpass) if credentials?
       req.content_type = 'application/x-www-form-urlencoded'
       req.set_form_data(formatted_data)
@@ -74,6 +75,7 @@ module SknUtils
     def initialize(opts={})
       @_username = opts[:username]
       @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
       @_uri      = URI.parse( opts[:full_url])
       @_data     = opts[:payload]
     end
@@ -91,7 +93,7 @@ module SknUtils
   # #################################################
   #
   class CommandJSONGet
-    def self.call(options)  # {full_url:,username:,userpass:}
+    def self.call(options)  # {full_url:,username:,userpass:,headers:}
       new(options)
     end
 
@@ -104,7 +106,7 @@ module SknUtils
     end
 
     def request
-      req = Net::HTTP::Get.new(uri.request_uri)
+      req = @_headers.nil? ? Net::HTTP::Get.new(uri.request_uri) : Net::HTTP::Get.new(uri.request_uri, @_headers)        # Generate HTTPRequest object
       req.basic_auth(@_username, @_userpass) if credentials?
       req
     end
@@ -114,6 +116,7 @@ module SknUtils
     def initialize(opts={})
       @_username = opts[:username]
       @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
       @_uri      = URI.parse( opts[:full_url])
     end
 
@@ -126,7 +129,7 @@ module SknUtils
   # #################################################
   #
   class CommandJSONPut
-    def self.call(options)  # {full_url:,username:,userpass:,payload:}
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
       new(options)
     end
 
@@ -139,7 +142,7 @@ module SknUtils
     end
 
     def request
-      req = Net::HTTP::Put.new(uri.path)        # Generate HTTPRequest object
+      req = @_headers.nil? ? Net::HTTP::Put.new(uri.path) : Net::HTTP::Put.new(uri.path, @_headers)        # Generate HTTPRequest object
       req.basic_auth(@_username, @_userpass) if credentials?
       req.content_type = 'application/json'
       req.body = formatted_data
@@ -151,6 +154,7 @@ module SknUtils
     def initialize(opts={})
       @_username = opts[:username]
       @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
       @_uri      = URI.parse( opts[:full_url])
       @_data     = opts[:payload]
     end
@@ -181,7 +185,7 @@ module SknUtils
     end
 
     def request
-      req = Net::HTTP::Delete.new(uri.request_uri)
+      req = @_headers.nil? ? Net::HTTP::Delete.new(uri.request_uri) : Net::HTTP::Delete.new(uri.request_uri, @_headers)        # Generate HTTPRequest object
       req.basic_auth(@_username, @_userpass) if credentials?
       req
     end
@@ -191,6 +195,7 @@ module SknUtils
     def initialize(opts={})
       @_username = opts[:username]
       @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
       @_uri      = URI.parse( opts[:full_url])
     end
 

data/lib/skn_utils/version.rb

@@ -4,7 +4,7 @@
 module SknUtils
   class Version
     MAJOR = 5
-    MINOR = 6
+    MINOR = 7
     PATCH = 0
 
     def self.to_s

data/spec/lib/skn_utils/concurrent_jobs_spec.rb

@@ -7,7 +7,7 @@ describe SknUtils::ConcurrentJobs, 'Run Multiple Jobs' do
 
   let(:commands) {
     [
-        SknUtils::CommandJSONPost.call(full_url: "http://example.com/posts", payload: {one: 1}),
+        SknUtils::CommandJSONPost.call(full_url: "http://example.com/posts", payload: {one: 1}, headers: {'my-header'=> "header-value"}),
         SknUtils::CommandFORMPost.call(full_url: "http://example.com/posts", payload: {one: 1}),
         SknUtils::CommandJSONGet.call(full_url: "http://example.com/posts/1"),
         SknUtils::CommandJSONPut.call(full_url: "http://example.com/posts", payload: {one: 1}),
@@ -199,10 +199,12 @@ describe SknUtils::ConcurrentJobs, 'Run Multiple Jobs' do
       expect(result).to be_a(SknUtils::Result)
       expect(result.success?).to be false
       expect(result.values.size).to eq(commands.size)
+      expect(result.values.last).to be_a(SknSuccess)
       expect(result.values[3].value).to eq("NameError")
-      expect(result.values[3]).to be_a(SknFailure)
-      expect(result.values[3]).to be_a(SknFailure)
-      expect(result.values[0]).to be nil
+      expect(result.values[2]).to be_a(SknFailure)
+      expect(result.values[1]).to be_a(SknFailure)
+      expect(result.values[0]).to be_a(SknFailure)
+      expect(result.values[0].value).to eq("Unknown")
     end
   end
 

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ require 'skn_utils'
 require 'rspec'
 
 require 'webmock/rspec'
+require 'support/xml_matchers'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

data/spec/support/xml_matchers.rb

@@ -0,0 +1,121 @@
+# ##
+# File: <spec>/xml_matchers.rb
+#
+# Refs: https://github.com/sparklemotion/nokogiri/wiki/Cheat-sheet
+#       https://arjanvandergaag.nl/blog/rspec-matchers.html
+#       http://blog.wolfman.com/articles/2008/1/2/xpath-matchers-for-rspec
+#       https://semaphoreci.com/community/tutorials/how-to-use-custom-rspec-matchers-to-specify-behaviour
+#
+
+# Useage
+# ----------------------------------------------------------------------
+# expect(bundle).to have_xpath('//witnesses/witness/role')
+# expect(bundle).to have_nodes('//witnesses/witness/role', 3)
+# expect(bundle).to match_xpath('//lossInformation/date', "2020-01-28")
+
+    # check if the xpath exists one or more times
+class HaveXpath
+  def initialize(xpath)
+    @xpath = xpath
+  end
+
+  def matches?(str)
+    @str = str
+    xml_document.xpath(@xpath).any?
+  end
+
+  def failure_message
+    "Expected xpath #{@xpath.inspect} to match in:\n" + pretty_printed_xml
+  end
+
+  def failure_message_when_negated
+    "Expected xpath #{@xpath.inspect} not to match in:\n" + pretty_printed_xml
+  end
+
+  private
+
+  def pretty_printed_xml
+    xml_document.to_xml(indent: 2)
+  end
+
+  def xml_document
+    @xml_document ||= Nokogiri::XML(@str)
+  end
+end
+
+def have_xpath(*xpath)
+  HaveXpath.new(*xpath)
+end
+
+# check if the xpath has the specified value
+# value is a string and there must be a single result to match its
+# equality against
+class MatchXpath
+  def initialize(xpath, val)
+    @xpath = xpath
+    @val= val
+  end
+
+  def matches?(response)
+    @response = response
+    doc = response.is_a?(Nokogiri::XML::Document) ? response : Nokogiri::XML(@response)
+    ok= true
+    doc.xpath(@xpath).each do |e|
+      @actual_val= case e
+                   when Nokogiri::XML::Attr
+                     e.to_s
+                   when Nokogiri::XML::Element
+                     e.text
+                   else
+                     e.to_s
+                   end
+      return false unless @val == @actual_val
+    end
+    return ok
+  end
+
+  def failure_message
+    "The xpath #{@xpath} did not have the value '#{@val}' \n It was '#{@actual_val}'"
+  end
+
+  def failure_message_when_negated
+    "The xpath #{@xpath} has the value '#{@val}' \n Was expected not to match '#{@actual_val}'"
+  end
+
+  def description
+    "match the xpath expression #{@xpath} with #{@val}"
+  end
+end
+
+def match_xpath(xpath, val)
+  MatchXpath.new(xpath, val)
+end
+
+# checks if the given xpath occurs num times
+class HaveNodes  #:nodoc:
+  def initialize(xpath, num)
+    @xpath= xpath
+    @num = num
+  end
+
+  def matches?(response)
+    @response = response
+    doc = response.is_a?(Nokogiri::XML::Document) ? response : Nokogiri::XML(@response)
+    matches = doc.xpath(@xpath)
+    @num_found= matches.size
+    @num_found == @num
+  end
+
+  def failure_message
+    "Did not find expected number of nodes #{@num} in xpath #{@xpath} \n Found #{@num_found}"
+  end
+
+  def description
+    "match the number of nodes #{@num}"
+  end
+end
+
+def have_nodes(xpath, num)
+  HaveNodes.new(xpath, num)
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-02 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -242,6 +242,7 @@ files:
 - spec/lib/skn_utils/wrappers_spec.rb
 - spec/spec_helper.rb
 - spec/support/configurables.rb
+- spec/support/xml_matchers.rb
 homepage: https://github.com/skoona/skn_utils
 licenses:
 - MIT
@@ -293,3 +294,4 @@ test_files:
 - spec/lib/skn_utils/wrappers_spec.rb
 - spec/spec_helper.rb
 - spec/support/configurables.rb
+- spec/support/xml_matchers.rb