uniqueCalculator 1.1 → 1.2.7

data/lib/apimatic_calculator/controllers/base_controller.rb

@@ -8,52 +8,58 @@ module ApimaticCalculator
   class BaseController
     attr_accessor :config, :http_call_back
 
-    def initialize(config, http_call_back: nil)
-      @config = config
-      @http_call_back = http_call_back
-
-      @global_headers = {
-        'user-agent' => get_user_agent
-      }
-    end
-
-    def validate_parameters(args)
-      args.each do |_name, value|
-        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
-      end
+    def self.user_agent
+      'APIMATIC 3.0'
     end
 
-    def validate_parameters_types(args)
-      args.each do |_name, type|
-        key, val = type.first
-        APIHelper.validate_types(key, val) unless key.nil?
-      end
-    end
 
-    def execute_request(request, binary: false)
-      @http_call_back&.on_before_request(request)
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
 
-      APIHelper.clean_hash(request.headers)
-      request.headers.merge!(@global_headers)
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
 
-      response = if binary
-                   config.http_client.execute_as_binary(request)
-                 else
-                   config.http_client.execute_as_string(request)
-                 end
-      @http_call_back&.on_after_response(response)
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
 
-      response
+    # Creates a new instance of the request builder.
+    # @param [HttpMethodEnum] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
     end
 
-    def validate_response(response)
-      raise APIException.new 'HTTP Response Not OK', response unless
-        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
     end
 
-    def get_user_agent
-      user_agent = 'APIMATIC 3.0'
-      user_agent
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
     end
   end
 end

data/lib/apimatic_calculator/controllers/simple_calculator_controller.rb

@@ -6,10 +6,6 @@
 module ApimaticCalculator
   # SimpleCalculatorController
   class SimpleCalculatorController < BaseController
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Calculates the expression using the specified operation.
     # @param [OperationTypeEnum] operation Required parameter: The operator to
     # apply on the variables
@@ -17,29 +13,19 @@ module ApimaticCalculator
     # @param [Float] y Required parameter: The RHS value
     # @return [Float] response from the API call
     def get_calculate(options = {})
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/{operation}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'operation' => { 'value' => options['operation'], 'encode' => true }
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'x' => options['x'],
-        'y' => options['y']
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url
-      )
-      _response = execute_request(_request)
-      validate_response(_response)
-
-      # Return appropriate response type.
-      _response.raw_body.to_f
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/{operation}',
+                                     Server::CALCULATOR)
+                   .template_param(new_parameter(options['operation'], key: 'operation')
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['x'], key: 'x'))
+                   .query_param(new_parameter(options['y'], key: 'y')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_f end)
+                   .is_primitive_response(true))
+        .execute
     end
   end
 end

data/lib/apimatic_calculator/exceptions/api_exception.rb

@@ -5,16 +5,6 @@
 
 module ApimaticCalculator
   # Class for exceptions when there is a network error, status code error, etc.
-  class APIException < StandardError
-    attr_reader :response, :response_code
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason)
-      @response = response
-      @response_code = response.status_code
-    end
+  class APIException < CoreLibrary::ApiException
   end
 end

data/lib/apimatic_calculator/http/http_call_back.rb

@@ -5,20 +5,6 @@
 
 module ApimaticCalculator
   # HttpCallBack allows defining callables for pre and post API calls.
-  class HttpCallBack
-    # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] The HttpRequest object which the HttpClient
-    # will execute.
-    def on_before_request(_http_request)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
-
-    # A controller will call this method after making an HTTP Request.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def on_after_response(_http_response)
-      raise NotImplementedError, 'This method needs
-        to be implemented in a child class.'
-    end
+  class HttpCallBack < CoreLibrary::HttpCallback
   end
 end

data/lib/apimatic_calculator/http/http_method_enum.rb

@@ -5,9 +5,6 @@
 
 module ApimaticCalculator
   # HTTP Methods Enumeration.
-  class HttpMethodEnum
-    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
-                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
-                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  class HttpMethodEnum < CoreLibrary::HttpMethod
   end
 end

data/lib/apimatic_calculator/http/http_request.rb

@@ -5,50 +5,6 @@
 
 module ApimaticCalculator
   # Represents a single Http Request.
-  class HttpRequest
-    attr_accessor :http_method, :query_url, :headers,
-                  :parameters, :username, :password,
-                  :context
-
-    # The constructor.
-    # @param [HttpMethodEnum] The HTTP method.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
-    # @param [Hash, Optional] The context for the HTTP Request.
-    def initialize(http_method,
-                   query_url,
-                   headers: {},
-                   parameters: {},
-                   context: {})
-      @http_method = http_method
-      @query_url = query_url
-      @headers = headers
-      @parameters = parameters
-      @context = context
-    end
-
-    # Add a header to the HttpRequest.
-    # @param [String] The name of the header.
-    # @param [String] The value of the header.
-    def add_header(name, value)
-      @headers[name] = value
-    end
-
-    # Add a parameter to the HttpRequest.
-    # @param [String] The name of the parameter.
-    # @param [String] The value of the parameter.
-    def add_parameter(name, value)
-      @parameters[name] = value
-    end
-
-    # Add a query parameter to the HttpRequest.
-    # @param [String] The name of the query parameter.
-    # @param [String] The value of the query parameter.
-    def add_query_parameter(name, value)
-      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
-                                                              name => value)
-      @query_url = APIHelper.clean_url(@query_url)
-    end
+  class HttpRequest < CoreLibrary::HttpRequest
   end
 end

data/lib/apimatic_calculator/http/http_response.rb

@@ -5,25 +5,6 @@
 
 module ApimaticCalculator
   # Http response received.
-  class HttpResponse
-    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
-
-    # The constructor
-    # @param [Integer] The status code returned by the server.
-    # @param [String] The reason phrase returned by the server.
-    # @param [Hash] The headers sent by the server in the response.
-    # @param [String] The raw body of the response.
-    # @param [HttpRequest] The request that resulted in this response.
-    def initialize(status_code,
-                   reason_phrase,
-                   headers,
-                   raw_body,
-                   request)
-      @status_code = status_code
-      @reason_phrase = reason_phrase
-      @headers = headers
-      @raw_body = raw_body
-      @request = request
-    end
+  class HttpResponse < CoreLibrary::HttpResponse
   end
 end

data/lib/apimatic_calculator/models/base_model.rb

@@ -5,7 +5,7 @@
 
 module ApimaticCalculator
   # Base model.
-  class BaseModel
+  class BaseModel < CoreLibrary::BaseModel
     # Returns a Hash representation of the current object.
     def to_hash
       hash = {}

data/lib/apimatic_calculator/utilities/date_time_helper.rb

@@ -6,151 +6,6 @@
 require 'date'
 module ApimaticCalculator
   # A utility  that supports dateTime conversion to different formats
-  class DateTimeHelper
-    # Safely converts a DateTime object into a rfc1123 format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The rfc1123 formatted datetime string
-    def self.to_rfc1123(date_time)
-      date_time&.httpdate
-    end
-
-    # Safely converts a map of DateTime objects into a map of rfc1123 format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of rfc1123 formatted datetime string
-    def self.to_rfc1123_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into an array of rfc1123 format string
-    # @param [Array] an array of DateTime objects
-    # @return [Array] an array of rfc1123 formatted datetime string
-    def self.to_rfc1123_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
-        end
-      end
-    end
-
-    # Safely converts a DateTime object into a unix format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The unix formatted datetime string
-    def self.to_unix(date_time)
-      date_time.to_time.utc.to_i unless date_time.nil?
-    end
-
-    # Safely converts a map of DateTime objects into a map of unix format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of unix formatted datetime string
-    def self.to_unix_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into a map of unix format string
-    # @param [hash] an array of DateTime objects
-    # @return [hash] an array of unix formatted datetime string
-    def self.to_unix_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
-        end
-      end
-    end
-
-    # Safely converts a DateTime object into a rfc3339 format string
-    # @param [DateTime] The DateTime object
-    # @return [String] The rfc3339 formatted datetime string
-    def self.to_rfc3339(date_time)
-      date_time&.rfc3339
-    end
-
-    # Safely converts a map of DateTime objects into a map of rfc1123 format string
-    # @param [hash] a map of DateTime objects
-    # @return [hash] a map of rfc1123 formatted datetime string
-    def self.to_rfc3339_map(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = {}
-      date_time.each do |k, v|
-        hash[key][k] =
-          if v.is_a?(BaseModel)
-            v.to_hash
-          else
-            v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
-          end
-      end
-      hash[key]
-    end
-
-    # Safely converts an array of DateTime objects into an array of rfc1123 format string
-    # @param [Array] an array of DateTime objects
-    # @return [Array] an array of rfc1123 formatted datetime string
-    def self.to_rfc3339_array(date_time, hash, key)
-      return if date_time.nil?
-
-      hash[key] = date_time.map do |v|
-        if v.is_a?(BaseModel)
-          v.to_hash
-        else
-          v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
-        end
-      end
-    end
-
-    # Safely converts a rfc1123 format string into a DateTime object
-    # @param [String] The rfc1123 formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_rfc1123(date_time)
-      DateTime.httpdate(date_time)
-    end
-
-    # Safely converts a unix format string into a DateTime object
-    # @param [String] The unix formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_unix(date_time)
-      Time.at(date_time.to_i).utc.to_datetime
-    end
-
-    # Safely converts a rfc3339 format string into a DateTime object
-    # @param [String] The rfc3339 formatted datetime string
-    # @return [DateTime] A DateTime object
-    def self.from_rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
-      else
-        DateTime.rfc3339("#{date_time}Z")
-      end
-    end
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
   end
 end

data/lib/apimatic_calculator/utilities/file_wrapper.rb

@@ -5,12 +5,12 @@
 
 module ApimaticCalculator
   # A utility to allow users to set the content-type for files
-  class FileWrapper
-    attr_reader :content_type, :file
-
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
     def initialize(file, content_type: 'application/octet-stream')
-      @file = file
-      @content_type = content_type
+      super
     end
   end
 end

data/lib/apimatic_calculator.rb

@@ -5,9 +5,12 @@
 
 require 'date'
 require 'json'
-require 'faraday'
-require 'certifi'
-require 'logging'
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+# rubocop:disable Style/MixinUsage
+include CoreLibrary
+# rubocop:enable Style/MixinUsage
 
 require_relative 'apimatic_calculator/api_helper'
 require_relative 'apimatic_calculator/client'
@@ -18,8 +21,6 @@ require_relative 'apimatic_calculator/utilities/date_time_helper'
 
 # Http
 require_relative 'apimatic_calculator/http/http_call_back'
-require_relative 'apimatic_calculator/http/http_client'
-require_relative 'apimatic_calculator/http/faraday_client'
 require_relative 'apimatic_calculator/http/http_method_enum'
 require_relative 'apimatic_calculator/http/http_request'
 require_relative 'apimatic_calculator/http/http_response'
@@ -30,7 +31,6 @@ require_relative 'apimatic_calculator/models/operation_type_enum'
 
 # Exceptions
 require_relative 'apimatic_calculator/exceptions/api_exception'
-require_relative 'apimatic_calculator/exceptions/validation_exception'
 
 require_relative 'apimatic_calculator/configuration'
 

data/test/controllers/controller_test_base.rb

@@ -9,7 +9,6 @@ require 'minitest/hell'
 require 'minitest/pride'
 require 'minitest/proveit'
 require 'apimatic_calculator'
-require_relative '../test_helper'
 require_relative '../http_response_catcher'
 
 class ControllerTestBase < Minitest::Test
@@ -17,5 +16,13 @@ class ControllerTestBase < Minitest::Test
   include ApimaticCalculator
 
   # Create configuration and set any test parameters
-  CONFIG = Configuration.new
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+  end
 end

data/test/controllers/test_simple_calculator_controller.rb

@@ -8,8 +8,9 @@ require_relative 'controller_test_base'
 class SimpleCalculatorControllerTests < ControllerTestBase
   # Called only once for the class before any test has executed
   def setup
-    @response_catcher = HttpResponseCatcher.new
-    @controller = SimpleCalculatorController.new CONFIG, http_call_back: @response_catcher
+    setup_class
+    @controller = @client.simple_calculator
+    @response_catcher = @controller.http_call_back
   end
 
   # Check if multiplication works