Skip to content

Latest commit

 

History

History
184 lines (115 loc) · 5 KB

CHANGELOG.md

File metadata and controls

184 lines (115 loc) · 5 KB
Raw

Changelog: Sapi Client for Ruby

All notable changes will be documented in this file.

1.2.0 - 2024-10-08

  • (AlexT) allow passing endpoint specifications directory in initializer Bump deps including minitest 5.15.0 -> 5.25.1, mocha 1.13.0 -> 2.4.5 and minitest-reporters 1.5.0 -> 1.7.1.

1.1.4 - 2024-10-08

  • (Dan) Upgrades ruby version to 2.7.8 and version cadence to 1.1.4

1.1.3 - 2024-06-03

  • (AlexT) require 'ostruct' to fix tests in Ruby 3.3.1. Use Matrix tests to check multiple Ruby versions, 2.7 to 3.3. Bump deps:
    • rexml 3.2.5 -> 3.2.8 fixing CVE-2024-35176
    • concurrent-ruby 1.1.9 -> 1.3.1
    • farady 1.10.0 -> 1.10.3
    • faraday-multipart 1.0.3 -> 1.0.4
    • i18n 1.10.0 -> 1.14.5
    • multipart-post 2.1.1 -> 2.4.
  • (Jon) Changed the primary branch name to main from master. Updated README to reflect this change alongside adding instructions for renaming the branch locally.

1.1.2 - 2022-27-03

  • (Ian) Record the duration of the API call and add to instrumentation
  • (Ian) Change instrumentation namespace to generic api, rather than sapi_nt

1.1.1 - 2022-03-18

  • (Ian) Fix reported issue in which view name was not recognised when it was cross-referenced from another endpoint

1.1.0 - 2022-03-11

  • (Ian) Add support for emitting ActiveSupport::Notification events when running in a Rails environment. This is in support of instrumenting calls to SapiNT endpoints using Prometheus.

1.0.1 - 2022-03-08

  • (Ian) Updating the build scripts

1.0.0 - 2022-03-07

  • (Mairead) Update gemspec to point to Github package registry

0.9.1 - 2022-03-07

  • (Ian) Remove errant require of byebug

0.9.0 - 2021-06-24

  • (Joseph) Creates a custom exception class (SapiError) specifically allowing for better surfacing of http response status codes.

0.8.1 - 2021-06-18

  • (Ian) Guard against calling log methods when handed instance of loggers that may not contain those methods

0.8.0 - 2021-02-25

  • Turn off logging of calls to remote API when running in production mode (if in Rails) - GH-26

0.7.0 - 2021-02-08

  • (Ian) Pass the X-Request-ID header to outbound calls if the value is set via a thread-local variable
  • (Ian) allow snake_case names as aliases for camel-case identifiers in JSON data
  • (Ian) update dependencies

0.6.1 - 2020-11-16 (Ian)

  • switched CI to Github actions rather than Travis

0.6.0 - 2020-11-12 (Ian)

  • Added support for hierarchy endpoints

0.5.3 - 2020-11-05 (Ian)

  • Fix for GH-16: allow . in endpoint names

0.5.2 - 2020-10-30 (Ian)

  • update gem dependencies
  • update VCR cassettes and fix test failure due to data change
  • fix deprecated endpoint types in Sapi-NT

0.5.1 - 2020-01-22

  • Added a type? predicate to the SapiResource class

0.5.0 - 2020-01-15

  • Added a feature to the API of Instance to allow a resource with only an @id property to be resolved by the API. See GH-13.

No changes yet

[0.4.12]

  • Add a feature that allows an API instance to return the base URL for the API.

[0.4.11]

  • Fix GH-11 by supporting multi-valued parameters for filters we pass to Sapi-NT.

[0.4.10]

  • Add a feature to support optional logging of requests and responses.

[0.4.9]

  • Fix GH-10: the lib was using the wrong attribute in JSON-LD for a human language

[0.4.8]

  • Fix regression arising from the use of Faraday instrumentation. This has a dependency on ActiveSupport, so should only be loaded in a Rails environment

[0.4.7]

  • Add a feature to return the slug from a URI, e.g. http://wimbledon.org/common has the slug common
  • Fix API spec parsing to also recognise forward endpoint specs

[0.4.6]

  • Generalise the API to instance.get() to allow other content-types to be retrieved, not just JSON.

[0.4.4]

  • Fix to allow nested values with non-symbol keys, which was preventing me from using path expressions into complex nested values coming from the Sapi API.

[0.4.3]

Fixed

  • Issue GH-7: allow bindings for path variables to be passed as either string keys or symbol keys
  • Issue GH-8: don't raise if the API returns HTTP 404. Instead, wrap the JSON return value as the item to be returned, which contains various structured messages describing the problem.

[0.4.2]

Added

  • SapiClient::EndpointValues as a proxy for a collection of values that is designed to play well with pagination

Fixed

  • Issue GH-6: Sapi-NT endpoint views can be specified inline, as well as indirectly by name.

[0.4.0]

Changed

  • Renamed EndpointSpec to EndpointGroup to reduce confusion. Even though the containing directory is endpointSpecs, a *.yaml file in that directory typically contains multiple endpoints. Each document in the YAML stream is a spec of an endpoint, so it was ambiguous whether an EndpointSpec was the container for a set of endpoints, or a single endpoint. Hence the change of name.

Added

  • Added resource wrapper classes, a default wrapper SapiClient::SapiResource and strategies for associating wrappers with endpoints. Details in README.