BATester 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc60ef680c3edf8a885861f678b83655a9df04e43142a1b3b8c0b5eaf3f1959a
+  data.tar.gz: a2eb5db5dc48637b5199e0d9e9e3713e79916d3ba3a3426a73d264ad2d0eaf9c
+SHA512:
+  metadata.gz: 49b2f03dc3a6f68663c92c9445a1f612e90e7d204963c7eb55121c3ab5108b53845bbba274641051a0b03942b9122c1f5c8cd503d2a319c5063c4ff6010dbdb3
+  data.tar.gz: 51bb72a762f0a2c12542627eb6c67189df681992a7ba5c5b557e68b33778f2a7f5c1481e5379a6e85c9827e9e993313faf5235f95fc4976cb6fc5a9bc4727703

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2020 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,182 @@
+# Getting Started with BATester with custom parameters
+
+## Getting Started
+
+### Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install BATester -v 1.1.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'BATester', '1.1.0'
+```
+
+For additional gem details, see the [RubyGems page for the BATester gem](https://rubygems.org/gems/BATester/versions/1.1.0).
+
+### Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+#### Fields
+
+| Name | Description |
+|  --- | --- |
+| production | - |
+| testing | **Default** |
+
+### Initialize the API Client
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `username` | `String` | *Default*: `'farhan'` |
+| `password` | `String` | *Default*: `'apimatic'` |
+| `port` | `String` | *Default*: `'80'` |
+| `suites` | `SuiteCodeEnum` | *Default*: `SuiteCodeEnum::HEARTS` |
+| `environment` | Environment | The API environment. <br> **Default: `Environment.TESTING`** |
+| `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** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 1** |
+
+The API client can be initialized as follows:
+
+```ruby
+client = BaTesterWithCustomParameters::Client.new(
+  username: 'farhan',
+  password: 'apimatic',
+  environment: Environment::TESTING,
+  port: '80',
+  suites: SuiteCodeEnum::HEARTS,
+)
+```
+
+### Authorization
+
+This API uses `Basic Authentication`.
+
+### Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Client Class Documentation
+
+### BATester with custom parameters Client
+
+The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
+
+### Controllers
+
+| Name | Description |
+|  --- | --- |
+| api | Gets APIController |
+
+## API Reference
+
+### List of APIs
+
+* [API](#api)
+
+### API
+
+#### Overview
+
+##### Get instance
+
+An instance of the `APIController` class can be accessed from the API Client.
+
+```
+client_controller = client.client
+```
+
+#### Get Basic Auth Test
+
+```ruby
+def get_basic_auth_test
+```
+
+##### Response Type
+
+`String`
+
+##### Example Usage
+
+```ruby
+result = client_controller.get_basic_auth_test()
+```
+
+## Model Reference
+
+### Enumerations
+
+* [Suite Code](#suite-code)
+
+#### Suite Code
+
+A integer based enum representing a Suite in a game of cards
+
+##### Class Name
+
+`SuiteCodeEnum`
+
+##### Fields
+
+| Name |
+|  --- |
+| `HEARTS` |
+| `SPADES` |
+| `CLUBS` |
+| `DIAMONDS` |
+
+## Utility Classes Documentation
+
+### ApiHelper Class
+
+API utility class.
+
+### Methods
+
+| Name | Return Type | Description |
+|  --- | --- | --- |
+| json_deserialize | Hash | Deserializes a JSON string to a Ruby Hash. |
+| rfc3339 | DateTime | Safely converts a string into an RFC3339 DateTime object. |
+
+## Common Code Documentation
+
+### HttpResponse
+
+Http response received.
+
+#### Properties
+
+| Name | Type | Description |
+|  --- | --- | --- |
+| status_code | Integer | The status code returned by the server. |
+| reason_phrase | String | The reason phrase returned by the server. |
+| headers | Hash | Response headers. |
+| raw_body | String | Response body. |
+| request | HttpRequest | The request that resulted in this response. |
+
+### HttpRequest
+
+Represents a single Http Request.
+
+#### Properties
+
+| Name | Type | Tag | Description |
+|  --- | --- | --- | --- |
+| http_method | HttpMethodEnum |  | The HTTP method of the request. |
+| query_url | String |  | The endpoint URL for the API request. |
+| headers | Hash | Optional | Request headers. |
+| parameters | Hash | Optional | Request body. |
+

data/lib/ba_tester_with_custom_parameters.rb

@@ -0,0 +1,40 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'ba_tester_with_custom_parameters/api_helper.rb'
+require_relative 'ba_tester_with_custom_parameters/client.rb'
+
+# Utilities
+require_relative 'ba_tester_with_custom_parameters/utilities/file_wrapper.rb'
+
+# Http
+require_relative 'ba_tester_with_custom_parameters/http/http_call_back.rb'
+require_relative 'ba_tester_with_custom_parameters/http/http_client.rb'
+require_relative 'ba_tester_with_custom_parameters/http/faraday_client.rb'
+require_relative 'ba_tester_with_custom_parameters/http/http_method_enum.rb'
+require_relative 'ba_tester_with_custom_parameters/http/http_request.rb'
+require_relative 'ba_tester_with_custom_parameters/http/http_response.rb'
+require_relative 'ba_tester_with_custom_parameters/http/auth/basic_auth.rb'
+
+# Models
+require_relative 'ba_tester_with_custom_parameters/models/base_model.rb'
+require_relative 'ba_tester_with_custom_parameters/models/suite_code_enum.rb'
+
+# Exceptions
+require_relative 'ba_tester_with_custom_parameters/exceptions/api_exception.rb'
+
+require_relative 'ba_tester_with_custom_parameters/configuration.rb'
+
+# Controllers
+require_relative 'ba_tester_with_custom_parameters/controllers/base' \
+                 '_controller.rb'
+require_relative 'ba_tester_with_custom_parameters/controllers/api' \
+                 '_controller.rb'

data/lib/ba_tester_with_custom_parameters/api_helper.rb

@@ -0,0 +1,289 @@
+# ba_tester_with_custom_parameters
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module BaTesterWithCustomParameters
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, val|
+        if val.nil?
+          replace_value = ''
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
+        else
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      array_serialization = 'indexed'
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join("\t")}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      array_serialization = 'indexed'
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          array_serialization))
+      end
+      encoded
+    end
+
+    def self.custom_merge(a, b)
+      x = {}
+      a.each do |key, value_a|
+        b.each do |k, value_b|
+          next unless key == k
+          x[k] = []
+          if value_a.instance_of? Array
+            value_a.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
+      retval = {}
+
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        if formatting == 'indexed'
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']'))
+          end
+        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+          obj.each do |value|
+            abc = if formatting == 'unindexed'
+                    APIHelper.form_encode(value, instance_name + '[]',
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']', formatting: formatting))
+          end
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+            key.to_s + ']', formatting: formatting))
+        end
+      elsif obj.instance_of? File
+        retval[instance_name] = UploadIO.new(
+          obj, 'application/octet-stream', File.basename(obj.path)
+        )
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+
+    # Retrieves a field from a Hash/Array based on an Array of keys/indexes
+    # @param [Hash, Array] The hash to extract data from
+    # @param [Array<String, Integer>] The keys/indexes to use
+    # @return [Object] The extracted value
+    def self.map_response(obj, keys)
+      val = obj
+      begin
+        keys.each do |key|
+          val = if val.is_a? Array
+                  if key.to_i.to_s == key
+                    val[key.to_i]
+                  else
+                    val = nil
+                  end
+                else
+                  val.fetch(key.to_sym)
+                end
+        end
+      rescue NoMethodError, TypeError, IndexError
+        val = nil
+      end
+      val
+    end
+
+    # Safely converts a string into an rfc3339 DateTime object
+    # @param [String] The datetime string
+    # @return [DateTime] A DateTime object of rfc3339 format
+    def self.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
+  end
+end