network-client 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69bc26f62b6e80de3ad2d7ec172477b1bf8e9977
-  data.tar.gz: b5e873f8f2a1824428365ed72bf0c8d995cf03c5
+  metadata.gz: 75b9ed5e72145a53a1dc73e09fed8a698cb7f723
+  data.tar.gz: 0fc103daaef34021254fcfcc00d7ebf624db40df
 SHA512:
-  metadata.gz: 52a46ce916e2a56e75b027684891d3910f0c9b671b99cf3260199a70f3d3cfec513846eb28255521e8dc6fcc38a81d15113cf26ec41a22aa860355b5d9ae2370
-  data.tar.gz: c250a7b4eba369c875e55a1df6ae532d86f8909f5d1a5d1922921ba84d6fbd98c81e9a8b7df03dd8f1162acc6acb9c2d6fb78fa3948ef4aba9976cb04ab431d3
+  metadata.gz: 3d969c67f60e33fd89d143a9939e16c39d27908a5ef3e25ecce35475d5f1be026732b4dd34a1fdec0859856724de0465ba3fff9ad9a0b21b1930d4c53f61ebbe
+  data.tar.gz: 10e9c5c9b8c12d651288bf50da04f925f526696dba0b9091a14cf0ad0cfe4b4129f531e0d9527f9ae90204c09d75c450e980e84273e044cbfaacdce36af7f254

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    network-client (1.1.5)
+    network-client (1.1.6)
 
 GEM
   remote: https://rubygems.org/

data/lib/network-client/core.rb

@@ -24,37 +24,40 @@ module NetworkClient
 
     attr_reader :username, :password, :default_headers, :logger, :tries
 
-    # error list for retrying strategy.
+    # Error list for retrying strategy.
     # Initially contains common errors encountered usually in net calls.
     attr_accessor :errors_to_recover
 
-    # error list for stop and propagate strategy.
+    # Error list for stop and propagate strategy.
     # Takes priority over *:errors_to_recover*.
     # Do not assign ancestor error classes here that prevent retry for descendant ones.
     attr_accessor :errors_to_propagate
 
+    ##
     # Construct and prepare client for requests targeting :endpoint.
     #
+    # === Parameters:
+    #
     # *endpoint*:
-    #   Uri for the host with schema and port. any other segment like paths will be discarded.
+    # Uri for the host with schema and port. any other segment like paths will be discarded.
     # *tries*:
-    #   Number to specify how many is to repeat failed calls. Default is 2.
+    # Number to specify how many is to repeat failed calls. Default is 2.
     # *headers*:
-    #   Hash to contain any common HTTP headers to be set in client calls.
+    # Hash to contain any common HTTP headers to be set in client calls.
     # *username*:
-    #  for HTTP basic authentication. Applies on all requests. Default to nil.
+    # for HTTP basic authentication. Applies on all requests. Default to nil.
     # *password*:
-    #  for HTTP basic authentication. Applies on all requests. Default to nil.
+    # for HTTP basic authentication. Applies on all requests. Default to nil.
+    #
+    # === Example:
+    #   require "network-client"
     #
-    # ==== Example:
-    # => require "network-client"
-    # =>
-    # => github_client = NetworkClient::Client.new(endpoint: 'https://api.github.com')
-    # => github_client.get '/emojis'
-    # => { "+1": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f44d.png?v7",
-    # =>   "-1": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f44e.png?v7",
-    # =>   "100": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f4af.png?v7",
-    # =>   ... }
+    #   github_client = NetworkClient::Client.new(endpoint: 'https://api.github.com')
+    #   github_client.get '/emojis'
+    #   #=> { "+1": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f44d.png?v7",
+    #        "-1": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f44e.png?v7",
+    #        "100": "https://assets-cdn.github.com/images/icons/emoji/unicode/1f4af.png?v7",
+    #        ... }
     #
     def initialize(endpoint:, tries: 2, headers: {}, username: nil, password: nil)
       @uri = URI.parse(endpoint)
@@ -128,6 +131,7 @@ module NetworkClient
                               Net::ReadTimeout,
                               Net::OpenTimeout,
                               Errno::ECONNREFUSED,
+                              Errno::ETIMEDOUT,
                               OpenSSL::SSL::SSLError,
                               SocketError]
       @errors_to_propagate = [Net::HTTPRequestURITooLarge,
@@ -207,13 +211,15 @@ module NetworkClient
       if params.nil? || params.empty?
         path
       else
+        params = stringify_keys(params)
         encoded = URI.encode_www_form(params)
         [path, encoded].join("?")
       end
     end
 
     def formulate_path(path)
-      path = '/' if path.nil? || path.empty?
+      path = '/'  if path.nil? || path.empty?
+      path.strip! if path.respond_to?(:strip)
       path.prepend('/') unless path.chars.first == '/'
       path
     end
@@ -225,5 +231,9 @@ module NetworkClient
     def warn_on_retry(message)
       @logger.warn("\n#{LOG_TAG} #{message} \nRetrying now ..")
     end
+
+    def stringify_keys(params)
+      params.respond_to?(:keys) ? params.collect { |k, v| [k.to_s, v] }.to_h : params
+    end
   end
 end

data/lib/network-client/version.rb

@@ -1,3 +1,3 @@
 module NetworkClient
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: network-client
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Abdullah Barrak (abarrak)