service_client 0.1.4 → 0.1.6

data/lib/service_client/base.rb

@@ -4,70 +4,126 @@ require 'httparty'
 require_relative 'response'
 
 module ServiceClient
-  # ParamsRequired error
+  # Raised when a required param is nil.
+  #
+  # @example Raise an error if any of the required params are nil.
+  #  raise ParamsRequired, "Params: #{params_required(params)} are required" if params_nil?(params)
   class ParamsRequired < StandardError; end
-
-  # Base class
+  # This class provides a lightweight and flexible way to make HTTP requests
+  # in Ruby projects.
+  #
+  # This class can be used to make GET, POST, PUT, and DELETE requests to RESTful APIs.
+  # It simplifies the HTTP request process with a simple and intuitive API, configurable
+  # base URL, and default headers. It also provides a consistent and structured way to
+  # receive responses.
   class Base
     class << self
+      # Sets the base URL to be used for all requests.
+      #
+      # @param url [String] the base URL to be used
       def base_url(url = nil)
         @base_url = url
       end
 
+      # Sets the default headers to be sent with all requests.
+      #
+      # @param headers [Hash] the default headers to be sent
       def default_headers(headers = nil)
         @default_headers = headers
       end
 
+      # Makes a POST request to the specified URL.
+      #
+      # @param url [String] the URL to make the request to
+      # @param headers [Hash] additional headers to send with the request
+      # @param body [Hash] the request body to send with the request
       def post(url = nil, headers: nil, body: nil)
-        raise_params_required(url: url, headers: headers, body: body)
-
-        request = HTTParty.post(build_url(url), headers: build_headers(headers), body: body)
-
-        make_response(request)
+        request(:post, url, headers: headers, body: body)
       end
 
+      # Makes a GET request to the specified URL.
+      #
+      # @param url [String] the URL to make the request to
+      # @param headers [Hash] additional headers to send with the request
       def get(url = nil, headers: nil)
-        raise_params_required(url: url)
-
-        request = HTTParty.get(build_url(url), headers: build_headers(headers))
-
-        make_response(request)
+        request(:get, url, headers: headers)
       end
 
+      # Makes a PUT request to the specified URL.
+      #
+      # @param url [String] the URL to make the request to
+      # @param headers [Hash] additional headers to send with the request
+      # @param body [Hash] the request body to send with the request
       def put(url = nil, headers: nil, body: nil)
-        raise_params_required(url: url, body: body)
-
-        request = HTTParty.put(build_url(url), headers: build_headers(headers), body: body)
-
-        make_response(request)
+        request(:put, url, headers: headers, body: body)
       end
 
+      # Makes a DELETE request to the specified URL.
+      #
+      # @param url [String] the URL to make the request to
+      # @param headers [Hash] additional headers to send with the request
       def delete(url = nil, headers: nil)
+        request(:delete, url, headers: headers)
+      end
+
+      private
+
+      # Makes an HTTP request to the specified URL.
+      #
+      # @param method [Symbol] the HTTP method to use (e.g. :get, :post)
+      # @param url [String] the URL to make the request to
+      # @param headers [Hash] additional headers to send with the request
+      # @param body [Hash] the request body to send with the request
+      def request(method, url, headers: nil, body: nil)
         raise_params_required(url: url)
 
-        request = HTTParty.delete(build_url(url), headers: build_headers(headers))
+        options = {
+          headers: build_headers(headers),
+          body: body
+        }.compact
+
+        request = HTTParty.send(method, build_url(url), options)
 
         make_response(request)
       end
 
-      private
-
+      # Converts the HTTP response into a structured response object.
+      #
+      # @param response [HTTParty::Response] the HTTP response object to convert
+      # @return [Response] the structured response object
       def make_response(response)
         Response.call(response)
       end
 
+      # Raises an error if any of the required params are nil.
+      # 
+      # @param params [Hash] the params to check for nil values
+      # @raise [ParamsRequired] if any of the params are nil
+      # @return [nil] if all params are not nil
       def raise_params_required(params)
-        raise ParamsRequired, "Params: #{nil_params(params)} are required" if params_nil?(params)
+        raise ParamsRequired, "Params: #{params_required(params)} are required" if params_nil?(params)
       end
 
-      def nil_params(params)
+      # Returns an array of the keys of the params that are nil.
+      #
+      # @param params [Hash] the params to check for nil values
+      # @return [Array] the keys of the params that are nil
+      def params_required(params)
         params.select { |_, value| value.nil? }.keys
       end
 
+      # Returns true if any of the params are nil.
+      #
+      # @param params [Hash] the params to check for nil values
+      # @return [Boolean] true if any of the params are nil
       def params_nil?(params)
         params.values.any?(&:nil?)
       end
 
+      # Builds the URL to make the request to.
+      #
+      # @param path [String] the path to append to the base URL
+      # @return [String] the URL to make the request
       def build_url(path)
         base_url = instance_variable_get('@base_url')
 
@@ -76,6 +132,10 @@ module ServiceClient
         [base_url, path].compact.join('/')
       end
 
+      # Builds the headers to send with the request.
+      #
+      # @param headers [Hash] the headers to send with the request
+      # @return [Hash] the headers to send with the request
       def build_headers(headers)
         default_headers = instance_variable_get('@default_headers')
         return default_headers if headers.nil?

data/lib/service_client/errors.rb

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
-# Purpose: ServiceClient::Errors module
+# This module defines a set of error classes for common HTTP status codes. Each error class inherits from BaseError,
+# which itself inherits from Ruby's StandardError class. These error classes are then used by the ServiceClient
+# module to raise specific errors for specific HTTP status codes.
 
-# Compare this snippet from lib/service_client/errors.rb:
 module ServiceClient
   # Errors module
   module Errors
-    # StandardError class
+    # BaseError class
     class BaseError < StandardError
-      attr_reader :response
-
+      # Initializes a new instance of the BaseError class with the given message and HTTP response.
+      # @param msg [String] The error message.
+      # @param response [HTTParty::Response] The HTTP response that caused the error.
       def initialize(msg, response)
         @response = response
         super(msg)
       end
+
+      # Returns the HTTP response that caused the error.
+      # @return [HTTParty::Response] The HTTP response.
+      attr_reader :response
     end
 
     # 400 – Bad Request
@@ -72,7 +78,7 @@ module ServiceClient
     class NoResponseError < BaseError; end
     # 449 – Retry With
     class RetryWithError < BaseError; end
-    # 450 – Bllocked by Windows Parental Controls
+    # 450 – Blocked by Windows Parental Controls
     class BlockedByWindowsParentalControlsError < BaseError; end
     # 451 – Unavailable For Legal Reasons
     class UnavailableForLegalReasonsError < BaseError; end
@@ -152,6 +158,12 @@ module ServiceClient
       '599': NetworkConnectTimeoutError,
     }.freeze
 
+    # Raises an error based on the given HTTP response.
+    #
+    # @param code [String] The HTTP response code.
+    # @param response [HTTParty::Response] The HTTP response.
+    # raise [BaseError] The error that corresponds to the given HTTP response code.
+    # @return [void]
     def raise_error(code, response)
       raise ERRORS[code.to_sym].new(ERRORS[code.to_sym].class.name, response)
     end

data/lib/service_client/response.rb

@@ -1,21 +1,31 @@
 # frozen_string_literal: true
+
 require_relative 'errors'
-# Purpose: Response class for ServiceClient
-#
-# Compare this snippet from lib/service_client/response.rb:
+
 module ServiceClient
-  # Response class
+  # The Response class encapsulates the HTTP response received by the ServiceClient gem.
+  #
+  # @attr_reader [Integer] code The HTTP status code of the response.
+  # @attr_reader [Hash, Array, String] data The parsed body of the response.
+  # @attr_reader [Hash] headers The HTTP headers of the response.
   class Response
     include ServiceClient::Errors
 
-    attr_accessor :code, :data, :headers
+    attr_reader :code, :data, :headers
 
+    # Initializes a new instance of Response with the given HTTP response object.
+    #
+    # @param response [HTTParty::Response] The HTTP response object.
     def initialize(response)
       @code = response.code
       @data = response.parsed_response
       @headers = response.headers
     end
 
+    # Determines whether the response was successful or not.
+    #
+    # @return [ServiceClient::Response] Returns itself if the response was successful.
+    # @raise [ServiceClient::Error] Raises an error with the response code and object if the response was unsuccessful.
     def call
       case code
       when 200..299
@@ -25,8 +35,15 @@ module ServiceClient
       end
     end
 
-    def self.call(response)
-      new(response).call
+    class << self
+      # Initializes a new instance of Response and calls it to determine success or failure.
+      #
+      # @param response [HTTParty::Response] The HTTP response object.
+      # @return [ServiceClient::Response] Returns itself if the response was successful.
+      # @raise [ServiceClient::Error] Raises an error with the response code and object if the response was unsuccessful.
+      def call(response)
+        new(response).call
+      end
     end
   end
 end

data/lib/service_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceClient
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Alef Ojeda de Oliveira
@@ -54,7 +54,70 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/ServiceClient.html
+- doc/ServiceClient/Base.html
+- doc/ServiceClient/Errors.html
+- doc/ServiceClient/Errors/BadGatewayError.html
+- doc/ServiceClient/Errors/BadRequestError.html
+- doc/ServiceClient/Errors/BaseError.html
+- doc/ServiceClient/Errors/BlockedByWindowsParentalControlsError.html
+- doc/ServiceClient/Errors/ClientClosedRequestError.html
+- doc/ServiceClient/Errors/ConflictError.html
+- doc/ServiceClient/Errors/EnhanceYourCalmError.html
+- doc/ServiceClient/Errors/ExpectationFailedError.html
+- doc/ServiceClient/Errors/FailedDependencyError.html
+- doc/ServiceClient/Errors/ForbiddenError.html
+- doc/ServiceClient/Errors/GatewayTimeoutError.html
+- doc/ServiceClient/Errors/GoneError.html
+- doc/ServiceClient/Errors/HTTPVersionNotSupportedError.html
+- doc/ServiceClient/Errors/InsufficientStorageError.html
+- doc/ServiceClient/Errors/InternalServerError.html
+- doc/ServiceClient/Errors/LengthRequiredError.html
+- doc/ServiceClient/Errors/LockedError.html
+- doc/ServiceClient/Errors/LoopDetectedError.html
+- doc/ServiceClient/Errors/MethodNotAllowedError.html
+- doc/ServiceClient/Errors/NetworkAuthenticationRequiredError.html
+- doc/ServiceClient/Errors/NetworkConnectTimeoutError.html
+- doc/ServiceClient/Errors/NetworkReadTimeoutError.html
+- doc/ServiceClient/Errors/NoResponseError.html
+- doc/ServiceClient/Errors/NotAcceptableError.html
+- doc/ServiceClient/Errors/NotExtendedError.html
+- doc/ServiceClient/Errors/NotFoundError.html
+- doc/ServiceClient/Errors/NotImplementedError.html
+- doc/ServiceClient/Errors/PaymentRequiredError.html
+- doc/ServiceClient/Errors/PreconditionFailedError.html
+- doc/ServiceClient/Errors/PreconditionRequiredError.html
+- doc/ServiceClient/Errors/ProxyAuthenticationRequiredError.html
+- doc/ServiceClient/Errors/RequestEntityTooLargeError.html
+- doc/ServiceClient/Errors/RequestHeaderFieldsTooLargeError.html
+- doc/ServiceClient/Errors/RequestTimeoutError.html
+- doc/ServiceClient/Errors/RequestURITooLongError.html
+- doc/ServiceClient/Errors/RequestedRangeNotSatisfiableError.html
+- doc/ServiceClient/Errors/RetryWithError.html
+- doc/ServiceClient/Errors/ServiceUnavailableError.html
+- doc/ServiceClient/Errors/TooManyRequestsError.html
+- doc/ServiceClient/Errors/UnauthorizedError.html
+- doc/ServiceClient/Errors/UnavailableForLegalReasonsError.html
+- doc/ServiceClient/Errors/UnprocessableEntityError.html
+- doc/ServiceClient/Errors/UnsupportedMediaTypeError.html
+- doc/ServiceClient/Errors/UpgradeRequiredError.html
+- doc/ServiceClient/Errors/VariantAlsoNegotiatesError.html
+- doc/ServiceClient/ParamsRequired.html
+- doc/ServiceClient/Response.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
 - doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/service_client.rb
 - lib/service_client/base.rb
 - lib/service_client/errors.rb
@@ -82,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Service client