network-client 1.1.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75b9ed5e72145a53a1dc73e09fed8a698cb7f723
-  data.tar.gz: 0fc103daaef34021254fcfcc00d7ebf624db40df
+  metadata.gz: 69a4eea5e01f0c07a0728a987d1e8722edf1b228
+  data.tar.gz: b1a9d49d2f9e73c9a88eb3bd3956b2a1ebfe7202
 SHA512:
-  metadata.gz: 3d969c67f60e33fd89d143a9939e16c39d27908a5ef3e25ecce35475d5f1be026732b4dd34a1fdec0859856724de0465ba3fff9ad9a0b21b1930d4c53f61ebbe
-  data.tar.gz: 10e9c5c9b8c12d651288bf50da04f925f526696dba0b9091a14cf0ad0cfe4b4129f531e0d9527f9ae90204c09d75c450e980e84273e044cbfaacdce36af7f254
+  metadata.gz: ba909db3bb7de0357673b06bd444b107810bdf1796afd2dbf2e8fc3669c072157dbd0f31af601903c0ec895c55419ae83534e7d56710ce147433a724c0479cef
+  data.tar.gz: cd044bc44966fa7292741f9088a9be74ce2409e4099bfba6ec94fcd3582e755a071e09db9ce838f99966cc87612812896efc1174fa54659b1525b195ba4b3ff0

data/Gemfile.lock

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

data/lib/network-client.rb

@@ -1,2 +1,2 @@
-require_relative "network-client/core"
-require_relative "network-client/version"
+require_relative "network/client"
+require_relative "network/version"

data/lib/network/client.rb

