restful_client 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ffdd1539730f64064b5e045bf4afcad0374ec2dc
-  data.tar.gz: 3110fcd87794defb963f4214b8164e706bf1cea5
+SHA256:
+  metadata.gz: fb2e3bbbe3c0e81b0449b9dc0231ee925fe14c8fecae5918cebf181974addb18
+  data.tar.gz: 22c1095b54d3375e20fcd229e6ffcb79cebc2bfa4a4118947f114f3ef92d0e3c
 SHA512:
-  metadata.gz: 2b432086f2e3598fae207ca1a85e56a7c3a74f69194d00b10aa9ed495737c8072452e08d9f0e2c4ef97ff0b0899216400215e350832eb09461b4999013d4510e
-  data.tar.gz: 6aebfaf5672c02e41a1b66d7c884bd0c7c3a404a4b9a678d014ef0f0fef9ae194a46868f69c5a9d4cec2bd078c9eeeab99710dde7d04e49d5f61df336a3000e6
+  metadata.gz: 6ca3fbc03892cc5a7c0eb238d5a01f1f0419f3c3a025c670a18c1ca10ad455c1dbd92e32f1df56c9e254b5b894441825cccac5df3a1c7c232facad2fa5384aa9
+  data.tar.gz: d85e49990eeaf1973aebf1334ecd82c7556bfc78fa5102b300cb6a0d564b4dcf0a9f618210cf6e0c63c517067fc8d03bb07c80a4b08f79b8c6f9b470250283f8

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+coverage
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.2
+ruby-2.2.3

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 script: 'bundle exec rspec'
 language: ruby
 rvm:
-  - 2.2
+  - 2.2.3

data/Gemfile

@@ -1,10 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'thin', '~> 1.6'
-
-gem 'pry-byebug', '~> 3.3.0', {}.merge(ENV['RM_INFO'] ? { require: false } : {})
-gem 'rspec', '~> 3.1'
-gem 'rspec-its', '~> 1.1'
+gem 'thin', '~> 1.7'
+gem 'simplecov', '~> 0.12', require: false
+gem 'pry-byebug', '~> 3.4', {}.merge(ENV['RM_INFO'] ? { require: false } : {})
+gem 'rspec', '~> 3.5'
+gem 'rspec-its', '~> 1.2'
 gem 'rubocop', '~> 0.35.1'
 
 gemspec

data/lib/restful_client.rb

@@ -11,15 +11,12 @@ module RestfulClient
 
   class RestError < StandardError; end
 
-  class << self
-    attr_writer :configuration, :logger, :timeout_occured_count
-  end
   @@configuration = nil
   @@logger = nil
   @@timeout_occured_count = 0
 
-  SERVER_SIDE_ERRORS_RANGE = 500
-  CLIENT_SIDE_ERRORS_RANGE = 400
+  SERVER_SIDE_ERRORS_RANGE = 500 unless defined?(SERVER_SIDE_ERRORS_RANGE)
+  CLIENT_SIDE_ERRORS_RANGE = 400 unless defined?(CLIENT_SIDE_ERRORS_RANGE)
 
   def self.configure
     @@configuration ||= RestfulClientConfiguration.new
@@ -44,7 +41,7 @@ module RestfulClient
     url = RestfulClientUri.uri_join(callerr_config(caller)['url'], path)
     headers = { 'Accept' => 'application/json' }
     headers.merge!(extra.fetch('headers', {}))
-    request_args = { headers: headers, method: 'GET', timeout: timeout, params: params }.merge(extra.fetch('args', {}))
+    request_args = { headers: headers, method: 'GET', timeout: timeout_for(caller), params: params }.merge(extra.fetch('args', {}))
     request = Typhoeus::Request.new(url, request_args.merge(extra.fetch('args', {})))
     run_safe_request(caller, request, true, &on_error_block)
   end
@@ -52,21 +49,15 @@ module RestfulClient
   def post(caller, path, payload, extra = {}, &on_error_block)
     url = RestfulClientUri.uri_join(callerr_config(caller)['url'], path)
     headers, payload_as_str = prepare_payload_with_headers(payload, extra.fetch('headers', {}))
-    request_args = { headers: headers, method: 'POST', body: payload_as_str, timeout: timeout }
+    request_args = { headers: headers, method: 'POST', body: payload_as_str, timeout: timeout_for(caller) }
     request = Typhoeus::Request.new(url, request_args.merge(extra.fetch('args', {})))
     run_safe_request(caller, request, false, &on_error_block)
   end
 
