Skip to content

Commit

Permalink
Add Faraday 1.x examples in authentication.md docs
Browse files Browse the repository at this point in the history
Fixes #1317
Fixes #1314
  • Loading branch information
iMacTia committed Sep 1, 2021
1 parent 0f9626c commit 47e8108
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/middleware/request/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ top_link: ./list

The `Faraday::Request::Authorization` middleware allows you to automatically add an `Authorization` header
to your requests. It also features a handy helper to manage Basic authentication.
Please note the way you use this middleware in Faraday 1.x is different,
examples are available at the bottom of this page.

```ruby
Faraday.new(...) do |conn|
Expand All @@ -37,3 +39,28 @@ Faraday.new(...) do |conn|
conn.request :authorization, :basic, 'username', 'password'
end
```

### Faraday 1.x usage

In Faraday 1.x, the way you use this middleware is slightly different:

```ruby
# Basic Auth request
# Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Faraday.new(...) do |conn|
conn.request :basic_auth, 'username', 'password'
end

# Token Auth request
# `options` are automatically converted into `key=value` format
# Authorization: Token authentication-token <options>
Faraday.new(...) do |conn|
conn.request :token_auth, 'authentication-token', **options
end

# Generic Auth Request
# Authorization: Bearer authentication-token
Faraday.new(...) do |conn|
conn.request :authorization, 'Bearer', 'authentication-token'
end
```

0 comments on commit 47e8108

Please sign in to comment.