@@ -0,0 +1,347 @@
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'logger'
+
+module Network
+  class Client
+    DEFAULT_HEADERS = { 'accept' => 'application/json',
+                        'Content-Type' => 'application/json' }.freeze
+    # The success response template.
+    #
+    # Represents the return of rest-like methods holding two values:
+    # HTTP response code, and body <em>(parsed as json if request type is json)</em>.
+    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, :user_agent,
+                :bearer_token, :auth_token_header
+
+    # 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+.
+    #
+    # == Parameters:
+    #
+    # [*endpoint*] +string+ Uri for the host with schema and port.
+    #              any other segment like paths will be discarded.
+    # [*tries*] +integer+ 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*] +string+ for HTTP basic authentication. Applies on all requests. Default to nil.
+    # [*password*] +string+ for HTTP basic authentication. Applies on all requests. Default to nil.
+    # [*user_agent*] +string+ Specifies the _User-Agent_ header value when making requests.
+    # *User-Agent* header value provided within +headers+ parameter in +initialize+ or on one of
+    # request methods will take precedence over +user_agent+ parameter.
+    #
+    # == Example:
+    #   require "network-client"
+    #
+    #   github_client = Network::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",
+    #         ... }
+    #
+    def initialize(endpoint:, tries: 2, headers: {}, username: nil, password: nil,
+                   user_agent: 'network-client gem')
+      @uri = URI.parse(endpoint)
+      @tries = tries
+
+      set_http_client
+      set_default_headers(headers)
+      set_basic_auth(username, password)
+      set_logger
+      define_error_strategies
+      set_user_agent(headers['User-Agent'] || user_agent)
+      set_bearer_auth
+      set_custom_token_auth
+    end
+
+    ##
+    # Perform a get request on the targeted client +endpoint+.
+    #
+    # == Parameters:
+    # [*path*] +string+ path on client's target host.
+    # [*params*] request parameters to be url encoded. Can be +hash+ or pair of values +array+.
+    # [*headers*] +hash+ set of http request headers.
+    #
+    # == Returns:
+    # http response data contained in +Response+ struct.
+    #
+    def get(path, params: {}, headers: {})
+      request_json :get, path, params, headers
+    end
+
+    ##
+    # Perform a post request on the targeted client +endpoint+.
+    #
+    # == Parameters:
+    # [*path*] +string+ path on client's target host.
+    # [*params*] +hash+ request parameters to json encoded in request body.
+    # [*headers*] +hash+ set of http request headers.
+    #
+    # == Returns:
+    # http response data contained in +Response+ struct.
+    #
+    def post(path, params: {}, headers: {})
+      request_json :post, path, params, headers
+    end
+
+    ##
+    # Perform a patch request on the targeted client +endpoint+.
+    #
+    # == Parameters:
+    # [*path*] +string+ path on client's target host.
+    # [*params*] +hash+ request parameters to json encoded in request body.
+    # [*headers*] +hash+ set of http request headers.
+    #
+    # == Returns:
+    # http response data contained in +Response+ struct.
+    #
+    def patch(path, params: {}, headers: {})
+      request_json :patch, path, params, headers
+    end
+
+    ##
+    # Perform a put request on the targeted client +endpoint+.
+    #
+    # == Parameters:
+    # [*path*] +string+ path on client's target host.
+    # [*params*] +hash+ request parameters to json encoded in request body.
+    # [*headers*] +hash+ set of http request headers.
+    #
+    # == Returns:
+    # http response data cotained in +Response+ strcut.
+    #
+    def put(path, params: {}, headers: {})
+      request_json :put, path, params, headers
+    end
+
+    ##
+    # Perform a delete request on the targeted client +endpoint+.
+    #
+    # == Parameters:
+    # [*path*] +string+ path on client's target host.
+    # [*params*] +hash+ request parameters to json encoded in request body.
+    # [*headers*] +hash+ set of http request headers.
+    #
+    # == Returns:
+    # http response data contained in +Response+ struct.
+    #
+    def delete(path, params: {}, headers: {})
+      request_json :delete, path, params, headers
+    end
+
+    def get_html(path, params: {}, headers: {})
+      raise NotImplementedError
+    end
+
+    def post_form(path, params: {}, headers: {})
+      raise NotImplementedError
+    end
+
+    ##
+    # Sets the client logger object.
+    # Execution is yielded to passed +block+ to set, customize, and returning a logger instance.
+    #
+    # == Returns:
+    # +logger+ instance variable.
+    #
+    def set_logger
+      @logger = if block_given?
+        yield
+      elsif defined?(Rails)
+        Rails.logger
+      else
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::DEBUG
+        logger
+      end
+    end
+
+    def set_basic_auth(username, password)
+      @username = username.nil? ? '' : username
+      @password = password.nil? ? '' : password
+    end
+
+    ##
+    # Assigns authentication bearer type token for use in standard HTTP authorization header.
+    #
+    # == Parameters:
+    # [*token*] +string+ bearer token value.
+    #
+    # == Returns:
+    # [@bearer_token] +string+ the newly assigned +@bearer_token+ value.
+    #
+    def set_bearer_auth(token: '')
+      @bearer_token = token
+    end
+
+    ##
+    # Assigns custom authentication token for use in standard HTTP authorization header.
+    # This takes precedence over Bearer authentication if both are set.
+    #
+    # == Parameters:
+    # [*header_value*] +string+ full authorization header value. _(e.g. Token token=123)_.
+    #
+    # == Returns:
+    # [@auth_token_header] +string+ the newly assigned +@auth_token_header+ value.
+    #
+    def set_custom_token_auth(header_value: '')
+      @auth_token_header = header_value
+    end
+
+    ##
+    # Assigns a new +User-Agent+ header to be sent in any subsequent request.
+    #
+    # == Parameters:
+    # [*new_user_agent*] +string+ the user-agent header value.
+    #
+    # == Returns:
+    # [@user_agent] +string+ the newly assigned +User-Agent+ header value.
+    #
+    def set_user_agent(new_user_agent)
+      @user_agent = @default_headers['User-Agent'] = new_user_agent
+    end
+
+    private
+
+    def set_http_client
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = @uri.scheme == 'https' ? true : false
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def set_default_headers(headers)
+      @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,
+                              Errno::ETIMEDOUT,
+                              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 = parse_as_json(response.body)
+      Response.new(response.code.to_i, body)
+    end
+
+    def request(http_method, path, params, headers)
+      path = formulate_path(path)
+      path = encode_path_params(path, params) if http_method == :get
+
+      headers = @default_headers.merge(headers)
+      headers = authenticate(headers)
+
+      request = Net::HTTP::const_get(http_method.to_s.capitalize.to_sym).new(path, headers)
+      request.body = params.to_s unless http_method == :get
+
+      basic_auth(request)
+
+      response = http_request(request)
+
+      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 authenticate(headers)
+      headers['Authorization'] = "Bearer #{bearer_token}" unless bearer_token.empty?
+      headers['Authorization'] = auth_token_header        unless auth_token_header.empty?
+      headers
+    end
+
+    def http_request(request)
+      tries_count ||= @tries
+      finished = ->() { (tries_count -= 1).zero? }
+
+      begin
+        response = @http.request(request)
+      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
+        false
+      end
+    end
+
+    def parse_as_json(response_body)
+      body = response_body
+      body = body.nil? || body.empty? ? body : JSON.parse(body)
+
+    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.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.strip! if path.respond_to?(:strip)
+      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
+
+    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/version.rb

@@ -0,0 +1,3 @@
+module Network
+  VERSION = "2.0.0"
+end

data/network-client.gemspec

@@ -2,12 +2,12 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'network-client/version'
+require 'network/version'
 require 'date'
 
 Gem::Specification.new do |spec|
   spec.name          = "network-client"
-  spec.version       = NetworkClient::VERSION
+  spec.version       = Network::VERSION
   spec.date          = Date.today.to_s
   spec.authors       = ["Abdullah Barrak (abarrak)"]
   spec.email         = ["abdullah@abarrak.com"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: network-client
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Abdullah Barrak (abarrak)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,8 +127,8 @@ files:
 - README.md
 - Rakefile
 - lib/network-client.rb
-- lib/network-client/core.rb
-- lib/network-client/version.rb
+- lib/network/client.rb
+- lib/network/version.rb
 - network-client.gemspec
 homepage: https://github.com/abarrak/network-client
 licenses:

data/lib/network-client/core.rb

@@ -1,239 +0,0 @@
-require 'net/http'
-require 'json'
-require 'logger'
-
-module NetworkClient
-  class Client
-
-    HTTP_VERBS = {
-      :get    => Net::HTTP::Get,
-      :post   => Net::HTTP::Post,
-      :put    => Net::HTTP::Put,
-      :delete => Net::HTTP::Delete
-    }
-
-    DEFAULT_HEADERS = { 'accept' => 'application/json',
-                        'Content-Type' => 'application/json' }.freeze
-
-    # 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.
-    #
-    # === Parameters:
-    #
-    # *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:
-    #   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: 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 = {})
-      request_json :get, path, params, headers
-    end
-
-    def post(path, params = {}, headers = {})
-      request_json :post, path, params, headers
-    end
-
-    def put(path, params = {}, headers = {})
-      request_json :put, path, params, headers
-    end
-
-    def delete(path, params = {}, headers = {})
-      request_json :delete, path, params, headers
-    end
-
-    def post_form(path, params = {}, headers = {})
-      raise NotImplementedError
-    end
-
-    def put_form(path, params = {}, headers = {})
-      raise NotImplementedError
-    end
-
-    def set_logger
-      @logger = if block_given?
-        yield
-      elsif defined?(Rails)
-        Rails.logger
-      else
-        logger = Logger.new(STDOUT)
-        logger.level = Logger::DEBUG
-        logger
-      end
-    end
-
-    def set_basic_auth(username, password)
-      @username = username.nil? ? '' : username
-      @password = password.nil? ? '' : password
-    end
-
-    private
-
-    def set_http_client
-      @http = Net::HTTP.new(@uri.host, @uri.port)
-      @http.use_ssl = @uri.scheme == 'https' ? true : false
-      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    end
-
-    def set_default_headers(headers)
-      @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,
-                              Errno::ETIMEDOUT,
-                              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 = parse_as_json(response.body)
-      Response.new(response.code.to_i, body)
-    end
-
-    def request(http_method, path, params, headers)
-      headers = @default_headers.merge(headers)
-      path = formulate_path(path)
-
-      case http_method
-      when :get
-        full_path = encode_path_params(path, params)
-        request = HTTP_VERBS[http_method].new(full_path, headers)
-      else
-        request = HTTP_VERBS[http_method].new(path, headers)
-        request.body = params.to_s
-      end
-
-      basic_auth(request)
-      response = http_request(request)
-
-      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
-        response = @http.request(request)
-      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
-        false
-      end
-    end
-
-    def parse_as_json(response_body)
-      body = response_body
-      body = body.nil? || body.empty? ? body : JSON.parse(body)
-
-    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.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.strip! if path.respond_to?(:strip)
-      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
-
-    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 +0,0 @@
-module NetworkClient
-  VERSION = "1.1.6"
-end