What's New?
7.2.0
Cookies
Hyper can now send cookies with a request and parse the returned cookies from a response. See the HyperRequest and HyperResponse docs for details.
7.1.0
Fake Requests
Hyper now has the ability to fake requests and return fake responses as a result. This is perfect for testing scenarios where you don't actually want to make an HTTP request.
Faking RequestsCustom Hyper Clients
It is now more straightforward to register a custom Hyper client. Inside your config/WireBox.cfc
in an afterAspectsLoad
method, you can get a reference to a HyperBuilder
, configure it as you would for a request, and then call the registerAs
method passing in your desired WireBox alias.
This is a welcome improvement as the init
arguments do not exactly match the method names. Also, for defaults like requestCallbacks
, responseCallbacks
, or even queryParams
, passing in arrays of functions or arrays or structs is not as straightforward as calling the related methods. Now, you can use the Hyper methods you are familiar with when registering your custom Hyper clients.
Putting the registration code in afterAspectsLoad
is required so Hyper can be loaded and available for injection.
7.0.0
CFHttp HTTP Client
This client now returns more accurate status codes for 502 Bad Gateway
and 408 Request Timeout
responses.
Previously, these responses were returned as 504 Gateway Timeout
responses. Hyper now normalizes the responses from the different CFML engines into a consistent response. 502 Bad Gateway
is returned instead of 504 Gateway Timeout
for invalid hosts. 408 Request Timeout
is returned if the request takes longer than the configured timeout
value.
Breaking Changes
If you were previously checking specifically for 504
status codes for bad hosts, you need to now either check for 502
status codes or use a more general method, like isServerError
or isError
.
If you were previously checking specifically for 504
status codes or isServerError
for timed out requests, you need to now either check for 408
status codes, isClientError
, or the more general isError
.
6.1.0
Add head
and options
shortcut methods.
6.0.0
Add
xml
support and anasXML
method to set the body format andContent-Type
header.Add
adobe@2023
to testing matrix.
Breaking Changes
Dropped
adobe@2016
support.
5.0.1
Correctly handle cases when the body
is a string and format is JSON
.
5.0.0
Add a debug
method to see what the HTTP client generates.
Breaking Changes
HyperHttpClientInterface
now requires a debug
method.
4.0.3
Do not prepend the base url when a full url is passed.
Add
resolveUrls
andencodeUrl
properties to the memento.Correctly set the
encodeUrl
property when cloning a request.
4.0.2
Update README for builder initWith
headers losing Content-Type
.
4.0.1
Fix HyperBuilder
example in the docs.
4.0.0
Allow adding multiple query params with the same key.
Breaking Changes
Previously, query params were stored as a struct. Some APIs expect multiple values for the same query param name to be passed as separate arguments. Hyper now stores the query params as an array and provides new methods for interacting with query params:
The following methods still exist, but now interact with arrays of query param structs instead of a simple struct.
The following methods have been deprecated:
Deprecated Method | Replacement Method |
---|---|
3.6.2
Convert array values correctly when sending form fields
3.6.1
Add a workaround for CommandBox not having the box:asyncManager
injection DSL.
3.6.0
Add async requests using ColdBox's AsyncManager.
3.5.0
Provide more useful error than cfhttp when
throwOnErrors
is enabled.Provide mementos for HyperRequest and HyperResponse instances.
Capture statusText and provide a status convenience string.
3.4.2
Add MIT License file
3.4.1
Use processState
over announce
until CommandBox can update its interceptorService
.
3.4.0
HyperRequest
Add
forwardHeaders
shortcut method.
HyperResponse
Allow for default values in
getHeader
.Add helper methods for checking for specific status codes:
3.3.0
Allowing attaching file uploads.
3.2.1
Support WireBox outside of ColdBox.
3.2.0
Include response data as detail in DeserializeJsonException
.
3.1.0
Add
clone
to quickly copyHyperRequest
instances.
3.0.0
Add execution time to HyperResponse
instances.
Breaking Changes
Dropped support for ColdBox 5.
2.3.11
Add support for NTLM authentication.
Include
getFullURL
method in docs.
2.3.10
Fixed typo of Bulider
to Builder
.
2.3.9
Add withoutEncodingUrl
flag.
2.3.8
Do not fail fast on cron job actions on CI.
2.3.7
Update fetch-depth for tests and release actions on CI.
2.3.6
Attempt to skip committing back changes on CI.
2.3.5
Add matrix and cron testing on CI.
2.3.4
Use better GitHub token on CI
2.3.1
Add workaround for boolean
values in query strings.
2.3.0
Add certificate auth.
2.2.1
Use the previous host for redirect if redirect does not include a full URL.
2.2.0
Add resolveUrls
flag.
2.1.1
Use OpenJDK instead of OracleJDK on CI.
2.1.0
Allow for pluggable HTTP Clients that follow the HyperHttpClientInterface
. (Clients do not need to use the implements
keyword.)
2.0.2
Avoid double encoding using cfhttpparam
.
2.0.1
Remove Lucee 4.5 support from docs. (Support was dropped in v2.0.0)
2.0.0
Add
adobe@2018
support to CI builds.
Breaking Changes
Dropped support for lucee@4.5
.
1.15.0
Add throwOnError
flag.
1.14.5
Use 504 Gateway Timeout
for incomplete responses.
1.14.4
Include equal signs in query param values.
1.14.0 – 1.0.0
New Features
Add
when
helper to execute conditions without breaking chaining.Add
clear
method to reset HyperRequest instances.Add configurable
timeout
.
Bug Fixes
Fix for Lucee 4 compatibility on
LinkedHashMaps
andkeyArray
.Preserve case in header names.
Preserve case for query parameters.
Serialize both params from the url and set on the
HyperRequest
instance.Default to
UTF-8
charset if none is present in the response.Fix withHeaders and withQueryParams for Lucee compatibility.
Only map HyperBuilder as a singleton in WireBox
Other
Migrate to coldbox-modules organization on GitHub.
Update
box.json
description.Enable CommandBox Semantic Release on CI.
Last updated