rest-client-wrapper 3.0.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def40a893f9c570b65d5bee0bb033b6c20788a4efb4a88f6f0b9bc5c6c732bd1
-  data.tar.gz: f4b4e68fb5aae3c0d5b8dcd2f8eb1feeb807f7c15753e2394c2bbfeae637e26d
+  metadata.gz: 672349eafd0d9487fd074d58761e4aa8de061bf370d165359d8a6378a0911af0
+  data.tar.gz: 7445c62040064f225ed52d81e0413e3f0cad2bde4843476a2ec486dbe5a92bb9
 SHA512:
-  metadata.gz: 2d6a4ff99f8181e0b66df0097b179af79f45d655ee432946f1ecd6c4dd3722bedd7d9e741442246e4f14c86fbc74f792578585840f55d24f8c9ab89f897e1542
-  data.tar.gz: 696d1b57674536173f903913745989bec8f520c83398d0f846e829f6589eeaaf008d8c5d0690072285c487ed6f718d80c94c16d9327ff36e44babc42e246181d
+  metadata.gz: 40477e74390f5cbc3f2fda466baf98cdaed8ce462508c1a40e881f190fba85449ef5dd1fc8c378bf2ab99a3dcefda97ea1bf19f2a94a78bb7206137aa1d3ff38
+  data.tar.gz: 9015cd901cfaa23fccd76f1f7b39223ed28f1c9a0111b10c080192a32cd0a0f2385c4f798b4a174966d991b2461fb0296a7ea673e1a2563b4067de463eb33b01

data/lib/rest_client_wrapper/paginators/echo.rb

@@ -36,13 +36,13 @@ module RestClientWrapper
         @config = { limit: limit }
       end
 
-      def paginate(http_method:, uri:, query_params: {}, headers: {}, data: false)
+      def paginate(http_method:, uri:, segment_params: {}, query_params: {}, headers: {}, data: false)
         raise RestClientError.new("Client not set, unable to make API call", nil, nil) unless @rest_client
 
         query_params.reverse_merge!(@config)
         responses = []
         loop do
-          response = @rest_client.make_request({ http_method: http_method, uri: uri, query_params: query_params, headers: headers })
+          response = @rest_client.make_request({ http_method: http_method, uri: uri, segment_params: segment_params, query_params: query_params, headers: headers })
           block_given? ? yield(response) : (responses << response)
           links = _pagination_links(response)
           break unless links.key?(:offset)

data/lib/rest_client_wrapper/paginators/echo_paginator.rb

@@ -36,13 +36,13 @@ module RestClientWrapper
         @config = { limit: limit }
       end
 
-      def paginate(http_method:, uri:, query_params: {}, headers: {}, data: false)
+      def paginate(http_method:, uri:, segment_params: {}, query_params: {}, headers: {}, data: false)
         raise RestClientError.new("Client not set, unable to make API call", nil, nil) unless @rest_client
 
         query_params.reverse_merge!(@config)
         responses = []
         loop do
-          response = @rest_client.make_request({ http_method: http_method, uri: uri, query_params: query_params, headers: headers })
+          response = @rest_client.make_request({ http_method: http_method, uri: uri, segment_params: segment_params, query_params: query_params, headers: headers })
           block_given? ? yield(response) : (responses << response)
           links = _pagination_links(response)
           break unless links.key?(:offset)
@@ -55,7 +55,7 @@ module RestClientWrapper
       private
 
       def _pagination_links(response)
-        next_l = response&.body&.[](:next) || ""
+        next_l = response&.body.class == Hash ? response&.body&.[](:next) || "" : ""
         next_h = Rack::Utils.parse_query(URI.parse(next_l)&.query)
         return next_h.symbolize_keys!
       end

data/lib/rest_client_wrapper/paginators/header_link.rb

@@ -36,14 +36,14 @@ module RestClientWrapper
         @config = { page: nil, per_page: per_page }
       end
 
-      def paginate(http_method:, uri:, query_params: {}, headers: {}, data: false)
+      def paginate(http_method:, uri:, segment_params: {}, query_params: {}, headers: {}, data: false)
         raise RestClientError.new("Client not set, unable to make API call", nil, nil) unless @rest_client
 
         query_params.reverse_merge!(@config)
         responses = []
         loop.with_index(1) do |_, page|
           query_params[:page] = page
-          response = @rest_client.make_request({ http_method: http_method, uri: uri, query_params: query_params, headers: headers })
+          response = @rest_client.make_request({ http_method: http_method, uri: uri, segment_params: segment_params, query_params: query_params, headers: headers })
           block_given? ? yield(response) : (responses << response)
           links = _pagination_links(response)
           break unless links.key?(:next)

data/lib/rest_client_wrapper/paginators/header_link_paginator.rb

@@ -36,14 +36,14 @@ module RestClientWrapper
         @config = { page: nil, per_page: per_page }
       end
 
-      def paginate(http_method:, uri:, query_params: {}, headers: {}, data: false)
+      def paginate(http_method:, uri:, segment_params: {}, query_params: {}, headers: {}, data: false)
         raise RestClientError.new("Client not set, unable to make API call", nil, nil) unless @rest_client
 
         query_params.reverse_merge!(@config)
         responses = []
         loop.with_index(1) do |_, page|
           query_params[:page] = page
-          response = @rest_client.make_request({ http_method: http_method, uri: uri, query_params: query_params, headers: headers })
+          response = @rest_client.make_request({ http_method: http_method, uri: uri, segment_params: segment_params, query_params: query_params, headers: headers })
           block_given? ? yield(response) : (responses << response)
           links = _pagination_links(response)
           break unless links.key?(:next)

data/lib/rest_client_wrapper/request.rb

@@ -28,13 +28,13 @@ module RestClientWrapper
     VALID_HTTP_METHODS = %i[get post put patch delete connect options trace].freeze
     HTTP_METHOD_FOR_JSON = %i[post put patch].freeze
 
-    def initialize(http_method:, uri:, segment_params: {}, payload: {}, query_params: {}, headers: {}) # rubocop:disable Metrics/ParameterLists
+    def initialize(http_method:, uri:, segment_params: {}, payload: {}, query_params: {}, headers: {})
       @uri = uri
       self.headers = headers
+      self.http_method = http_method
       self.segment_params = segment_params
       self.payload = payload
       self.query_params = query_params
-      self.http_method = http_method
     end
 
     def http_method=(http_method)
@@ -47,7 +47,7 @@ module RestClientWrapper
     end
 
     def payload=(payload)
-      raise TypeError, "Request payload parameters is not a hash" unless payload.is_a?(Hash)
+      raise TypeError, "Request payload parameters is not a hash" if !payload.is_a?(Hash) && self.headers[:content_type] == :json
 
       @payload = payload
     end

data/lib/rest_client_wrapper/rest_client.rb

@@ -66,7 +66,7 @@ module RestClientWrapper
         response_code = nil
 
         begin
-          payload = Request::HTTP_METHOD_FOR_JSON.include?(request.http_method) ? request.payload.to_json : request.payload
+          payload = Request::HTTP_METHOD_FOR_JSON.include?(request.http_method) && request.headers[:content_type] == :json ? request.payload.to_json : request.payload
           request.headers[:params] = request.query_params
           response = ::RestClient::Request.execute({ method: request.http_method, url: url, payload: payload, headers: request.headers })
           response_code = response&.code
@@ -84,22 +84,21 @@ module RestClientWrapper
       end
     end
 
-    def make_request(http_method:, uri:, payload: {}, query_params: {}, headers: {})
-      parsed_uri = URI.parse(uri)
-
-      raise ArgumentError, "URL host does not match config host of instance, unable to make API call" if parsed_uri.absolute? && @host.casecmp("#{ parsed_uri.scheme }://#{ parsed_uri.host }").nonzero?
+    def execute_paginated_request(request:, data: true)
+      return self.make_request_for_pages({ http_method: request.http_method, uri: request.uri, segment_params: request.segment_params, query_params: request.query_params, headers: request.headers, data: data }) # rubocop:disable Metrics/LineLength
+    end
 
