rb-net_http-client 1.1.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd08c5fc978270d92748ff8a6594e8d5bb378291f6f9c20876ef4bcf1324c2a
-  data.tar.gz: cd627208077f5aee71a705fbffa68508d30bbaeafe60b38398b9aadeea69906f
+  metadata.gz: 76514495cfbed0e713c811a595304ea13ae5937725b1dba6646fac7e3ad30c51
+  data.tar.gz: f8e1c648f4a160894bb528b1c0de495b177447c64667b6e2cd3dffce60b38f84
 SHA512:
-  metadata.gz: 9a78e2436a1d5a7434e916faba197d82fef92e226c31f2d4506d2b3fcd49af6b21210b877fa3bf0d5d386b49e5de9b28758ee625d715e25ca2078b39ee8f6bc0
-  data.tar.gz: 17f36a54dd7dc2f85a066ab13e62134e73346a7e58fdef771209f901c39a4810f341244408cb6c95526f4b1c428e38f4ce9235fff209ed9f20f6ec13a6270262
+  metadata.gz: c37314a18313a524c34866fa7c9fe2cbddb8afd1df9ada8758de62902fd577812d98369cfc9aee358cc3e38a46a1536f1ded02c99fdc4fbdd6cf5b840c5b1c4b
+  data.tar.gz: 1dca387d785df28c71ec30609bb6d6203f311070417054dfeac4b4315ac9637fca4ddb497753c836e99f880d6ad8d0fc2dba0d7911fffe57cda0c76209782696

data/lib/client/client.rb

@@ -18,6 +18,7 @@ module NetHTTP
                 :pkcs12,
                 :pkcs12_file,
                 :pkcs12_passphrase,
+                :proxy_from_env,
                 :proxy_uri,
                 :proxy_url,
                 :query,
@@ -32,22 +33,27 @@ module NetHTTP
 
     def initialize(opts = {})
       send('logger=', opts[:logger])
-      schema_results = Core.schema_validation(opts, NetHTTP::Client::Schema) unless opts[:enforce_schema_validation] == false
+      schema_results = Core.schema_validation(opts, NetHTTP::Client::Schema.new) unless opts[:enforce_schema_validation] == false
       unless schema_results.nil?
         logger.debug("NetHTTP::Client::SchemaError -> #{schema_results}")
         raise NetHTTP::Client::SchemaError.new(schema_results.to_s)
       end
 
       send('uri=', opts)
+      send('proxy_uri=', opts)
       send('client=', opts)
     end
 
     def client=(opts = {})
-      @client = Net::HTTP.new(uri.host, uri.port)
+      if proxy_uri
+        @client = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port).new(uri.host, uri.port)
+      else
+        @client = Net::HTTP.new(uri.host, uri.port)
+      end
 
-      send('proxy_uri=', opts)
-      send('open_timeout=', (opts[:open_timeout] ||= 60))
-      send('read_timeout=', (opts[:read_timeout] ||= 60))
+      send('proxy_from_env=', opts[:proxy_from_env])
+      send('open_timeout=', (opts[:open_timeout] || 60))
+      send('read_timeout=', (opts[:read_timeout] || 60))
       send('use_ssl=', opts[:use_ssl], uri.scheme)
       send('ssl_path=', opts[:ssl_path])
       send('pkcs12_file=', opts[:pkcs12_file])
@@ -58,6 +64,7 @@ module NetHTTP
       send('ca_file=', opts[:ca_file])
       send('verify_mode=', opts[:verify_mode])
 
+      @client.proxy_from_env = proxy_from_env
       @client.open_timeout = open_timeout
       @client.read_timeout = read_timeout
       @client.use_ssl = use_ssl

data/lib/client/ext.rb

@@ -3,7 +3,7 @@
 module NetHTTP
   class Client
     def proxy_uri=(opts = {})
-      proxy_uri = opts[:proxy_uri] ||= opts[:proxy_url] ||= ENV['http_proxy'] ||= ENV['HTTP_PROXY'] ||= ENV['https_proxy'] ||= ENV['HTTPS_PROXY']
+      proxy_uri = opts[:proxy_uri] || opts[:proxy_url]
 
       begin
         if proxy_uri.to_s.empty? == false
@@ -21,14 +21,14 @@ module NetHTTP
             )
           )
         end
-      rescue RuntimeError => error
-        logger.debug(error)
+      rescue RuntimeError => err
+        logger.debug(err)
         @proxy_uri = nil
       end
     end
 
     def uri=(opts = {})
-      uri = opts[:uri] ||= opts[:url]
+      uri = opts[:uri] || opts[:url]
       begin
         if uri.to_s.empty? == false
           @uri = Core::Utilities.parse_uri(uri)
@@ -45,8 +45,8 @@ module NetHTTP
             )
           )
         end
-      rescue RuntimeError => error
-        logger.debug(error)
+      rescue RuntimeError => err
+        logger.debug(err)
         @uri = nil
       end
     end
@@ -109,6 +109,14 @@ module NetHTTP
       end
     end
 
+    def proxy_from_env=(proxy_from_env)
+      if proxy_from_env == true
+        @proxy_from_env = true
+      else
+        @proxy_from_env = false
+      end
+    end
+
     def read_timeout=(read_timeout)
       @read_timeout = read_timeout.to_s.to_i
     end

data/lib/client/schema.rb

@@ -4,47 +4,42 @@ require 'dry-validation'
 
 module NetHTTP
   class Client
-    Schema = Dry::Validation.Schema do
-      configure do
-        def name
-          'NetHTTP::Client::Schema'
-        end
-
-        def true_or_false
-          [true, false]
-        end
+    class Schema < Dry::Validation::Contract
+      schema do
+        optional(:ca_file).value(:string).filled
+        optional(:host).value(:string)
+        optional(:logger).filled
+        optional(:open_timeout).value(:integer).filled
+        optional(:path).value(:string)
+        optional(:port).value(:integer)
+        optional(:pkcs12_file).value(:string).filled
+        optional(:pkcs12_passphrase).value(:string).filled
+        optional(:proxy_uri_host).value(:string)
+        optional(:proxy_uri_path).value(:string)
+        optional(:proxy_uri_port).value(:integer)
+        optional(:proxy_uri_scheme).value(:string)
+        optional(:proxy_uri).value(:string).filled
+        optional(:proxy_url).value(:string).filled
+        optional(:query).value(:string).filled
+        optional(:read_timeout).value(:integer).filled
+        optional(:scheme).value(:string)
+        optional(:ssl_path).value(:string).filled
+        optional(:uri).value(:string)
+        optional(:url).value(:string)
+        optional(:use_ssl)
+        optional(:verify_mode).filled
       end
 
-      optional(:ca_file).filled(type?: String)
-      optional(:host).maybe(type?: String)
-      optional(:logger).filled
-      optional(:open_timeout).filled(type?: Integer)
-      optional(:path).maybe(type?: String)
-      optional(:port).maybe(type?: Integer)
-      optional(:pkcs12_file).filled(type?: String)
-      optional(:pkcs12_passphrase).filled(type?: String)
-      optional(:proxy_uri_host).maybe(type?: String)
-      optional(:proxy_uri_path).maybe(type?: String)
-      optional(:proxy_uri_port).maybe(type?: Integer)
-      optional(:proxy_uri_scheme).maybe(type?: String)
-      optional(:proxy_uri).filled(type?: String)
-      optional(:proxy_url).filled(type?: String)
-      optional(:query).filled(type?: String)
-      optional(:read_timeout).filled(type?: Integer)
-      optional(:scheme).maybe(type?: String)
-      optional(:ssl_path).filled(type?: String)
-      optional(:uri).maybe(type?: String)
-      optional(:url).maybe(type?: String)
-      optional(:use_ssl).filled(included_in?: true_or_false)
-      optional(:verify_mode).filled
+      rule(:uri, :url, :host) do
+        key.failure('uri, url, & host cannot all be nil') if (values[:uri].nil? && values[:url].nil? && values[:host].nil?)
+      end
 
-      rule(if_url_and_uri_are_nil_must_provide_host: [:uri, :url, :host]) do |uri, url, host|
-        uri.empty?.then(url.empty?.then(host.filled?))
+      rule(:uri, :url, :scheme, :port) do
+        key.failure('if uri and url are nil, scheme or port cannot be nil') if (values[:uri].nil? && values[:url].nil? && (values[:scheme].nil? || values[:port].nil?))
       end
 
-      rule(if_url_and_uri_are_nil_must_provide_scheme_or_port: [:uri, :url, :scheme, :port]) do |uri, url, scheme, port|
-        uri.empty?.then(url.empty?.then(scheme.empty?.then(port.filled?)))
-        uri.empty?.then(url.empty?.then(port.empty?.then(scheme.filled?)))
+      rule(:use_ssl) do
+        key.failure('use_ssl must be either true or false') if (!values[:use_ssl].nil? && values[:use_ssl].class != (FalseClass || TrueClass))
       end
     end
 

data/lib/core/core.rb

@@ -20,14 +20,8 @@ module NetHTTP
       if results.success?
         return nil
       else
-        return results.messages
+        return results.errors.to_h
       end
     end
   end
-
-  class SchemaError < StandardError
-    def initialize(msg)
-      super(msg)
-    end
-  end
 end

data/lib/core/utilities.rb

@@ -56,15 +56,14 @@ module NetHTTP
       end
 
       def self.parse_query(query)
-        # todo: may need to update this as URI.escape is considered obsolete
         case query
         when String
           query = query[1..-1] if query.start_with?('?')
-          URI.escape("?#{query}")
+          URI.encode_www_form_component("?#{query}")
         when Hash
           query = query.map { |k, v| "#{k}=#{v}" }
           query = query.join('&')
-          URI.escape("?#{query}")
+          URI.encode_www_form_component("?#{query}")
         else
           nil
         end
@@ -221,8 +220,8 @@ module NetHTTP
             format: 'snake',
             type: type.downcase
           )
-        rescue RuntimeError => error
-          raise error
+        rescue RuntimeError => err
+          raise err
         end
       end
 
@@ -245,8 +244,8 @@ module NetHTTP
             format: 'snake',
             type: type.downcase
           )
-        rescue RuntimeError => error
-          raise error
+        rescue RuntimeError => err
+          raise err
         end
       end
 
@@ -289,8 +288,8 @@ module NetHTTP
             format: 'snake',
             type: type.downcase
           )
-        rescue RuntimeError => error
-          raise error
+        rescue RuntimeError => err
+          raise err
         end
       end
 
@@ -300,13 +299,13 @@ module NetHTTP
           return false if json_doc.empty?
 
           JSON.parse(json_doc)
-        rescue JSON::ParserError => error
+        rescue JSON::ParserError => err
           if logger.nil? || logger.to_s.empty?
             puts 'WARNING - JSON syntax / parsing errors detected:'
-            puts error
+            puts err
           else
             logger.debug('WARNING - JSON syntax / parsing errors detected:')
-            logger.debug(error)
+            logger.debug(err)
           end
           return false
         end
@@ -362,8 +361,8 @@ module NetHTTP
             end
             return true
           end
-        rescue RuntimeError => error
-          raise error
+        rescue RuntimeError => err
+          raise err
         end
 
         true

data/lib/request/request.rb

@@ -41,6 +41,8 @@ module NetHTTP
       logger.debug('Request Host => ' + request_opts[:uri].scheme.to_s + '://' + request_opts[:uri].host.to_s)
       logger.debug('Request Port => ' + request_opts[:uri].port.to_s)
       logger.debug('Request Path => ' + path)
