rest-client-wrapper 3.0.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850533c6b1b1da4dafb1059762820eb8085d43544d934b3a6db1e925228017e8
-  data.tar.gz: 8cafb6e965ae858ba748d970438faabdc3e92ec7a31c2c76f316f37d018caa4f
+  metadata.gz: 8b402585e6034813c0b9d3fa1af05e943ca106f7cdcae0b0f6e205e822250304
+  data.tar.gz: 64390499b6848d1dab15c57a723b9b02bded8eedf2b5f3650e8f3f8ed789f3f2
 SHA512:
-  metadata.gz: 2201ea8ebc813d0437933446da66d4f735493bb9c2cfb71cfe92c2cb6d4581db4d7ae1f6e4c8f6d31a219f40d06433db4803e1a3dc8b48be297a93e2e9d1115d
-  data.tar.gz: 971a6eb73f52120ecf6cf194b73e58a690e1449012bd50d450cc9b26952fd2037b2e10a66d2d886a695c57c8ff39ae60ae308f67c05f319649dae6975e8e0968
+  metadata.gz: 8769b420a7bfe481450e0665a3f4899564dff302769bf050f7d512564b828479529a5a3859dd8fb581d714e8b4452601e102a0d28226771bc57ece9f16b4cc88
+  data.tar.gz: 46a6573d732840fe66240d6773db7f07ecd274d70b3a7b794b44d1bb31eca85fe514a050726571afe47538b8b4a16b260013c872b20283eb52c515df47829d6f

data/lib/rest_client_wrapper/authenticators/basic.rb

@@ -29,9 +29,9 @@ module RestClientWrapper
 
       include Auth
 
-      def initialize(username:, password:)
-        @username = username
-        @password = password
+      def initialize(**config)
+        @username = config[:username]
+        @password = config[:password]
       end
 
       def generate_auth

data/lib/rest_client_wrapper/authenticators/custom.rb

@@ -32,9 +32,9 @@ module RestClientWrapper
 
       TYPE = %i[header query_param].freeze
 
-      def initialize(type:, auth_param:)
-        self.type = type
-        self.auth_param = auth_param
+      def initialize(**config)
+        self.type = config[:type]
+        self.auth_param = config[:auth_param]
       end
 
       def generate_auth

data/lib/rest_client_wrapper/authenticators/oauth.rb

@@ -36,9 +36,9 @@ module RestClientWrapper
 
       @@api_client = {} # rubocop:disable Style/ClassVars
 
-      def initialize(site:, token_url_path:, client_id:, client_secret:)
+      def initialize(client_id:, **config)
         @client_id = client_id
-        @@api_client[client_id] = { lock: Mutex.new, settings: { site: site, token_url_path: token_url_path, client_secret: client_secret }, access_token: nil, refresh_token: nil }
+        @@api_client[client_id] = { lock: Mutex.new, settings: config, access_token: nil, refresh_token: nil }
       end
 
       def tokens

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.instance_of?(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

@@ -21,20 +21,20 @@ module RestClientWrapper
   # Request
   class Request
 
-    attr_reader :uri, :headers, :http_method, :payload, :segment_params, :query_params
-    attr_writer :uri
+    attr_accessor :uri
+    attr_reader :headers, :http_method, :payload, :segment_params, :query_params
 
     DEFAULT_CONTENT_TYPE = { content_type: :json, accept: :json }.freeze # default content type for post and put requests
     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
-      @uri = uri
-      self.headers = headers
-      self.http_method = http_method
-      self.segment_params = segment_params
-      self.payload = payload
-      self.query_params = query_params
+    def initialize(**params)
+      @uri = params[:uri]
+      self.headers = params[:headers].nil? ? {} : params[:headers]
+      self.http_method = params[:http_method]
+      self.segment_params = params[:segment_params].nil? ? {} : params[:segment_params]
+      self.payload = params[:payload].nil? ? {} : params[:payload]
+      self.query_params = params[:query_params].nil? ? {} : params[:query_params]
     end
 
     def http_method=(http_method)

data/lib/rest_client_wrapper/rest_client.rb

@@ -41,7 +41,7 @@ module RestClientWrapper
       }
     }.freeze
 
-    def initialize(host:, config: {})
+    def initialize(host:, **config)
       @host          = host
       @config        = config
       @retry_configs = {}.reverse_merge(DEFAULT_CONFIG[:retries])
@@ -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,12 +120,16 @@ 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)
       # Regex to find segments in uri with the pattern <segment_param>
-      url_segments = request.uri.scan(/\<(.*?)\>/).flatten
+      url_segments = request.uri.scan(/<(.*?)>/).flatten
       url_segments.each do |url_segment|
         raise ArgumentError, "Segment parameter not provided for #{ url_segment }. URI #{ request.uri }" unless request.segment_params.include? url_segment.to_sym
       end
@@ -153,8 +156,8 @@ module RestClientWrapper
       return { ok: true } if response.body == "ok".to_json # Handle special case for Echo delete responses
 
       return JSON.parse(response.body, { object_class: Hash, symbolize_names: true })
-    rescue StandardError => e
-      raise RestClientError.new("Response could not be parsed as JSON", response, e)
+    rescue StandardError
+      return response.body
     end
 
     def _reset_retries

data/lib/rest_client_wrapper/version.rb

@@ -18,6 +18,6 @@
 
 module RestClientWrapper
 
-  VERSION = "3.0.3".freeze
+  VERSION = "4.0.0".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"

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rest-client-wrapper
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 4.0.0
 platform: ruby
 authors:
 - University of Adelaide
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2021-07-21 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.9
+signing_key:
 specification_version: 4
 summary: Rest client wrapper
 test_files: