rest-client-wrapper 3.0.1

data/lib/rest_client_wrapper.rb

@@ -0,0 +1,33 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# RestClientWrapper
+module RestClientWrapper
+
+  require_relative "rest_client_wrapper/authenticators/basic"
+  require_relative "rest_client_wrapper/authenticators/custom"
+  require_relative "rest_client_wrapper/authenticators/oauth"
+  require_relative "rest_client_wrapper/authenticators/token"
+  require_relative "rest_client_wrapper/paginators/echo"
+  require_relative "rest_client_wrapper/paginators/header_link"
+  require_relative "rest_client_wrapper/rest_client"
+  require_relative "rest_client_wrapper/http"
+  require_relative "rest_client_wrapper/request"
+  require_relative "rest_client_wrapper/response"
+
+end

data/lib/rest_client_wrapper/authenticators/auth.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestClientWrapper
+
+  # Interface for authenticators to implement
+  module Auth
+
+    def generate_auth
+      raise NotImplementedError
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/authenticators/basic.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "base64"
+require_relative "auth"
+
+module RestClientWrapper
+
+  # Authenticator
+  module Authenticator
+
+    # Basic
+    class Basic
+
+      include Auth
+
+      def initialize(username:, password:)
+        @username = username
+        @password = password
+      end
+
+      def generate_auth
+        return { Authorization: "Basic #{ Base64.strict_encode64("#{ @username }:#{ @password }") }" }
+      end
+
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/authenticators/custom.rb

@@ -0,0 +1,61 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require_relative "auth"
+
+module RestClientWrapper
+
+  # Authenticator
+  module Authenticator
+
+    # Custom
+    class Custom
+
+      include Auth
+
+      attr_reader :type
+
+      TYPE = %i[header query_param].freeze
+
+      def initialize(type:, auth_param:)
+        self.type = type
+        self.auth_param = auth_param
+      end
+
+      def generate_auth
+        return @auth_param
+      end
+
+      def type=(type)
+        raise TypeError, "Request type parameter is not a symbol" unless type.is_a?(Symbol)
+        raise ArgumentError, "Not a valid http method" unless TYPE.include?(type)
+
+        @type = type
+      end
+
+      def auth_param=(auth_param)
+        raise TypeError, "Request auth_param is not a hash" unless auth_param.is_a?(Hash)
+
+        @auth_param = auth_param
+      end
+
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/authenticators/oauth.rb

@@ -0,0 +1,90 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "json"
+require "rest_client"
+require_relative "auth"
+require_relative "../constants"
+require_relative "../http"
+
+module RestClientWrapper
+
+  # Authenticator
+  module Authenticator
+
+    # Oauth
+    class Oauth
+
+      include Auth
+
+      attr_reader :client_id
+
+      @@api_client = {} # rubocop:disable Style/ClassVars
+
+      def initialize(site:, token_url_path:, client_id:, client_secret:)
+        @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 }
+      end
+
+      def tokens
+        return @@api_client
+      end
+
+      def access_token
+        return @@api_client&.[](@client_id)&.[](:access_token)
+      end
+
+      def generate_auth
+        Authenticator::Oauth.authenticate({ client_id: @client_id }) if @@api_client&.[](@client_id)&.[](:access_token).nil?
+        access_token = @@api_client&.[](@client_id)&.[](:access_token)
+        raise StandardError "Unable to authenticate #{ @client_id }" if @@api_client&.[](@client_id)&.[](:access_token).nil?
+
+        return { Authorization: "Bearer #{ access_token }" }
+      end
+
+      def self.authenticate(client_id:, access_token: nil)
+        # Ensure that other threads aren't checking and updating the token at the same time
+        @@api_client[client_id][:lock].synchronize do
+          # Return access_token from @@api_client when the current_token is different to what's in @@api_client as it's already been refreshed
+          return @@api_client[client_id][:access_token] if !access_token.nil? && !@@api_client[client_id][:access_token].nil? && @@api_client[client_id][:access_token].casecmp(access_token).nonzero?
+
+          payload = {
+            grant_type:    GrantType::CLIENT_CREDENTIALS,
+            client_id:     client_id,
+            client_secret: @@api_client&.[](client_id)&.[](:settings)&.[](:client_secret)
+          }
+          url = "#{ @@api_client&.[](client_id)&.[](:settings)&.[](:site) }#{ @@api_client&.[](client_id)&.[](:settings)&.[](:token_url_path) }"
+
+          response = ::RestClient::Request.execute({ method: :post, url: url, payload: payload })
+
+          if Http.ok?(response.code)
+            content_type = MIME::Types[response&.headers&.[](:content_type)].first
+            raise StandardError "Unable to retreive token, response was in a unexpected format" unless content_type == "application/json"
+
+            token_payload = JSON.parse(response.body)
+            @@api_client[client_id][:access_token] = token_payload["access_token"]
+            @@api_client[client_id][:refresh_token] = token_payload["refresh_token"]
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/authenticators/token.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require_relative "auth"
+
+module RestClientWrapper
+
+  # Authenticator
+  module Authenticator
+
+    # Token
+    class Token
+
+      include Auth
+
+      def initialize(access_token:)
+        @access_token = access_token
+      end
+
+      def generate_auth
+        return { Authorization: "Bearer #{ @access_token }" }
+      end
+
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/constants.rb

@@ -0,0 +1,28 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestClientWrapper
+
+  # Contants for application wide use
+  class GrantType
+
+    CLIENT_CREDENTIALS = "client_credentials".freeze
+
+  end
+
+end

data/lib/rest_client_wrapper/exceptions.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestClientWrapper
+
+  # RestClientError
+  class RestClientError < StandardError
+
+    attr_reader :response, :error
+
+    def initialize(message=nil, response=nil, error=nil)
+      @response = response
+      @error = error
+      super(message)
+    end
+
+  end
+
+  class RestClientNotSuccessful < RestClientError
+  end
+
+end

data/lib/rest_client_wrapper/http.rb

@@ -0,0 +1,66 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestClientWrapper
+
+  # Http
+  module Http
+
+    SUCCESS_STATUS_CODES = {
+      200 => "OK",
+      201 => "Created",
+      202 => "Accepted",
+      203 => "Non-Authoritative Information",
+      205 => "No Content",
+      206 => "Partial Content",
+      207 => "Multi-Status"
+    }.freeze
+
+    # success
+    def self.success?(code)
+      return SUCCESS_STATUS_CODES[code].nil? ? false : true
+    end
+
+    # 200
+    def self.ok?(code)
+      return code == Rack::Utils::SYMBOL_TO_STATUS_CODE[:ok]
+    end
+
+    # 400
+    def self.bad_request?(code)
+      return code == Rack::Utils::SYMBOL_TO_STATUS_CODE[:bad_request]
+    end
+
+    # 401
+    def self.unauthorized?(code)
+      return code == Rack::Utils::SYMBOL_TO_STATUS_CODE[:unauthorized]
+    end
+
+    # 404
+    def self.not_found?(code)
+      return code == Rack::Utils::SYMBOL_TO_STATUS_CODE[:not_found]
+    end
+
+    # 429
+    def self.too_many_requests?(code)
+      return code == Rack::Utils::SYMBOL_TO_STATUS_CODE[:too_many_requests]
+    end
+
+  end
+
+end

data/lib/rest_client_wrapper/paginators/echo.rb

@@ -0,0 +1,67 @@
+# Copyright (C) 2019 The University of Adelaide
+#
+# This file is part of Rest-Client-Wrapper.
+#
+# Rest-Client-Wrapper is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rest-Client-Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rest-Client-Wrapper. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require_relative "paginate"
+require_relative "../exceptions"
+
+module RestClientWrapper
+
+  # Paginator
+  module Paginator
+
+    include Paginate
+
+    # Echo
+    class Echo
+
+      attr_accessor :rest_client
+
+      def initialize(limit: Paginate::DEFAULT_PAGINATION_PAGE_SIZE)
+        @rest_client = nil
+        @config = { limit: limit }
+      end
+
+      def paginate(http_method:, uri:, 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 })
+          block_given? ? yield(response) : (responses << response)
+          links = _pagination_links(response)
+          break unless links.key?(:offset)
+
+          query_params[:offset] = links[:offset]
+        end
+        return data ? responses.map(&:body).pluck(:data).flatten : responses
+      end
+
+      private
+
+      def _pagination_links(response)
+        next_l = response&.body&.[](:next) || ""
+        next_h = Rack::Utils.parse_query(URI.parse(next_l)&.query)
+        return next_h.symbolize_keys!
+      end
+
+    end
+
+  end
+
+end