network-client 1.0.9 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64ff58738532ca1e75915fdf62d59dbffe8fb3b3
-  data.tar.gz: bf9d4e529a0d104ff1e72dc7a02da3a9c23a5bd2
+  metadata.gz: 69bc26f62b6e80de3ad2d7ec172477b1bf8e9977
+  data.tar.gz: b5e873f8f2a1824428365ed72bf0c8d995cf03c5
 SHA512:
-  metadata.gz: a525076e0a9b9d6a9a2f9252af12a2e32fa7598b6fb8c0999d94b1ba6b65aeab37780157f3d42495cc4c3b005a6d9f13fb39460c9cdcfc15705222fb4fb6273c
-  data.tar.gz: e90d925d53cf26b219c0ea15c75fed6e71b46bcb8bf05b447a1b09759c166ed141d819af8ae55adfe7fad23257155433310f62a1f151da6ada5adae470788f83
+  metadata.gz: 52a46ce916e2a56e75b027684891d3910f0c9b671b99cf3260199a70f3d3cfec513846eb28255521e8dc6fcc38a81d15113cf26ec41a22aa860355b5d9ae2370
+  data.tar.gz: c250a7b4eba369c875e55a1df6ae532d86f8909f5d1a5d1922921ba84d6fbd98c81e9a8b7df03dd8f1162acc6acb9c2d6fb78fa3948ef4aba9976cb04ab431d3

data/Gemfile.lock

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

data/README.md

@@ -29,12 +29,19 @@ $ gem install network-client
 ## Usage
 
 
