skn_utils 5.4.0 → 5.8.0

data/lib/skn_utils/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # lib/skn_utils/configuration.rb
 #

data/lib/skn_utils/core_extensions.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 # ##
 # File: ./lib/skn_utils/core_extensions.rb  --
 # -- from: Rails 4.1 ActiveSupport:lib/active_support/core_ext/object/blank.rb
 # -- Ref: https://6ftdan.com/allyourdev/2015/01/20/refinements-over-monkey-patching/
+# -- Ref: https://medium.com/rubycademy/the-complete-guide-to-create-a-copy-of-an-object-in-ruby-part-ii-cd28a99d58d9
 
 module SknUtils
   module CoreObjectExtensions
@@ -51,6 +54,15 @@ module SknUtils
         def presence
           self if present?
         end
+
+        def duplicable?
+          true
+        end
+
+        def deep_dup
+          duplicable? ? dup : self
+        end
+
       end
 
       class ::NilClass
@@ -94,6 +106,10 @@ module SknUtils
         #
         # @return [true, false]
         alias_method :blank?, :empty?
+
+        def deep_dup
+          map(&:deep_dup)
+        end
       end
 
       class ::Hash
@@ -104,6 +120,19 @@ module SknUtils
         #
         # @return [true, false]
         alias_method :blank?, :empty?
+
+        def deep_dup
+          hash = dup
+          each_pair do |key, value|
+            if key.frozen? && ::String === key
+              hash[key] = value.deep_dup
+            else
+              hash.delete(key)
+              hash[key.deep_dup] = value.deep_dup
+            end
+          end
+          hash
+        end
       end
 
       class ::String

data/lib/skn_utils/dotted_hash.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module SknUtils
   class DottedHash < NestedResult

data/lib/skn_utils/env_string_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: ./lib/skn_utils/env_string_handler.rb
 #
 # Wrapping a string in this class gives you a prettier way to test

data/lib/skn_utils/http_processor.rb

@@ -0,0 +1,34 @@
+# ##
+#
+#
+module SknUtils
+
+  class HttpProcessor
+
+    def self.call(command)
+      completion = false
+
+      response = Net::HTTP.start( command.uri.host,command.uri.port,
+                                  use_ssl: command.uri.scheme.eql?("https")
+      ) do |http|
+        http.open_timeout = 5           # in seconds, for internal http timeouts
+        http.read_timeout = 15          # in seconds
+        if command.uri.scheme.eql?("https")
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http.request(command.request)
+      end
+
+      if ( response.kind_of?(Net::HTTPClientError) or response.kind_of?(Net::HTTPServerError) )
+        completion = SknFailure.call(response.code, response.message)
+      else
+        payload = command.json? ? JSON.load(response.body) : response.body
+        completion = SknSuccess.call(payload, response.class.name)
+      end
+
+      completion
+    rescue => exception
+      SknFailure.call(command.uri.request_uri, "#{exception.message}; #{exception.backtrace[0]}")
+    end
+  end
+end

data/lib/skn_utils/job_commands.rb

@@ -0,0 +1,247 @@
+# ##
+#
+# Ref: https://yukimotopress.github.io/http
+
+module SknUtils
+  # #################################################
+  #
+  class CommandJSONPDelete
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
+      new(options)
+    end
+
+    def json?
+      true
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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.content_type = 'application/json'
+      req.body = formatted_data
+      req
+    end
+
+    private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+      @_data     = opts[:payload]
+    end
+
+    def formatted_data
+      @_data.respond_to?(:to_json) ? @_data.to_json : @_data
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+
+  # #################################################
+  #
+  class CommandJSONPost
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
+      new(options)
+    end
+
+    def json?
+      true
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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
+      req
+    end
+
+  private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+      @_data     = opts[:payload]
+    end
+
+    def formatted_data
+      @_data.respond_to?(:to_json) ? @_data.to_json : @_data
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+
+
+  # #################################################
+  #
+  class CommandFORMPost
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
+      new(options)
+    end
+
+    def json?
+      false
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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)
+      req
+    end
+
+    private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+      @_data     = opts[:payload]
+    end
+
+    def formatted_data
+      @_data
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+
+
+  # #################################################
+  #
+  class CommandJSONGet
+    def self.call(options)  # {full_url:,username:,userpass:,headers:}
+      new(options)
+    end
+
+    def json?
+      true
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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
+
+    private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+
+
+  # #################################################
+  #
+  class CommandJSONPut
+    def self.call(options)  # {full_url:,username:,userpass:,payload:,headers:}
+      new(options)
+    end
+
+    def json?
+      true
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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
+      req
+    end
+
+    private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+      @_data     = opts[:payload]
+    end
+
+    def formatted_data
+      @_data.respond_to?(:to_json) ? @_data.to_json : @_data
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+
+
+  # #################################################
+  #
+  class CommandFORMDelete
+    def self.call(options)  # {full_url:,username:,userpass:}
+      new(options)
+    end
+
+    def json?
+      false
+    end
+
+    def uri
+      @_uri
+    end
+
+    def request
+      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
+
+    private
+
+    def initialize(opts={})
+      @_username = opts[:username]
+      @_userpass = opts[:userpass]
+      @_headers  = opts[:headers]
+      @_uri      = URI.parse( opts[:full_url])
+    end
+
+    def credentials?
+      !(@_username.nil? || @_userpass.nil?)
+    end
+  end
+end

