checkoff 0.222.0 → 0.225.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (260) hide show
  1. checksums.yaml +4 -4
  2. data/checkoff.gemspec +10 -5
  3. data/lib/checkoff/attachments.rb +1 -0
  4. data/lib/checkoff/cli.rb +1 -1
  5. data/lib/checkoff/clients.rb +2 -1
  6. data/lib/checkoff/custom_fields.rb +2 -1
  7. data/lib/checkoff/events.rb +2 -1
  8. data/lib/checkoff/internal/asana_event_enrichment.rb +1 -0
  9. data/lib/checkoff/internal/asana_event_filter.rb +1 -0
  10. data/lib/checkoff/internal/config_loader.rb +2 -2
  11. data/lib/checkoff/internal/logging.rb +6 -5
  12. data/lib/checkoff/internal/project_hashes.rb +1 -0
  13. data/lib/checkoff/internal/project_selector_evaluator.rb +2 -1
  14. data/lib/checkoff/internal/project_timing.rb +1 -0
  15. data/lib/checkoff/internal/search_url/custom_field_param_converter.rb +1 -0
  16. data/lib/checkoff/internal/search_url/custom_field_variant.rb +1 -0
  17. data/lib/checkoff/internal/search_url/date_param_converter.rb +1 -0
  18. data/lib/checkoff/internal/search_url/parser.rb +1 -0
  19. data/lib/checkoff/internal/search_url/results_merger.rb +1 -0
  20. data/lib/checkoff/internal/search_url/simple_param_converter.rb +1 -0
  21. data/lib/checkoff/internal/search_url.rb +1 -0
  22. data/lib/checkoff/internal/section_selector_evaluator.rb +2 -1
  23. data/lib/checkoff/internal/selector_classes/common/function_evaluator.rb +1 -0
  24. data/lib/checkoff/internal/selector_classes/common.rb +1 -0
  25. data/lib/checkoff/internal/selector_classes/function_evaluator.rb +1 -0
  26. data/lib/checkoff/internal/selector_classes/project/function_evaluator.rb +1 -0
  27. data/lib/checkoff/internal/selector_classes/project.rb +1 -0
  28. data/lib/checkoff/internal/selector_classes/section/function_evaluator.rb +3 -1
  29. data/lib/checkoff/internal/selector_classes/section.rb +1 -0
  30. data/lib/checkoff/internal/selector_classes/task/function_evaluator.rb +1 -0
  31. data/lib/checkoff/internal/selector_classes/task.rb +1 -0
  32. data/lib/checkoff/internal/selector_evaluator.rb +5 -4
  33. data/lib/checkoff/internal/task_hashes.rb +1 -0
  34. data/lib/checkoff/internal/task_selector_evaluator.rb +2 -1
  35. data/lib/checkoff/internal/task_timing.rb +1 -0
  36. data/lib/checkoff/internal/thread_local.rb +1 -0
  37. data/lib/checkoff/monkeypatches/resource_marshalling.rb +1 -0
  38. data/lib/checkoff/my_tasks.rb +2 -1
  39. data/lib/checkoff/portfolios.rb +12 -9
  40. data/lib/checkoff/project_selectors.rb +1 -0
  41. data/lib/checkoff/projects.rb +3 -1
  42. data/lib/checkoff/resources.rb +1 -0
  43. data/lib/checkoff/section_selectors.rb +1 -0
  44. data/lib/checkoff/sections.rb +4 -4
  45. data/lib/checkoff/subtasks.rb +1 -0
  46. data/lib/checkoff/tags.rb +67 -17
  47. data/lib/checkoff/task_searches.rb +1 -0
  48. data/lib/checkoff/task_selectors.rb +1 -0
  49. data/lib/checkoff/tasks.rb +2 -2
  50. data/lib/checkoff/timelines.rb +1 -0
  51. data/lib/checkoff/timing.rb +1 -0
  52. data/lib/checkoff/version.rb +2 -1
  53. data/lib/checkoff/workspaces.rb +2 -1
  54. data/lib/checkoff.rb +1 -0
  55. data/rbi/checkoff.rbi +4529 -0
  56. data/sig/checkoff.rbs +3749 -0
  57. metadata +4 -205
  58. data/.circleci/config.yml +0 -291
  59. data/.envrc +0 -9
  60. data/.git-hooks/pre_commit/circle_ci.rb +0 -25
  61. data/.git-hooks/pre_commit/punchlist.rb +0 -51
  62. data/.git-hooks/pre_commit/solargraph_typecheck.rb +0 -76
  63. data/.gitattributes +0 -6
  64. data/.gitignore +0 -61
  65. data/.markdownlint_style.rb +0 -3
  66. data/.mdlrc +0 -1
  67. data/.overcommit.yml +0 -114
  68. data/.rubocop.yml +0 -143
  69. data/.rubocop_todo.yml +0 -90
  70. data/.solargraph.yml +0 -35
  71. data/.yamllint.yml +0 -8
  72. data/CODE_OF_CONDUCT.md +0 -133
  73. data/CONTRIBUTING.rst +0 -75
  74. data/DEVELOPMENT.md +0 -69
  75. data/GLOSSARY.md +0 -16
  76. data/Gemfile +0 -66
  77. data/Gemfile.lock +0 -336
  78. data/LICENSE +0 -21
  79. data/Makefile +0 -121
  80. data/bin/brakeman +0 -27
  81. data/bin/bump +0 -29
  82. data/bin/checkoff +0 -29
  83. data/bin/console +0 -15
  84. data/bin/overcommit +0 -29
  85. data/bin/overcommit_branch +0 -114
  86. data/bin/rake +0 -29
  87. data/bin/rubocop +0 -27
  88. data/bin/setup +0 -8
  89. data/bin/solargraph +0 -27
  90. data/bin/sord +0 -27
  91. data/bin/spoom +0 -27
  92. data/bin/srb +0 -27
  93. data/bin/srb-rbi +0 -27
  94. data/bin/tapioca +0 -27
  95. data/bin/yard +0 -27
  96. data/config/annotations_asana.rb +0 -254
  97. data/config/annotations_misc.rb +0 -68
  98. data/config/env.1p +0 -2
  99. data/docs/.gitignore +0 -3
  100. data/docs/cookiecutter_input.json +0 -17
  101. data/docs/example_project.png +0 -0
  102. data/fix.sh +0 -534
  103. data/metrics/bigfiles_high_water_mark +0 -1
  104. data/metrics/brakeman_high_water_mark +0 -1
  105. data/metrics/bundle-audit_high_water_mark +0 -1
  106. data/metrics/cane_high_water_mark +0 -1
  107. data/metrics/eslint_high_water_mark +0 -1
  108. data/metrics/flake8_high_water_mark +0 -1
  109. data/metrics/flay_high_water_mark +0 -1
  110. data/metrics/flog_high_water_mark +0 -1
  111. data/metrics/jscs_high_water_mark +0 -1
  112. data/metrics/mdl_high_water_mark +0 -1
  113. data/metrics/pep8_high_water_mark +0 -1
  114. data/metrics/punchlist_high_water_mark +0 -1
  115. data/metrics/pycodestyle_high_water_mark +0 -1
  116. data/metrics/rails_best_practices_high_water_mark +0 -1
  117. data/metrics/rubocop_high_water_mark +0 -1
  118. data/metrics/scalastyle_high_water_mark +0 -1
  119. data/metrics/shellcheck_high_water_mark +0 -1
  120. data/package.json +0 -9
  121. data/rakelib/citest.rake +0 -4
  122. data/rakelib/clear_metrics.rake +0 -9
  123. data/rakelib/console.rake +0 -15
  124. data/rakelib/default.rake +0 -4
  125. data/rakelib/doc.rake +0 -6
  126. data/rakelib/gem_tasks.rake +0 -3
  127. data/rakelib/localtest.rake +0 -4
  128. data/rakelib/overcommit.rake +0 -6
  129. data/rakelib/quality.rake +0 -4
  130. data/rakelib/repl.rake +0 -4
  131. data/rakelib/test.rake +0 -10
  132. data/rakelib/trigger_next_builds.rake +0 -7
  133. data/rakelib/undercover.rake +0 -8
  134. data/requirements_dev.txt +0 -2
  135. data/sorbet/config +0 -4
  136. data/sorbet/rbi/annotations/.gitattributes +0 -1
  137. data/sorbet/rbi/annotations/activesupport.rbi +0 -453
  138. data/sorbet/rbi/annotations/faraday.rbi +0 -17
  139. data/sorbet/rbi/annotations/minitest.rbi +0 -119
  140. data/sorbet/rbi/annotations/mocha.rbi +0 -34
  141. data/sorbet/rbi/annotations/rainbow.rbi +0 -269
  142. data/sorbet/rbi/annotations/webmock.rbi +0 -9
  143. data/sorbet/rbi/dsl/.gitattributes +0 -1
  144. data/sorbet/rbi/dsl/active_support/callbacks.rbi +0 -23
  145. data/sorbet/rbi/gems/.gitattributes +0 -1
  146. data/sorbet/rbi/gems/activesupport@7.1.5.rbi +0 -18746
  147. data/sorbet/rbi/gems/addressable@2.8.6.rbi +0 -1994
  148. data/sorbet/rbi/gems/ansi@1.5.0.rbi +0 -688
  149. data/sorbet/rbi/gems/asana@0.10.6-ab9393136d9ca59b75e42a661fdddc1c65c8f7c3.rbi +0 -6142
  150. data/sorbet/rbi/gems/ast@2.4.2.rbi +0 -585
  151. data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -523
  152. data/sorbet/rbi/gems/base64@0.2.0.rbi +0 -509
  153. data/sorbet/rbi/gems/benchmark@0.4.0.rbi +0 -618
  154. data/sorbet/rbi/gems/bigdecimal@3.1.5.rbi +0 -78
  155. data/sorbet/rbi/gems/brakeman@6.2.2.rbi +0 -222
  156. data/sorbet/rbi/gems/builder@3.2.4.rbi +0 -505
  157. data/sorbet/rbi/gems/bump@0.10.0.rbi +0 -169
  158. data/sorbet/rbi/gems/cache@0.4.1.rbi +0 -211
  159. data/sorbet/rbi/gems/cache_method@0.2.7.rbi +0 -293
  160. data/sorbet/rbi/gems/chef-utils@18.3.0.rbi +0 -9
  161. data/sorbet/rbi/gems/childprocess@5.1.0.rbi +0 -383
  162. data/sorbet/rbi/gems/coderay@1.1.3.rbi +0 -3427
  163. data/sorbet/rbi/gems/concurrent-ruby@1.2.3.rbi +0 -11591
  164. data/sorbet/rbi/gems/connection_pool@2.4.1.rbi +0 -9
  165. data/sorbet/rbi/gems/crack@0.4.5.rbi +0 -145
  166. data/sorbet/rbi/gems/diff-lcs@1.5.1.rbi +0 -969
  167. data/sorbet/rbi/gems/docile@1.4.0.rbi +0 -377
  168. data/sorbet/rbi/gems/drb@2.2.1.rbi +0 -1347
  169. data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -9
  170. data/sorbet/rbi/gems/erubi@1.13.0.rbi +0 -152
  171. data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +0 -222
  172. data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +0 -126
  173. data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +0 -136
  174. data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +0 -145
  175. data/sorbet/rbi/gems/faraday-multipart@1.0.4.rbi +0 -259
  176. data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +0 -142
  177. data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +0 -118
  178. data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +0 -125
  179. data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +0 -133
  180. data/sorbet/rbi/gems/faraday-retry@1.0.3.rbi +0 -198
  181. data/sorbet/rbi/gems/faraday@1.10.3.rbi +0 -2729
  182. data/sorbet/rbi/gems/faraday_middleware-multi_json@0.0.6.rbi +0 -29
  183. data/sorbet/rbi/gems/faraday_middleware@1.2.0.rbi +0 -1004
  184. data/sorbet/rbi/gems/gli@2.22.0.rbi +0 -9
  185. data/sorbet/rbi/gems/hashdiff@1.0.1.rbi +0 -351
  186. data/sorbet/rbi/gems/i18n@1.14.6.rbi +0 -2359
  187. data/sorbet/rbi/gems/imagen@0.1.8.rbi +0 -340
  188. data/sorbet/rbi/gems/iniparse@1.5.0.rbi +0 -899
  189. data/sorbet/rbi/gems/jaro_winkler@1.6.0.rbi +0 -22
  190. data/sorbet/rbi/gems/json@2.7.1.rbi +0 -1562
  191. data/sorbet/rbi/gems/jwt@2.7.1.rbi +0 -1405
  192. data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -128
  193. data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3272
  194. data/sorbet/rbi/gems/language_server-protocol@3.17.0.3.rbi +0 -14238
  195. data/sorbet/rbi/gems/logger@1.6.2.rbi +0 -923
  196. data/sorbet/rbi/gems/mdl@0.13.0.rbi +0 -445
  197. data/sorbet/rbi/gems/method_source@1.0.0.rbi +0 -273
  198. data/sorbet/rbi/gems/mime-types-data@3.2023.1205.rbi +0 -127
  199. data/sorbet/rbi/gems/mime-types@3.5.1.rbi +0 -1252
  200. data/sorbet/rbi/gems/minitest-profile@0.0.2.rbi +0 -136
  201. data/sorbet/rbi/gems/minitest-reporters@1.6.1.rbi +0 -1014
  202. data/sorbet/rbi/gems/minitest@5.21.1.rbi +0 -1539
  203. data/sorbet/rbi/gems/mixlib-cli@2.1.8.rbi +0 -314
  204. data/sorbet/rbi/gems/mixlib-config@3.0.27.rbi +0 -581
  205. data/sorbet/rbi/gems/mixlib-shellout@3.2.7.rbi +0 -629
  206. data/sorbet/rbi/gems/mocha@2.1.0.rbi +0 -12
  207. data/sorbet/rbi/gems/multi_json@1.15.0.rbi +0 -268
  208. data/sorbet/rbi/gems/multi_xml@0.6.0.rbi +0 -102
  209. data/sorbet/rbi/gems/multipart-post@2.3.0.rbi +0 -234
  210. data/sorbet/rbi/gems/mutex_m@0.3.0.rbi +0 -97
  211. data/sorbet/rbi/gems/netrc@0.11.0.rbi +0 -159
  212. data/sorbet/rbi/gems/nokogiri@1.17.0.rbi +0 -8201
  213. data/sorbet/rbi/gems/oauth2@1.4.11.rbi +0 -833
  214. data/sorbet/rbi/gems/overcommit@0.64.1.rbi +0 -2400
  215. data/sorbet/rbi/gems/parallel@1.23.0.rbi +0 -274
  216. data/sorbet/rbi/gems/parser@3.2.2.4.rbi +0 -7253
  217. data/sorbet/rbi/gems/prism@1.2.0.rbi +0 -39085
  218. data/sorbet/rbi/gems/pry@0.14.2.rbi +0 -10070
  219. data/sorbet/rbi/gems/public_suffix@5.0.4.rbi +0 -936
  220. data/sorbet/rbi/gems/punchlist@1.3.2.rbi +0 -173
  221. data/sorbet/rbi/gems/racc@1.8.1.rbi +0 -162
  222. data/sorbet/rbi/gems/rack@3.1.8.rbi +0 -4896
  223. data/sorbet/rbi/gems/rainbow@3.1.1.rbi +0 -403
  224. data/sorbet/rbi/gems/rake@13.1.0.rbi +0 -3022
  225. data/sorbet/rbi/gems/rbi@0.2.1.rbi +0 -4535
  226. data/sorbet/rbi/gems/rbs@2.8.4.rbi +0 -5613
  227. data/sorbet/rbi/gems/regexp_parser@2.8.3.rbi +0 -3750
  228. data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -390
  229. data/sorbet/rbi/gems/rexml@3.3.9.rbi +0 -4964
  230. data/sorbet/rbi/gems/rubocop-ast@1.30.0.rbi +0 -7061
  231. data/sorbet/rbi/gems/rubocop-minitest@0.34.5.rbi +0 -2577
  232. data/sorbet/rbi/gems/rubocop-performance@1.20.2.rbi +0 -3262
  233. data/sorbet/rbi/gems/rubocop-rake@0.6.0.rbi +0 -329
  234. data/sorbet/rbi/gems/rubocop-rspec@3.0.0.rbi +0 -7546
  235. data/sorbet/rbi/gems/rubocop@1.59.0.rbi +0 -57238
  236. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +0 -1318
  237. data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +0 -9
  238. data/sorbet/rbi/gems/rugged@1.6.3.rbi +0 -1577
  239. data/sorbet/rbi/gems/securerandom@0.4.0.rbi +0 -75
  240. data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -217
  241. data/sorbet/rbi/gems/simplecov-lcov@0.8.0.rbi +0 -256
  242. data/sorbet/rbi/gems/simplecov@0.22.0.rbi +0 -2149
  243. data/sorbet/rbi/gems/simplecov_json_formatter@0.1.4.rbi +0 -9
  244. data/sorbet/rbi/gems/solargraph-rails@1.1.0-9dc37915bd4f3b169046e34db6fb32193ab347d8.rbi +0 -320
  245. data/sorbet/rbi/gems/solargraph@0.50.1-904b9304770a59fac393c5cc3cad481e5bdf0fd8.rbi +0 -9396
  246. data/sorbet/rbi/gems/source_finder@3.2.1.rbi +0 -317
  247. data/sorbet/rbi/gems/spoom@1.5.0.rbi +0 -4932
  248. data/sorbet/rbi/gems/tapioca@0.16.5.rbi +0 -3617
  249. data/sorbet/rbi/gems/thor@1.3.2.rbi +0 -4378
  250. data/sorbet/rbi/gems/tilt@2.4.0.rbi +0 -933
  251. data/sorbet/rbi/gems/tomlrb@2.0.3.rbi +0 -9
  252. data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +0 -5918
  253. data/sorbet/rbi/gems/undercover@0.5.0.rbi +0 -433
  254. data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -66
  255. data/sorbet/rbi/gems/webmock@3.19.1.rbi +0 -1769
  256. data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +0 -435
  257. data/sorbet/rbi/gems/yard@0.9.37.rbi +0 -18406
  258. data/sorbet/rbi/todo.rbi +0 -11
  259. data/sorbet/tapioca/config.yml +0 -13
  260. data/sorbet/tapioca/require.rb +0 -4
@@ -1,2729 +0,0 @@
1
- # typed: true
2
-
3
- # DO NOT EDIT MANUALLY
4
- # This is an autogenerated file for types exported from the `faraday` gem.
5
- # Please instead update this file by running `bin/tapioca gem faraday`.
6
-
7
-
8
- # This is the main namespace for Faraday.
9
- #
10
- # It provides methods to create {Connection} objects, and HTTP-related
11
- # methods to use directly.
12
- #
13
- # @example Helpful class methods for easy usage
14
- # Faraday.get "http://faraday.com"
15
- # @example Helpful class method `.new` to create {Connection} objects.
16
- # conn = Faraday.new "http://faraday.com"
17
- # conn.get '/'
18
- #
19
- # source://faraday//lib/faraday/middleware_registry.rb#5
20
- module Faraday
21
- class << self
22
- # @overload default_adapter
23
- # @overload default_adapter=
24
- #
25
- # source://faraday//lib/faraday.rb#81
26
- def default_adapter; end
27
-
28
- # Documented elsewhere, see default_adapter reader
29
- #
30
- # source://faraday//lib/faraday.rb#137
31
- def default_adapter=(adapter); end
32
-
33
- # @overload default_connection
34
- # @overload default_connection=
35
- #
36
- # source://faraday//lib/faraday.rb#155
37
- def default_connection; end
38
-
39
- # Documented below, see default_connection
40
- #
41
- # source://faraday//lib/faraday.rb#84
42
- def default_connection=(_arg0); end
43
-
44
- # Gets the default connection options used when calling {Faraday#new}.
45
- #
46
- # @return [Faraday::ConnectionOptions]
47
- #
48
- # source://faraday//lib/faraday.rb#162
49
- def default_connection_options; end
50
-
51
- # Sets the default options used when calling {Faraday#new}.
52
- #
53
- # @param options [Hash, Faraday::ConnectionOptions]
54
- #
55
- # source://faraday//lib/faraday.rb#169
56
- def default_connection_options=(options); end
57
-
58
- # Tells Faraday to ignore the environment proxy (http_proxy).
59
- # Defaults to `false`.
60
- #
61
- # @return [Boolean]
62
- #
63
- # source://faraday//lib/faraday.rb#89
64
- def ignore_env_proxy; end
65
-
66
- # Tells Faraday to ignore the environment proxy (http_proxy).
67
- # Defaults to `false`.
68
- #
69
- # @return [Boolean]
70
- #
71
- # source://faraday//lib/faraday.rb#89
72
- def ignore_env_proxy=(_arg0); end
73
-
74
- # Gets or sets the path that the Faraday libs are loaded from.
75
- #
76
- # @return [String]
77
- #
78
- # source://faraday//lib/faraday.rb#72
79
- def lib_path; end
80
-
81
- # Gets or sets the path that the Faraday libs are loaded from.
82
- #
83
- # @return [String]
84
- #
85
- # source://faraday//lib/faraday.rb#72
86
- def lib_path=(_arg0); end
87
-
88
- # Initializes a new {Connection}.
89
- #
90
- # @example With an URL argument
91
- # Faraday.new 'http://faraday.com'
92
- # # => Faraday::Connection to http://faraday.com
93
- # @example With everything in an options hash
94
- # Faraday.new url: 'http://faraday.com',
95
- # params: { page: 1 }
96
- # # => Faraday::Connection to http://faraday.com?page=1
97
- # @example With an URL argument and an options hash
98
- # Faraday.new 'http://faraday.com', params: { page: 1 }
99
- # # => Faraday::Connection to http://faraday.com?page=1
100
- # @option options
101
- # @option options
102
- # @option options
103
- # @option options
104
- # @option options
105
- # @option options
106
- # @param url [String, Hash] The optional String base URL to use as a prefix
107
- # for all requests. Can also be the options Hash. Any of these
108
- # values will be set on every request made, unless overridden
109
- # for a specific request.
110
- # @param options [Hash]
111
- # @return [Faraday::Connection]
112
- #
113
- # source://faraday//lib/faraday.rb#118
114
- def new(url = T.unsafe(nil), options = T.unsafe(nil), &block); end
115
-
116
- # Internal: Requires internal Faraday libraries.
117
- #
118
- # @param libs [Array] one or more relative String names to Faraday classes.
119
- # @private
120
- # @return [void]
121
- #
122
- # source://faraday//lib/faraday.rb#128
123
- def require_lib(*libs); end
124
-
125
- # Internal: Requires internal Faraday libraries.
126
- #
127
- # @param libs [Array] one or more relative String names to Faraday classes.
128
- # @private
129
- # @return [void]
130
- #
131
- # source://faraday//lib/faraday.rb#128
132
- def require_libs(*libs); end
133
-
134
- # @return [Boolean]
135
- #
136
- # source://faraday//lib/faraday.rb#142
137
- def respond_to_missing?(symbol, include_private = T.unsafe(nil)); end
138
-
139
- # The root path that Faraday is being loaded from.
140
- #
141
- # This is the root from where the libraries are auto-loaded.
142
- #
143
- # @return [String]
144
- #
145
- # source://faraday//lib/faraday.rb#68
146
- def root_path; end
147
-
148
- # The root path that Faraday is being loaded from.
149
- #
150
- # This is the root from where the libraries are auto-loaded.
151
- #
152
- # @return [String]
153
- #
154
- # source://faraday//lib/faraday.rb#68
155
- def root_path=(_arg0); end
156
-
157
- private
158
-
159
- # Internal: Proxies method calls on the Faraday constant to
160
- # .default_connection.
161
- #
162
- # source://faraday//lib/faraday.rb#178
163
- def method_missing(name, *args, &block); end
164
- end
165
- end
166
-
167
- # Adapter is the base class for all Faraday adapters.
168
- #
169
- # @see lib/faraday/adapter.rb Original class location
170
- #
171
- # source://faraday//lib/faraday/adapter.rb#6
172
- class Faraday::Adapter
173
- extend ::Faraday::MiddlewareRegistry
174
- extend ::Faraday::DependencyLoader
175
- extend ::Faraday::Adapter::Parallelism
176
- extend ::Faraday::AutoloadHelper
177
-
178
- # @return [Adapter] a new instance of Adapter
179
- #
180
- # source://faraday//lib/faraday/adapter.rb#33
181
- def initialize(_app = T.unsafe(nil), opts = T.unsafe(nil), &block); end
182
-
183
- # source://faraday//lib/faraday/adapter.rb#60
184
- def call(env); end
185
-
186
- # Close any persistent connections. The adapter should still be usable
187
- # after calling close.
188
- #
189
- # source://faraday//lib/faraday/adapter.rb#55
190
- def close; end
191
-
192
- # Yields or returns an adapter's configured connection. Depends on
193
- # #build_connection being defined on this adapter.
194
- #
195
- # @param env [Faraday::Env, Hash] The env object for a faraday request.
196
- # @return The return value of the given block, or the HTTP connection object
197
- # if no block is given.
198
- # @yield [conn]
199
- #
200
- # source://faraday//lib/faraday/adapter.rb#46
201
- def connection(env); end
202
-
203
- private
204
-
205
- # Fetches either a read, write, or open timeout setting. Defaults to the
206
- # :timeout value if a more specific one is not given.
207
- #
208
- # @param type [Symbol] Describes which timeout setting to get: :read,
209
- # :write, or :open.
210
- # @param options [Hash] Hash containing Symbol keys like :timeout,
211
- # :read_timeout, :write_timeout, :open_timeout, or
212
- # :timeout
213
- # @return [Integer, nil] Timeout duration in seconds, or nil if no timeout
214
- # has been set.
215
- #
216
- # source://faraday//lib/faraday/adapter.rb#91
217
- def request_timeout(type, options); end
218
-
219
- # source://faraday//lib/faraday/adapter.rb#67
220
- def save_response(env, status, body, headers = T.unsafe(nil), reason_phrase = T.unsafe(nil)); end
221
- end
222
-
223
- # source://faraday//lib/faraday/adapter.rb#10
224
- Faraday::Adapter::CONTENT_LENGTH = T.let(T.unsafe(nil), String)
225
-
226
- # This module marks an Adapter as supporting parallel requests.
227
- #
228
- # source://faraday//lib/faraday/adapter.rb#17
229
- module Faraday::Adapter::Parallelism
230
- # source://faraday//lib/faraday/adapter.rb#24
231
- def inherited(subclass); end
232
-
233
- # Sets the attribute supports_parallel
234
- #
235
- # @param value the value to set the attribute supports_parallel to.
236
- #
237
- # source://faraday//lib/faraday/adapter.rb#18
238
- def supports_parallel=(_arg0); end
239
-
240
- # @return [Boolean]
241
- #
242
- # source://faraday//lib/faraday/adapter.rb#20
243
- def supports_parallel?; end
244
- end
245
-
246
- # source://faraday//lib/faraday/adapter.rb#99
247
- Faraday::Adapter::TIMEOUT_KEYS = T.let(T.unsafe(nil), Hash)
248
-
249
- # @example
250
- # test = Faraday::Connection.new do
251
- # use Faraday::Adapter::Test do |stub|
252
- # # Define matcher to match the request
253
- # stub.get '/resource.json' do
254
- # # return static content
255
- # [200, {'Content-Type' => 'application/json'}, 'hi world']
256
- # end
257
- #
258
- # # response with content generated based on request
259
- # stub.get '/showget' do |env|
260
- # [200, {'Content-Type' => 'text/plain'}, env[:method].to_s]
261
- # end
262
- #
263
- # # A regular expression can be used as matching filter
264
- # stub.get /\A\/items\/(\d+)\z/ do |env, meta|
265
- # # in case regular expression is used, an instance of MatchData
266
- # # can be received
267
- # [200,
268
- # {'Content-Type' => 'text/plain'},
269
- # "showing item: #{meta[:match_data][1]}"
270
- # ]
271
- # end
272
- #
273
- # # You can set strict_mode to exactly match the stubbed requests.
274
- # stub.strict_mode = true
275
- # end
276
- # end
277
- #
278
- # resp = test.get '/resource.json'
279
- # resp.body # => 'hi world'
280
- #
281
- # resp = test.get '/showget'
282
- # resp.body # => 'get'
283
- #
284
- # resp = test.get '/items/1'
285
- # resp.body # => 'showing item: 1'
286
- #
287
- # resp = test.get '/items/2'
288
- # resp.body # => 'showing item: 2'
289
- #
290
- # source://faraday//lib/faraday/adapter/test.rb#45
291
- class Faraday::Adapter::Test < ::Faraday::Adapter
292
- # @return [Test] a new instance of Test
293
- #
294
- # source://faraday//lib/faraday/adapter/test.rb#226
295
- def initialize(app, stubs = T.unsafe(nil), &block); end
296
-
297
- # @param env [Faraday::Env]
298
- #
299
- # source://faraday//lib/faraday/adapter/test.rb#237
300
- def call(env); end
301
-
302
- # @yield [stubs]
303
- #
304
- # source://faraday//lib/faraday/adapter/test.rb#232
305
- def configure; end
306
-
307
- # Returns the value of attribute stubs.
308
- #
309
- # source://faraday//lib/faraday/adapter/test.rb#46
310
- def stubs; end
311
-
312
- # Sets the attribute stubs
313
- #
314
- # @param value the value to set the attribute stubs to.
315
- #
316
- # source://faraday//lib/faraday/adapter/test.rb#46
317
- def stubs=(_arg0); end
318
- end
319
-
320
- # Stub request
321
- #
322
- # source://faraday//lib/faraday/adapter/test.rb#167
323
- class Faraday::Adapter::Test::Stub < ::Struct
324
- # @return [Boolean]
325
- #
326
- # source://faraday//lib/faraday/adapter/test.rb#206
327
- def headers_match?(request_headers); end
328
-
329
- # @param env [Faraday::Env]
330
- # @return [Boolean]
331
- #
332
- # source://faraday//lib/faraday/adapter/test.rb#168
333
- def matches?(env); end
334
-
335
- # @param env [Faraday::Env]
336
- # @return [Boolean]
337
- #
338
- # source://faraday//lib/faraday/adapter/test.rb#193
339
- def params_match?(env); end
340
-
341
- # @return [Boolean]
342
- #
343
- # source://faraday//lib/faraday/adapter/test.rb#184
344
- def path_match?(request_path, meta); end
345
-
346
- # source://faraday//lib/faraday/adapter/test.rb#221
347
- def to_s; end
348
- end
349
-
350
- # A stack of Stubs
351
- #
352
- # source://faraday//lib/faraday/adapter/test.rb#49
353
- class Faraday::Adapter::Test::Stubs
354
- # @return [Stubs] a new instance of Stubs
355
- # @yield [_self]
356
- # @yieldparam _self [Faraday::Adapter::Test::Stubs] the object that the method was called on
357
- #
358
- # source://faraday//lib/faraday/adapter/test.rb#53
359
- def initialize(strict_mode: T.unsafe(nil)); end
360
-
361
- # source://faraday//lib/faraday/adapter/test.rb#101
362
- def delete(path, headers = T.unsafe(nil), &block); end
363
-
364
- # @return [Boolean]
365
- #
366
- # source://faraday//lib/faraday/adapter/test.rb#61
367
- def empty?; end
368
-
369
- # source://faraday//lib/faraday/adapter/test.rb#81
370
- def get(path, headers = T.unsafe(nil), &block); end
371
-
372
- # source://faraday//lib/faraday/adapter/test.rb#85
373
- def head(path, headers = T.unsafe(nil), &block); end
374
-
375
- # @param env [Faraday::Env]
376
- #
377
- # source://faraday//lib/faraday/adapter/test.rb#66
378
- def match(env); end
379
-
380
- # source://faraday//lib/faraday/adapter/test.rb#105
381
- def options(path, headers = T.unsafe(nil), &block); end
382
-
383
- # source://faraday//lib/faraday/adapter/test.rb#97
384
- def patch(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
385
-
386
- # source://faraday//lib/faraday/adapter/test.rb#89
387
- def post(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
388
-
389
- # source://faraday//lib/faraday/adapter/test.rb#93
390
- def put(path, body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
391
-
392
- # Set strict_mode. If the value is true, this adapter tries to find matched requests strictly,
393
- # which means that all of a path, parameters, and headers must be the same as an actual request.
394
- #
395
- # source://faraday//lib/faraday/adapter/test.rb#126
396
- def strict_mode=(value); end
397
-
398
- # Raises an error if any of the stubbed calls have not been made.
399
- #
400
- # source://faraday//lib/faraday/adapter/test.rb#110
401
- def verify_stubbed_calls; end
402
-
403
- protected
404
-
405
- # @param stack [Hash]
406
- # @param env [Faraday::Env]
407
- # @return [Boolean]
408
- #
409
- # source://faraday//lib/faraday/adapter/test.rb#156
410
- def matches?(stack, env); end
411
-
412
- # source://faraday//lib/faraday/adapter/test.rb#137
413
- def new_stub(request_method, path, headers = T.unsafe(nil), body = T.unsafe(nil), &block); end
414
- end
415
-
416
- # source://faraday//lib/faraday/adapter/test.rb#50
417
- class Faraday::Adapter::Test::Stubs::NotFound < ::StandardError; end
418
-
419
- # Typhoeus adapter. This class is just a stub, the real adapter is in
420
- # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
421
- #
422
- # source://faraday//lib/faraday/adapter/typhoeus.rb#8
423
- class Faraday::Adapter::Typhoeus < ::Faraday::Adapter
424
- # Needs to define this method in order to support Typhoeus <= 1.3.0
425
- #
426
- # source://faraday//lib/faraday/adapter/typhoeus.rb#9
427
- def call; end
428
- end
429
-
430
- # AdapterRegistry registers adapter class names so they can be looked up by a
431
- # String or Symbol name.
432
- #
433
- # source://faraday//lib/faraday/adapter_registry.rb#8
434
- class Faraday::AdapterRegistry
435
- # @return [AdapterRegistry] a new instance of AdapterRegistry
436
- #
437
- # source://faraday//lib/faraday/adapter_registry.rb#9
438
- def initialize; end
439
-
440
- # source://faraday//lib/faraday/adapter_registry.rb#14
441
- def get(name); end
442
-
443
- # source://faraday//lib/faraday/adapter_registry.rb#23
444
- def set(klass, name = T.unsafe(nil)); end
445
- end
446
-
447
- # Adds the ability for other modules to manage autoloadable
448
- # constants.
449
- #
450
- # @api private
451
- #
452
- # source://faraday//lib/faraday/autoload.rb#8
453
- module Faraday::AutoloadHelper
454
- # Filters the module's contents with those that have been already
455
- # autoloaded.
456
- #
457
- # @api private
458
- # @return [Array<Class, Module>]
459
- #
460
- # source://faraday//lib/faraday/autoload.rb#49
461
- def all_loaded_constants; end
462
-
463
- # Registers the constants to be auto loaded.
464
- #
465
- # @api private
466
- # @example
467
- #
468
- # Faraday.autoload_all 'faraday/foo',
469
- # Bar: 'bar'
470
- #
471
- # # requires faraday/foo/bar to load Faraday::Bar.
472
- # Faraday::Bar
473
- # @param prefix [String] The require prefix. If the path is inside Faraday,
474
- # then it will be prefixed with the root path of this loaded
475
- # Faraday version.
476
- # @param options [{ Symbol => String }] library names.
477
- # @return [void]
478
- #
479
- # source://faraday//lib/faraday/autoload.rb#25
480
- def autoload_all(prefix, options); end
481
-
482
- # Loads each autoloaded constant. If thread safety is a concern,
483
- # wrap this in a Mutex.
484
- #
485
- # @api private
486
- # @return [void]
487
- #
488
- # source://faraday//lib/faraday/autoload.rb#39
489
- def load_autoloaded_constants; end
490
- end
491
-
492
- # Raised by Faraday::Response::RaiseError in case of a 400 response.
493
- #
494
- # source://faraday//lib/faraday/error.rb#89
495
- class Faraday::BadRequestError < ::Faraday::ClientError; end
496
-
497
- # source://faraday//lib/faraday.rb#60
498
- Faraday::CONTENT_TYPE = T.let(T.unsafe(nil), String)
499
-
500
- # Faraday client error class. Represents 4xx status responses.
501
- #
502
- # source://faraday//lib/faraday/error.rb#85
503
- class Faraday::ClientError < ::Faraday::Error; end
504
-
505
- # Raised by Faraday::Response::RaiseError in case of a 409 response.
506
- #
507
- # source://faraday//lib/faraday/error.rb#109
508
- class Faraday::ConflictError < ::Faraday::ClientError; end
509
-
510
- # Connection objects manage the default properties and the middleware
511
- # stack for fulfilling an HTTP request.
512
- #
513
- # @example
514
- #
515
- # conn = Faraday::Connection.new 'http://sushi.com'
516
- #
517
- # # GET http://sushi.com/nigiri
518
- # conn.get 'nigiri'
519
- # # => #<Faraday::Response>
520
- #
521
- # source://faraday//lib/faraday/connection.rb#17
522
- class Faraday::Connection
523
- extend ::Forwardable
524
- extend ::Faraday::Deprecate
525
-
526
- # Initializes a new Faraday::Connection.
527
- #
528
- # @option options
529
- # @option options
530
- # @option options
531
- # @option options
532
- # @option options
533
- # @option options
534
- # @option options
535
- # @option options
536
- # @option options
537
- # @param url [URI, String] URI or String base URL to use as a prefix for all
538
- # requests (optional).
539
- # @param options [Hash, Faraday::ConnectionOptions]
540
- # @return [Connection] a new instance of Connection
541
- # @yield [self] after all setup has been done
542
- #
543
- # source://faraday//lib/faraday/connection.rb#65
544
- def initialize(url = T.unsafe(nil), options = T.unsafe(nil)); end
545
-
546
- # source://faraday//lib/faraday/connection.rb#348
547
- def _deprecated_authorization(type, token); end
548
-
549
- # source://faraday//lib/faraday/connection.rb#301
550
- def _deprecated_basic_auth(login, pass); end
551
-
552
- # source://faraday//lib/faraday/connection.rb#321
553
- def _deprecated_token_auth(token, options = T.unsafe(nil)); end
554
-
555
- # source://forwardable/1.3.2/forwardable.rb#229
556
- def adapter(*args, **_arg1, &block); end
557
-
558
- # source://forwardable/1.3.2/forwardable.rb#229
559
- def app(*args, **_arg1, &block); end
560
-
561
- # Sets up a custom Authorization header.
562
- #
563
- # @example
564
- #
565
- # conn.authorization :Bearer, 'mF_9.B5f-4.1JqM'
566
- # conn.headers['Authorization']
567
- # # => "Bearer mF_9.B5f-4.1JqM"
568
- #
569
- # conn.authorization :Token, token: 'abcdef', foo: 'bar'
570
- # conn.headers['Authorization']
571
- # # => "Token token=\"abcdef\",
572
- # foo=\"bar\""
573
- # @param type [String] authorization type
574
- # @param token [String, Hash] token. A String value is taken literally, and
575
- # a Hash is encoded into comma-separated key/value pairs.
576
- # @return [void]
577
- #
578
- # source://faraday//lib/faraday/deprecate.rb#86
579
- def authorization(*args, &block); end
580
-
581
- # Sets up the Authorization header with these credentials, encoded
582
- # with base64.
583
- #
584
- # @example
585
- #
586
- # conn.basic_auth 'Aladdin', 'open sesame'
587
- # conn.headers['Authorization']
588
- # # => "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
589
- # @param login [String] The authentication login.
590
- # @param pass [String] The authentication password.
591
- # @return [void]
592
- #
593
- # source://faraday//lib/faraday/deprecate.rb#86
594
- def basic_auth(*args, &block); end
595
-
596
- # source://forwardable/1.3.2/forwardable.rb#229
597
- def build(*args, **_arg1, &block); end
598
-
599
- # Build an absolute URL based on url_prefix.
600
- #
601
- # of the resulting url (default: nil).
602
- #
603
- # @param url [String, URI]
604
- # @param params [Faraday::Utils::ParamsHash] A Faraday::Utils::ParamsHash to
605
- # replace the query values
606
- # @return [URI]
607
- #
608
- # source://faraday//lib/faraday/connection.rb#542
609
- def build_exclusive_url(url = T.unsafe(nil), params = T.unsafe(nil), params_encoder = T.unsafe(nil)); end
610
-
611
- # Creates and configures the request object.
612
- #
613
- # @param method [Symbol]
614
- # @return [Faraday::Request]
615
- # @yield [Faraday::Request] if block given
616
- #
617
- # source://faraday//lib/faraday/connection.rb#525
618
- def build_request(method); end
619
-
620
- # Takes a relative url for a request and combines it with the defaults
621
- # set on the connection instance.
622
- #
623
- # @example
624
- # conn = Faraday::Connection.new { ... }
625
- # conn.url_prefix = "https://sushi.com/api?token=abc"
626
- # conn.scheme # => https
627
- # conn.path_prefix # => "/api"
628
- #
629
- # conn.build_url("nigiri?page=2")
630
- # # => https://sushi.com/api/nigiri?token=abc&page=2
631
- #
632
- # conn.build_url("nigiri", page: 2)
633
- # # => https://sushi.com/api/nigiri?token=abc&page=2
634
- # @param url [String]
635
- # @param extra_params [Hash]
636
- #
637
- # source://faraday//lib/faraday/connection.rb#479
638
- def build_url(url = T.unsafe(nil), extra_params = T.unsafe(nil)); end
639
-
640
- # @return [Faraday::RackBuilder] Builder for this Connection.
641
- #
642
- # source://faraday//lib/faraday/connection.rb#33
643
- def builder; end
644
-
645
- # Closes the underlying resources and/or connections. In the case of
646
- # persistent connections, this closes all currently open connections
647
- # but does not prevent new connections from being made.
648
- #
649
- # source://faraday//lib/faraday/connection.rb#127
650
- def close; end
651
-
652
- # Check if the adapter is parallel-capable.
653
- #
654
- # @api private
655
- # @return [Object, nil] a parallel manager or nil if yielded
656
- # @yield if the adapter isn't parallel-capable, or if no adapter is set yet.
657
- #
658
- # source://faraday//lib/faraday/connection.rb#363
659
- def default_parallel_manager; end
660
-
661
- # Sets the default parallel manager for this connection.
662
- #
663
- # source://faraday//lib/faraday/connection.rb#42
664
- def default_parallel_manager=(_arg0); end
665
-
666
- # source://faraday//lib/faraday/connection.rb#201
667
- def delete(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
668
-
669
- # Creates a duplicate of this Faraday::Connection.
670
- #
671
- # @api private
672
- # @return [Faraday::Connection]
673
- #
674
- # source://faraday//lib/faraday/connection.rb#564
675
- def dup; end
676
-
677
- # source://faraday//lib/faraday/connection.rb#620
678
- def find_default_proxy; end
679
-
680
- # source://faraday//lib/faraday/connection.rb#201
681
- def get(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
682
-
683
- # source://faraday//lib/faraday/connection.rb#201
684
- def head(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
685
-
686
- # @return [Hash] unencoded HTTP header key/value pairs.
687
- #
688
- # source://faraday//lib/faraday/connection.rb#26
689
- def headers; end
690
-
691
- # Sets the Hash of unencoded HTTP header key/value pairs.
692
- #
693
- # @param hash [Hash]
694
- #
695
- # source://faraday//lib/faraday/connection.rb#116
696
- def headers=(hash); end
697
-
698
- # source://forwardable/1.3.2/forwardable.rb#229
699
- def host(*args, **_arg1, &block); end
700
-
701
- # source://forwardable/1.3.2/forwardable.rb#229
702
- def host=(*args, **_arg1, &block); end
703
-
704
- # Sets up the parallel manager to make a set of requests.
705
- #
706
- # @param manager [Object] The parallel manager that this Connection's
707
- # Adapter uses.
708
- # @return [void]
709
- # @yield a block to execute multiple requests.
710
- #
711
- # source://faraday//lib/faraday/connection.rb#389
712
- def in_parallel(manager = T.unsafe(nil)); end
713
-
714
- # Determine if this Faraday::Connection can make parallel requests.
715
- #
716
- # @return [Boolean]
717
- #
718
- # source://faraday//lib/faraday/connection.rb#378
719
- def in_parallel?; end
720
-
721
- # source://faraday//lib/faraday/connection.rb#98
722
- def initialize_proxy(url, options); end
723
-
724
- # @example
725
- # conn.options '/items/1'
726
- # @overload options
727
- # @overload options
728
- # @return [Faraday::Response]
729
- # @yield [Faraday::Request] for further request customizations
730
- #
731
- # source://faraday//lib/faraday/connection.rb#224
732
- def options(*args); end
733
-
734
- # @return [Object] the parallel manager for this Connection.
735
- #
736
- # source://faraday//lib/faraday/connection.rb#39
737
- def parallel_manager; end
738
-
739
- # @return [Hash] URI query unencoded key/value pairs.
740
- #
741
- # source://faraday//lib/faraday/connection.rb#23
742
- def params; end
743
-
744
- # Sets the Hash of URI query unencoded key/value pairs.
745
- #
746
- # @param hash [Hash]
747
- #
748
- # source://faraday//lib/faraday/connection.rb#110
749
- def params=(hash); end
750
-
751
- # source://faraday//lib/faraday/connection.rb#282
752
- def patch(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
753
-
754
- # source://forwardable/1.3.2/forwardable.rb#229
755
- def path_prefix(*args, **_arg1, &block); end
756
-
757
- # Sets the path prefix and ensures that it always has a leading
758
- # slash.
759
- #
760
- # @param value [String]
761
- # @return [String] the new path prefix
762
- #
763
- # source://faraday//lib/faraday/connection.rb#454
764
- def path_prefix=(value); end
765
-
766
- # source://forwardable/1.3.2/forwardable.rb#229
767
- def port(*args, **_arg1, &block); end
768
-
769
- # source://forwardable/1.3.2/forwardable.rb#229
770
- def port=(*args, **_arg1, &block); end
771
-
772
- # source://faraday//lib/faraday/connection.rb#282
773
- def post(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
774
-
775
- # @return [Hash] proxy options.
776
- #
777
- # source://faraday//lib/faraday/connection.rb#45
778
- def proxy; end
779
-
780
- # Sets the Hash proxy options.
781
- #
782
- # @param new_value [Object]
783
- #
784
- # source://faraday//lib/faraday/connection.rb#405
785
- def proxy=(new_value); end
786
-
787
- # source://faraday//lib/faraday/connection.rb#628
788
- def proxy_for_request(url); end
789
-
790
- # source://faraday//lib/faraday/connection.rb#595
791
- def proxy_from_env(url); end
792
-
793
- # source://faraday//lib/faraday/connection.rb#282
794
- def put(url = T.unsafe(nil), body = T.unsafe(nil), headers = T.unsafe(nil), &block); end
795
-
796
- # source://forwardable/1.3.2/forwardable.rb#229
797
- def request(*args, **_arg1, &block); end
798
-
799
- # source://forwardable/1.3.2/forwardable.rb#229
800
- def response(*args, **_arg1, &block); end
801
-
802
- # Builds and runs the Faraday::Request.
803
- #
804
- # @param method [Symbol] HTTP method.
805
- # @param url [String, URI] String or URI to access.
806
- # @param body [Object] The request body that will eventually be converted to
807
- # a string.
808
- # @param headers [Hash] unencoded HTTP header key/value pairs.
809
- # @return [Faraday::Response]
810
- #
811
- # source://faraday//lib/faraday/connection.rb#503
812
- def run_request(method, url, body, headers); end
813
-
814
- # source://forwardable/1.3.2/forwardable.rb#229
815
- def scheme(*args, **_arg1, &block); end
816
-
817
- # source://forwardable/1.3.2/forwardable.rb#229
818
- def scheme=(*args, **_arg1, &block); end
819
-
820
- # source://faraday//lib/faraday/connection.rb#587
821
- def set_authorization_header(header_type, *args); end
822
-
823
- # source://faraday//lib/faraday/connection.rb#443
824
- def set_basic_auth(user, password); end
825
-
826
- # @return [Hash] SSL options.
827
- #
828
- # source://faraday//lib/faraday/connection.rb#36
829
- def ssl; end
830
-
831
- # @return [Boolean]
832
- #
833
- # source://faraday//lib/faraday/connection.rb#638
834
- def support_parallel?(adapter); end
835
-
836
- # Sets up the Authorization header with the given token.
837
- #
838
- # @example
839
- #
840
- # conn.token_auth 'abcdef', foo: 'bar'
841
- # conn.headers['Authorization']
842
- # # => "Token token=\"abcdef\",
843
- # foo=\"bar\""
844
- # @param token [String]
845
- # @param options [Hash] extra token options.
846
- # @return [void]
847
- #
848
- # source://faraday//lib/faraday/deprecate.rb#86
849
- def token_auth(*args, &block); end
850
-
851
- # source://faraday//lib/faraday/connection.rb#201
852
- def trace(url = T.unsafe(nil), params = T.unsafe(nil), headers = T.unsafe(nil)); end
853
-
854
- # @return [String] a URI with the prefix used for all requests from this
855
- # Connection. This includes a default host name, scheme, port, and path.
856
- #
857
- # source://faraday//lib/faraday/connection.rb#30
858
- def url_prefix; end
859
-
860
- # Parses the given URL with URI and stores the individual
861
- # components in this connection. These components serve as defaults for
862
- # requests made by this connection.
863
- #
864
- # @example
865
- #
866
- # conn = Faraday::Connection.new { ... }
867
- # conn.url_prefix = "https://sushi.com/api"
868
- # conn.scheme # => https
869
- # conn.path_prefix # => "/api"
870
- #
871
- # conn.get("nigiri?page=2") # accesses https://sushi.com/api/nigiri
872
- # @param url [String, URI]
873
- # @param encoder [Object]
874
- #
875
- # source://faraday//lib/faraday/connection.rb#428
876
- def url_prefix=(url, encoder = T.unsafe(nil)); end
877
-
878
- # source://forwardable/1.3.2/forwardable.rb#229
879
- def use(*args, **_arg1, &block); end
880
-
881
- # Yields username and password extracted from a URI if they both exist.
882
- #
883
- # @api private
884
- # @param uri [URI]
885
- # @return [void]
886
- # @yield [username, password] any username and password
887
- # @yieldparam username [String] any username from URI
888
- # @yieldparam password [String] any password from URI
889
- #
890
- # source://faraday//lib/faraday/connection.rb#581
891
- def with_uri_credentials(uri); end
892
- end
893
-
894
- # A Set of allowed HTTP verbs.
895
- #
896
- # source://faraday//lib/faraday/connection.rb#19
897
- Faraday::Connection::METHODS = T.let(T.unsafe(nil), Set)
898
-
899
- # source://faraday//lib/faraday/connection.rb#20
900
- Faraday::Connection::USER_AGENT = T.let(T.unsafe(nil), String)
901
-
902
- # A unified error for failed connections.
903
- #
904
- # source://faraday//lib/faraday/error.rb#136
905
- class Faraday::ConnectionFailed < ::Faraday::Error; end
906
-
907
- # ConnectionOptions contains the configurable properties for a Faraday
908
- # connection object.
909
- #
910
- # source://faraday//lib/faraday/options/connection_options.rb#8
911
- class Faraday::ConnectionOptions < ::Faraday::Options
912
- # source://faraday//lib/faraday/options.rb#177
913
- def builder_class; end
914
-
915
- # source://faraday//lib/faraday/options/connection_options.rb#18
916
- def new_builder(block); end
917
-
918
- # source://faraday//lib/faraday/options.rb#177
919
- def request; end
920
-
921
- # source://faraday//lib/faraday/options.rb#177
922
- def ssl; end
923
- end
924
-
925
- # Sub-module for decoding query-string into parameters.
926
- #
927
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#75
928
- module Faraday::DecodeMethods
929
- # @param query [nil, String]
930
- # @raise [TypeError] if the nesting is incorrect
931
- # @return [Array<Array, String>] the decoded params
932
- #
933
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#81
934
- def decode(query); end
935
-
936
- protected
937
-
938
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#138
939
- def add_to_context(is_array, context, value, subkey); end
940
-
941
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#101
942
- def decode_pair(key, value, context); end
943
-
944
- # Internal: convert a nested hash with purely numeric keys into an array.
945
- # FIXME: this is not compatible with Rack::Utils.parse_nested_query
946
- #
947
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#145
948
- def dehash(hash, depth); end
949
-
950
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#133
951
- def match_context(context, subkey); end
952
-
953
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#123
954
- def new_context(subkey, is_array, context); end
955
-
956
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#113
957
- def prepare_context(context, subkey, is_array, last_subkey); end
958
- end
959
-
960
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#99
961
- Faraday::DecodeMethods::SUBKEYS_REGEX = T.let(T.unsafe(nil), Regexp)
962
-
963
- # DependencyLoader helps Faraday adapters and middleware load dependencies.
964
- #
965
- # source://faraday//lib/faraday/dependency_loader.rb#7
966
- module Faraday::DependencyLoader
967
- # Executes a block which should try to require and reference dependent
968
- # libraries
969
- #
970
- # source://faraday//lib/faraday/dependency_loader.rb#12
971
- def dependency(lib = T.unsafe(nil)); end
972
-
973
- # source://faraday//lib/faraday/dependency_loader.rb#30
974
- def inherited(subclass); end
975
-
976
- # Returns the value of attribute load_error.
977
- #
978
- # source://faraday//lib/faraday/dependency_loader.rb#8
979
- def load_error; end
980
-
981
- # @return [Boolean]
982
- #
983
- # source://faraday//lib/faraday/dependency_loader.rb#26
984
- def loaded?; end
985
-
986
- # source://faraday//lib/faraday/dependency_loader.rb#18
987
- def new(*_arg0, **_arg1); end
988
-
989
- private
990
-
991
- # Sets the attribute load_error
992
- #
993
- # @param value the value to set the attribute load_error to.
994
- #
995
- # source://faraday//lib/faraday/dependency_loader.rb#37
996
- def load_error=(_arg0); end
997
- end
998
-
999
- # Deprecation using semver instead of date, based on Gem::Deprecate
1000
- # Provides a single method +deprecate+ to be used to declare when
1001
- # something is going away.
1002
- #
1003
- # class Legacy
1004
- # def self.klass_method
1005
- # # ...
1006
- # end
1007
- #
1008
- # def instance_method
1009
- # # ...
1010
- # end
1011
- #
1012
- # extend Faraday::Deprecate
1013
- # deprecate :instance_method, "X.z", '1.0'
1014
- #
1015
- # class << self
1016
- # extend Faraday::Deprecate
1017
- # deprecate :klass_method, :none, '1.0'
1018
- # end
1019
- # end
1020
- #
1021
- # source://faraday//lib/faraday/deprecate.rb#49
1022
- module Faraday::Deprecate
1023
- private
1024
-
1025
- # Simple deprecation method that deprecates +name+ by wrapping it up
1026
- # in a dummy method. It warns on each call to the dummy method
1027
- # telling the user of +repl+ (unless +repl+ is :none) and the
1028
- # semver that it is planned to go away.
1029
- #
1030
- # @param name [Symbol] the method symbol to deprecate
1031
- # @param repl [#to_s, :none] the replacement to use, when `:none` it will
1032
- # alert the user that no replacement is present.
1033
- # @param ver [String] the semver the method will be removed.
1034
- #
1035
- # source://faraday//lib/faraday/deprecate.rb#81
1036
- def deprecate(name, repl, ver, custom_message = T.unsafe(nil)); end
1037
-
1038
- # Temporarily turn off warnings. Intended for tests only.
1039
- #
1040
- # source://faraday//lib/faraday/deprecate.rb#65
1041
- def skip_during; end
1042
-
1043
- class << self
1044
- # Simple deprecation method that deprecates +name+ by wrapping it up
1045
- # in a dummy method. It warns on each call to the dummy method
1046
- # telling the user of +repl+ (unless +repl+ is :none) and the
1047
- # semver that it is planned to go away.
1048
- #
1049
- # @param name [Symbol] the method symbol to deprecate
1050
- # @param repl [#to_s, :none] the replacement to use, when `:none` it will
1051
- # alert the user that no replacement is present.
1052
- # @param ver [String] the semver the method will be removed.
1053
- #
1054
- # source://faraday//lib/faraday/deprecate.rb#81
1055
- def deprecate(name, repl, ver, custom_message = T.unsafe(nil)); end
1056
-
1057
- # source://faraday//lib/faraday/deprecate.rb#50
1058
- def skip; end
1059
-
1060
- # source://faraday//lib/faraday/deprecate.rb#60
1061
- def skip=(value); end
1062
-
1063
- # Temporarily turn off warnings. Intended for tests only.
1064
- #
1065
- # source://faraday//lib/faraday/deprecate.rb#65
1066
- def skip_during; end
1067
- end
1068
- end
1069
-
1070
- # @param new_klass [Class] new Klass to use
1071
- # @return [Class] A modified version of new_klass that warns on
1072
- # usage about deprecation.
1073
- # @see Faraday::Deprecate
1074
- #
1075
- # source://faraday//lib/faraday/deprecate.rb#9
1076
- module Faraday::DeprecatedClass
1077
- class << self
1078
- # source://faraday//lib/faraday/deprecate.rb#10
1079
- def proxy_class(origclass, ver = T.unsafe(nil)); end
1080
- end
1081
- end
1082
-
1083
- # Sub-module for encoding parameters into query-string.
1084
- #
1085
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#5
1086
- module Faraday::EncodeMethods
1087
- # @param params [nil, Array, #to_hash] parameters to be encoded
1088
- # @raise [TypeError] if params can not be converted to a Hash
1089
- # @return [String] the encoded params
1090
- #
1091
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#11
1092
- def encode(params); end
1093
-
1094
- protected
1095
-
1096
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#64
1097
- def encode_array(parent, value); end
1098
-
1099
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#53
1100
- def encode_hash(parent, value); end
1101
-
1102
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#40
1103
- def encode_pair(parent, value); end
1104
- end
1105
-
1106
- # source://faraday//lib/faraday/options/env.rb#52
1107
- class Faraday::Env < ::Faraday::Options
1108
- extend ::Forwardable
1109
-
1110
- # @param key [Object]
1111
- #
1112
- # source://faraday//lib/faraday/options/env.rb#84
1113
- def [](key); end
1114
-
1115
- # @param key [Object]
1116
- # @param value [Object]
1117
- #
1118
- # source://faraday//lib/faraday/options/env.rb#96
1119
- def []=(key, value); end
1120
-
1121
- # string.
1122
- #
1123
- # @return [String] The request body that will eventually be converted to a
1124
- #
1125
- # source://faraday//lib/faraday/options/env.rb#113
1126
- def body; end
1127
-
1128
- # string.
1129
- #
1130
- # @return [String] The request body that will eventually be converted to a
1131
- #
1132
- # source://faraday//lib/faraday/options/env.rb#117
1133
- def body=(value); end
1134
-
1135
- # Sets content length to zero and the body to the empty string.
1136
- #
1137
- # source://faraday//lib/faraday/options/env.rb#133
1138
- def clear_body; end
1139
-
1140
- # source://faraday//lib/faraday/options/env.rb#109
1141
- def current_body; end
1142
-
1143
- # @private
1144
- #
1145
- # source://faraday//lib/faraday/options/env.rb#161
1146
- def custom_members; end
1147
-
1148
- # @return [Boolean]
1149
- #
1150
- # source://faraday//lib/faraday/options/env.rb#167
1151
- def in_member_set?(key); end
1152
-
1153
- # source://faraday//lib/faraday/options/env.rb#149
1154
- def inspect; end
1155
-
1156
- # set of {MethodsWithBodies}.
1157
- #
1158
- # @return [Boolean] true if there's no body yet, and the method is in the
1159
- #
1160
- # source://faraday//lib/faraday/options/env.rb#128
1161
- def needs_body?; end
1162
-
1163
- # @return [Boolean] true if there is a parallel_manager
1164
- #
1165
- # source://faraday//lib/faraday/options/env.rb#145
1166
- def parallel?; end
1167
-
1168
- # source://forwardable/1.3.2/forwardable.rb#229
1169
- def params_encoder(*args, **_arg1, &block); end
1170
-
1171
- # {StatusesWithoutBody}.
1172
- #
1173
- # @return [Boolean] true if the status isn't in the set of
1174
- #
1175
- # source://faraday//lib/faraday/options/env.rb#140
1176
- def parse_body?; end
1177
-
1178
- # @return [Boolean] true if status is in the set of {SuccessfulStatuses}.
1179
- #
1180
- # source://faraday//lib/faraday/options/env.rb#122
1181
- def success?; end
1182
-
1183
- class << self
1184
- # Build a new Env from given value. Respects and updates `custom_members`.
1185
- #
1186
- # @param value [Object] a value fitting Option.from(v).
1187
- # @return [Env] from given value
1188
- #
1189
- # source://faraday//lib/faraday/options/env.rb#75
1190
- def from(value); end
1191
-
1192
- # @private
1193
- #
1194
- # source://faraday//lib/faraday/options/env.rb#177
1195
- def member_set; end
1196
- end
1197
- end
1198
-
1199
- # source://faraday//lib/faraday/options/env.rb#55
1200
- Faraday::Env::ContentLength = T.let(T.unsafe(nil), String)
1201
-
1202
- # A Set of HTTP verbs that typically send a body. If no body is set for
1203
- # these requests, the Content-Length header is set to 0.
1204
- #
1205
- # source://faraday//lib/faraday/options/env.rb#62
1206
- Faraday::Env::MethodsWithBodies = T.let(T.unsafe(nil), Set)
1207
-
1208
- # source://faraday//lib/faraday/options/env.rb#56
1209
- Faraday::Env::StatusesWithoutBody = T.let(T.unsafe(nil), Set)
1210
-
1211
- # source://faraday//lib/faraday/options/env.rb#57
1212
- Faraday::Env::SuccessfulStatuses = T.let(T.unsafe(nil), Range)
1213
-
1214
- # Faraday error base class.
1215
- #
1216
- # source://faraday//lib/faraday/error.rb#6
1217
- class Faraday::Error < ::StandardError
1218
- # @return [Error] a new instance of Error
1219
- #
1220
- # source://faraday//lib/faraday/error.rb#9
1221
- def initialize(exc, response = T.unsafe(nil)); end
1222
-
1223
- # source://faraday//lib/faraday/error.rb#15
1224
- def backtrace; end
1225
-
1226
- # source://faraday//lib/faraday/error.rb#23
1227
- def inspect; end
1228
-
1229
- # Returns the value of attribute response.
1230
- #
1231
- # source://faraday//lib/faraday/error.rb#7
1232
- def response; end
1233
-
1234
- # source://faraday//lib/faraday/error.rb#39
1235
- def response_body; end
1236
-
1237
- # source://faraday//lib/faraday/error.rb#35
1238
- def response_headers; end
1239
-
1240
- # source://faraday//lib/faraday/error.rb#31
1241
- def response_status; end
1242
-
1243
- # Returns the value of attribute wrapped_exception.
1244
- #
1245
- # source://faraday//lib/faraday/error.rb#7
1246
- def wrapped_exception; end
1247
-
1248
- protected
1249
-
1250
- # Pulls out potential parent exception and response hash.
1251
- #
1252
- # source://faraday//lib/faraday/error.rb#74
1253
- def exc_msg_and_response(exc, response = T.unsafe(nil)); end
1254
-
1255
- # Pulls out potential parent exception and response hash, storing them in
1256
- # instance variables.
1257
- # exc - Either an Exception, a string message, or a response hash.
1258
- # response - Hash
1259
- # :status - Optional integer HTTP response status
1260
- # :headers - String key/value hash of HTTP response header
1261
- # values.
1262
- # :body - Optional string HTTP response body.
1263
- # :request - Hash
1264
- # :method - Symbol with the request HTTP method.
1265
- # :url_path - String with the url path requested.
1266
- # :params - String key/value hash of query params
1267
- # present in the request.
1268
- # :headers - String key/value hash of HTTP request
1269
- # header values.
1270
- # :body - String HTTP request body.
1271
- #
1272
- # If a subclass has to call this, then it should pass a string message
1273
- # to `super`. See NilStatusError.
1274
- #
1275
- # source://faraday//lib/faraday/error.rb#64
1276
- def exc_msg_and_response!(exc, response = T.unsafe(nil)); end
1277
- end
1278
-
1279
- # FlatParamsEncoder manages URI params as a flat hash. Any Array values repeat
1280
- # the parameter multiple times.
1281
- #
1282
- # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#6
1283
- module Faraday::FlatParamsEncoder
1284
- class << self
1285
- # Decode converts the given URI querystring into a hash.
1286
- #
1287
- # @example
1288
- #
1289
- # decode('a=one&a=two&a=three&b=true&c=C')
1290
- # # => {"a"=>["one", "two", "three"], "b"=>"true", "c"=>"C"}
1291
- # @param query [String] query arguments to parse.
1292
- # @return [Hash] parsed keys and value strings from the querystring.
1293
- #
1294
- # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#74
1295
- def decode(query); end
1296
-
1297
- # Encode converts the given param into a URI querystring. Keys and values
1298
- # will converted to strings and appropriately escaped for the URI.
1299
- #
1300
- # @example
1301
- #
1302
- # encode({a: %w[one two three], b: true, c: "C"})
1303
- # # => 'a=one&a=two&a=three&b=true&c=C'
1304
- # @param params [Hash] query arguments to convert.
1305
- # @return [String] the URI querystring (without the leading '?')
1306
- #
1307
- # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#23
1308
- def encode(params); end
1309
-
1310
- # source://forwardable/1.3.2/forwardable.rb#229
1311
- def escape(*args, **_arg1, &block); end
1312
-
1313
- # Returns the value of attribute sort_params.
1314
- #
1315
- # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#99
1316
- def sort_params; end
1317
-
1318
- # Sets the attribute sort_params
1319
- #
1320
- # @param value the value to set the attribute sort_params to.
1321
- #
1322
- # source://faraday//lib/faraday/encoders/flat_params_encoder.rb#99
1323
- def sort_params=(_arg0); end
1324
-
1325
- # source://forwardable/1.3.2/forwardable.rb#229
1326
- def unescape(*args, **_arg1, &block); end
1327
- end
1328
- end
1329
-
1330
- # Raised by Faraday::Response::RaiseError in case of a 403 response.
1331
- #
1332
- # source://faraday//lib/faraday/error.rb#97
1333
- class Faraday::ForbiddenError < ::Faraday::ClientError; end
1334
-
1335
- # source://faraday//lib/faraday/logging/formatter.rb#5
1336
- module Faraday::Logging; end
1337
-
1338
- # Serves as an integration point to customize logging
1339
- #
1340
- # source://faraday//lib/faraday/logging/formatter.rb#7
1341
- class Faraday::Logging::Formatter
1342
- extend ::Forwardable
1343
-
1344
- # @return [Formatter] a new instance of Formatter
1345
- #
1346
- # source://faraday//lib/faraday/logging/formatter.rb#13
1347
- def initialize(logger:, options:); end
1348
-
1349
- # source://forwardable/1.3.2/forwardable.rb#229
1350
- def debug(*args, **_arg1, &block); end
1351
-
1352
- # source://forwardable/1.3.2/forwardable.rb#229
1353
- def error(*args, **_arg1, &block); end
1354
-
1355
- # source://forwardable/1.3.2/forwardable.rb#229
1356
- def fatal(*args, **_arg1, &block); end
1357
-
1358
- # source://faraday//lib/faraday/logging/formatter.rb#39
1359
- def filter(filter_word, filter_replacement); end
1360
-
1361
- # source://forwardable/1.3.2/forwardable.rb#229
1362
- def info(*args, **_arg1, &block); end
1363
-
1364
- # source://faraday//lib/faraday/logging/formatter.rb#21
1365
- def request(env); end
1366
-
1367
- # source://faraday//lib/faraday/logging/formatter.rb#31
1368
- def response(env); end
1369
-
1370
- # source://forwardable/1.3.2/forwardable.rb#229
1371
- def warn(*args, **_arg1, &block); end
1372
-
1373
- private
1374
-
1375
- # source://faraday//lib/faraday/logging/formatter.rb#79
1376
- def apply_filters(output); end
1377
-
1378
- # source://faraday//lib/faraday/logging/formatter.rb#49
1379
- def dump_body(body); end
1380
-
1381
- # source://faraday//lib/faraday/logging/formatter.rb#45
1382
- def dump_headers(headers); end
1383
-
1384
- # source://faraday//lib/faraday/logging/formatter.rb#99
1385
- def log_body(type, body); end
1386
-
1387
- # @return [Boolean]
1388
- #
1389
- # source://faraday//lib/faraday/logging/formatter.rb#70
1390
- def log_body?(type); end
1391
-
1392
- # source://faraday//lib/faraday/logging/formatter.rb#94
1393
- def log_headers(type, headers); end
1394
-
1395
- # @return [Boolean]
1396
- #
1397
- # source://faraday//lib/faraday/logging/formatter.rb#61
1398
- def log_headers?(type); end
1399
-
1400
- # source://faraday//lib/faraday/logging/formatter.rb#86
1401
- def log_level; end
1402
-
1403
- # source://faraday//lib/faraday/logging/formatter.rb#57
1404
- def pretty_inspect(body); end
1405
- end
1406
-
1407
- # source://faraday//lib/faraday/logging/formatter.rb#10
1408
- Faraday::Logging::Formatter::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
1409
-
1410
- # source://faraday//lib/faraday/methods.rb#5
1411
- Faraday::METHODS_WITH_BODY = T.let(T.unsafe(nil), Array)
1412
-
1413
- # source://faraday//lib/faraday/methods.rb#4
1414
- Faraday::METHODS_WITH_QUERY = T.let(T.unsafe(nil), Array)
1415
-
1416
- # Middleware is the basic base class of any Faraday middleware.
1417
- #
1418
- # source://faraday//lib/faraday/middleware.rb#5
1419
- class Faraday::Middleware
1420
- extend ::Faraday::MiddlewareRegistry
1421
- extend ::Faraday::DependencyLoader
1422
-
1423
- # @return [Middleware] a new instance of Middleware
1424
- #
1425
- # source://faraday//lib/faraday/middleware.rb#11
1426
- def initialize(app = T.unsafe(nil), options = T.unsafe(nil)); end
1427
-
1428
- # Returns the value of attribute app.
1429
- #
1430
- # source://faraday//lib/faraday/middleware.rb#9
1431
- def app; end
1432
-
1433
- # source://faraday//lib/faraday/middleware.rb#16
1434
- def call(env); end
1435
-
1436
- # source://faraday//lib/faraday/middleware.rb#23
1437
- def close; end
1438
-
1439
- # Returns the value of attribute options.
1440
- #
1441
- # source://faraday//lib/faraday/middleware.rb#9
1442
- def options; end
1443
- end
1444
-
1445
- # Adds the ability for other modules to register and lookup
1446
- # middleware classes.
1447
- #
1448
- # source://faraday//lib/faraday/middleware_registry.rb#8
1449
- module Faraday::MiddlewareRegistry
1450
- # source://faraday//lib/faraday/middleware_registry.rb#99
1451
- def fetch_middleware(key); end
1452
-
1453
- # source://faraday//lib/faraday/middleware_registry.rb#103
1454
- def load_middleware(key); end
1455
-
1456
- # Lookup middleware class with a registered Symbol shortcut.
1457
- #
1458
- # @example
1459
- #
1460
- # module Faraday
1461
- # class Whatever
1462
- # register_middleware foo: Foo
1463
- # end
1464
- # end
1465
- #
1466
- # Faraday::Whatever.lookup_middleware(:foo)
1467
- # # => Faraday::Whatever::Foo
1468
- # @param key [Symbol] key for the registered middleware.
1469
- # @raise [Faraday::Error] if given key is not registered
1470
- # @return [Class] a middleware Class.
1471
- #
1472
- # source://faraday//lib/faraday/middleware_registry.rb#89
1473
- def lookup_middleware(key); end
1474
-
1475
- # source://faraday//lib/faraday/middleware_registry.rb#94
1476
- def middleware_mutex(&block); end
1477
-
1478
- # Register middleware class(es) on the current module.
1479
- #
1480
- # }] Middleware mapping from a lookup symbol to a reference to the
1481
- # middleware.
1482
- # Classes can be expressed as:
1483
- # - a fully qualified constant
1484
- # - a Symbol
1485
- # - a Proc that will be lazily called to return the former
1486
- # - an array is given, its first element is the constant or symbol,
1487
- # and its second is a file to `require`.
1488
- #
1489
- # @example Lookup by a constant
1490
- #
1491
- # module Faraday
1492
- # class Whatever
1493
- # # Middleware looked up by :foo returns Faraday::Whatever::Foo.
1494
- # register_middleware foo: Foo
1495
- # end
1496
- # end
1497
- # @example Lookup by a symbol
1498
- #
1499
- # module Faraday
1500
- # class Whatever
1501
- # # Middleware looked up by :bar returns
1502
- # # Faraday::Whatever.const_get(:Bar)
1503
- # register_middleware bar: :Bar
1504
- # end
1505
- # end
1506
- # @example Lookup by a symbol and string in an array
1507
- #
1508
- # module Faraday
1509
- # class Whatever
1510
- # # Middleware looked up by :baz requires 'baz' and returns
1511
- # # Faraday::Whatever.const_get(:Baz)
1512
- # register_middleware baz: [:Baz, 'baz']
1513
- # end
1514
- # end
1515
- # @param autoload_path [String] Middleware autoload path
1516
- # @param mapping [Hash{
1517
- # Symbol => Module,
1518
- # Symbol => Array<Module, Symbol, String>,] apping [Hash{
1519
- # Symbol => Module,
1520
- # Symbol => Array<Module, Symbol, String>,
1521
- # @return [void]
1522
- #
1523
- # source://faraday//lib/faraday/middleware_registry.rb#54
1524
- def register_middleware(autoload_path = T.unsafe(nil), mapping = T.unsafe(nil)); end
1525
-
1526
- # Unregister a previously registered middleware class.
1527
- #
1528
- # @param key [Symbol] key for the registered middleware.
1529
- #
1530
- # source://faraday//lib/faraday/middleware_registry.rb#68
1531
- def unregister_middleware(key); end
1532
- end
1533
-
1534
- # This is the default encoder for Faraday requests.
1535
- # Using this encoder, parameters will be encoded respecting their structure,
1536
- # so you can send objects such as Arrays or Hashes as parameters
1537
- # for your requests.
1538
- #
1539
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#162
1540
- module Faraday::NestedParamsEncoder
1541
- extend ::Faraday::EncodeMethods
1542
- extend ::Faraday::DecodeMethods
1543
-
1544
- class << self
1545
- # source://forwardable/1.3.2/forwardable.rb#229
1546
- def escape(*args, **_arg1, &block); end
1547
-
1548
- # Returns the value of attribute sort_params.
1549
- #
1550
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#164
1551
- def sort_params; end
1552
-
1553
- # Sets the attribute sort_params
1554
- #
1555
- # @param value the value to set the attribute sort_params to.
1556
- #
1557
- # source://faraday//lib/faraday/encoders/nested_params_encoder.rb#164
1558
- def sort_params=(_arg0); end
1559
-
1560
- # source://forwardable/1.3.2/forwardable.rb#229
1561
- def unescape(*args, **_arg1, &block); end
1562
- end
1563
- end
1564
-
1565
- # Raised by Faraday::Response::RaiseError in case of a nil status in response.
1566
- #
1567
- # source://faraday//lib/faraday/error.rb#128
1568
- class Faraday::NilStatusError < ::Faraday::ServerError
1569
- # @return [NilStatusError] a new instance of NilStatusError
1570
- #
1571
- # source://faraday//lib/faraday/error.rb#129
1572
- def initialize(exc, response = T.unsafe(nil)); end
1573
- end
1574
-
1575
- # Subclasses Struct with some special helpers for converting from a Hash to
1576
- # a Struct.
1577
- #
1578
- # source://faraday//lib/faraday/options.rb#7
1579
- class Faraday::Options < ::Struct
1580
- # source://faraday//lib/faraday/options.rb#185
1581
- def [](key); end
1582
-
1583
- # Public
1584
- #
1585
- # source://faraday//lib/faraday/options.rb#46
1586
- def clear; end
1587
-
1588
- # Public
1589
- #
1590
- # source://faraday//lib/faraday/options.rb#71
1591
- def deep_dup; end
1592
-
1593
- # Public
1594
- #
1595
- # source://faraday//lib/faraday/options.rb#39
1596
- def delete(key); end
1597
-
1598
- # Public
1599
- #
1600
- # source://faraday//lib/faraday/options.rb#13
1601
- def each; end
1602
-
1603
- # Public
1604
- #
1605
- # source://faraday//lib/faraday/options.rb#106
1606
- def each_key(&block); end
1607
-
1608
- # Public
1609
- #
1610
- # source://faraday//lib/faraday/options.rb#120
1611
- def each_value(&block); end
1612
-
1613
- # Public
1614
- #
1615
- # @return [Boolean]
1616
- #
1617
- # source://faraday//lib/faraday/options.rb#101
1618
- def empty?; end
1619
-
1620
- # Public
1621
- #
1622
- # source://faraday//lib/faraday/options.rb#76
1623
- def fetch(key, *args); end
1624
-
1625
- # Public
1626
- #
1627
- # @return [Boolean]
1628
- #
1629
- # source://faraday//lib/faraday/options.rb#113
1630
- def has_key?(key); end
1631
-
1632
- # Public
1633
- #
1634
- # @return [Boolean]
1635
- #
1636
- # source://faraday//lib/faraday/options.rb#127
1637
- def has_value?(value); end
1638
-
1639
- # Internal
1640
- #
1641
- # source://faraday//lib/faraday/options.rb#144
1642
- def inspect; end
1643
-
1644
- # Public
1645
- #
1646
- # @return [Boolean]
1647
- #
1648
- # source://faraday//lib/faraday/options.rb#113
1649
- def key?(key); end
1650
-
1651
- # Public
1652
- #
1653
- # source://faraday//lib/faraday/options.rb#96
1654
- def keys; end
1655
-
1656
- # Public
1657
- #
1658
- # source://faraday//lib/faraday/options.rb#66
1659
- def merge(other); end
1660
-
1661
- # Public
1662
- #
1663
- # source://faraday//lib/faraday/options.rb#51
1664
- def merge!(other); end
1665
-
1666
- # source://faraday//lib/faraday/options.rb#194
1667
- def symbolized_key_set; end
1668
-
1669
- # Public
1670
- #
1671
- # source://faraday//lib/faraday/options.rb#134
1672
- def to_hash; end
1673
-
1674
- # Public
1675
- #
1676
- # source://faraday//lib/faraday/options.rb#22
1677
- def update(obj); end
1678
-
1679
- # Public
1680
- #
1681
- # @return [Boolean]
1682
- #
1683
- # source://faraday//lib/faraday/options.rb#127
1684
- def value?(value); end
1685
-
1686
- # Public
1687
- #
1688
- # source://faraday//lib/faraday/options.rb#91
1689
- def values_at(*keys); end
1690
-
1691
- class << self
1692
- # Internal
1693
- #
1694
- # source://faraday//lib/faraday/options.rb#166
1695
- def attribute_options; end
1696
-
1697
- # source://faraday//lib/faraday/options.rb#204
1698
- def fetch_error_class; end
1699
-
1700
- # Public
1701
- #
1702
- # source://faraday//lib/faraday/options.rb#8
1703
- def from(value); end
1704
-
1705
- # @private
1706
- #
1707
- # source://faraday//lib/faraday/options.rb#198
1708
- def inherited(subclass); end
1709
-
1710
- # source://faraday//lib/faraday/options.rb#170
1711
- def memoized(key, &block); end
1712
-
1713
- # source://faraday//lib/faraday/options.rb#181
1714
- def memoized_attributes; end
1715
-
1716
- # Internal
1717
- #
1718
- # source://faraday//lib/faraday/options.rb#156
1719
- def options(mapping); end
1720
-
1721
- # Internal
1722
- #
1723
- # source://faraday//lib/faraday/options.rb#161
1724
- def options_for(key); end
1725
- end
1726
- end
1727
-
1728
- # Raised by FaradayMiddleware::ResponseMiddleware
1729
- #
1730
- # source://faraday//lib/faraday/error.rb#144
1731
- class Faraday::ParsingError < ::Faraday::Error; end
1732
-
1733
- # Raised by Faraday::Response::RaiseError in case of a 407 response.
1734
- #
1735
- # source://faraday//lib/faraday/error.rb#105
1736
- class Faraday::ProxyAuthError < ::Faraday::ClientError; end
1737
-
1738
- # ProxyOptions contains the configurable properties for the proxy
1739
- # configuration used when making an HTTP request.
1740
- #
1741
- # source://faraday//lib/faraday/options/proxy_options.rb#6
1742
- class Faraday::ProxyOptions < ::Faraday::Options
1743
- extend ::Forwardable
1744
-
1745
- # source://forwardable/1.3.2/forwardable.rb#229
1746
- def host(*args, **_arg1, &block); end
1747
-
1748
- # source://forwardable/1.3.2/forwardable.rb#229
1749
- def host=(*args, **_arg1, &block); end
1750
-
1751
- # source://faraday//lib/faraday/options.rb#177
1752
- def password; end
1753
-
1754
- # source://forwardable/1.3.2/forwardable.rb#229
1755
- def path(*args, **_arg1, &block); end
1756
-
1757
- # source://forwardable/1.3.2/forwardable.rb#229
1758
- def path=(*args, **_arg1, &block); end
1759
-
1760
- # source://forwardable/1.3.2/forwardable.rb#229
1761
- def port(*args, **_arg1, &block); end
1762
-
1763
- # source://forwardable/1.3.2/forwardable.rb#229
1764
- def port=(*args, **_arg1, &block); end
1765
-
1766
- # source://forwardable/1.3.2/forwardable.rb#229
1767
- def scheme(*args, **_arg1, &block); end
1768
-
1769
- # source://forwardable/1.3.2/forwardable.rb#229
1770
- def scheme=(*args, **_arg1, &block); end
1771
-
1772
- # source://faraday//lib/faraday/options.rb#177
1773
- def user; end
1774
-
1775
- class << self
1776
- # source://faraday//lib/faraday/options/proxy_options.rb#11
1777
- def from(value); end
1778
- end
1779
- end
1780
-
1781
- # A Builder that processes requests into responses by passing through an inner
1782
- # middleware stack (heavily inspired by Rack).
1783
- #
1784
- # @example
1785
- # Faraday::Connection.new(url: 'http://sushi.com') do |builder|
1786
- # builder.request :url_encoded # Faraday::Request::UrlEncoded
1787
- # builder.adapter :net_http # Faraday::Adapter::NetHttp
1788
- # end
1789
- #
1790
- # source://faraday//lib/faraday/rack_builder.rb#15
1791
- class Faraday::RackBuilder
1792
- # @return [RackBuilder] a new instance of RackBuilder
1793
- #
1794
- # source://faraday//lib/faraday/rack_builder.rb#61
1795
- def initialize(handlers = T.unsafe(nil), adapter = T.unsafe(nil), &block); end
1796
-
1797
- # source://faraday//lib/faraday/rack_builder.rb#179
1798
- def ==(other); end
1799
-
1800
- # source://faraday//lib/faraday/rack_builder.rb#80
1801
- def [](idx); end
1802
-
1803
- # source://faraday//lib/faraday/rack_builder.rb#111
1804
- def adapter(klass = T.unsafe(nil), *args, **_arg2, &block); end
1805
-
1806
- # The "rack app" wrapped in middleware. All requests are sent here.
1807
- #
1808
- # The builder is responsible for creating the app object. After this,
1809
- # the builder gets locked to ensure no further modifications are made
1810
- # to the middleware stack.
1811
- #
1812
- # Returns an object that responds to `call` and returns a Response.
1813
- #
1814
- # source://faraday//lib/faraday/rack_builder.rb#164
1815
- def app; end
1816
-
1817
- # @yield [_self]
1818
- # @yieldparam _self [Faraday::RackBuilder] the object that the method was called on
1819
- #
1820
- # source://faraday//lib/faraday/rack_builder.rb#73
1821
- def build(options = T.unsafe(nil)); end
1822
-
1823
- # ENV Keys
1824
- # :http_method - a symbolized request HTTP method (:get, :post)
1825
- # :body - the request body that will eventually be converted to a string.
1826
- # :url - URI instance for the current request.
1827
- # :status - HTTP response status code
1828
- # :request_headers - hash of HTTP Headers to be sent to the server
1829
- # :response_headers - Hash of HTTP headers from the server
1830
- # :parallel_manager - sent if the connection is in parallel mode
1831
- # :request - Hash of options for configuring the request.
1832
- # :timeout - open/read timeout Integer in seconds
1833
- # :open_timeout - read timeout Integer in seconds
1834
- # :proxy - Hash of proxy options
1835
- # :uri - Proxy Server URI
1836
- # :user - Proxy server username
1837
- # :password - Proxy server password
1838
- # :ssl - Hash of options for configuring SSL requests.
1839
- #
1840
- # source://faraday//lib/faraday/rack_builder.rb#205
1841
- def build_env(connection, request); end
1842
-
1843
- # Processes a Request into a Response by passing it through this Builder's
1844
- # middleware stack.
1845
- #
1846
- # @param connection [Faraday::Connection]
1847
- # @param request [Faraday::Request]
1848
- # @return [Faraday::Response]
1849
- #
1850
- # source://faraday//lib/faraday/rack_builder.rb#153
1851
- def build_response(connection, request); end
1852
-
1853
- # source://faraday//lib/faraday/rack_builder.rb#141
1854
- def delete(handler); end
1855
-
1856
- # source://faraday//lib/faraday/rack_builder.rb#185
1857
- def dup; end
1858
-
1859
- # Returns the value of attribute handlers.
1860
- #
1861
- # source://faraday//lib/faraday/rack_builder.rb#19
1862
- def handlers; end
1863
-
1864
- # Sets the attribute handlers
1865
- #
1866
- # @param value the value to set the attribute handlers to.
1867
- #
1868
- # source://faraday//lib/faraday/rack_builder.rb#19
1869
- def handlers=(_arg0); end
1870
-
1871
- # methods to push onto the various positions in the stack:
1872
- #
1873
- # source://faraday//lib/faraday/rack_builder.rb#120
1874
- def insert(index, *args, **_arg2, &block); end
1875
-
1876
- # source://faraday//lib/faraday/rack_builder.rb#129
1877
- def insert_after(index, *args, **_arg2, &block); end
1878
-
1879
- # methods to push onto the various positions in the stack:
1880
- #
1881
- # source://faraday//lib/faraday/rack_builder.rb#120
1882
- def insert_before(index, *args, **_arg2, &block); end
1883
-
1884
- # Locks the middleware stack to ensure no further modifications are made.
1885
- #
1886
- # source://faraday//lib/faraday/rack_builder.rb#85
1887
- def lock!; end
1888
-
1889
- # @return [Boolean]
1890
- #
1891
- # source://faraday//lib/faraday/rack_builder.rb#89
1892
- def locked?; end
1893
-
1894
- # source://faraday//lib/faraday/rack_builder.rb#103
1895
- def request(key, *args, **_arg2, &block); end
1896
-
1897
- # source://faraday//lib/faraday/rack_builder.rb#107
1898
- def response(key, *args, **_arg2, &block); end
1899
-
1900
- # source://faraday//lib/faraday/rack_builder.rb#134
1901
- def swap(index, *args, **_arg2, &block); end
1902
-
1903
- # source://faraday//lib/faraday/rack_builder.rb#171
1904
- def to_app; end
1905
-
1906
- # source://faraday//lib/faraday/rack_builder.rb#93
1907
- def use(klass, *args, **_arg2, &block); end
1908
-
1909
- private
1910
-
1911
- # @return [Boolean]
1912
- #
1913
- # source://faraday//lib/faraday/rack_builder.rb#230
1914
- def adapter_set?; end
1915
-
1916
- # source://faraday//lib/faraday/rack_builder.rb#242
1917
- def assert_index(index); end
1918
-
1919
- # @return [Boolean]
1920
- #
1921
- # source://faraday//lib/faraday/rack_builder.rb#234
1922
- def is_adapter?(klass); end
1923
-
1924
- # source://faraday//lib/faraday/rack_builder.rb#224
1925
- def raise_if_adapter(klass); end
1926
-
1927
- # @raise [StackLocked]
1928
- #
1929
- # source://faraday//lib/faraday/rack_builder.rb#220
1930
- def raise_if_locked; end
1931
-
1932
- # source://faraday//lib/faraday/rack_builder.rb#238
1933
- def use_symbol(mod, key, *args, **_arg3, &block); end
1934
- end
1935
-
1936
- # borrowed from ActiveSupport::Dependencies::Reference &
1937
- # ActionDispatch::MiddlewareStack::Middleware
1938
- #
1939
- # source://faraday//lib/faraday/rack_builder.rb#26
1940
- class Faraday::RackBuilder::Handler
1941
- # source://faraday//lib/faraday/rack_builder.rb#31
1942
- def initialize(klass, *args, **_arg2, &block); end
1943
-
1944
- # source://faraday//lib/faraday/rack_builder.rb#46
1945
- def ==(other); end
1946
-
1947
- # source://faraday//lib/faraday/rack_builder.rb#56
1948
- def build(app = T.unsafe(nil)); end
1949
-
1950
- # source://faraday//lib/faraday/rack_builder.rb#42
1951
- def inspect; end
1952
-
1953
- # source://faraday//lib/faraday/rack_builder.rb#38
1954
- def klass; end
1955
-
1956
- # Returns the value of attribute name.
1957
- #
1958
- # source://faraday//lib/faraday/rack_builder.rb#29
1959
- def name; end
1960
- end
1961
-
1962
- # source://faraday//lib/faraday/rack_builder.rb#27
1963
- Faraday::RackBuilder::Handler::REGISTRY = T.let(T.unsafe(nil), Faraday::AdapterRegistry)
1964
-
1965
- # source://faraday//lib/faraday/rack_builder.rb#218
1966
- Faraday::RackBuilder::LOCK_ERR = T.let(T.unsafe(nil), String)
1967
-
1968
- # Used to detect missing arguments
1969
- #
1970
- # source://faraday//lib/faraday/rack_builder.rb#17
1971
- Faraday::RackBuilder::NO_ARGUMENT = T.let(T.unsafe(nil), Object)
1972
-
1973
- # Error raised when trying to modify the stack after calling `lock!`
1974
- #
1975
- # source://faraday//lib/faraday/rack_builder.rb#22
1976
- class Faraday::RackBuilder::StackLocked < ::RuntimeError; end
1977
-
1978
- # Used to setup URLs, params, headers, and the request body in a sane manner.
1979
- #
1980
- #
1981
- # @example
1982
- # @connection.post do |req|
1983
- # req.url 'http://localhost', 'a' => '1' # 'http://localhost?a=1'
1984
- # req.headers['b'] = '2' # Header
1985
- # req.params['c'] = '3' # GET Param
1986
- # req['b'] = '2' # also Header
1987
- # req.body = 'abc'
1988
- # end
1989
- #
1990
- # source://faraday//lib/faraday/request.rb#32
1991
- class Faraday::Request < ::Struct
1992
- extend ::Faraday::MiddlewareRegistry
1993
- extend ::Faraday::Deprecate
1994
- extend ::Faraday::AutoloadHelper
1995
-
1996
- # @param key [Object] key to look up in headers
1997
- # @return [Object] value of the given header name
1998
- #
1999
- # source://faraday//lib/faraday/request.rb#112
2000
- def [](key); end
2001
-
2002
- # @param key [Object] key of header to write
2003
- # @param value [Object] value of header
2004
- #
2005
- # source://faraday//lib/faraday/request.rb#118
2006
- def []=(key, value); end
2007
-
2008
- # source://faraday//lib/faraday/request.rb#60
2009
- def _deprecated_method; end
2010
-
2011
- # Replace request headers, preserving the existing hash type.
2012
- #
2013
- # @param hash [Hash] new headers
2014
- #
2015
- # source://faraday//lib/faraday/request.rb#81
2016
- def headers=(hash); end
2017
-
2018
- # Marshal serialization support.
2019
- #
2020
- # @return [Hash] the hash ready to be serialized in Marshal.
2021
- #
2022
- # source://faraday//lib/faraday/request.rb#125
2023
- def marshal_dump; end
2024
-
2025
- # Marshal serialization support.
2026
- # Restores the instance variables according to the +serialised+.
2027
- #
2028
- # @param serialised [Hash] the serialised object.
2029
- #
2030
- # source://faraday//lib/faraday/request.rb#139
2031
- def marshal_load(serialised); end
2032
-
2033
- # source://faraday//lib/faraday/deprecate.rb#86
2034
- def method(*args, &block); end
2035
-
2036
- # Replace params, preserving the existing hash type.
2037
- #
2038
- # @param hash [Hash] new params
2039
- #
2040
- # source://faraday//lib/faraday/request.rb#70
2041
- def params=(hash); end
2042
-
2043
- # @return [Env] the Env for this Request
2044
- #
2045
- # source://faraday//lib/faraday/request.rb#149
2046
- def to_env(connection); end
2047
-
2048
- # Update path and params.
2049
- #
2050
- # @param path [URI, String]
2051
- # @param params [Hash, nil]
2052
- # @return [void]
2053
- #
2054
- # source://faraday//lib/faraday/request.rb#94
2055
- def url(path, params = T.unsafe(nil)); end
2056
-
2057
- class << self
2058
- # @param request_method [String]
2059
- # @return [Request]
2060
- # @yield [request] for block customization, if block given
2061
- # @yieldparam request [Request]
2062
- #
2063
- # source://faraday//lib/faraday/request.rb#54
2064
- def create(request_method); end
2065
- end
2066
- end
2067
-
2068
- # Request middleware for the Authorization HTTP header
2069
- #
2070
- # source://faraday//lib/faraday/request/authorization.rb#8
2071
- class Faraday::Request::Authorization < ::Faraday::Middleware
2072
- # @param app [#call]
2073
- # @param type [String, Symbol] Type of Authorization
2074
- # @param param [String, Symbol, Hash, Proc] parameter to build the Authorization header.
2075
- # This value can be a proc, in which case it will be invoked on each request.
2076
- # @return [Authorization] a new instance of Authorization
2077
- #
2078
- # source://faraday//lib/faraday/request/authorization.rb#48
2079
- def initialize(app, type, param); end
2080
-
2081
- # @param env [Faraday::Env]
2082
- #
2083
- # source://faraday//lib/faraday/request/authorization.rb#55
2084
- def on_request(env); end
2085
-
2086
- class << self
2087
- # @api private
2088
- # @param type [String]
2089
- # @param hash [Hash]
2090
- # @return [String] type followed by comma-separated key=value pairs
2091
- #
2092
- # source://faraday//lib/faraday/request/authorization.rb#34
2093
- def build_hash(type, hash); end
2094
-
2095
- # @param type [String, Symbol]
2096
- # @param token [String, Symbol, Hash]
2097
- # @return [String] a header value
2098
- #
2099
- # source://faraday//lib/faraday/request/authorization.rb#16
2100
- def header(type, token); end
2101
- end
2102
- end
2103
-
2104
- # source://faraday//lib/faraday/request/authorization.rb#10
2105
- Faraday::Request::Authorization::KEY = T.let(T.unsafe(nil), String)
2106
-
2107
- # Authorization middleware for Basic Authentication.
2108
- #
2109
- # source://faraday//lib/faraday/request/basic_authentication.rb#12
2110
- class Faraday::Request::BasicAuthentication < ::Faraday::Request::Authorization
2111
- class << self
2112
- # @param login [String]
2113
- # @param pass [String]
2114
- # @return [String] a Basic Authentication header line
2115
- #
2116
- # source://faraday//lib/faraday/request/basic_authentication.rb#13
2117
- def header(login, pass); end
2118
- end
2119
- end
2120
-
2121
- # Middleware for instrumenting Requests.
2122
- #
2123
- # source://faraday//lib/faraday/request/instrumentation.rb#7
2124
- class Faraday::Request::Instrumentation < ::Faraday::Middleware
2125
- # Instruments requests using Active Support.
2126
- #
2127
- # Measures time spent only for synchronous requests.
2128
- #
2129
- # @example Using ActiveSupport::Notifications to measure time spent
2130
- # for Faraday requests.
2131
- # ActiveSupport::Notifications
2132
- # .subscribe('request.faraday') do |name, starts, ends, _, env|
2133
- # url = env[:url]
2134
- # http_method = env[:method].to_s.upcase
2135
- # duration = ends - starts
2136
- # $stderr.puts '[%s] %s %s (%.3f s)' %
2137
- # [url.host, http_method, url.request_uri, duration]
2138
- # end
2139
- # @option options
2140
- # @option options
2141
- # @param app [#call]
2142
- # @param options [nil, Hash] Options hash
2143
- # @return [Instrumentation] a new instance of Instrumentation
2144
- #
2145
- # source://faraday//lib/faraday/request/instrumentation.rb#40
2146
- def initialize(app, options = T.unsafe(nil)); end
2147
-
2148
- # @param env [Faraday::Env]
2149
- #
2150
- # source://faraday//lib/faraday/request/instrumentation.rb#47
2151
- def call(env); end
2152
- end
2153
-
2154
- # Options class used in Request::Instrumentation class.
2155
- #
2156
- # source://faraday//lib/faraday/request/instrumentation.rb#9
2157
- class Faraday::Request::Instrumentation::Options < ::Faraday::Options
2158
- # @return [Class]
2159
- #
2160
- # source://faraday//lib/faraday/request/instrumentation.rb#15
2161
- def instrumenter; end
2162
-
2163
- # @return [String]
2164
- #
2165
- # source://faraday//lib/faraday/request/instrumentation.rb#10
2166
- def name; end
2167
- end
2168
-
2169
- # source://faraday//lib/faraday.rb#32
2170
- Faraday::Request::Multipart = Faraday::Multipart::Middleware
2171
-
2172
- # source://faraday//lib/faraday.rb#33
2173
- Faraday::Request::Retry = Faraday::Retry::Middleware
2174
-
2175
- # TokenAuthentication is a middleware that adds a 'Token' header to a
2176
- # Faraday request.
2177
- #
2178
- # source://faraday//lib/faraday/request/token_authentication.rb#8
2179
- class Faraday::Request::TokenAuthentication < ::Faraday::Request::Authorization
2180
- # @return [TokenAuthentication] a new instance of TokenAuthentication
2181
- #
2182
- # source://faraday//lib/faraday/request/token_authentication.rb#15
2183
- def initialize(app, token, options = T.unsafe(nil)); end
2184
-
2185
- class << self
2186
- # Public
2187
- #
2188
- # source://faraday//lib/faraday/request/token_authentication.rb#9
2189
- def header(token, options = T.unsafe(nil)); end
2190
- end
2191
- end
2192
-
2193
- # Middleware for supporting urlencoded requests.
2194
- #
2195
- # source://faraday//lib/faraday/request/url_encoded.rb#6
2196
- class Faraday::Request::UrlEncoded < ::Faraday::Middleware
2197
- # Encodes as "application/x-www-form-urlencoded" if not already encoded or
2198
- # of another type.
2199
- #
2200
- # @param env [Faraday::Env]
2201
- #
2202
- # source://faraday//lib/faraday/request/url_encoded.rb#20
2203
- def call(env); end
2204
-
2205
- # @param env [Faraday::Env]
2206
- # @yield [request_body] Body of the request
2207
- #
2208
- # source://faraday//lib/faraday/request/url_encoded.rb#30
2209
- def match_content_type(env); end
2210
-
2211
- # @param env [Faraday::Env]
2212
- # @return [Boolean] True if the request has a body and its Content-Type is
2213
- # urlencoded.
2214
- #
2215
- # source://faraday//lib/faraday/request/url_encoded.rb#41
2216
- def process_request?(env); end
2217
-
2218
- # @param env [Faraday::Env]
2219
- # @return [String]
2220
- #
2221
- # source://faraday//lib/faraday/request/url_encoded.rb#49
2222
- def request_type(env); end
2223
-
2224
- class << self
2225
- # Returns the value of attribute mime_type.
2226
- #
2227
- # source://faraday//lib/faraday/request/url_encoded.rb#12
2228
- def mime_type; end
2229
-
2230
- # Sets the attribute mime_type
2231
- #
2232
- # @param value the value to set the attribute mime_type to.
2233
- #
2234
- # source://faraday//lib/faraday/request/url_encoded.rb#12
2235
- def mime_type=(_arg0); end
2236
- end
2237
- end
2238
-
2239
- # source://faraday//lib/faraday/request/url_encoded.rb#8
2240
- Faraday::Request::UrlEncoded::CONTENT_TYPE = T.let(T.unsafe(nil), String)
2241
-
2242
- # RequestOptions contains the configurable properties for a Faraday request.
2243
- #
2244
- # source://faraday//lib/faraday/options/request_options.rb#8
2245
- class Faraday::RequestOptions < ::Faraday::Options
2246
- # source://faraday//lib/faraday/options/request_options.rb#10
2247
- def []=(key, value); end
2248
-
2249
- # @return [Boolean]
2250
- #
2251
- # source://faraday//lib/faraday/options/request_options.rb#18
2252
- def stream_response?; end
2253
- end
2254
-
2255
- # Raised by Faraday::Response::RaiseError in case of a 404 response.
2256
- #
2257
- # source://faraday//lib/faraday/error.rb#101
2258
- class Faraday::ResourceNotFound < ::Faraday::ClientError; end
2259
-
2260
- # Response represents an HTTP response from making an HTTP request.
2261
- #
2262
- # source://faraday//lib/faraday/response.rb#7
2263
- class Faraday::Response
2264
- extend ::Forwardable
2265
- extend ::Faraday::MiddlewareRegistry
2266
- extend ::Faraday::AutoloadHelper
2267
-
2268
- # @return [Response] a new instance of Response
2269
- #
2270
- # source://faraday//lib/faraday/response.rb#28
2271
- def initialize(env = T.unsafe(nil)); end
2272
-
2273
- # source://forwardable/1.3.2/forwardable.rb#229
2274
- def [](*args, **_arg1, &block); end
2275
-
2276
- # Expand the env with more properties, without overriding existing ones.
2277
- # Useful for applying request params after restoring a marshalled Response.
2278
- #
2279
- # source://faraday//lib/faraday/response.rb#96
2280
- def apply_request(request_env); end
2281
-
2282
- # source://faraday//lib/faraday/response.rb#49
2283
- def body; end
2284
-
2285
- # Returns the value of attribute env.
2286
- #
2287
- # source://faraday//lib/faraday/response.rb#33
2288
- def env; end
2289
-
2290
- # source://faraday//lib/faraday/response.rb#66
2291
- def finish(env); end
2292
-
2293
- # @return [Boolean]
2294
- #
2295
- # source://faraday//lib/faraday/response.rb#53
2296
- def finished?; end
2297
-
2298
- # source://faraday//lib/faraday/response.rb#43
2299
- def headers; end
2300
-
2301
- # because @on_complete_callbacks cannot be marshalled
2302
- #
2303
- # source://faraday//lib/faraday/response.rb#86
2304
- def marshal_dump; end
2305
-
2306
- # source://faraday//lib/faraday/response.rb#90
2307
- def marshal_load(env); end
2308
-
2309
- # source://faraday//lib/faraday/response.rb#57
2310
- def on_complete(&block); end
2311
-
2312
- # source://faraday//lib/faraday/response.rb#39
2313
- def reason_phrase; end
2314
-
2315
- # source://faraday//lib/faraday/response.rb#35
2316
- def status; end
2317
-
2318
- # @return [Boolean]
2319
- #
2320
- # source://faraday//lib/faraday/response.rb#74
2321
- def success?; end
2322
-
2323
- # source://faraday//lib/faraday/response.rb#78
2324
- def to_hash; end
2325
- end
2326
-
2327
- # Logger is a middleware that logs internal events in the HTTP request
2328
- # lifecycle to a given Logger object. By default, this logs to STDOUT. See
2329
- # Faraday::Logging::Formatter to see specifically what is logged.
2330
- #
2331
- # source://faraday//lib/faraday/response/logger.rb#12
2332
- class Faraday::Response::Logger < ::Faraday::Response::Middleware
2333
- # @return [Logger] a new instance of Logger
2334
- # @yield [@formatter]
2335
- #
2336
- # source://faraday//lib/faraday/response/logger.rb#13
2337
- def initialize(app, logger = T.unsafe(nil), options = T.unsafe(nil)); end
2338
-
2339
- # source://faraday//lib/faraday/response/logger.rb#21
2340
- def call(env); end
2341
-
2342
- # source://faraday//lib/faraday/response/logger.rb#26
2343
- def on_complete(env); end
2344
- end
2345
-
2346
- # Used for simple response middleware.
2347
- #
2348
- # source://faraday//lib/faraday/response.rb#12
2349
- class Faraday::Response::Middleware < ::Faraday::Middleware
2350
- # Override this to modify the environment after the response has finished.
2351
- # Calls the `parse` method if defined
2352
- # `parse` method can be defined as private, public and protected
2353
- #
2354
- # source://faraday//lib/faraday/response.rb#13
2355
- def on_complete(env); end
2356
- end
2357
-
2358
- # RaiseError is a Faraday middleware that raises exceptions on common HTTP
2359
- # client or server error responses.
2360
- #
2361
- # source://faraday//lib/faraday/response/raise_error.rb#8
2362
- class Faraday::Response::RaiseError < ::Faraday::Response::Middleware
2363
- # source://faraday//lib/faraday/response/raise_error.rb#13
2364
- def on_complete(env); end
2365
-
2366
- # source://faraday//lib/faraday/response/raise_error.rb#40
2367
- def response_values(env); end
2368
- end
2369
-
2370
- # source://faraday//lib/faraday/response/raise_error.rb#9
2371
- Faraday::Response::RaiseError::ClientErrorStatuses = T.let(T.unsafe(nil), Range)
2372
-
2373
- # source://faraday//lib/faraday/response/raise_error.rb#10
2374
- Faraday::Response::RaiseError::ServerErrorStatuses = T.let(T.unsafe(nil), Range)
2375
-
2376
- # A unified client error for SSL errors.
2377
- #
2378
- # source://faraday//lib/faraday/error.rb#140
2379
- class Faraday::SSLError < ::Faraday::Error; end
2380
-
2381
- # SSL-related options.
2382
- #
2383
- # source://faraday//lib/faraday/options/ssl_options.rb#47
2384
- class Faraday::SSLOptions < ::Faraday::Options
2385
- # @return [Boolean] true if should not verify
2386
- #
2387
- # source://faraday//lib/faraday/options/ssl_options.rb#55
2388
- def disable?; end
2389
-
2390
- # @return [Boolean] true if should verify
2391
- #
2392
- # source://faraday//lib/faraday/options/ssl_options.rb#50
2393
- def verify?; end
2394
- end
2395
-
2396
- # Faraday server error class. Represents 5xx status responses.
2397
- #
2398
- # source://faraday//lib/faraday/error.rb#117
2399
- class Faraday::ServerError < ::Faraday::Error; end
2400
-
2401
- # A unified client error for timeouts.
2402
- #
2403
- # source://faraday//lib/faraday/error.rb#121
2404
- class Faraday::TimeoutError < ::Faraday::ServerError
2405
- # @return [TimeoutError] a new instance of TimeoutError
2406
- #
2407
- # source://faraday//lib/faraday/error.rb#122
2408
- def initialize(exc = T.unsafe(nil), response = T.unsafe(nil)); end
2409
- end
2410
-
2411
- # source://faraday//lib/faraday.rb#12
2412
- Faraday::Timer = Timeout
2413
-
2414
- # Raised by Faraday::Response::RaiseError in case of a 401 response.
2415
- #
2416
- # source://faraday//lib/faraday/error.rb#93
2417
- class Faraday::UnauthorizedError < ::Faraday::ClientError; end
2418
-
2419
- # Raised by Faraday::Response::RaiseError in case of a 422 response.
2420
- #
2421
- # source://faraday//lib/faraday/error.rb#113
2422
- class Faraday::UnprocessableEntityError < ::Faraday::ClientError; end
2423
-
2424
- # Utils contains various static helper methods.
2425
- #
2426
- # source://faraday//lib/faraday/utils/headers.rb#4
2427
- module Faraday::Utils
2428
- private
2429
-
2430
- # Normalize URI() behavior across Ruby versions
2431
- #
2432
- # url - A String or URI.
2433
- #
2434
- # Returns a parsed URI.
2435
- #
2436
- # source://faraday//lib/faraday/utils.rb#63
2437
- def URI(url); end
2438
-
2439
- # source://faraday//lib/faraday/utils.rb#15
2440
- def build_nested_query(params); end
2441
-
2442
- # source://faraday//lib/faraday/utils.rb#11
2443
- def build_query(params); end
2444
-
2445
- # Recursive hash merge
2446
- #
2447
- # source://faraday//lib/faraday/utils.rb#109
2448
- def deep_merge(source, hash); end
2449
-
2450
- # Recursive hash update
2451
- #
2452
- # source://faraday//lib/faraday/utils.rb#97
2453
- def deep_merge!(target, hash); end
2454
-
2455
- # source://faraday//lib/faraday/utils.rb#50
2456
- def default_params_encoder; end
2457
-
2458
- # source://faraday//lib/faraday/utils.rb#19
2459
- def default_space_encoding; end
2460
-
2461
- # source://faraday//lib/faraday/utils.rb#73
2462
- def default_uri_parser; end
2463
-
2464
- # source://faraday//lib/faraday/utils.rb#80
2465
- def default_uri_parser=(parser); end
2466
-
2467
- # source://faraday//lib/faraday/utils.rb#29
2468
- def escape(str); end
2469
-
2470
- # Receives a String or URI and returns just
2471
- # the path with the query string sorted.
2472
- #
2473
- # source://faraday//lib/faraday/utils.rb#90
2474
- def normalize_path(url); end
2475
-
2476
- # source://faraday//lib/faraday/utils.rb#46
2477
- def parse_nested_query(query); end
2478
-
2479
- # Adapted from Rack
2480
- #
2481
- # source://faraday//lib/faraday/utils.rb#42
2482
- def parse_query(query); end
2483
-
2484
- # source://faraday//lib/faraday/utils.rb#113
2485
- def sort_query_params(query); end
2486
-
2487
- # source://faraday//lib/faraday/utils.rb#35
2488
- def unescape(str); end
2489
-
2490
- class << self
2491
- # Normalize URI() behavior across Ruby versions
2492
- #
2493
- # url - A String or URI.
2494
- #
2495
- # Returns a parsed URI.
2496
- #
2497
- # source://faraday//lib/faraday/utils.rb#63
2498
- def URI(url); end
2499
-
2500
- # source://faraday//lib/faraday/utils.rb#15
2501
- def build_nested_query(params); end
2502
-
2503
- # source://faraday//lib/faraday/utils.rb#11
2504
- def build_query(params); end
2505
-
2506
- # Recursive hash merge
2507
- #
2508
- # source://faraday//lib/faraday/utils.rb#109
2509
- def deep_merge(source, hash); end
2510
-
2511
- # Recursive hash update
2512
- #
2513
- # source://faraday//lib/faraday/utils.rb#97
2514
- def deep_merge!(target, hash); end
2515
-
2516
- # source://faraday//lib/faraday/utils.rb#50
2517
- def default_params_encoder; end
2518
-
2519
- # Sets the attribute default_params_encoder
2520
- #
2521
- # @param value the value to set the attribute default_params_encoder to.
2522
- #
2523
- # source://faraday//lib/faraday/utils.rb#55
2524
- def default_params_encoder=(_arg0); end
2525
-
2526
- # source://faraday//lib/faraday/utils.rb#19
2527
- def default_space_encoding; end
2528
-
2529
- # Sets the attribute default_space_encoding
2530
- #
2531
- # @param value the value to set the attribute default_space_encoding to.
2532
- #
2533
- # source://faraday//lib/faraday/utils.rb#24
2534
- def default_space_encoding=(_arg0); end
2535
-
2536
- # source://faraday//lib/faraday/utils.rb#73
2537
- def default_uri_parser; end
2538
-
2539
- # source://faraday//lib/faraday/utils.rb#80
2540
- def default_uri_parser=(parser); end
2541
-
2542
- # source://faraday//lib/faraday/utils.rb#29
2543
- def escape(str); end
2544
-
2545
- # Receives a String or URI and returns just
2546
- # the path with the query string sorted.
2547
- #
2548
- # source://faraday//lib/faraday/utils.rb#90
2549
- def normalize_path(url); end
2550
-
2551
- # source://faraday//lib/faraday/utils.rb#46
2552
- def parse_nested_query(query); end
2553
-
2554
- # Adapted from Rack
2555
- #
2556
- # source://faraday//lib/faraday/utils.rb#42
2557
- def parse_query(query); end
2558
-
2559
- # source://faraday//lib/faraday/utils.rb#113
2560
- def sort_query_params(query); end
2561
-
2562
- # source://faraday//lib/faraday/utils.rb#35
2563
- def unescape(str); end
2564
- end
2565
- end
2566
-
2567
- # source://faraday//lib/faraday/utils.rb#39
2568
- Faraday::Utils::DEFAULT_SEP = T.let(T.unsafe(nil), Regexp)
2569
-
2570
- # source://faraday//lib/faraday/utils.rb#27
2571
- Faraday::Utils::ESCAPE_RE = T.let(T.unsafe(nil), Regexp)
2572
-
2573
- # A case-insensitive Hash that preserves the original case of a header
2574
- # when set.
2575
- #
2576
- # Adapted from Rack::Utils::HeaderHash
2577
- #
2578
- # source://faraday//lib/faraday/utils/headers.rb#9
2579
- class Faraday::Utils::Headers < ::Hash
2580
- # @return [Headers] a new instance of Headers
2581
- #
2582
- # source://faraday//lib/faraday/utils/headers.rb#20
2583
- def initialize(hash = T.unsafe(nil)); end
2584
-
2585
- # source://faraday//lib/faraday/utils/headers.rb#52
2586
- def [](key); end
2587
-
2588
- # source://faraday//lib/faraday/utils/headers.rb#57
2589
- def []=(key, val); end
2590
-
2591
- # source://faraday//lib/faraday/utils/headers.rb#71
2592
- def delete(key); end
2593
-
2594
- # source://faraday//lib/faraday/utils/headers.rb#65
2595
- def fetch(key, *args, &block); end
2596
-
2597
- # @return [Boolean]
2598
- #
2599
- # source://faraday//lib/faraday/utils/headers.rb#80
2600
- def has_key?(key); end
2601
-
2602
- # @return [Boolean]
2603
- #
2604
- # source://faraday//lib/faraday/utils/headers.rb#80
2605
- def include?(key); end
2606
-
2607
- # source://faraday//lib/faraday/utils/headers.rb#26
2608
- def initialize_names; end
2609
-
2610
- # @return [Boolean]
2611
- #
2612
- # source://faraday//lib/faraday/utils/headers.rb#80
2613
- def key?(key); end
2614
-
2615
- # @return [Boolean]
2616
- #
2617
- # source://faraday//lib/faraday/utils/headers.rb#80
2618
- def member?(key); end
2619
-
2620
- # source://faraday//lib/faraday/utils/headers.rb#95
2621
- def merge(other); end
2622
-
2623
- # source://faraday//lib/faraday/utils/headers.rb#88
2624
- def merge!(other); end
2625
-
2626
- # source://faraday//lib/faraday/utils/headers.rb#111
2627
- def parse(header_string); end
2628
-
2629
- # source://faraday//lib/faraday/utils/headers.rb#100
2630
- def replace(other); end
2631
-
2632
- # source://faraday//lib/faraday/utils/headers.rb#107
2633
- def to_hash; end
2634
-
2635
- # source://faraday//lib/faraday/utils/headers.rb#88
2636
- def update(other); end
2637
-
2638
- protected
2639
-
2640
- # Returns the value of attribute names.
2641
- #
2642
- # source://faraday//lib/faraday/utils/headers.rb#129
2643
- def names; end
2644
-
2645
- private
2646
-
2647
- # Join multiple values with a comma.
2648
- #
2649
- # source://faraday//lib/faraday/utils/headers.rb#134
2650
- def add_parsed(key, value); end
2651
-
2652
- # on dup/clone, we need to duplicate @names hash
2653
- #
2654
- # source://faraday//lib/faraday/utils/headers.rb#31
2655
- def initialize_copy(other); end
2656
-
2657
- class << self
2658
- # source://faraday//lib/faraday/utils/headers.rb#14
2659
- def allocate; end
2660
-
2661
- # source://faraday//lib/faraday/utils/headers.rb#10
2662
- def from(value); end
2663
- end
2664
- end
2665
-
2666
- # symbol -> string mapper + cache
2667
- #
2668
- # source://faraday//lib/faraday/utils/headers.rb#40
2669
- Faraday::Utils::Headers::KeyMap = T.let(T.unsafe(nil), Hash)
2670
-
2671
- # A hash with stringified keys.
2672
- #
2673
- # source://faraday//lib/faraday/utils/params_hash.rb#6
2674
- class Faraday::Utils::ParamsHash < ::Hash
2675
- # source://faraday//lib/faraday/utils/params_hash.rb#7
2676
- def [](key); end
2677
-
2678
- # source://faraday//lib/faraday/utils/params_hash.rb#11
2679
- def []=(key, value); end
2680
-
2681
- # source://faraday//lib/faraday/utils/params_hash.rb#15
2682
- def delete(key); end
2683
-
2684
- # @return [Boolean]
2685
- #
2686
- # source://faraday//lib/faraday/utils/params_hash.rb#19
2687
- def has_key?(key); end
2688
-
2689
- # @return [Boolean]
2690
- #
2691
- # source://faraday//lib/faraday/utils/params_hash.rb#19
2692
- def include?(key); end
2693
-
2694
- # @return [Boolean]
2695
- #
2696
- # source://faraday//lib/faraday/utils/params_hash.rb#19
2697
- def key?(key); end
2698
-
2699
- # @return [Boolean]
2700
- #
2701
- # source://faraday//lib/faraday/utils/params_hash.rb#19
2702
- def member?(key); end
2703
-
2704
- # source://faraday//lib/faraday/utils/params_hash.rb#35
2705
- def merge(params); end
2706
-
2707
- # source://faraday//lib/faraday/utils/params_hash.rb#27
2708
- def merge!(params); end
2709
-
2710
- # source://faraday//lib/faraday/utils/params_hash.rb#44
2711
- def merge_query(query, encoder = T.unsafe(nil)); end
2712
-
2713
- # source://faraday//lib/faraday/utils/params_hash.rb#39
2714
- def replace(other); end
2715
-
2716
- # source://faraday//lib/faraday/utils/params_hash.rb#50
2717
- def to_query(encoder = T.unsafe(nil)); end
2718
-
2719
- # source://faraday//lib/faraday/utils/params_hash.rb#27
2720
- def update(params); end
2721
-
2722
- private
2723
-
2724
- # source://faraday//lib/faraday/utils/params_hash.rb#56
2725
- def convert_key(key); end
2726
- end
2727
-
2728
- # source://faraday//lib/faraday/version.rb#4
2729
- Faraday::VERSION = T.let(T.unsafe(nil), String)