-      uri = parsed_uri.absolute? ? parsed_uri.path : uri
-      request = Request.new({ http_method: http_method, uri: uri, payload: payload, query_params: query_params })
+    def make_request(http_method:, uri:, payload: {}, segment_params: {}, query_params: {}, headers: {})
+      request = Request.new({ http_method: http_method, uri: uri, payload: payload, segment_params: segment_params, query_params: query_params })
       request.headers = headers
       return self.execute({ request: request })
     end
 
-    def make_request_for_pages(http_method:, uri:, query_params: {}, headers: {}, data: false)
+    def make_request_for_pages(http_method:, uri:, segment_params: {}, query_params: {}, headers: {}, data: false)
       raise RestClientError.new("Paginator not set, unable to make API call", nil, nil) unless @paginator
 
       @paginator.rest_client ||= self
-      return @paginator.paginate({ http_method: http_method, uri: uri, query_params: query_params, headers: headers, data: data })
+      return @paginator.paginate({ http_method: http_method, uri: uri, segment_params: segment_params, query_params: query_params, headers: headers, data: data })
     end
 
     private
@@ -121,7 +120,11 @@ module RestClientWrapper
     end
 
     def _build_uri(request)
-      return format("#{ @host }#{ request.uri }", request.segment_params)
+      uri = format(request.uri, request.segment_params)
+      parsed_uri = URI.parse(uri)
+      raise ArgumentError, "URL host does not match config host of instance, unable to make API call" if parsed_uri.absolute? && @host.casecmp("#{ parsed_uri.scheme }://#{ parsed_uri.host }").nonzero?
+
+      return parsed_uri.absolute? ? uri : "#{ @host }#{ uri }"
     end
 
     def _validate_request(request)

data/lib/rest_client_wrapper/version.rb

@@ -18,6 +18,6 @@
 
 module RestClientWrapper
 
-  VERSION = "3.0.1".freeze
+  VERSION = "3.2.1".freeze
 
 end

data/rest-client-wrapper.gemspec

@@ -30,12 +30,12 @@ Gem::Specification.new do |s|
   s.summary     = "Rest client wrapper"
   s.description = "Generic REST client wrapper"
   s.license     = "GPL 3.0"
-  s.required_ruby_version = ">= 2.4.0"
+  s.required_ruby_version = ">= 2.6.0"
 
-  s.add_runtime_dependency "json", "~> 1.8", ">= 1.8.3"
-  s.add_runtime_dependency "oauth2", "~> 1.2"
-  s.add_runtime_dependency "rack", "~> 2.0.5"
-  s.add_runtime_dependency "rest-client", "~> 2.0.2"
+  s.add_runtime_dependency "json", ">= 1.8.3"
+  s.add_runtime_dependency "oauth2", ">= 1.2"
+  s.add_runtime_dependency "rack", ">= 2.0.5"
+  s.add_runtime_dependency "rest-client", ">= 2.0.2"
   s.add_runtime_dependency "typhoeus", "~> 1.0", ">= 1.0.1"
 
   s.add_development_dependency "colorize", "~> 0.7", ">= 0.7.0"

data/spec/request_spec.rb

@@ -142,7 +142,7 @@ module RestClientWrapper # rubocop:disable Metrics/ModuleLength
       context "when payload is not a hash" do
 
         it "will raise TypeError" do
-          expect { Request.new({ http_method: :get, uri: @api_uri, segment_params: @param_hash, payload: @non_hash_value }) }.to raise_error(TypeError)
+          expect { Request.new({ http_method: :put, uri: @api_uri, segment_params: @param_hash, payload: @non_hash_value }) }.to raise_error(TypeError)
         end
 
       end

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rest-client-wrapper
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.1
 platform: ruby
 authors:
 - University of Adelaide
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
@@ -24,9 +21,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
@@ -34,42 +28,42 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
@@ -186,7 +180,7 @@ licenses:
 - GPL 3.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -194,15 +188,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Rest client wrapper
 test_files: