Getting Started with Cypress Test API

Introduction

This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and a custom model.

Install the gem from the command line:

gem install jescie-house-sdk -v 1.2.0

Or add the gem to your Gemfile and run bundle:

gem 'jescie-house-sdk', '1.2.0'

To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:

rake

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
default_host	`String`	Default: `'www.example.com'`
environment	`Environment`	The API environment. Default: `Environment.PRODUCTION`
connection	`Faraday::Connection`	The Faraday connection object passed by the SDK user for making requests
adapter	`Faraday::Adapter`	The Faraday adapter object passed by the SDK user for performing http requests
timeout	`Float`	The value to use for connection timeout. Default: 60
max_retries	`Integer`	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	`Float`	Pause in seconds between retries. Default: 1
backoff_factor	`Float`	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	`Array`	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	`Array`	A list of HTTP methods to retry. Default: %i[get put]
http_callback	`HttpCallBack`	The Http CallBack allows defining callables for pre and post API calls.

The API client can be initialized as follows:

client = CypressTestApi::Client.new(
  environment: Environment::PRODUCTION,
  default_host: 'www.example.com'
)