99 Commits

Author SHA1 Message Date
Matt
93a693b9ef
* Remove retry middleware and all its documentation and tests. (#1356) 2022-01-02 10:19:15 +00:00
Matt
1c3e27616d
Improve documentation for v2 (#1353) 2021-12-30 14:46:00 +00:00
DariuszMusielak
a555580f5f
Allow to raise a Faraday::Error without parameters (#1351) 2021-12-21 09:57:19 +00:00
Matt
fdf797bb28 Add Faraday 1.x examples in authentication.md docs
Fixes #1317
Fixes #1314
2021-09-01 10:57:37 +02:00
Olle Jonsson
7de0a389dc
Say "2021" on the docs website
Using the current year has no legal weight, but it pops.
2021-08-20 17:58:17 +02:00
Matt
fe600c72ad
Drop deprecated auth helpers from Connection. (#1308)
Merge Authentication middleware.
Add possibility of passing a proc.
Update documentation.
2021-08-15 10:28:49 +02:00
Matt
7d727f4f02 Merge latest commits from 1.x 2021-08-14 13:32:53 +01:00
Matt
fa612a060a
[1.x] Deprecate Authorization helpers in Faraday::Connection (#1306) 2021-08-14 13:30:11 +01:00
Matt
4b6162d364
Move json middleware (request and response) from faraday_middleware (#1300) 2021-08-09 08:52:02 +01:00
Yutaka Kamei
a1ee375bcd
Add strict_mode to Test::Stubs (#1298) 2021-08-01 17:45:32 +01:00
Adam Doppelt
11d793dd7e
Docs: add more middleware examples (#1277) 2021-05-02 08:28:29 +02:00
Adam Doppelt
a582495311
[docs] Improve introduction page (#1273)
This set of change are intended to help the first-time reader.

- show method signatures for HTTP verbs
- give an overview of adapters & middleware
- explain a bit more about the shortcut methods vs. creating a connection
- use httpbingo.org instead of the defunct sushi.com
- make a quick note about the default connection and url encoding

Discussion started in #1270.
2021-04-26 09:00:28 +02:00
Olle Jonsson
a0c4a1cd03 Trivially edit docs/ README
...to push to the docs/ directory, to try to get it to build.
2021-04-14 08:31:48 +02:00
Damau
8d379a16fe
Some docs on EventMachine adapters. (#1232) 2021-04-11 13:30:57 +01:00
Tiago
118f896ac3
[docs] Add httpx to list of external adapters (#1246)
httpx bundles its own faraday adapter, a la typhoeus. This adds it to the external adapters list.
2021-03-05 12:49:48 +01:00
Nick Campbell
d22dd00856
Fix broken Rubydoc.info links (#1236)
For some reason the docs are not being published for this gem anymore,
but they are still reachable when referencing the github path instead.
2021-01-12 15:19:45 +01:00
Matt
453b26f1f0
Improves retry middleware documentation. (#1228) 2020-12-31 11:25:20 +00:00
Nathan Beyer
01c25e880c
Adjust the retry documentation and spec to align with implementation (#1197) (#1198) 2020-10-27 06:11:38 +01:00
Tijmen Brommet
95667f848a
Update documentation on using the logger (#1196)
`Faraday::Logging::Formatter` is the correct class to subclass.
2020-10-26 09:17:27 +01:00
Olle Jonsson
4e9f4b06f1
Fix a typo re: on_response -> on_complete 2020-10-23 17:28:00 +02:00
Olle Jonsson
0977306827
docs: Fix typo in markdown
Missing backtick ruined some formatting.
2020-10-22 20:23:25 +02:00
Matt
d56742a174
Introduces on_request and on_complete methods in Faraday::Middleware. (#1194) 2020-10-22 15:04:46 +01:00
Olle Jonsson
7326cd8bfd
docs: Adapters, how to create them (#1193)
This begins a new section, probably we want to move the Parallel section to its own "Advanced Adapter authoring" or a subject-specific text. Anyway, we have started!
2020-10-22 11:55:46 +02:00
Joel Stimson
85b46bef6c
Remove retry_change_requests from documentation (#1185) 2020-10-06 10:33:29 +01:00
Matt
9af091f9c4
Improves documentation on how to contribute to the site by using Docker. (#1175) 2020-09-01 16:32:18 +01:00
Alexander Popov
680b9f8a6c Add EditorConfig file
Resolve issues.

More info here: https://editorconfig.org/
2020-04-19 22:56:50 +02:00
Olle Jonsson
3ca146de4d Update year markers to 2020 for a lively look 2020-04-03 18:18:51 +02:00
Marjan Povolni
e2c56e90c9 docs(website): fix request/response mix-up in text 2020-02-24 09:36:13 +01:00
Vincent Voyer
47dcf037a7
Merge branch 'master' into docs/add-documentation-search 2020-01-21 12:38:59 +01:00
Vincent Voyer
008321b24f docs(website): add search to the website
This commit adds documentation search to the whole website using Algolia's
DocSearch project: https://community.algolia.com/docsearch/.
Analytics are available via an Algolia account, ask vincent@codeagain.com for
more information.

I tried to be as close as the Faraday design as possible.
2020-01-21 12:38:12 +01:00
Olle Jonsson
6015ae97d6
[docs] Use "including" wording
By mentioning "including" instead of "configuring like this", we avoid the possible understanding "replace the whole list".
2020-01-09 10:37:22 +01:00
Vincent Voyer
024bfebd1a
docs(retry): precise usage of retry-after
fixes https://github.com/lostisland/faraday/pull/1109#issuecomment-572448991
2020-01-09 09:48:13 +01:00
Mattia
8a43a47919
Retry middleware documentation fix (#1109)
Fixes https://github.com/lostisland/faraday/pull/773#issuecomment-571089608
2020-01-08 20:20:44 +00:00
Amr El-Bakry
9726bc2029 Add log_level option to logger default formatter (#1079) 2019-12-27 17:02:08 +00:00
Julien Kirch
073bc25cd4 Very small fix in adapter documentation 2019-12-11 06:54:35 +01:00
rick olson
f7f91b7077 raise_error: update docs to mention nil status code 2019-10-15 13:37:41 -06:00
Stanisław Pitucha
cccc145e2f Describe clearing cached stubs
This was the solution proposed in https://github.com/lostisland/faraday/issues/1041
2019-10-07 19:48:59 +02:00
risk danger olson
80ba52c721
update multipart docs to mention ParamPart class (#1018)
* update multipart docs to mention ParamsPart class

* Use newer "FilePart" name

* annotate example

* Consistently use single quotes

* remove last UploadIO reference
2019-09-20 05:08:56 -06:00
risk danger olson
e8792e43d5 port changes from #1000 (#1004) 2019-07-19 14:11:30 +02:00
Lewis Cowles
ac27ce502e Configure Jekyll plugin jekyll-remote-theme to support Docker usage (#999)
I tried to build with Jekyll 3.6.x (`jekyll/jekyll:latest`). It went badly.

By following the author guide https://github.com/benbalter/jekyll-remote-theme I noticed we were missing a YAML configuration entry.
2019-07-09 22:05:10 +02:00
iMacTia
0ec66e8959 Fixes website navigation by adding trailing slashes to /index.md files.
See https://stackoverflow.com/questions/54727643/trailing-slashes-in-jekyll-github-pages-site-cause-404
2019-07-08 18:45:46 +01:00
rick olson
26c542d9e1 fix the order of the site nav 2019-07-02 07:43:06 -06:00
iMacTia
6cd8c5dc35 Fixes placeholders for Faraday website URL. 2019-06-27 15:47:06 +01:00
iMacTia
0826817f4e Switches back to standard theme. 2019-06-26 12:08:20 +01:00
iMacTia
5d3e667c1a Merge branch 'faraday-website' of https://github.com/lostisland/faraday into faraday-website 2019-06-26 09:54:16 +01:00
iMacTia
9070f6bf2e Fixes homepage title. 2019-06-26 09:53:44 +01:00
rick olson
62cbdb9d78 restructure adapters section:
* more prominent placing of test adapter
* remove next/prev navigation for adapter pages, they don't need to be read in order
* ensure all adapter pages link to top nav
2019-06-25 10:28:14 -06:00
rick olson
08cd1b3be9 top links to middleware pages 2019-06-25 10:09:12 -06:00
rick olson
caf7545906 add top links to usage pages 2019-06-25 10:07:43 -06:00
rick olson
75605b9c36 remove redundant sitemap 2019-06-25 09:59:18 -06:00