BATester 1.1.0

data/lib/ba_tester_with_custom_parameters/http/http_method_enum.rb

@@ -0,0 +1,13 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # 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
+  end
+end

data/lib/ba_tester_with_custom_parameters/http/http_request.rb

@@ -0,0 +1,50 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # 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.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    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
+  end
+end

data/lib/ba_tester_with_custom_parameters/http/http_response.rb

@@ -0,0 +1,29 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # 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
+  end
+end

data/lib/ba_tester_with_custom_parameters/models/base_model.rb

@@ -0,0 +1,36 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/ba_tester_with_custom_parameters/models/suite_code_enum.rb

@@ -0,0 +1,23 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # A integer based enum representing a Suite in a game of cards
+  class SuiteCodeEnum
+    SUITE_CODE_ENUM = [
+      # TODO: Write general description for HEARTS
+      HEARTS = 1,
+
+      # TODO: Write general description for SPADES
+      SPADES = 2,
+
+      # TODO: Write general description for CLUBS
+      CLUBS = 3,
+
+      # TODO: Write general description for DIAMONDS
+      DIAMONDS = 4
+    ].freeze
+  end
+end

data/lib/ba_tester_with_custom_parameters/utilities/file_wrapper.rb

@@ -0,0 +1,17 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # A utility to allow users to set the content-type for files
+  class FileWrapper
+    attr_reader :content_type
+    attr_reader :file
+
+    def initialize(file, content_type: 'application/octet-stream')
+      @file = file
+      @content_type = content_type
+    end
+  end
+end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,21 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'ba_tester_with_custom_parameters'
+require_relative '../test_helper'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include BaTesterWithCustomParameters
+
+  # Create configuration and set any test parameters
+  CONFIG = Configuration.new(environment: Environment::TESTING)
+end

data/test/controllers/test_api_controller.rb

@@ -0,0 +1,29 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class APIControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    @controller = APIController.new CONFIG, http_call_back: @response_catcher
+  end
+
+  # Todo: Add description for test test_basic_auth_test
+  def test_basic_auth_test()
+
+    # Perform the API call through the SDK function
+    result = @controller.get_basic_auth_test()
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    assert_equal('You\'ve passed the test!', @response_catcher.response.raw_body)
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < BaTesterWithCustomParameters::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,94 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'tempfile'
+require 'open-uri'
+
+class TestHelper
+
+  @cache = Hash.new
+
+  # Class method to compare the received headers with the expected headers.
+  # @param [Hash] A hash of expected headers (keys in lower case).
+  # @param [Hash] A hash of received headers.
+  # @param [Boolean, optional] A flag which determines if we allow extra headers.
+  def self.match_headers(expected_headers,
+                         received_headers,
+                         allow_extra: true)
+    return false if ((received_headers.length < expected_headers.length) ||
+                    ((allow_extra == false) && (received_headers.length > expected_headers.length)))
+
+    received_headers = Hash[received_headers.map{|k, v| [k.to_s.downcase, v]}]
+    expected_headers.each do |e_key, e_value|
+      return false unless received_headers.key?(e_key)
+      return false if ((e_value != nil) &&
+                       (e_value != received_headers[e_key]))
+    end
+
+    return true
+  end
+
+  # Class method to compare the received body with the expected body.
+  # @param [Dynamic] The expected body.
+  # @param [Dynamic] The received body.
+  # @param [Boolean, optional] A flag which determines if we check values in dictionaries.
+  # @param [Boolean, optional] A flag which determines if we check the order of array elements.
+  # @param [Boolean, optional] A flag which determines if we check the count of array elements.
+  def self.match_body(expected_body,
+                      received_body,
+                      check_values: false,
+                      check_order: false,
+                      check_count: false)
+    if expected_body.instance_of? Hash
+      return false unless received_body.instance_of? Hash
+      for key in expected_body.keys           
+        return false unless received_body.keys.include? key
+        if check_values or expected_body[key].instance_of? Hash
+          return false unless TestHelper.match_body(expected_body[key], 
+                                                    received_body[key], 
+                                                    check_values: check_values, 
+                                                    check_order: check_order, 
+                                                    check_count: check_count)
+        end
+      end
+    elsif expected_body.instance_of? Array
+      return False unless received_body.instance_of? Array
+      if check_count == true && (expected_body.length != received_body.length)
+        return false
+      else
+        previous_matches = Array.new
+        expected_body.each.with_index do |expected_element, i|
+          matches = (received_body.map.with_index do |received_element, j|
+                      j if TestHelper.match_body(expected_element, 
+                                                 received_element, 
+                                                 check_values: check_values, 
+                                                 check_order: check_order, 
+                                                 check_count: check_count)
+                    end).compact
+          return false if matches.length == 0
+          if check_order == true
+            return false if (i != 0 && matches.map{|x| previous_matches.map{|y| y > x}.all?}.all?)
+            previous_matches = matches
+          end
+        end
+      end
+    elsif expected_body != received_body
+      return false
+    end
+    return true
+  end  
+  
+  # Class method which takes a URL, downloads the file (if not already downloaded 
+  # for this test session) and returns the path of the file.
+  # @param [String] The URL of the required file.
+  def self.get_file(url)
+    unless @cache.keys.include? url  
+      @cache[url] = Tempfile.new('APIMatic')
+      @cache[url].binmode
+      @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
+    end
+    return @cache[url].path
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: BATester
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- APIMatic SDK Generator
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: certifi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ''
+email: support@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ba_tester_with_custom_parameters.rb
+- lib/ba_tester_with_custom_parameters/api_helper.rb
+- lib/ba_tester_with_custom_parameters/client.rb
+- lib/ba_tester_with_custom_parameters/configuration.rb
+- lib/ba_tester_with_custom_parameters/controllers/api_controller.rb
+- lib/ba_tester_with_custom_parameters/controllers/base_controller.rb
+- lib/ba_tester_with_custom_parameters/exceptions/api_exception.rb
+- lib/ba_tester_with_custom_parameters/http/auth/basic_auth.rb
+- lib/ba_tester_with_custom_parameters/http/faraday_client.rb
+- lib/ba_tester_with_custom_parameters/http/http_call_back.rb
+- lib/ba_tester_with_custom_parameters/http/http_client.rb
+- lib/ba_tester_with_custom_parameters/http/http_method_enum.rb
+- lib/ba_tester_with_custom_parameters/http/http_request.rb
+- lib/ba_tester_with_custom_parameters/http/http_response.rb
+- lib/ba_tester_with_custom_parameters/models/base_model.rb
+- lib/ba_tester_with_custom_parameters/models/suite_code_enum.rb
+- lib/ba_tester_with_custom_parameters/utilities/file_wrapper.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_api_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
+homepage: https://apimatic.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ba_tester_with_custom_parameters
+test_files: []