-  def post_raw(caller, path, payload, custom_timeout = timeout, &on_error_block)
-    url = RestfulClientUri.uri_join(callerr_config(caller)['url'], path)
-    request = Typhoeus::Request.new(url, method: 'POST', body: payload, timeout: custom_timeout)
-    run_safe_request(caller, request, false, &on_error_block)
-  end
-
   def delete(caller, path, payload = {}, extra = {}, &on_error_block)
     url = RestfulClientUri.uri_join(callerr_config(caller)['url'], path)
     headers, payload_as_str = prepare_payload_with_headers(payload, extra.fetch('headers', {}))
-    request_args = { headers: headers, method: 'DELETE', body: payload_as_str, timeout: timeout }
+    request_args = { headers: headers, method: 'DELETE', body: payload_as_str, timeout: timeout_for(caller) }
     request = Typhoeus::Request.new(url, request_args.merge(extra.fetch('args', {})))
     run_safe_request(caller, request, true, &on_error_block)
   end
@@ -74,7 +65,7 @@ module RestfulClient
   def put(caller, path, payload, extra = {}, &on_error_block)
     url = RestfulClientUri.uri_join(callerr_config(caller)['url'], path)
     headers, payload_as_str = prepare_payload_with_headers(payload, extra.fetch('headers', {}))
-    request = Typhoeus::Request.new(url, headers: headers, method: 'PUT', body: payload_as_str, timeout: timeout)
+    request = Typhoeus::Request.new(url, headers: headers, method: 'PUT', body: payload_as_str, timeout: timeout_for(caller))
     run_safe_request(caller, request, false, &on_error_block)
   end
 
@@ -87,10 +78,10 @@ module RestfulClient
   def run_safe_request(caller, request, retry_if_needed, &on_error_block)
     @@timeout_occured_count = 0
     if !use_jynx?
-      response = run_request(request.dup, __method__, false)
+      response = run_request(request.dup, __method__, false, caller)
     elsif ServiceJynx.alive?(caller)
       begin
-        response = run_request(request.dup, __method__, retry_if_needed)
+        response = run_request(request.dup, __method__, retry_if_needed, caller)
       end while response.is_a?(Typhoeus::Response)
 
       response
@@ -108,7 +99,7 @@ module RestfulClient
     on_error_block.call("Exception in #{caller} execution - #{e.message}") if on_error_block
   end
 
-  def run_request(request, method, retry_if_needed)
+  def run_request(request, method, retry_if_needed, service_name)
     logger.debug { "#{__method__} :: Request :: #{request.inspect}" }
     request.options[:headers].merge!('X-Forwarded-For' => $client_ip) if $client_ip
     request.options[:headers].merge!('User-Agent' => user_agent)
@@ -116,7 +107,7 @@ module RestfulClient
       # 200, OK
       if response.success?
         logger.debug { "Success in #{method} :: Code: #{response.response_code}, #{response.body}" }
-        return '' if response.body.empty?
+        return '' if response.body.empty? || response.body == ' '
         begin
           return JSON.parse(response.body)
         rescue => e
@@ -126,7 +117,7 @@ module RestfulClient
         # Timeout occured
       elsif response.timed_out?
         @@timeout_occured_count += 1
-        skip_raise = (retry_if_needed && @@timeout_occured_count <= retries)
+        skip_raise = (retry_if_needed && @@timeout_occured_count <= retries_for(service_name))
 
         error_type = 'TimeoutOccured'
         error_description = prettify_logger(error_type, request, response)
@@ -164,7 +155,6 @@ module RestfulClient
         logger.error { "#{error_type} #{response.code}/#{response.return_code} for: #{error_description}" }
         return ''
       else
-
         fail RestError.new(:BadReturnCode)
       end
     end
@@ -219,4 +209,12 @@ module RestfulClient
     "#{type} #{response.code}/#{response.return_code} for: #{request.options.fetch(:method)}, "\
     "#{request.base_url}, Total time: #{response.total_time} seconds"
   end
+
+  def timeout_for(service_name)
+    callerr_config(service_name)['timeout'] || timeout
+  end
+
+  def retries_for(service_name)
+    callerr_config(service_name)['retries'] || retries
+  end
 end

data/restful_client.gemspec

@@ -3,12 +3,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'restful_client'
-  spec.version       = '0.3.0'
+  spec.version       = '1.1.0'
   spec.authors       = ['Avner Cohen']
   spec.email         = ['israbirding@gmail.com']
   spec.description   = 'An HTTP framework for micro-services based environment, build on top of Typheous and Service Jynx'
   spec.summary       = 'An HTTP framework for micro-services based environment'
-  spec.homepage      = 'https://github.com/AvnerCohen/restful_client'
+  spec.homepage      = 'https://github.com/AvnerCohen/restful-client'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -16,8 +16,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-
-  spec.add_runtime_dependency 'service_jynx'
-  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'service_jynx', '~> 0'
+  spec.add_runtime_dependency 'typhoeus', '~> 0'
 end

data/spec/config/restful_services.yml

@@ -4,9 +4,9 @@ default: &default
   posts:
     url: http://1.2.3.4:8383/api/v1/
   locally:
-    url: http://127.0.0.1:8383/api/v1/
+    url: http://localhost:8383/api/v1/
   pompa_service:
-    url: http://127.0.0.1:8383/api/v1/
+    url: http://localhost:8383/api/v1/
 
 
 development: &development
@@ -19,4 +19,4 @@ production: &production
   posts:
     url: http://1.2.3.4:8383/api/v0/
   locally:
-    url: http://127.0.0.1:8383/api/v0/
+    url: http://localhost:8383/api/v0/

data/spec/restful_client_spec.rb

@@ -201,10 +201,6 @@ describe :RestfulClient do
       RestfulClient.configure do |config|
         config.env_name = 'production'
         config.config_folder = 'spec/config'
-        config.report_method = proc do |*args|
-          klass = args.first
-          set_global(klass)
-        end
       end
       RestfulClient.get('locally', '/client_error') { nil }
 
@@ -215,10 +211,6 @@ describe :RestfulClient do
       RestfulClient.configure do |config|
         config.env_name = 'production'
         config.config_folder = 'spec/config'
-        config.report_method = proc do |*args|
-          klass = args.first
-          set_global(klass)
-        end
       end
 
       RestfulClient.get('locally', '/non_existing') { nil }
@@ -231,11 +223,8 @@ describe :RestfulClient do
         RestfulClient.configure do |config|
           config.env_name = 'production'
           config.config_folder = 'spec/config'
-          config.report_method = proc do |*args|
-            klass = args.first
-            set_global(klass)
-          end
         end
+
         0.upto(9) do
           RestfulClient.get('locally', '/non_existing') { 'default' }
         end
@@ -262,6 +251,25 @@ describe :RestfulClient do
 
         expect($some_global).to eq('ServiceJynx')
       end
+
+      it 'should not call server after max errors with http_code => 500' do
+        RestfulClient.configure do |config|
+          config.env_name = 'production'
+          config.config_folder = 'spec/config'
+          config.report_method = proc do |*args|
+            klass = args.first
+            set_global(klass)
+          end
+        end
+        0.upto(10) do
+          RestfulClient.get('locally', '/server_error') { 'default' }
+        end
+
+        RestfulClient.get('locally', '/server_error') { |msg| $some_global = msg }
+
+        expect($some_global).to include('set as down')
+      end
+
     end
   end
 
@@ -422,4 +430,16 @@ describe :RestfulClient do
       expect(RestfulClient.srv_url('posts')).to eq('http://1.2.3.4:8383/api/v0/')
     end
   end
+
+  describe :NonJsonResponse do
+    it 'should fail to block when server side returns a plain string rather than json' do
+      RestfulClient.configure do |config|
+        config.env_name = 'production'
+        config.config_folder = 'spec/config'
+      end
+
+      RestfulClient.get('locally', '/non_json') { |msg| $some_global = msg }
+      expect($some_global).to include('unexpected token')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 require 'bundler'
 Bundler.require
 
-require 'rspec'
+require 'simplecov'
+SimpleCov.start
 
 Dir['./spec/support/**/*.rb'].each { |f| load(f) }
 load("#{File.dirname(__FILE__)}/../lib/restful_client.rb")

data/spec/support/test_server.rb

@@ -15,6 +15,8 @@ module MyApp
           [500, { 'Content-Type' => 'application/json' }, { counter: @@counter }.to_json]
         elsif path == '/api/v0/bounce'
           [200, { 'Content-Type' => 'text/plain' }, env['rack.input'].gets]
+        elsif path == '/api/v0/non_json'
+          [200, { 'Content-Type' => 'text/plain' }, 'moshe']
         elsif path == '/api/v0/non_existing'
           [404, { 'Content-Type' => 'text/plain' }, {}.to_json]
         elsif path == '/api/v0/server_error'

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: restful_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Avner Cohen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2026-09-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: service_jynx
   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: typhoeus
   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'
 description: An HTTP framework for micro-services based environment, build on top
@@ -79,11 +65,11 @@ files:
 - spec/restful_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
-homepage: https://github.com/AvnerCohen/restful_client
+homepage: https://github.com/AvnerCohen/restful-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,9 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: An HTTP framework for micro-services based environment
 test_files: