README.md in onfido-2.9.0 vs README.md in onfido-3.0.0
- old
+ new
@@ -1,105 +1,123 @@
-# Onfido
+# Onfido Ruby Library
The official Ruby library for integrating with the Onfido API.
+Documentation can be found at <https://documentation.onfido.com>.
+
+This version uses Onfido API v3.6. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+
[](http://badge.fury.io/rb/onfido)
[](https://travis-ci.org/onfido/onfido-ruby)
-Documentation can be found at https://documentation.onfido.com
+## Installation & Usage
-This version uses Onfido API v3.6 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+### Installation
-## Installation
-
-Add this line to your application's Gemfile:
-
```ruby
-gem 'onfido', '~> 2.0.1'
+gem onfido, '~> 3.0.0'
```
-## Getting started
+Configure with your API token, region and optional timeout (default value is 30):
-Configure with your API token and region:
-
```ruby
-onfido = Onfido::API.new(
- api_key: ENV['ONFIDO_API_KEY'],
- # Supports :eu, :us and :ca. Previously defaulted to :eu.
- region: :eu
-)
+require onfido
+
+Onfido.configure do |config|
+ config.api_token = ENV["ONFIDO_API_TOKEN"]
+ config.region = config.region[:EU]
+ config.timeout = 30
+end
+
+onfido_api = Onfido::DefaultApi.new
```
All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.
-For example, to create an applicant:
+### Making a call to the API
```ruby
-onfido.applicant.create(
+applicant = onfido_api.create_applicant(
first_name: 'Test',
last_name: 'Applicant'
)
```
Documentation and code examples can be found at https://documentation.onfido.com
## Error Handling
-There are 3 classes of errors raised by the library, all of which subclass `Onfido::OnfidoError`:
+All errors are wrapped by `ApiError` coming from [FaradayExpection](https://www.rubydoc.info/github/lostisland/faraday/Faraday/ClientError):
-- `Onfido::RequestError` is raised whenever Onfido returns a `4xx` response
-- `Onfido::ServerError` is raised whenever Onfido returns a `5xx` response
-- `Onfido::ConnectionError` is raised whenever a network error occurs (e.g., a timeout)
+- `Connection timed out` is raised in case of `Faraday::TimeoutError`
+- `Connection failed` is raised in case of `Faraday::ConnectionFailed`
-All 3 error classes provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error (although for `Onfido::ServerError` and `Onfido::ConnectionError` the last 3 are likely to be `nil`).
+All errors provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error.
```ruby
def create_applicant
- onfido.applicant.create(params)
-rescue Onfido::RequestError => e
+ onfido_api.create_applicant(params)
+rescue Faraday::ConnectionFailed => e
e.type # => 'validation_error'
e.fields # => { "email": { "messages": ["invalid format"] } }
e.response_code # => '422'
end
```
-## Other configuration
+### Webhook event verification
-Optional configuration options with their defaults:
+Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:
```ruby
-onfido = Onfido::API.new(
- # ...
- open_timeout: 10,
- read_timeout: 30
-)
-```
+ require 'onfido/webhook_event_verifier'
-## Verifying webhooks
+ def webhook_verifier()
+ verifier = Onfido::WebhookEventVerifier.new(ENV["ONFIDO_WEBHOOK_SECRET_TOKEN"])
-Each webhook endpoint has a secret token, generated automatically and [exposed](https://documentation.onfido.com/#register-webhook) in the API. When sending a request, Onfido includes a signature computed using the request body and this token in the `X-SHA2-Signature` header.
+ signature = "a0...760e"
-You should compare this provided signature to one you generate yourself with the token to verify that a webhook is a genuine request from Onfido.
+ event = verifier.read_payload('{"payload":{"r...3"}}', signature)
-```ruby
-if Onfido::Webhook.valid?(request.raw_post,
- request.headers["X-SHA2-Signature"],
- ENV['ONFIDO_WEBHOOK_TOKEN'])
- process_webhook
-else
- render status: 498, text: "498 Token expired/invalid"
-end
+ rescue Onfido::OnfidoInvalidSignatureError => e
+ e.type
+ e.fields
+ e.response_code
+ end
```
-Read more at https://developers.onfido.com/guide/manual-webhook-signature-verification#webhook-security
-
## Contributing
-1. Fork it ( https://github.com/onfido/onfido-ruby/fork )
+This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.6.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
+
+For contributions to the tests instead, please follow the steps below:
+
+1. [Fork](https://github.com/onfido/onfido-ruby/fork) repository
2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+3. Make your changes
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+## Versioning policy
+
+[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:
+
+- MAJOR versions (x.0.0) might:
+ - target a new API version
+ - include non-backward compatible change
+- MINOR versions (0.x.0) might:
+ - add a new functionality, non-mandatory parameter or property
+ - deprecate an old functionality
+ - include non-backward compatible change to a functionality which is:
+ - labelled as alpha or beta
+ - completely broken and not usable
+- PATCH version (0.0.x) might:
+ - fix a bug
+ - include backward compatible changes only
+
## More documentation
-More documentation and code examples can be found at https://documentation.onfido.com
+More documentation and code examples can be found at <https://documentation.onfido.com>.
+
+## Support
+
+Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.