data/lib/skn_utils/nested_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # <project.root>/lib/skn_utils/nested_result.rb
 #

data/lib/skn_utils/notifier_base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #
 # Ruby Notify like class

data/lib/skn_utils/null_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # lib/skn_utils/null_object.rb
 #

data/lib/skn_utils/page_controls.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 
 module SknUtils
   class PageControls < NestedResult

data/lib/skn_utils/result_bean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 
 module SknUtils
   class ResultBean < NestedResult

data/lib/skn_utils/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # A better way to say it
 module SknUtils
   class Version
     MAJOR = 5
-    MINOR = 4
+    MINOR = 8
     PATCH = 0
 
     def self.to_s

data/lib/skn_utils/wrappable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# ##
+#
+# Ref: https://blog.appsignal.com/2018/10/02/ruby-magic-class-level-instance-variables.html
+
+module SknUtils
+
+  module Wrappable
+    def wrap(mod)
+      wrappers << mod
+    end
+
+    def wrappers
+      @wrappers ||= []
+    end
+
+    def inherited_wrappers
+      ancestors
+          .grep(Wrappable)
+          .reverse
+          .flat_map(&:wrappers)
+    end
+
+    def new(*arguments, &block)
+      instance = allocate
+      inherited_wrappers.each { |mod|instance.singleton_class.include(mod) }
+      instance.send(:initialize, *arguments, &block)
+      instance
+    end
+  end
+end

data/skn_utils.gemspec

@@ -1,44 +1,49 @@
+# frozen_string_literal: true
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'skn_utils/version'
+
+require_relative 'lib/skn_utils/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'skn_utils'
   spec.version       = SknUtils::VERSION
   spec.author        = 'James Scott Jr'
   spec.email         = 'skoona@gmail.com'  
-  spec.summary       = <<-EOF
-SknUtils contains a small collection of Ruby utilities, the first being a NestedResult a key/value container.
-EOF
-
-  spec.description   = <<-EOF
-The intent of the NestedResult class is to be a container for data values composed of key/value pairs, 
-with easy access to its contents, and on-demand transformation back to the hash (#to_hash).
+  spec.summary       = <<-DESC
+Ruby utilities for dependency injection/lookup, class customizations, and dot.notion access over nested hashes.
+  DESC
+  spec.description   = <<-DESC
+Value containers supporting nested dot.notation access over hashes, and utilities offering dependency injection/lookup, and 
+language extensions support running in a non-rails environment.  Plus, examples of null objects, class customization, 
+and concurrent processing.
 
 Review the RSpec tests, and or review the README for more details.
-EOF
-  spec.post_install_message = <<-EOF
+  DESC
+
+  spec.post_install_message = <<-DESC
 This version includes modified versions of SknUtils::ResultBean, SknUtils::PageControls classes, which inherit from  
 SknUtils::NestedResult class.  SknUtils::NestedResult replaces those original classes and consolidates their function.  
-EOF
+  DESC
+
   spec.homepage      = "https://github.com/skoona/skn_utils"
   spec.license       = "MIT"
   spec.platform      = Gem::Platform::RUBY
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files          = `git ls-files -z`.split("\x0")
   spec.executables   = []
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ['lib']
+  spec.test_files     = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = %w[lib]
+  spec.extra_rdoc_files = Dir["README.md", "CODE_OF_CONDUCT.md", "LICENSE"]
 
   spec.add_runtime_dependency 'deep_merge', '~> 1'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1'
   spec.add_runtime_dependency 'thor', '~> 0'
 
-  spec.add_development_dependency "bundler",   "~> 1"
-  spec.add_development_dependency "rake",      "~> 10"
-  spec.add_development_dependency "rspec",     '~> 3'
-  spec.add_development_dependency "pry",       "~> 0"
-  spec.add_development_dependency "simplecov", "~> 0"
-  spec.add_development_dependency 'benchmark-ips', '~> 2'
+  spec.add_development_dependency "bundler",   ">= 1"
+  spec.add_development_dependency "rake",      ">= 12.3.3"
+  spec.add_development_dependency "rspec",     '>= 3'
+  spec.add_development_dependency "pry",       ">= 0"
+  spec.add_development_dependency "pry-coolline"
+  spec.add_development_dependency "simplecov", ">= 0"
+  spec.add_development_dependency 'benchmark-ips', '>= 2'
+  spec.add_development_dependency 'webmock'
 
 end