+      logger.debug('Request Headers =>')
+      logger.debug(Hash[request_opts[:headers].to_h.map { |k, v| [k.to_s, v] }])
       NetHTTP::Response.new(
         response: client.delete(
           path
@@ -65,7 +67,7 @@ module NetHTTP
       logger.debug('Request Port => ' + request_opts[:uri].port.to_s)
       logger.debug('Request Path => ' + path)
       logger.debug('Request Headers =>')
-      logger.debug(request_opts[:headers])
+      logger.debug(Hash[request_opts[:headers].to_h.map { |k, v| [k.to_s, v] }])
       NetHTTP::Response.new(
         response: client.get(
           path,
@@ -91,7 +93,7 @@ module NetHTTP
       logger.debug('Request Port => ' + request_opts[:uri].port.to_s)
       logger.debug('Request Path => ' + path)
       logger.debug('Request Headers =>')
-      logger.debug(request_opts[:headers])
+      logger.debug(Hash[request_opts[:headers].to_h.map { |k, v| [k.to_s, v] }])
       logger.debug('Request Body =>')
       logger.debug(request_opts[:body])
       NetHTTP::Response.new(
@@ -120,7 +122,7 @@ module NetHTTP
       logger.debug('Request Port => ' + request_opts[:uri].port.to_s)
       logger.debug('Request Path => ' + path)
       logger.debug('Request Headers =>')
-      logger.debug(request_opts[:headers])
+      logger.debug(Hash[request_opts[:headers].to_h.map { |k, v| [k.to_s, v] }])
       logger.debug('Request Body =>')
       logger.debug(URI.encode_www_form(request_opts[:body]))
       NetHTTP::Response.new(
@@ -151,7 +153,7 @@ module NetHTTP
       logger.debug('Request Port => ' + request_opts[:uri].port.to_s)
       logger.debug('Request Path => ' + path)
       logger.debug('Request Headers =>')
-      logger.debug(request_opts[:headers])
+      logger.debug(Hash[request_opts[:headers].to_h.map { |k, v| [k.to_s, v] }])
       logger.debug('Request Body =>')
       logger.debug(request_opts[:body])
       NetHTTP::Response.new(
@@ -165,18 +167,18 @@ module NetHTTP
     end
 
     def request_opts(opts)
-      schema_results = Core.schema_validation(opts, NetHTTP::Request::Schema) unless opts[:enforce_schema_validation] == false
+      schema_results = Core.schema_validation(opts, NetHTTP::Request::Schema.new) unless opts[:enforce_schema_validation] == false
       unless schema_results.nil?
         logger.debug("NetHTTP::Request::SchemaError -> #{schema_results}")
         raise NetHTTP::Request::SchemaError.new(schema_results.to_s)
       end
 
-      request_method = opts[:method] ||= 'post'
+      request_method = opts[:method] || 'post'
       request_uri = Core::Utilities.parse_uri(opts[:uri] || opts[:url] || uri)
       request_path = (opts[:path] || request_uri.path || path).chomp('?')
       request_query = Core::Utilities.parse_query((opts[:query] || request_uri.query || query))
-      request_headers = opts[:headers] ||= {}
-      request_body = opts[:body] ||= nil
+      request_headers = opts[:headers] || {}
+      request_body = opts[:body] || nil
 
       {
         method: request_method,

data/lib/request/schema.rb

@@ -4,20 +4,19 @@ require 'dry-validation'
 
 module NetHTTP
   class Request
-    Schema = Dry::Validation.Schema do
-      configure do
-        def name
-          'NetHTTP::Request::Schema'
-        end
+    class Schema < Dry::Validation::Contract
+      schema do
+        required(:method).value(:string).filled
+        optional(:headers).value(:hash)
+        optional(:body)
+        optional(:query).filled
+        optional(:uri).value(:string).filled
+        optional(:url).value(:string).filled
+        optional(:path).value(:string).filled
       end
 
-      required(:method).filled(type?: String)
-      optional(:headers).maybe(type?: Hash)
-      optional(:body).maybe
-      optional(:query).filled
-
-      rule(if_url_and_uri_are_nil_must_provide_path: [:uri, :url, :path]) do |uri, url, path|
-        uri.empty?.then(url.empty?.then(path.filled?))
+      rule(:uri, :url, :path) do
+        key.failure('uri, url, & path cannot all be nil') if (values[:uri].nil? && values[:url].nil? && values[:path].nil?)
       end
     end
 

data/lib/response/response.rb

@@ -32,52 +32,37 @@ module NetHTTP
       log_response
     end
 
-    alias resp response
-
     def body=
       @body = response.body
     end
 
-    alias resp_body body
-    alias response_body body
-
     def body_obj=
       @body_obj = {}
 
-      if valid_json?
-        begin
-          @body_obj = NetHTTP::Core::Utilities.json_2_hash(body, 'symbol', logger)
-        rescue JSON::ParserError => error
-          logger.debug(error)
-        end
-      elsif valid_xml? || valid_html?
-        begin
-          @body_obj = NetHTTP::Core::Utilities.xml_2_hash(body, 'symbol', logger)
-        rescue Nokogiri::XML::SyntaxError => error
-          logger.debug(error)
-        end
+      if content_type.to_s.downcase.include?('json')
+        @body_obj = parse_json(body, logger)
+      elsif content_type.to_s.downcase.include?('xml') || content_type.to_s.downcase.include?('html')
+        @body_obj = parse_xml(body, logger)
       end
-    end
 
-    alias resp_body_obj body_obj
-    alias response_body_obj body_obj
+      @body_obj
+    end
 
     def body_os=
       @body_os = JSON.parse(body_obj.to_json, object_class: OpenStruct)
     end
 
-    alias resp_body_os body_os
-    alias response_body_os body_os
-    alias body_open_struct body_os
-    alias resp_body_open_struct body_os
-    alias response_body_open_struct body_os
-
     def code=
       @code = response.code
     end
 
-    alias resp_code code
-    alias response_code code
+    def content_type
+      content_type = headers_hash.select { |k,v| k.to_s.downcase == 'content_type' }
+
+      return nil if content_type.empty?
+
+      content_type[:content_type]
+    end
 
     def headers=
       @headers = {}
@@ -86,35 +71,40 @@ module NetHTTP
       end
     end
 
-    alias resp_headers headers
-    alias response_headers headers
-
     def headers_hash=
-      @headers_hash = {}
-      NetHTTP::Core::Utilities.convert_hash_keys(
+      @headers_hash = NetHTTP::Core::Utilities.convert_hash_keys(
         object: headers,
         format: 'snake',
         type: 'symbol'
       )
     end
 
-    alias resp_headers_hash headers_hash
-    alias response_headers_hash headers_hash
-
     def headers_os=
       @headers_os = JSON.parse(headers_hash.to_json, object_class: OpenStruct)
     end
 
-    alias resp_headers_os headers_os
-    alias response_headers_os headers_os
-    alias headers_open_struct headers_os
-    alias resp_headers_struct headers_os
-    alias response_headers_open_struct headers_os
-
     def response=(response)
       @response = response
     end
 
+    def parse_json(body, logger)
+      begin
+        NetHTTP::Core::Utilities.json_2_hash(body, 'symbol', logger)
+      rescue JSON::ParserError => err
+        logger.debug(err)
+        return {}
+      end
+    end
+
+    def parse_xml(body, logger)
+      begin
+        NetHTTP::Core::Utilities.xml_2_hash(body, 'symbol', logger)
+      rescue Nokogiri::XML::SyntaxError => err
+        logger.debug(err)
+        return {}
+      end
+    end
+
     def valid_json?
       NetHTTP::Core::Utilities.valid_json?(body, logger)
     end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NetHTTP
-  VERSION = '1.1.4'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rb-net_http-client
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Ryan Bostian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A Simple Ruby HTTP Client