network-client 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2948c33239606721a0bab258f94eb7ef32c42441
-  data.tar.gz: 897d29f3df3617533a1279843b7a113865c337a1
+  metadata.gz: 64ff58738532ca1e75915fdf62d59dbffe8fb3b3
+  data.tar.gz: bf9d4e529a0d104ff1e72dc7a02da3a9c23a5bd2
 SHA512:
-  metadata.gz: 7a646e593e940cf06c3b96e232238dc574f7baf75ba4c6f1a668d25c2d169626ab91211ba086eb615cabac64ee9934fb89cd17f2ee93c9bf133dbb12a4d2a5a6
-  data.tar.gz: 89d53050f65e8a84e7fad544b09bf50677e6218c4dc3288b12fca5a0ad60342ec3792ba230578ec01545902572f56347868c38f3546562b48d911b989f605bc1
+  metadata.gz: a525076e0a9b9d6a9a2f9252af12a2e32fa7598b6fb8c0999d94b1ba6b65aeab37780157f3d42495cc4c3b005a6d9f13fb39460c9cdcfc15705222fb4fb6273c
+  data.tar.gz: e90d925d53cf26b219c0ea15c75fed6e71b46bcb8bf05b447a1b09759c166ed141d819af8ae55adfe7fad23257155433310f62a1f151da6ada5adae470788f83

data/.gitignore

@@ -53,3 +53,6 @@ build-iPhoneSimulator/
 .rvmrc
 
 # End of https://www.gitignore.io/api/ruby
+
+# Ignore publish script due to credentials
+.publish

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    network-client (1.0.7)
+    network-client (1.0.9)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +16,7 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.1.5)
+    dotenv (2.2.1)
     factory_girl (4.8.0)
       activesupport (>= 3.0.0)
     i18n (0.8.1)
@@ -50,6 +51,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.14)
   codeclimate-test-reporter (~> 1.0)
+  dotenv (~> 2.2)
   factory_girl (~> 4.5)
   network-client!
   rake (~> 10.0)

data/README.md

@@ -20,7 +20,7 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Or install the gem directly:
 
 ```sh
 $ gem install network-client
@@ -29,6 +29,7 @@ $ gem install network-client
 ## Usage
 
 
+For more refer to [the API docuemntation](#soon).
 
 ## Contributing
 

data/lib/network-client/core.rb

@@ -6,12 +6,9 @@ require 'logger'
 
 
 module NetworkClient
-  # This class is simple HTTP client that meant to be initialized configured with a single URI.
+  # 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.
   #
-  # Return values of its rest-like methods is Struct holding two values for the code and response
-  # body parsed as JSON.
-  #
   class Client
 
     HTTP_VERBS = {
@@ -21,6 +18,25 @@ module NetworkClient
       :delete => Net::HTTP::Delete
     }
 
+    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)
+
+    # 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*:
+    #   Hash to contain any common HTTP headers to be set in client calls.
+    #
+    # Example:
+    # =>
+    #
     def initialize(endpoint:, tries: 1, headers: {})
       @uri = URI.parse(endpoint)
       @tries = tries
@@ -28,7 +44,6 @@ module NetworkClient
       set_http_client
       set_default_headers(headers)
       set_logger
-      set_response_struct
     end
 
     def get(path, params = {}, headers = {})
@@ -76,19 +91,14 @@ module NetworkClient
     end
 
     def set_default_headers(headers)
-      defaults = { 'accept' => 'application/json', 'Content-Type' => 'application/json' }
-      @default_headers = defaults.merge(headers)
-    end
-
-    def set_response_struct
-      @response_struct = Struct.new(:code, :body)
+      @default_headers = DEFAULT_HEADERS.merge(headers)
     end
 
     def request_json(http_method, path, params, headers)
       response = request(http_method, path, params, headers)
       body = JSON.parse(response.body)
 
-      @response_struct.new(response.code, body)
+      RESPONSE.new(response.code, body)
 
     rescue JSON::ParserError => error
       @logger.error "parsing response body as json failed.\n Details: \n #{error.message}"
@@ -97,6 +107,7 @@ module NetworkClient
 
     def request(http_method, path, params, headers)
       headers = @default_headers.merge(headers)
+      path = formulate_path(path)
 
       case http_method
       when :get
@@ -123,7 +134,7 @@ module NetworkClient
         tries_count ||= @tries
         response = @http.request(request)
       rescue *errors_to_recover_by_retry => error
-        @logger.warn(error.message)
+        @logger.warn "[Error]: #{error.message} \nRetry .."
         (tries_count -= 1).zero? ? raise : retry
       else
         response
@@ -132,16 +143,24 @@ module NetworkClient
 
     def errors_to_recover_by_retry
       [Errno::ECONNREFUSED, Net::HTTPServiceUnavailable, Net::ProtocolError, Net::ReadTimeout,
-       Net::OpenTimeout, OpenSSL::SSL::SSLError]
+       Net::OpenTimeout, OpenSSL::SSL::SSLError, SocketError]
     end
 
     def errors_to_recover_by_propogate
+      # TODO: make configurable set of errors that stop net call without retry.
     end
 
     def encode_path_params(path, params)
-      return path if params.empty?
-      encoded = URI.encode_www_form(params)
-      [path, encoded].join("?")
+      if params.empty?
+        path
+      else
+        encoded = URI.encode_www_form(params)
+        [path, encoded].join("?")
+      end
+    end
+
+    def formulate_path(path)
+      path.chars.last.nil? ? "#{path}/" : path
     end
   end
 end

data/lib/network-client/version.rb

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

data/network-client.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_girl", "~> 4.5"
   spec.add_development_dependency "simplecov", "~> 0.14.1"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+  spec.add_development_dependency "dotenv", "~> 2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: network-client
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Abdullah Barrak (abarrak)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: network-client gem is almost a drop-in thin layer around Net::HTTP classes                         with
   simple error handling and retry functionality implemented.
 email: