automation-test 1.19 → 1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f4d4c8244b7d92484f24313e1885a74fb6154a8044fbc5d32694ca4cbe802c
-  data.tar.gz: 4efdc95f1cbb8a4889cbf0b0a8e7bb2e1ce401e2a2c3e8a1dc4894cc27495871
+  metadata.gz: 0bbadee38c26e33d07680d66d9c3178bd21a397ef63e0faf86c34d5843a3dafa
+  data.tar.gz: 672fe6cfd2fb6eb91cbdf43f7ac2a7aae08ce313affe47f1a7a4d83df574654d
 SHA512:
-  metadata.gz: 5af3f880446823a884fee99314a6c18f0e999ec04a8ebe1db0ec7f303348c0ab08488fcab3dbfde461bb1417771a132adcc856f4ad7fd48daa879d9093b67cf0
-  data.tar.gz: bfdae30bb85ac6e95c80d50216204945763ef80ee28b1ef0bbd19c60a221c2c533e2e46b5a06fe9d07ca4156ecdbc998dcdded2112fd4a48acd51536d1b3ba67
+  metadata.gz: 516ad91a9ee37dd7f62598b46b1eebdd9820ebfda1dedabc6a12869c942b46e526dd6e48ff9c2b856ed189c25172c35b43599595930f0e4d8b869c7079cc41e0
+  data.tar.gz: 384ce20df710cb5421fe1b1d3caf6cee82b42fbf2646dbce657f84cc81ce980e702157a7265919877d9b50625eaedc531a50176f48c76bee342ea598dc70a29b

data/README.md

@@ -3,23 +3,31 @@
 
 ## Introduction
 
-Simple calculator API hosted on APIMATIC for demo on 29th Sept
+Simple calculator API hosted on APIMATIC
 
 ## Install the Package
 
 Install the gem from the command line:
 
 ```ruby
-gem install automation-test -v 1.19
+gem install automation-test -v 1.23
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'automation-test', '1.19'
+gem 'automation-test', '1.23'
 ```
 
-For additional gem details, see the [RubyGems page for the automation-test gem](https://rubygems.org/gems/automation-test/versions/1.19).
+For additional gem details, see the [RubyGems page for the automation-test gem](https://rubygems.org/gems/automation-test/versions/1.23).
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
 
 ## Initialize the API Client
 
@@ -29,6 +37,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
 | `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
 | `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
 | `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
@@ -39,7 +48,8 @@ The following parameters are configurable for the API Client:
 The API client can be initialized as follows:
 
 ```ruby
-client = ApimaticCalculator::Client.new(
+client = ApimaticCalculator::Client.new(
+  environment: Environment::PRODUCTION,
 )
 ```
 

data/lib/apimatic_calculator/configuration.rb

@@ -15,7 +15,7 @@ module ApimaticCalculator
   # An enum for API servers.
   class Server
     SERVER = [
-      DEFAULT = 'default'.freeze
+      CALCULATOR = 'Calculator'.freeze
     ].freeze
   end
 
@@ -96,7 +96,7 @@ module ApimaticCalculator
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       Environment::PRODUCTION => {
-        Server::DEFAULT => 'http://examples.apimatic.io/apps/calculator'
+        Server::CALCULATOR => 'https://examples.apimatic.io/apps/calculator'
       }
     }.freeze
 
@@ -104,7 +104,7 @@ module ApimaticCalculator
     # @param [Configuration::Server] The server enum for which the base URI is
     # required.
     # @return [String] The base URI.
-    def get_base_uri(server = Server::DEFAULT)
+    def get_base_uri(server = Server::CALCULATOR)
       ENVIRONMENTS[environment][server].clone
     end
   end

data/lib/apimatic_calculator/controllers/simple_calculator_controller.rb

@@ -11,31 +11,23 @@ module ApimaticCalculator
     end
 
     # Calculates the expression using the specified operation.
-    # 
-    # 
-    # | Table Column 1 | Table Column 2 | Table Column 3 |
-    # | -------------- | -------------- | -------------- |
-    # | Row 1x1        | Row 1x2        | Row 1x3        |
-    # | Row 2x1        | Row 2x2        | Row 2x3        |
     # @param [OperationTypeEnum] operation Required parameter: The operator to
     # apply on the variables
     # @param [Float] x Required parameter: The LHS value
     # @param [Float] y Required parameter: The RHS value
     # @return [Float] response from the API call
-    def calculate(operation,
-                  x,
-                  y)
+    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' => operation, 'encode' => true }
+        'operation' => { 'value' => options['operation'], 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'x' => x,
-        'y' => y
+        'x' => options['x'],
+        'y' => options['y']
       )
       _query_url = APIHelper.clean_url _query_builder
 

data/lib/apimatic_calculator/models/operation_type_enum.rb

@@ -7,16 +7,16 @@ module ApimaticCalculator
   # Possible operators are sum, subtract, multiply, divide
   class OperationTypeEnum
     OPERATION_TYPE_ENUM = [
-      # TODO: Write general description for SUM
+      # Represents the sum operator
       SUM = 'SUM'.freeze,
 
-      # TODO: Write general description for SUBTRACT
+      # Represents the subtract operator
       SUBTRACT = 'SUBTRACT'.freeze,
 
-      # TODO: Write general description for MULTIPLY
+      # Represents the multiply operator
       MULTIPLY = 'MULTIPLY'.freeze,
 
-      # TODO: Write general description for DIVIDE
+      # Represents the divide operator
       DIVIDE = 'DIVIDE'.freeze
     ].freeze
   end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,21 @@
+# apimatic_calculator
+#
+# 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 'apimatic_calculator'
+require_relative '../test_helper'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ApimaticCalculator
+
+  # Create configuration and set any test parameters
+  CONFIG = Configuration.new
+end

data/test/controllers/test_simple_calculator_controller.rb

@@ -0,0 +1,34 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+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
+  end
+
+  # Check if multiplication works
+  def test_multiply()
+    # Parameters for the API call
+    options = {}
+    options['operation'] = 'MULTIPLY'
+    options['x'] = 4
+    options['y'] = 5
+
+    # Perform the API call through the SDK function
+    result = @controller.get_calculate(options)
+
+    # 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('20', @response_catcher.response.raw_body)
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < ApimaticCalculator::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 @@
+# apimatic_calculator
+#
+# 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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: automation-test
 version: !ruby/object:Gem::Version
-  version: '1.19'
+  version: '1.23'
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -92,7 +92,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description: Simple calculator API hosted on APIMATIC for demo on 29th Sept
+- !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: Simple calculator API hosted on APIMATIC
 email: support@apimatic.io
 executables: []
 extensions: []
@@ -117,6 +151,10 @@ files:
 - lib/apimatic_calculator/models/operation_type_enum.rb
 - lib/apimatic_calculator/utilities/date_time_helper.rb
 - lib/apimatic_calculator/utilities/file_wrapper.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_simple_calculator_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
 homepage: https://apimatic.io
 licenses:
 - MIT