faraday-1.1.0/docs/_includes/footer.html 0000664 0000000 0000000 00000001473 13742546043 0020216 0 ustar 00root root 0000000 0000000
{% if site.theme_settings.katex and page.id %}
{% endif %}
{% if site.theme_settings.footer_text %}
{% endif %}
faraday-1.1.0/docs/_includes/header.html 0000664 0000000 0000000 00000003752 13742546043 0020152 0 ustar 00root root 0000000 0000000
faraday-1.1.0/docs/_layouts/ 0000775 0000000 0000000 00000000000 13742546043 0015717 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/_layouts/documentation.md 0000664 0000000 0000000 00000000077 13742546043 0021116 0 ustar 00root root 0000000 0000000 ---
layout: page
---
{{ content }}
{% include docs_nav.md %}
faraday-1.1.0/docs/_posts/ 0000775 0000000 0000000 00000000000 13742546043 0015367 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/_posts/2019-03-12-welcome-to-jekyll.markdown 0000664 0000000 0000000 00000002267 13742546043 0023536 0 ustar 00root root 0000000 0000000 ---
layout: post
title: "Welcome to Jekyll!"
date: 2019-03-12 10:25:23 +0000
categories: jekyll update
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Jekyll also offers powerful support for code snippets:
{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}
Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
[jekyll-docs]: https://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/
faraday-1.1.0/docs/_sass/ 0000775 0000000 0000000 00000000000 13742546043 0015170 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/_sass/_variables.scss 0000664 0000000 0000000 00000000462 13742546043 0020176 0 ustar 00root root 0000000 0000000 // Override theme variables.
@import url('https://fonts.googleapis.com/css?family=Raleway:700');
$link-color: #EE4266;
$text-color: #3C3C3C;
$font-family-main: 'KohinoorTelugu-Regular', Helvetica, Arial, sans-serif;
$font-family-headings: 'Raleway', Helvetica, Arial, sans-serif;
$search-color: #EE4266;
faraday-1.1.0/docs/_sass/faraday.sass 0000664 0000000 0000000 00000004335 13742546043 0017477 0 ustar 00root root 0000000 0000000 // Custom Styles added on top of the theme.
.btn
display: inline-block
background-color: $link-color
padding: 5px 10px
box-shadow: 0 4px 10px 5px rgba(238, 66, 102, 0.30)
border-radius: 20px
width: 200px
color: #FFFFFF
letter-spacing: -0.41px
text-align: center
margin: 0 10px
&:hover
background-color: darken($link-color, 10%)
color: white
text-decoration: none
.text-center
text-align: center
.mt-60
margin-top: 60px
.hidden
display: none
.docs-nav
display: flex
margin-top: 40px
.docs-nav-item
flex: 1 1 0
text-align: center
pre.highlight
padding: 20px
background-color: #F6F6F6
border-radius: 4px
code
word-wrap: normal
overflow: scroll
code.highlighter-rouge
background-color: #EEE
padding: 0 5px
border-radius: 3px
.site-header .site-nav li
margin-right: 1.2em
h1, h2, h3, h4, h5, h6
font-weight: bold
.feature-image header
@media (max-width: 1000px)
padding: 7% 12.5%
@media (max-width: 576px)
padding: 4% 5% 1% 5%
#team-content
h3
margin: 30px 0
#contributors-list
text-align: justify
.team-tile
width: 200px
display: inline-block
margin: 0 20px
img
width: 100%
border-radius: 50%
footer
background-color: #f1f3f4
#active-maintainers-list, #historical-team-list
text-align: center
#loader
margin-top: 20%
margin-bottom: 20%
text-align: center
.lds-ring
display: inline-block
position: relative
width: 200px
height: 200px
.lds-ring div
box-sizing: border-box
display: block
position: absolute
width: 187px
height: 187px
margin: 6px
border: 12px solid $link-color
border-radius: 50%
animation: lds-ring 1.2s cubic-bezier(0.5, 0, 0.5, 1) infinite
border-color: $link-color transparent transparent transparent
.lds-ring div:nth-child(1)
animation-delay: -0.45s
.lds-ring div:nth-child(2)
animation-delay: -0.3s
.lds-ring div:nth-child(3)
animation-delay: -0.15s
@keyframes lds-ring
0%
transform: rotate(0deg)
100%
transform: rotate(360deg)
#search-form
display: inline-block
// You need a minimal window size for the search to display well, should be ok, people are on desktop
// when needing search usually
@media screen and (max-width: 800px)
display: none
faraday-1.1.0/docs/adapters/ 0000775 0000000 0000000 00000000000 13742546043 0015663 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/adapters/em-http.md 0000664 0000000 0000000 00000001076 13742546043 0017567 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "EM-HTTP Adapter"
permalink: /adapters/em-http
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [em-http-request][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :em_http
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: https://www.rubydoc.info/gems/em-http-request
[src]: https://github.com/igrigorik/em-http-request#readme
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/EMHttp
faraday-1.1.0/docs/adapters/em-synchrony.md 0000664 0000000 0000000 00000001144 13742546043 0020640 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "EM-Synchrony Adapter"
permalink: /adapters/em-synchrony
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [em-synchrony][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :em_synchrony
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
* [EM-HTTP Adapter](./em-http.md)
[rdoc]: https://www.rubydoc.info/gems/em-synchrony
[src]: https://github.com/igrigorik/em-synchrony
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/EMSynchrony
faraday-1.1.0/docs/adapters/excon.md 0000664 0000000 0000000 00000001016 13742546043 0017317 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Excon Adapter"
permalink: /adapters/excon
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [excon][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
# no custom options available
f.adapter :excon
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: https://www.rubydoc.info/gems/excon
[src]: https://github.com/excon/excon
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/Excon
faraday-1.1.0/docs/adapters/httpclient.md 0000664 0000000 0000000 00000001200 13742546043 0020354 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "HTTPClient Adapter"
permalink: /adapters/httpclient
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [httpclient][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
f.adapter :httpclient do |client|
# yields HTTPClient
client.keep_alive_timeout = 20
client.ssl_config.timeout = 25
end
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: https://www.rubydoc.info/gems/httpclient
[src]: https://github.com/nahi/httpclient
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/HTTPClient
faraday-1.1.0/docs/adapters/index.md 0000664 0000000 0000000 00000003477 13742546043 0017327 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Adapters"
permalink: /adapters/
order: 2
---
The Faraday Adapter interface determines how a Faraday request is turned into
a Faraday response object. Adapters are typically implemented with common Ruby
HTTP clients, but can have custom implementations. Adapters can be configured
either globally or per Faraday Connection through the configuration block.
{: .mt-60}
## Built-in adapters
Faraday includes these adapters (but not the HTTP client libraries):
* [Net::HTTP][net_http] _(this is the default adapter)_
* [Net::HTTP::Persistent][persistent]
* [Excon][excon]
* [Patron][patron]
* [EM-Synchrony][em-synchrony]
* [HTTPClient][httpclient]
While most adapters use a common Ruby HTTP client library, adapters can also
have completely custom implementations.
* [Test Adapter][testing]
* Rack Adapter (link TBD)
## External adapters
Adapters are slowly being moved into their own gems, or bundled with HTTP clients.
Please refer to their documentation for usage examples.
* [Typhoeus][typhoeus]
* [HTTP.rb][faraday-http]
## Ad-hoc adapters customization
Faraday is intended to be a generic interface between your code and the adapter.
However, sometimes you need to access a feature specific to one of the adapters that is not covered in Faraday's interface.
When that happens, you can pass a block when specifying the adapter to customize it.
The block parameter will change based on the adapter you're using. See each adapter page for more details.
[net_http]: ./net-http
[persistent]: ./net-http-persistent
[excon]: ./excon
[patron]: ./patron
[em-synchrony]: ./em-synchrony
[httpclient]: ./httpclient
[typhoeus]: https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
[faraday-http]: https://github.com/lostisland/faraday-http
[testing]: ./testing
faraday-1.1.0/docs/adapters/net_http.md 0000664 0000000 0000000 00000001255 13742546043 0020035 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Net::HTTP Adapter"
permalink: /adapters/net-http
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [`Net::HTTP`][rdoc] client from the Ruby standard library to make
HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
f.adapter :net_http do |http|
# yields Net::HTTP
http.idle_timeout = 100
http.verify_callback = lambda do |preverify, cert_store|
# do something here...
end
end
end
```
## Links
* [Net::HTTP RDoc][rdoc]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/Net/HTTP.html
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/NetHttp
faraday-1.1.0/docs/adapters/net_http_persistent.md 0000664 0000000 0000000 00000001257 13742546043 0022317 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Net::HTTP::Persistent Adapter"
permalink: /adapters/net-http-persistent
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [net-http-persistent][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
f.adapter :net_http_persistent, pool_size: 5 do |http|
# yields Net::HTTP::Persistent
http.idle_timeout = 100
end
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: https://www.rubydoc.info/gems/net-http-persistent
[src]: https://github.com/drbrain/net-http-persistent
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/NetHttpPersistent
faraday-1.1.0/docs/adapters/patron.md 0000664 0000000 0000000 00000001105 13742546043 0017505 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Patron Adapter"
permalink: /adapters/patron
hide: true
top_name: Adapters
top_link: ./
---
This Adapter uses the [patron][rdoc] gem to make HTTP requests.
```ruby
conn = Faraday.new(...) do |f|
f.adapter :patron do |session|
# yields Patron::Session
session.max_redirects = 10
end
end
```
## Links
* [Gem RDoc][rdoc]
* [Gem source][src]
* [Adapter RDoc][adapter_rdoc]
[rdoc]: https://www.rubydoc.info/gems/patron
[src]: https://github.com/toland/patron
[adapter_rdoc]: https://www.rubydoc.info/gems/faraday/Faraday/Adapter/Patron
faraday-1.1.0/docs/adapters/testing.md 0000664 0000000 0000000 00000004525 13742546043 0017670 0 ustar 00root root 0000000 0000000 ---
layout: documentation
title: "Testing"
permalink: /adapters/testing
hide: true
top_name: Adapters
top_link: ./
---
The built-in Faraday Test adapter lets you define stubbed HTTP requests. This can
be used to mock out network services in an application's unit tests.
The easiest way to do this is to create the stubbed requests when initializing
a `Faraday::Connection`. Stubbing a request by path yields a block with a
`Faraday::Env` object. The stub block expects an Array return value with three
values: an Integer HTTP status code, a Hash of key/value headers, and a
response body.
```ruby
conn = Faraday.new do |builder|
builder.adapter :test do |stub|
# block returns an array with 3 items:
# - Integer response status
# - Hash HTTP headers
# - String response body
stub.get('/ebi') do |env|
[
200,
{ 'Content-Type': 'text/plain', },
'shrimp'
]
end
# test exceptions too
stub.get('/boom') do
raise Faraday::ConnectionFailed, nil
end
end
end
```
You can define the stubbed requests outside of the test adapter block:
```ruby
stubs = Faraday::Adapter::Test::Stubs.new do |stub|
stub.get('/tamago') { |env| [200, {}, 'egg'] }
end
```
This Stubs instance can be passed to a new Connection:
```ruby
conn = Faraday.new do |builder|
builder.adapter :test, stubs do |stub|
stub.get('/ebi') { |env| [ 200, {}, 'shrimp' ]}
end
end
```
It's also possible to stub additional requests after the connection has been
initialized. This is useful for testing.
```ruby
stubs.get('/uni') { |env| [ 200, {}, 'urchin' ]}
```
Finally, you can treat your stubs as mocks by verifying that all of the stubbed
calls were made. NOTE: this feature is still fairly experimental. It will not
verify the order or count of any stub.
```ruby
stubs.verify_stubbed_calls
```
After the test case is completed (possibly in an `after` hook), you should clear
the default connection to prevent it from being cached between different tests.
This allows for each test to have its own set of stubs
```ruby
Faraday.default_connection = nil
```
## Examples
Working [RSpec] and [test/unit] examples for a fictional JSON API client are
available.
[RSpec]: https://github.com/lostisland/faraday/blob/master/examples/client_spec.rb
[test/unit]: https://github.com/lostisland/faraday/blob/master/examples/client_test.rb
faraday-1.1.0/docs/assets/ 0000775 0000000 0000000 00000000000 13742546043 0015362 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/assets/css/ 0000775 0000000 0000000 00000000000 13742546043 0016152 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/assets/css/main.scss 0000664 0000000 0000000 00000000230 13742546043 0017766 0 ustar 00root root 0000000 0000000 ---
---
@import "variables";
@import "type-theme";
@import "faraday";
@import "https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
faraday-1.1.0/docs/assets/img/ 0000775 0000000 0000000 00000000000 13742546043 0016136 5 ustar 00root root 0000000 0000000 faraday-1.1.0/docs/assets/img/favicon.png 0000664 0000000 0000000 00000001274 13742546043 0020275 0 ustar 00root root 0000000 0000000 ‰PNG
IHDR szzô gAMA ±Ź üa sIDATX Ő—?n1Ćý6ŰP$ˇBBÉü!Ą €"‘R¤ 7Č
ŕä Ü 7( @˘€–"Jvv D‡´4«1ß·Y/žYďŚíŮXJĆöĽ÷ľźź˙Í*őżµ$Éöţ± ;Ž~Ś#ł,y«”~IÔ7Ń÷JDthĽ`r#ŽçTÜBü¬(FÁA uq5&€ÖjťĎ }J] >#ĄÖžŠôź >d f…SC[¶}Š—ˇK\díŮp8Ľ˘H–eĘrňŐ”íL´´‰S%˘ŔWü!b)@¨x,„ V<b «x(D`Uâ!s€U‹űBLbűőîS¨(Š FĐőlÚ˘ŇE\ëÉ
â4<Ś†ŕuŠCôőŚ|dźp®Ń°Ź#§8î€ ¶q'\Ć@Ŕó¤~śšă•]ĹÇ‘űAľ„@|çň1}ČŇ5`OMu]™tŚ1’0ülŚěg]Ľ×ë ń=î÷ĘݶLäůÖ~YĘl7ć÷Řë`„K|0ü˘žçwŰ śâř€qnĂ:D“8Xš –‰ÓoŔ†+č Ç9gÚÍČéc„Č$[H»őéV`°:ľ-~˘÷Q›¸±!0ľď"ę^eÎ-qú, °Ó†‰|ĂČ–Ťś6v™A|BśÇěź/¸š8ßŐ·!űč g glc›=,Ër—uźŰ=úжIĽ53‘¦Űď’dKăŔúť¦éó6'Ř Ń–>ôeŚ6źĆ÷!+7d>·&îŃE
{% elsif site.theme_settings.avatar %}
{% endif %}