Skip to content

Latest commit

 

History

History
505 lines (395 loc) · 20.4 KB

CHANGELOG.md

File metadata and controls

505 lines (395 loc) · 20.4 KB
Raw

3.11.12 (pending)

  • make the default basic cache concurrent.

3.11.11

  • useSystemProperties is not overwritten and should be reset back to true on reset

3.11.10

  • issue #394 use the configured Object Mapper rather than always Json
  • internal pre-factorings to get ready for Unirest 4

3.11.09

  • Expected body param values for Mock expects need to be url encoded
  • Support ANY expectation on methods for MockClient. (e.g. ```expect(HttpMethod.GET)``)

3.11.08

  • Adds new body matchers to the Mock client for asserting multipart forms.

3.11.07

  • add a new object constructor on JSONObject for basic object serialization
  • issue #392 overwrite non-specified number serialization

3.11.06

  • add a convenience method for setting the content type
  • add a common reference to popular mime types
  • cache methods on Config were not returning the config for the builder pattern.
  • add a CookieSpecs const class for reference

3.11.05

  • issue #383 some problems with relocated packages.

3.11.04

  • issue #383 missing some relocations for uber-jars
  • PR #381 support for custom ciphers and protocols for https requests
  • Mock server should call into metrics just like the real thing
  • CI/CD improvements

3.11.03

  • issue #378 make getDefaultBaseUrl public
  • issue #376 make sane toString representations for body parts.
  • issue #376 add a method for getting a particular body field
  • issue #376 added a asString() to the request summary to get string of the request so far suitable for logging
  • issue #379 Interceptors are not called when using MockClient

3.11.02

  • Issue #373 MockClient should pass the config to the response.
  • Issue #374 Add methods to add default cookies to the config
  • Issue #375 Do not Escape HTML in JSON

3.11.01

  • Upgrade Apache Http Client to 4.5.13 (fixes incorrect handling of malformed authority component in request URIs.)
  • Upgrade Jackson to 2.11.3 for the Jackson object mapper module
  • Upgrade various test and ci dependencies

3.11.00

  • issue #368 honor hosts header when set by consumer. This mimics behavior in Postman
  • issue #370 expose copyOptions for file downloads
  • issue #265 New Mocking framework! See the unirest-mocks module.
  • issue #305 adding a noCharset() method as a more obvious way to do noCharset(null)
  • Added Documentation
  • Merged the request body(JSONObject) amd body(JSONArray) into common body(JSONElement) method
  • Filled in some missing methods on RequestBodyEntity from HttpRequestWithBody to fully allow chaining in different orders.

3.10.00

  • Introduce new HttpStatus constants class for reference to Http response codes.
  • Switch the ApacheClient to use Apache's build in eviction monitor rather than a custom one.
  • Add native default support for various Java DateTime types for the built in object mapper. All types will serialize to ISO-8601. Parsing from json will attempt various ISO variants.
    • Types Supported:
      • ZonedDateTime
      • LocalDateTime
      • LocalDate
      • Calendar
      • Date

3.9.00

  • Issue #362 when passing a string to the body method for a post, route as a string rather than passing to the object mapper.
  • Issue #362 when passing a native Unirest JSON Type to the body method for a post, route as a Json Type rather than passing to the object mapper.
  • issue #363 support multiple interceptors

3.8.06

  • issue #359 make the default object mapper lazy so gson can be excluded

3.8.01-.05 (RIP)

  • sacrificed to an angry Nexus god.
  • Nexus deploy plugin upgraded

3.8.00

  • Minor updates to org.apache.httpcomponents to 4.5.12
  • Upgrade Jackson to 2.11.0
  • Switch all unit tests to JUnit 5 and update Mockito
  • issue #358 add ability to set a collection of cookies
  • issue #325 add response caching framework

3.7.04

  • issue #357 Nulls are not serialized on JSONElement::toString

3.7.03

  • fix defaultBaseUrl to return the config builder

3.7.02

  • Issue #348 Add 'Duration' as flavor to configure connection TTL
  • Issue #350 Parsing error occurs when POST response is empty gzip content type

3.7.01

  • Issue #345 better error for path segment missing in JSONPointer
  • Support mapError to map into a String

3.7.00

  • Issue #342: Add a default base URL configuration

3.6.01

  • Issue #341:
    • Do not URLDecode cookie values because they may not be and decoding can remove legit values like +
    • Split cookie pairs on the first = only so values can have =

3.6.00

  • issue #336 Add ProgressMonitor for file downloads.

3.5.00

  • Re-package the object mapper sub-modules to work with Java 11 per issue #324.
  • Update Jackson to 2.10.2
  • Update various build tools to work with Java 11

3.4.04

  • issue #335 keep around failure bodies for mapping to error objects
  • Request objects implement equals for future feature to support request caching

3.4.03

  • Patch bump of all Apache dependencies
  • Patch bump of gson
  • Minor bump of test dependencies: junit, mockito, etc

3.4.02

  • #333 Spaces in route parameters
  • added the SameSite cookie attribute to the cookie parser
  • Updated checkstyle test dependency for security

3.4.01

  • #331 ArrayIndexOutOfBoundsException when parsing cookie
  • Handle quoted cookie values

3.4.00

  • Add methods to add cookies to the request and read cookie from the response

3.3.00

  • Allow setting a custom HostNameVerifier for issue #322
  • By default use DefaultHostNameVerifier rather than the noop one

3.2.00

  • Allow users to inject a custom SSLContext into the Config for security
  • Allow for a custom interceptor that is called when
    • Before the request
    • After the request
    • When a fatal connection error happens.
  • Directly exposing Apache Interceptors is now deprecated
  • #319 escape spaces and tabs in raw urls
  • Override toString on Headers for better logging pr #321

3.1.02

  • #308 When parsing an error body allow for non-parsing error bodies

3.1.00

  • #301 Unirest is now configured by default with a JsonObjectMapper
  • #302 Support a globally configured error consumer
  • JsonNode now has a toPrettyString method for getting a formatted json string

3.0.00

  • Replace the dependency on org.json with a native kong.unirest library powered by gson that matches org.json interfaces. See the Upgrade Guide for details.
  • Issue #299. Remove gzip content-encoding header after decompression on async client

2.4.01

  • #308 When parsing an error body allow for non-parsing error bodies

2.4.00

  • add an entire new return type: asBytes() (as well as async versions) will return a raw byte[] array.

2.3.17

  • Issue #292: Use per request Object Mapper for request bodies.

2.3.16

  • Catch the proper error rather than Exception in the old-apache compatibility fix

2.3.15

  • Update jackson-databind to 2.9.9.3 because .2 has shenanigans

2.3.14

  • Update jackson-databind to 2.9.9.2 to address moderate security vulnerability

2.3.13

  • Add FAIL_ON_UNKNOWN_PROPERTIES = false to the default Jackson object mapper.

2.3.12

  • Remember when an older version of apache was on the path for the remainder of the runtime

2.3.11

  • Skip calling apache method that may not exist if older versions of client are on the path to avoid MethodNotFound exceptions.
  • Add a config option for setting the TTL of persistent connections:/ issue #286

2.3.10

  • Update of jackson-databind for CVE-2019-12814

2.3.09

  • #284 allow setting a custom factory for the RequestConfig

2.3.08

  • #282 force maven not to pick the async clients version of client

2.3.07

  • #280 regular Apache client not picking up max connections

2.3.06

  • Updated dependencies to latest, including Apache Http Client (4.5.9)

2.3.05

  • Unriest is now packaged both as a traditional jar and as a standalone jar with all of it's dependencies shaded. This is nice when you have a large project where many components may use different versions of things like Apache Http Client.

2.3.02

  • Remove mistaken dependency that should have been scoped to test.

2.3.01

  • Update Jackson dependency in object-mapper-jackson due to security.

2.3.00

  • #267 make sure hooks are registered regardless of where we are in the lifecycle of the client engines
  • #264 Adds a metric hook for observing the health and performance of unirest.
  • #270 Throw a more helpful error when a older version of Apache Client has been pulled in over Unirest's requirement.
  • Upgrade Apache Http Client Dependency to 4.5.8

2.2.02

  • Add a mapper function to transform a HttpResponse to a HttpResponse
HttpResponse<Integer> response = Unirest.get("http://someplace/number")
                .asString()
                .map(Integer::valueOf);
  • Add a few ways to map a error response into a different type than the original
ErrorThing error = Unirest.get("http://someplace")
                .asObject(Thing.class)
                .mapError(ErrorThing.class); // will be null if the request had been successful

Unirest.get("http://someplace")
                .asObject(Thing.class)
                .ifFailure(ErrorThing.class, f -> {
                    // f is a HttpResponse<ErrorThing> 
                    // this function is not called if the request was succesful
                });

2.2.01

  • add cookiespec policies to config. These are the same as Apache Http Clients cookiespec. See org.apache.http.client.config.CookieSpec

2.2.00

  • Introduce default implementations of popular object mappers
    • Jackson
    • GSON

2.1.03

  • Finally address #26 You can add a file upload progress monitor. This monitor will get called for each file in a multipart file upload by name.
    Unirest.post("http://someplace")
           .field("myFile", new File("/file/somthing.tar")
           .uploadMonitor((fieldName, fileName, bytesWritten, totalBytes) -> {
                // draw a upload progress bar or something
           })
           .asEmpty()
  • Fix an issue where when using generic methods that take object, passing in complex objects like InputStreams would not get send as the correct type.

2.1.02

  • #120 support client certificates. You can pass in an entire keystore or just the path to it in the config.
  • part of #260: only support a single basic auth header.

2.1.01

  • #260 add option to configure a default basic auth header

2.1.00

  • #259 optionally flag the config to auto register the clients with shutdownhooks.
  • #165 allow forcing a simple url-encoded param POST/PUT to be multipart. This adds a new method to the body interface so bumping the minor.

2.0.05

  • #118 enable overriding socket and connection timeouts per request
  • #72 enable passing a proxy per request. Only works with simple proxies for now.

2.0.04

  • Disable SSL validation with Unirest.config().verifySsl(false). PLEASE DO NOT DO THIS IN PRODUCTION
  • Disable Automatic retries with Unirest.config().automaticRetries(false)

2.0.03

  • Make sure the GzipInputStream gets closed.
  • Support disabling compressed results which is asked for by default
Unirest.config().requestCompression(false);

2.0.02

  • Pass route params as a map
Unirest.get("http://example")
       .routeParam(ImmutableMap.of("cheese", "cheddar", "age", 42))

The following were releases from the merged OpenUnirest project

OpenUnirest:3.3.05

  • Add a noop response type when you just don't care about the body.
   HttpResponse re = Unirest.get("http://no.body.knows").asEmpty();

OpenUnirest:3.3.04

  • Add the ability to follow a paged response by providing a lambda for the response type and one for getting the next page. It will stop once the next link is null or empty.
  • The PagedList has handy dandy methods to pass consumers to all success and failure responses.
PagedList<JsonNode> result =  Unirest.get("http://and.pagey")
                .asPaged(
                        r -> r.asJson(),
                        r -> r.getHeaders().getFirst("nextPage")
                );

OpenUnirest:3.3.03

  • Pulled isSuccess() up to the response interface so it can be used and enjoyed by everyone.

OpenUnirest:3.3.02

  • Add the ability to make requests to non-standard web methods for things like WebDAV, SVN, or other horrible things.
   Unirest.request("CHEESE", "http://some.cheesy.thing")
          .asString();

OpenUnirest:3.3.00

  • Slight breaking change with regard to accessing Apache specific classes via the config
    • getClient and getAsyncClient return the Unirest containers for clients. You can still get to the Apache client through that for now but this is also deprecated. Eventually Unirest will make Apache just one of several modules.
    • Apache client wrappers are now package local.
  • Add support for overriding the default expected encoding both on a per-request basis and as a default in the config.
// Changing the default from UTF-8 for all requests
// Unirest will still honor content-encoding if defined in the response headers
Unirest.config().setDefaultResponseEncoding("windows-1250");

// Changing the default on a request. 
// This will explicitly be used EVEN IF the headers define something else.
Unirest.get("http://some.file.with.windows.encoding/file.txt")
                .responseEncoding("windows-1250")
                .asString();

OpenUnirest:3.2.06

  • access headers in order

OpenUnirest:3.2.05

  • UnirestInstance is autoclosable

OpenUnirest:3.2.04

  • Adds chainable ifSuccess and ifFailure consumer methods to the response. Now you can handle the response like
 Unirest.get("https://localhost/somewhere")
                .asString()
                .ifSuccess(r -> log.info("Yippy!"))
                .ifFailure(r -> log.error("Booo"));

OpenUnirest:3.2.03

  • Allow the configuration of header suppliers.
   Unirest.config().setDefaultHeader("trace", () -> value);

OpenUnirest:3.2.02

  • distinguish between set and add for default headers.

OpenUnirest:3.2.01

  • add method to replace a header rather than append to it.

OpenUnirest:3.3.00

  • Now you can stream the results into a file!
    • It doesn't need to be a file either. It could be any result. Unirest will shove it in a file.
File file = Unirest.get("https://someplace/file.tar.gz")
                   .asFile("/local/storage/file.tar.gz")
                   .getBody();

OpenUnirest:3.3.00

  • When encountering a parsing error with asObject or asJson capture the body in a UnirestParsingException
  • New BETA feature asFile method to stream the response into a file.

OpenUnirest:3.1.01

  • Detect if the async client has stopped for some reason and construct a new one. This one may be different from the one that was originally configured so we need to add a way to configure a supplier for clients rather than a direct client.

OpenUnirest:3.3.00

  • Deprecate methods that expose Apache. In the 4 line we will start supporting other clients. Primarily the java one supplied in Java9 (apache will still exist for 8-)
  • Add several functional methods for dealing with the raw response before the connection is closed. This is nice for large responses.

OpenUnirest:3.0.04

  • Parsing handler should capture unirest exceptions just like other exceptions.

OpenUnirest:3.0.03

OpenUnirest:3.0.02

  • Add support for the authenticated proxies to the async client

OpenUnirest:3.0.01

  • Support for authenticated proxies with Unirest.config().proxy("proxy.server.host", 80, "username","password")

OpenUnirest:3.3.00

  • This is a major release with several breaking changes which (other than the namespace change) should ONLY impact you if you are using some of Unirests more advanced features or custom configurations.
  • The maven artifact has changed to open-unirest-java
  • The namespace has been shortened to just unirest (inspired by Java Spark)
  • The configuration system has been completely redone. Previously it was scattered across several classes and was entirely static. The new system has instances and supports multiple configurations. See the UPGRADE_GUIDE.md for details.
    • Start accessing the config with Unirest.config()
  • Almost everything is now fronted by interfaces, this makes testing easier.
  • Unirest itself can now be accessed as a interface with UnirestInstance
  • ObjectMappers can be passed in as part of the builder.
  • option no longer supports body (per http spec)
  • Accept and ContentType are now 1st class headers in the builder (Unirest.get(path).accept("application/json"))
  • Major internal fixes so that which builder operations were available when is consistent.

OpenUnirest:2.5.03

  • Lazy init the HttpClients so they don't get in the way of setting custom clients.

OpenUnirest:2.5.02

  • More safety for issue #41

OpenUnirest:2.5.01

  • Fix Issue #41: possible init error in HttpClient under heavy load

OpenUnirest:2.5.00

  • Extracted Interface for HttpResponse to make testing easier

OpenUnirest:2.4.02

  • Updated org.json dependency

OpenUnirest:2.4.01

  • Add async versions of generic type methods

OpenUnirest:2.4.00

  • Issue #19 Add support for generic types with object mappers.

OpenUnirest:2.3.00

     Unirest.jsonPatch(MockServer.PATCH)
            .add("/fruits/-", "Apple")
            .remove("/bugs")
            .replace("/lastname", "Flintsone")
            .test("/firstname", "Fred")
            .move("/old/location", "/new/location")
            .copy("/original/location", "/new/location")
            .asJson();

OpenUnirest:2.2.12

  • Add optional flag overload to Unirest.shutDown(false). The flag indicates if the various Options should be cleared. This only applies to options that could survive a shutdown. The HttpClients and thread monitors will still be discarded.

OpenUnirest:2.2.11

  • Change default MultiPart mode to BROWSER_COMPATIBLE in order to support unicode filenames. Clients wishing to use the legacy mode can set it to STRICT. This should not be a problem for most users as few servers today lack support for unicode file names. Issue #35

OpenUnirest:2.2.10

OpenUnirest:2.2.08

  • add an option to disable cookie management with Options.enableCookieManagement(false).
  • In the future ignoring cookies will be the default.

OpenUnirest:2.2.07

  • Fix init error

OpenUnirest:2.2.06

  • added ability to turn off redirect following with Options.followRedirects(boolean enable) (default is true)

OpenUnirest:2.2.04

  • Add .charset(Charset charset) to POSTS (both form and body)
  • Clean up some ambiguous methods in form posting. This may be a breaking change for a very small number of users. There are better methods for handling these cases.
  • Added the ability to add HttpRequestInterceptors to the client. Though Options.addInterceptor(new TestInterceptor());

OpenUnirest:2.2.03

  • Expose the Options.init() method to restore the system to a fresh start after a shutdown.
  • Unirest.shutdown() no longer throws a checked exception

OpenUnirest:2.2.02

  • Fix NPE with null bodies from HEAD requests.

OpenUnirest:2.2.01

  • Quitly consume and close InputStreams that may not be complete.

OpenUnirest:2.2.00

  • Major refactoring of how response objects are built. This internalizes HttpClientHelper which was previously public but not needed if you were using the library in in the expected way. This refactoring sets up the library for future work to extend the number of supported formats and for greater expression in the methods for those formats.
  • Additional of functional map methods to HttpResponse so you don't have to stop the flow for further transformations.
  • Update the org.json dependency
  • Fixed issue with achor hashes in URLs (#17)
  • Fixed NPE in passing args as maps (#20)

OpenUnirest:2.1.01

  • JSON parsing errors no longer just throw out of asJson but are captured and can be inspected via HttpResponse::getParsingError. This resolves the fact that most API's do not return valid JSON for non-200 status codes.
  • Return CompletableFuture rather that boring old Futures for all async methods.

OpenUnirest:2.0.02

  • UnirestException is no longer checked
  • Namespaces have been migrated to new io.gitgub.openunirest namespace
  • Thread leak in Options fixed