-For more refer to [the API docuemntation](#soon).
+For more details refer to [the API docuemntation](http://www.rubydoc.info/gems/network-client/).
 
 ## Contributing
 
 Bug reports and pull requests are very much appreciated at [Github](https://github.com/abarrak/network-client).
 
+  - Fork The repository.
+  - Create a branch with a clear name.
+  - Make your changes (Please also add/change test, README if applicable).
+  - Push changes to the created branch
+  - Create an Pull Request
+  - That's it!
+
 
 ## License
 [MIT](http://opensource.org/licenses/MIT).

data/lib/network-client/core.rb

@@ -1,14 +1,8 @@
 require 'net/http'
 require 'json'
-require 'securerandom'
-require 'erb'
 require 'logger'
 
-
 module NetworkClient
-  # This class is simple HTTP client that is meant to be initialized configured with a single URI.
-  # Subsequent calls should target endpoints/paths of that URI.
-  #
   class Client
 
     HTTP_VERBS = {
@@ -21,29 +15,56 @@ module NetworkClient
     DEFAULT_HEADERS = { 'accept' => 'application/json',
                         'Content-Type' => 'application/json' }.freeze
 
-    # Return values of rest-like methods is a struct holding two values:
-    # the response code, and body (parsed as JSON in json request).
-    RESPONSE = Struct.new(:code, :body)
+    # The success response template. Represents the return of rest-like methods holding two values:
+    # HTTP response code, and body (parsed as json if request type is json).
+    Response = Struct.new(:code, :body)
+
+    # Stamp in front of each log written by client *@logger*
+    LOG_TAG = '[NETWORK CLIENT]:'.freeze
+
+    attr_reader :username, :password, :default_headers, :logger, :tries
+
+    # 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.
+    # 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.
     #
-    # = *endpoint*:
-    #   Uri for the host with scheam and port. any other segment like paths will be discarded.
-    # = *tries*:
-    #   Number to specify how many is to repeat falied calls.
-    # = *headers*:
+    # *endpoint*:
+    #   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.
+    # *headers*:
     #   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.
+    # *password*:
+    #  for HTTP basic authentication. Applies on all requests. Default to nil.
     #
-    # Example:
+    # ==== 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",
+    # =>   ... }
     #
-    def initialize(endpoint:, tries: 1, headers: {})
+    def initialize(endpoint:, tries: 2, headers: {}, username: nil, password: nil)
       @uri = URI.parse(endpoint)
       @tries = tries
 
       set_http_client
       set_default_headers(headers)
+      set_basic_auth(username, password)
       set_logger
+      define_error_strategies
     end
 
     def get(path, params = {}, headers = {})
@@ -71,10 +92,10 @@ module NetworkClient
     end
 
     def set_logger
-      @logger = if defined?(Rails)
-        Rails.logger
-      elsif block_given?
+      @logger = if block_given?
         yield
+      elsif defined?(Rails)
+        Rails.logger
       else
         logger = Logger.new(STDOUT)
         logger.level = Logger::DEBUG
@@ -82,6 +103,11 @@ module NetworkClient
       end
     end
 
+    def set_basic_auth(username, password)
+      @username = username.nil? ? '' : username
+      @password = password.nil? ? '' : password
+    end
+
     private
 
     def set_http_client
@@ -94,15 +120,24 @@ module NetworkClient
       @default_headers = DEFAULT_HEADERS.merge(headers)
     end
 
+    def define_error_strategies
+      @errors_to_recover   = [Net::HTTPTooManyRequests,
+                              Net::HTTPServerError,
+                              Net::ProtocolError,
+                              Net::HTTPBadResponse,
+                              Net::ReadTimeout,
+                              Net::OpenTimeout,
+                              Errno::ECONNREFUSED,
+                              OpenSSL::SSL::SSLError,
+                              SocketError]
+      @errors_to_propagate = [Net::HTTPRequestURITooLarge,
+                              Net::HTTPMethodNotAllowed]
+    end
+
     def request_json(http_method, path, params, headers)
       response = request(http_method, path, params, headers)
-      body = JSON.parse(response.body)
-
-      RESPONSE.new(response.code, body)
-
-    rescue JSON::ParserError => error
-      @logger.error "parsing response body as json failed.\n Details: \n #{error.message}"
-      response
+      body = parse_as_json(response.body)
+      Response.new(response.code.to_i, body)
     end
 
     def request(http_method, path, params, headers)
@@ -118,40 +153,58 @@ module NetworkClient
         request.body = params.to_s
       end
 
+      basic_auth(request)
       response = http_request(request)
-      case response
-      when Net::HTTPSuccess
-        true
-      else
-        @logger.error "endpoint responded with a non-success #{response.code} code."
+
+      unless Net::HTTPSuccess === response
+        log "endpoint responded with non-success #{response.code} code.\nResponse: #{response.body}"
       end
 
       response
     end
 
+    def basic_auth(request)
+      request.basic_auth(@username, @password) unless @username.empty? && @password.empty?
+    end
+
     def http_request(request)
+      tries_count ||= @tries
+      finished = ->() { (tries_count -= 1).zero? }
+
       begin
-        tries_count ||= @tries
         response = @http.request(request)
-      rescue *errors_to_recover_by_retry => error
-        @logger.warn "[Error]: #{error.message} \nRetry .."
-        (tries_count -= 1).zero? ? raise : retry
+      end until !recoverable?(response) || finished.call
+      response
+
+    rescue *@errors_to_propagate => error
+      log "Request Failed. \nReason: #{error.message}"
+      raise
+
+    rescue *@errors_to_recover => error
+      warn_on_retry "#{error.message}"
+      finished.call ? raise : retry
+    end
+
+    def recoverable?(response)
+      if @errors_to_recover.any? { |error_class| response.is_a?(error_class) }
+        warn_on_retry "#{response.class} response type."
+        true
       else
-        response
+        false
       end
     end
 
-    def errors_to_recover_by_retry
-      [Errno::ECONNREFUSED, Net::HTTPServiceUnavailable, Net::ProtocolError, Net::ReadTimeout,
-       Net::OpenTimeout, OpenSSL::SSL::SSLError, SocketError]
-    end
+    def parse_as_json(response_body)
+      body = response_body
+      body = body.nil? || body.empty? ? body : JSON.parse(body)
 
-    def errors_to_recover_by_propogate
-      # TODO: make configurable set of errors that stop net call without retry.
+    rescue JSON::ParserError => error
+      log "Parsing response body as JSON failed! Returning raw body. \nDetails: \n#{error.message}"
+      body
     end
 
     def encode_path_params(path, params)
-      if params.empty?
+      if params.nil? || params.empty?
         path
       else
         encoded = URI.encode_www_form(params)
@@ -160,7 +213,17 @@ module NetworkClient
     end
 
     def formulate_path(path)
-      path.chars.last.nil? ? "#{path}/" : path
+      path = '/' if path.nil? || path.empty?
+      path.prepend('/') unless path.chars.first == '/'
+      path
+    end
+
+    def log(message)
+      @logger.error("\n#{LOG_TAG} #{message}.")
+    end
+
+    def warn_on_retry(message)
+      @logger.warn("\n#{LOG_TAG} #{message} \nRetrying now ..")
     end
   end
 end

data/lib/network-client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: network-client
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.5
 platform: ruby
 authors:
 - Abdullah Barrak (abarrak)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-28 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler