checkoff 0.223.0 → 0.225.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/checkoff.gemspec +10 -5
- data/lib/checkoff/cli.rb +1 -1
- data/lib/checkoff/clients.rb +1 -1
- data/lib/checkoff/custom_fields.rb +1 -1
- data/lib/checkoff/events.rb +1 -1
- data/lib/checkoff/internal/config_loader.rb +2 -3
- data/lib/checkoff/internal/selector_classes/section/function_evaluator.rb +3 -2
- data/lib/checkoff/my_tasks.rb +1 -1
- data/lib/checkoff/portfolios.rb +11 -9
- data/lib/checkoff/projects.rb +1 -1
- data/lib/checkoff/sections.rb +3 -4
- data/lib/checkoff/tags.rb +66 -17
- data/lib/checkoff/tasks.rb +1 -1
- data/lib/checkoff/version.rb +1 -1
- data/lib/checkoff/workspaces.rb +1 -1
- data/rbi/checkoff.rbi +4529 -0
- data/sig/checkoff.rbs +3749 -0
- metadata +4 -210
- data/.circleci/config.yml +0 -291
- data/.envrc +0 -9
- data/.git-hooks/pre_commit/circle_ci.rb +0 -26
- data/.git-hooks/pre_commit/punchlist.rb +0 -52
- data/.git-hooks/pre_commit/solargraph_typecheck.rb +0 -77
- data/.gitattributes +0 -6
- data/.gitignore +0 -65
- data/.markdownlint_style.rb +0 -4
- data/.mdlrc +0 -1
- data/.overcommit.yml +0 -115
- data/.rubocop.yml +0 -143
- data/.rubocop_todo.yml +0 -90
- data/.solargraph.yml +0 -35
- data/.yamllint.yml +0 -8
- data/.yardopts +0 -2
- data/CODE_OF_CONDUCT.md +0 -133
- data/CONTRIBUTING.rst +0 -75
- data/DEVELOPMENT.md +0 -69
- data/GLOSSARY.md +0 -16
- data/Gemfile +0 -67
- data/Gemfile.lock +0 -351
- data/LICENSE +0 -21
- data/Makefile +0 -139
- data/bin/brakeman +0 -27
- data/bin/bump +0 -29
- data/bin/checkoff +0 -29
- data/bin/console +0 -15
- data/bin/overcommit +0 -29
- data/bin/overcommit_branch +0 -114
- data/bin/rake +0 -29
- data/bin/rubocop +0 -27
- data/bin/setup +0 -8
- data/bin/solargraph +0 -27
- data/bin/sord +0 -27
- data/bin/spoom +0 -27
- data/bin/srb +0 -27
- data/bin/srb-rbi +0 -27
- data/bin/tapioca +0 -27
- data/bin/yard +0 -27
- data/config/annotations_asana.rb +0 -253
- data/config/annotations_misc.rb +0 -68
- data/config/env.1p +0 -2
- data/docs/.gitignore +0 -3
- data/docs/cookiecutter_input.json +0 -17
- data/docs/example_project.png +0 -0
- data/fix.sh +0 -534
- data/metrics/bigfiles_high_water_mark +0 -1
- data/metrics/brakeman_high_water_mark +0 -1
- data/metrics/bundle-audit_high_water_mark +0 -1
- data/metrics/cane_high_water_mark +0 -1
- data/metrics/eslint_high_water_mark +0 -1
- data/metrics/flake8_high_water_mark +0 -1
- data/metrics/flay_high_water_mark +0 -1
- data/metrics/flog_high_water_mark +0 -1
- data/metrics/jscs_high_water_mark +0 -1
- data/metrics/mdl_high_water_mark +0 -1
- data/metrics/pep8_high_water_mark +0 -1
- data/metrics/punchlist_high_water_mark +0 -1
- data/metrics/pycodestyle_high_water_mark +0 -1
- data/metrics/rails_best_practices_high_water_mark +0 -1
- data/metrics/rubocop_high_water_mark +0 -1
- data/metrics/scalastyle_high_water_mark +0 -1
- data/metrics/shellcheck_high_water_mark +0 -1
- data/package.json +0 -9
- data/rakelib/citest.rake +0 -4
- data/rakelib/clear_metrics.rake +0 -9
- data/rakelib/console.rake +0 -15
- data/rakelib/default.rake +0 -4
- data/rakelib/doc.rake +0 -6
- data/rakelib/gem_tasks.rake +0 -3
- data/rakelib/localtest.rake +0 -4
- data/rakelib/overcommit.rake +0 -6
- data/rakelib/quality.rake +0 -4
- data/rakelib/repl.rake +0 -4
- data/rakelib/test.rake +0 -10
- data/rakelib/trigger_next_builds.rake +0 -7
- data/rakelib/undercover.rake +0 -8
- data/requirements_dev.txt +0 -2
- data/sorbet/config +0 -4
- data/sorbet/rbi/annotations/.gitattributes +0 -1
- data/sorbet/rbi/annotations/activesupport.rbi +0 -453
- data/sorbet/rbi/annotations/faraday.rbi +0 -17
- data/sorbet/rbi/annotations/minitest.rbi +0 -119
- data/sorbet/rbi/annotations/mocha.rbi +0 -34
- data/sorbet/rbi/annotations/rainbow.rbi +0 -269
- data/sorbet/rbi/annotations/webmock.rbi +0 -9
- data/sorbet/rbi/dsl/.gitattributes +0 -1
- data/sorbet/rbi/dsl/active_support/callbacks.rbi +0 -23
- data/sorbet/rbi/gems/.gitattributes +0 -1
- data/sorbet/rbi/gems/activesupport@7.1.5.rbi +0 -18746
- data/sorbet/rbi/gems/addressable@2.8.6.rbi +0 -1994
- data/sorbet/rbi/gems/ansi@1.5.0.rbi +0 -688
- data/sorbet/rbi/gems/asana@0.10.6-ab9393136d9ca59b75e42a661fdddc1c65c8f7c3.rbi +0 -6142
- data/sorbet/rbi/gems/ast@2.4.2.rbi +0 -585
- data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -523
- data/sorbet/rbi/gems/base64@0.2.0.rbi +0 -509
- data/sorbet/rbi/gems/benchmark@0.4.0.rbi +0 -618
- data/sorbet/rbi/gems/bigdecimal@3.1.5.rbi +0 -78
- data/sorbet/rbi/gems/brakeman@6.2.2.rbi +0 -222
- data/sorbet/rbi/gems/builder@3.2.4.rbi +0 -505
- data/sorbet/rbi/gems/bump@0.10.0.rbi +0 -169
- data/sorbet/rbi/gems/cache@0.4.1.rbi +0 -211
- data/sorbet/rbi/gems/cache_method@0.2.7.rbi +0 -293
- data/sorbet/rbi/gems/chef-utils@18.3.0.rbi +0 -9
- data/sorbet/rbi/gems/childprocess@5.1.0.rbi +0 -383
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +0 -3427
- data/sorbet/rbi/gems/commander@4.6.0.rbi +0 -9
- data/sorbet/rbi/gems/concurrent-ruby@1.2.3.rbi +0 -11591
- data/sorbet/rbi/gems/connection_pool@2.4.1.rbi +0 -9
- data/sorbet/rbi/gems/crack@0.4.5.rbi +0 -145
- data/sorbet/rbi/gems/diff-lcs@1.5.1.rbi +0 -969
- data/sorbet/rbi/gems/docile@1.4.0.rbi +0 -377
- data/sorbet/rbi/gems/drb@2.2.1.rbi +0 -1347
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -9
- data/sorbet/rbi/gems/erubi@1.13.0.rbi +0 -152
- data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +0 -222
- data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +0 -126
- data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +0 -136
- data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +0 -145
- data/sorbet/rbi/gems/faraday-multipart@1.0.4.rbi +0 -259
- data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +0 -142
- data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +0 -118
- data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +0 -125
- data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +0 -133
- data/sorbet/rbi/gems/faraday-retry@1.0.3.rbi +0 -198
- data/sorbet/rbi/gems/faraday@1.10.3.rbi +0 -2729
- data/sorbet/rbi/gems/faraday_middleware-multi_json@0.0.6.rbi +0 -29
- data/sorbet/rbi/gems/faraday_middleware@1.2.0.rbi +0 -1004
- data/sorbet/rbi/gems/gli@2.22.0.rbi +0 -9
- data/sorbet/rbi/gems/hashdiff@1.0.1.rbi +0 -351
- data/sorbet/rbi/gems/highline@2.0.3.rbi +0 -9
- data/sorbet/rbi/gems/i18n@1.14.6.rbi +0 -2359
- data/sorbet/rbi/gems/imagen@0.1.8.rbi +0 -340
- data/sorbet/rbi/gems/iniparse@1.5.0.rbi +0 -899
- data/sorbet/rbi/gems/jaro_winkler@1.6.0.rbi +0 -22
- data/sorbet/rbi/gems/json@2.7.1.rbi +0 -1562
- data/sorbet/rbi/gems/jwt@2.7.1.rbi +0 -1405
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -128
- data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3272
- data/sorbet/rbi/gems/language_server-protocol@3.17.0.3.rbi +0 -14238
- data/sorbet/rbi/gems/logger@1.6.2.rbi +0 -923
- data/sorbet/rbi/gems/mdl@0.13.0.rbi +0 -445
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +0 -273
- data/sorbet/rbi/gems/mime-types-data@3.2023.1205.rbi +0 -127
- data/sorbet/rbi/gems/mime-types@3.5.1.rbi +0 -1252
- data/sorbet/rbi/gems/minitest-profile@0.0.2.rbi +0 -136
- data/sorbet/rbi/gems/minitest-reporters@1.6.1.rbi +0 -1014
- data/sorbet/rbi/gems/minitest@5.21.1.rbi +0 -1539
- data/sorbet/rbi/gems/mixlib-cli@2.1.8.rbi +0 -314
- data/sorbet/rbi/gems/mixlib-config@3.0.27.rbi +0 -581
- data/sorbet/rbi/gems/mixlib-shellout@3.2.7.rbi +0 -629
- data/sorbet/rbi/gems/mocha@2.1.0.rbi +0 -12
- data/sorbet/rbi/gems/multi_json@1.15.0.rbi +0 -268
- data/sorbet/rbi/gems/multi_xml@0.6.0.rbi +0 -102
- data/sorbet/rbi/gems/multipart-post@2.3.0.rbi +0 -234
- data/sorbet/rbi/gems/mutex_m@0.3.0.rbi +0 -97
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +0 -159
- data/sorbet/rbi/gems/nokogiri@1.17.0.rbi +0 -8201
- data/sorbet/rbi/gems/oauth2@1.4.11.rbi +0 -833
- data/sorbet/rbi/gems/overcommit@0.64.1.rbi +0 -2400
- data/sorbet/rbi/gems/parallel@1.23.0.rbi +0 -274
- data/sorbet/rbi/gems/parlour@5.0.0.rbi +0 -3007
- data/sorbet/rbi/gems/parser@3.2.2.4.rbi +0 -7253
- data/sorbet/rbi/gems/prism@1.2.0.rbi +0 -39085
- data/sorbet/rbi/gems/pry@0.14.2.rbi +0 -10070
- data/sorbet/rbi/gems/public_suffix@5.0.4.rbi +0 -936
- data/sorbet/rbi/gems/punchlist@1.3.2.rbi +0 -173
- data/sorbet/rbi/gems/racc@1.8.1.rbi +0 -162
- data/sorbet/rbi/gems/rack@3.1.8.rbi +0 -4896
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +0 -403
- data/sorbet/rbi/gems/rake@13.1.0.rbi +0 -3022
- data/sorbet/rbi/gems/rbi@0.2.1.rbi +0 -4535
- data/sorbet/rbi/gems/rbs@2.8.4.rbi +0 -5613
- data/sorbet/rbi/gems/regexp_parser@2.8.3.rbi +0 -3750
- data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -390
- data/sorbet/rbi/gems/rexml@3.3.9.rbi +0 -4964
- data/sorbet/rbi/gems/rubocop-ast@1.30.0.rbi +0 -7127
- data/sorbet/rbi/gems/rubocop-minitest@0.34.5.rbi +0 -2577
- data/sorbet/rbi/gems/rubocop-performance@1.20.2.rbi +0 -3262
- data/sorbet/rbi/gems/rubocop-rake@0.6.0.rbi +0 -329
- data/sorbet/rbi/gems/rubocop-rspec@3.0.0.rbi +0 -7546
- data/sorbet/rbi/gems/rubocop@1.59.0.rbi +0 -57238
- data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +0 -1318
- data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +0 -9
- data/sorbet/rbi/gems/rugged@1.6.3.rbi +0 -1577
- data/sorbet/rbi/gems/securerandom@0.4.0.rbi +0 -75
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -217
- data/sorbet/rbi/gems/simplecov-lcov@0.8.0.rbi +0 -256
- data/sorbet/rbi/gems/simplecov@0.22.0.rbi +0 -2149
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.4.rbi +0 -9
- data/sorbet/rbi/gems/solargraph-rails@1.1.0-9dc37915bd4f3b169046e34db6fb32193ab347d8.rbi +0 -320
- data/sorbet/rbi/gems/solargraph@0.50.1-904b9304770a59fac393c5cc3cad481e5bdf0fd8.rbi +0 -9396
- data/sorbet/rbi/gems/sord@5.1.0.rbi +0 -820
- data/sorbet/rbi/gems/source_finder@3.2.1.rbi +0 -317
- data/sorbet/rbi/gems/spoom@1.5.0.rbi +0 -4932
- data/sorbet/rbi/gems/tapioca@0.16.5.rbi +0 -3617
- data/sorbet/rbi/gems/thor@1.3.2.rbi +0 -4378
- data/sorbet/rbi/gems/tilt@2.4.0.rbi +0 -933
- data/sorbet/rbi/gems/tomlrb@2.0.3.rbi +0 -9
- data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +0 -5918
- data/sorbet/rbi/gems/undercover@0.5.0.rbi +0 -433
- data/sorbet/rbi/gems/unicode-display_width@2.5.0.rbi +0 -66
- data/sorbet/rbi/gems/webmock@3.19.1.rbi +0 -1769
- data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +0 -435
- data/sorbet/rbi/gems/yard@0.9.37.rbi +0 -18406
- data/sorbet/rbi/todo.rbi +0 -11
- data/sorbet/tapioca/config.yml +0 -13
- data/sorbet/tapioca/require.rb +0 -4
@@ -1,833 +0,0 @@
|
|
1
|
-
# typed: true
|
2
|
-
|
3
|
-
# DO NOT EDIT MANUALLY
|
4
|
-
# This is an autogenerated file for types exported from the `oauth2` gem.
|
5
|
-
# Please instead update this file by running `bin/tapioca gem oauth2`.
|
6
|
-
|
7
|
-
|
8
|
-
# source://oauth2//lib/oauth2/error.rb#3
|
9
|
-
module OAuth2; end
|
10
|
-
|
11
|
-
# source://oauth2//lib/oauth2/access_token.rb#4
|
12
|
-
class OAuth2::AccessToken
|
13
|
-
# Initalize an AccessToken
|
14
|
-
#
|
15
|
-
# @option opts
|
16
|
-
# @option opts
|
17
|
-
# @option opts
|
18
|
-
# @option opts
|
19
|
-
# @option opts
|
20
|
-
# @option opts
|
21
|
-
# @param client [Client] the OAuth2::Client instance
|
22
|
-
# @param token [String] the Access Token value
|
23
|
-
# @param opts [Hash] the options to create the Access Token with
|
24
|
-
# @return [AccessToken] a new instance of AccessToken
|
25
|
-
#
|
26
|
-
# source://oauth2//lib/oauth2/access_token.rb#43
|
27
|
-
def initialize(client, token, opts = T.unsafe(nil)); end
|
28
|
-
|
29
|
-
# Indexer to additional params present in token response
|
30
|
-
#
|
31
|
-
# @param key [String] entry key to Hash
|
32
|
-
#
|
33
|
-
# source://oauth2//lib/oauth2/access_token.rb#63
|
34
|
-
def [](key); end
|
35
|
-
|
36
|
-
# Returns the value of attribute client.
|
37
|
-
#
|
38
|
-
# source://oauth2//lib/oauth2/access_token.rb#5
|
39
|
-
def client; end
|
40
|
-
|
41
|
-
# Make a DELETE request with the Access Token
|
42
|
-
#
|
43
|
-
# @see AccessToken#request
|
44
|
-
#
|
45
|
-
# source://oauth2//lib/oauth2/access_token.rb#145
|
46
|
-
def delete(path, opts = T.unsafe(nil), &block); end
|
47
|
-
|
48
|
-
# Whether or not the token is expired
|
49
|
-
#
|
50
|
-
# @return [Boolean]
|
51
|
-
#
|
52
|
-
# source://oauth2//lib/oauth2/access_token.rb#77
|
53
|
-
def expired?; end
|
54
|
-
|
55
|
-
# Whether or not the token expires
|
56
|
-
#
|
57
|
-
# @return [Boolean]
|
58
|
-
#
|
59
|
-
# source://oauth2//lib/oauth2/access_token.rb#70
|
60
|
-
def expires?; end
|
61
|
-
|
62
|
-
# Returns the value of attribute expires_at.
|
63
|
-
#
|
64
|
-
# source://oauth2//lib/oauth2/access_token.rb#5
|
65
|
-
def expires_at; end
|
66
|
-
|
67
|
-
# Returns the value of attribute expires_in.
|
68
|
-
#
|
69
|
-
# source://oauth2//lib/oauth2/access_token.rb#5
|
70
|
-
def expires_in; end
|
71
|
-
|
72
|
-
# Make a GET request with the Access Token
|
73
|
-
#
|
74
|
-
# @see AccessToken#request
|
75
|
-
#
|
76
|
-
# source://oauth2//lib/oauth2/access_token.rb#117
|
77
|
-
def get(path, opts = T.unsafe(nil), &block); end
|
78
|
-
|
79
|
-
# Get the headers hash (includes Authorization token)
|
80
|
-
#
|
81
|
-
# source://oauth2//lib/oauth2/access_token.rb#150
|
82
|
-
def headers; end
|
83
|
-
|
84
|
-
# Returns the value of attribute options.
|
85
|
-
#
|
86
|
-
# source://oauth2//lib/oauth2/access_token.rb#6
|
87
|
-
def options; end
|
88
|
-
|
89
|
-
# Sets the attribute options
|
90
|
-
#
|
91
|
-
# @param value the value to set the attribute options to.
|
92
|
-
#
|
93
|
-
# source://oauth2//lib/oauth2/access_token.rb#6
|
94
|
-
def options=(_arg0); end
|
95
|
-
|
96
|
-
# Returns the value of attribute params.
|
97
|
-
#
|
98
|
-
# source://oauth2//lib/oauth2/access_token.rb#5
|
99
|
-
def params; end
|
100
|
-
|
101
|
-
# Make a PATCH request with the Access Token
|
102
|
-
#
|
103
|
-
# @see AccessToken#request
|
104
|
-
#
|
105
|
-
# source://oauth2//lib/oauth2/access_token.rb#138
|
106
|
-
def patch(path, opts = T.unsafe(nil), &block); end
|
107
|
-
|
108
|
-
# Make a POST request with the Access Token
|
109
|
-
#
|
110
|
-
# @see AccessToken#request
|
111
|
-
#
|
112
|
-
# source://oauth2//lib/oauth2/access_token.rb#124
|
113
|
-
def post(path, opts = T.unsafe(nil), &block); end
|
114
|
-
|
115
|
-
# Make a PUT request with the Access Token
|
116
|
-
#
|
117
|
-
# @see AccessToken#request
|
118
|
-
#
|
119
|
-
# source://oauth2//lib/oauth2/access_token.rb#131
|
120
|
-
def put(path, opts = T.unsafe(nil), &block); end
|
121
|
-
|
122
|
-
# Refreshes the current Access Token
|
123
|
-
#
|
124
|
-
# @note options should be carried over to the new AccessToken
|
125
|
-
# @return [AccessToken] a new AccessToken
|
126
|
-
#
|
127
|
-
# source://oauth2//lib/oauth2/access_token.rb#85
|
128
|
-
def refresh!(params = T.unsafe(nil)); end
|
129
|
-
|
130
|
-
# Returns the value of attribute refresh_token.
|
131
|
-
#
|
132
|
-
# source://oauth2//lib/oauth2/access_token.rb#6
|
133
|
-
def refresh_token; end
|
134
|
-
|
135
|
-
# Sets the attribute refresh_token
|
136
|
-
#
|
137
|
-
# @param value the value to set the attribute refresh_token to.
|
138
|
-
#
|
139
|
-
# source://oauth2//lib/oauth2/access_token.rb#6
|
140
|
-
def refresh_token=(_arg0); end
|
141
|
-
|
142
|
-
# Make a request with the Access Token
|
143
|
-
#
|
144
|
-
# @param verb [Symbol] the HTTP request method
|
145
|
-
# @param path [String] the HTTP URL path of the request
|
146
|
-
# @param opts [Hash] the options to make the request with
|
147
|
-
# @see Client#request
|
148
|
-
#
|
149
|
-
# source://oauth2//lib/oauth2/access_token.rb#109
|
150
|
-
def request(verb, path, opts = T.unsafe(nil), &block); end
|
151
|
-
|
152
|
-
# Convert AccessToken to a hash which can be used to rebuild itself with AccessToken.from_hash
|
153
|
-
#
|
154
|
-
# @return [Hash] a hash of AccessToken property values
|
155
|
-
#
|
156
|
-
# source://oauth2//lib/oauth2/access_token.rb#99
|
157
|
-
def to_hash; end
|
158
|
-
|
159
|
-
# Returns the value of attribute token.
|
160
|
-
#
|
161
|
-
# source://oauth2//lib/oauth2/access_token.rb#5
|
162
|
-
def token; end
|
163
|
-
|
164
|
-
private
|
165
|
-
|
166
|
-
# source://oauth2//lib/oauth2/access_token.rb#156
|
167
|
-
def configure_authentication!(opts); end
|
168
|
-
|
169
|
-
# source://oauth2//lib/oauth2/access_token.rb#177
|
170
|
-
def convert_expires_at(expires_at); end
|
171
|
-
|
172
|
-
class << self
|
173
|
-
# Initializes an AccessToken from a Hash
|
174
|
-
#
|
175
|
-
# @param the [Client] OAuth2::Client instance
|
176
|
-
# @param a [Hash] hash of AccessToken property values
|
177
|
-
# @return [AccessToken] the initalized AccessToken
|
178
|
-
#
|
179
|
-
# source://oauth2//lib/oauth2/access_token.rb#15
|
180
|
-
def from_hash(client, hash); end
|
181
|
-
|
182
|
-
# Initializes an AccessToken from a key/value application/x-www-form-urlencoded string
|
183
|
-
#
|
184
|
-
# @param client [Client] the OAuth2::Client instance
|
185
|
-
# @param kvform [String] the application/x-www-form-urlencoded string
|
186
|
-
# @return [AccessToken] the initalized AccessToken
|
187
|
-
#
|
188
|
-
# source://oauth2//lib/oauth2/access_token.rb#25
|
189
|
-
def from_kvform(client, kvform); end
|
190
|
-
end
|
191
|
-
end
|
192
|
-
|
193
|
-
# source://oauth2//lib/oauth2/authenticator.rb#6
|
194
|
-
class OAuth2::Authenticator
|
195
|
-
# @return [Authenticator] a new instance of Authenticator
|
196
|
-
#
|
197
|
-
# source://oauth2//lib/oauth2/authenticator.rb#9
|
198
|
-
def initialize(id, secret, mode); end
|
199
|
-
|
200
|
-
# Apply the request credentials used to authenticate to the Authorization Server
|
201
|
-
#
|
202
|
-
# Depending on configuration, this might be as request params or as an
|
203
|
-
# Authorization header.
|
204
|
-
#
|
205
|
-
# User-provided params and header take precedence.
|
206
|
-
#
|
207
|
-
# @param params [Hash] a Hash of params for the token endpoint
|
208
|
-
# @return [Hash] params amended with appropriate authentication details
|
209
|
-
#
|
210
|
-
# source://oauth2//lib/oauth2/authenticator.rb#24
|
211
|
-
def apply(params); end
|
212
|
-
|
213
|
-
# Returns the value of attribute id.
|
214
|
-
#
|
215
|
-
# source://oauth2//lib/oauth2/authenticator.rb#7
|
216
|
-
def id; end
|
217
|
-
|
218
|
-
# Returns the value of attribute mode.
|
219
|
-
#
|
220
|
-
# source://oauth2//lib/oauth2/authenticator.rb#7
|
221
|
-
def mode; end
|
222
|
-
|
223
|
-
# Returns the value of attribute secret.
|
224
|
-
#
|
225
|
-
# source://oauth2//lib/oauth2/authenticator.rb#7
|
226
|
-
def secret; end
|
227
|
-
|
228
|
-
private
|
229
|
-
|
230
|
-
# Adds an `Authorization` header with Basic Auth credentials if and only if
|
231
|
-
# it is not already set in the params.
|
232
|
-
#
|
233
|
-
# source://oauth2//lib/oauth2/authenticator.rb#59
|
234
|
-
def apply_basic_auth(params); end
|
235
|
-
|
236
|
-
# When using schemes that don't require the client_secret to be passed i.e TLS Client Auth,
|
237
|
-
# we don't want to send the secret
|
238
|
-
#
|
239
|
-
# source://oauth2//lib/oauth2/authenticator.rb#53
|
240
|
-
def apply_client_id(params); end
|
241
|
-
|
242
|
-
# Adds client_id and client_secret request parameters if they are not
|
243
|
-
# already set.
|
244
|
-
#
|
245
|
-
# source://oauth2//lib/oauth2/authenticator.rb#47
|
246
|
-
def apply_params_auth(params); end
|
247
|
-
|
248
|
-
# @see https://datatracker.ietf.org/doc/html/rfc2617#section-2
|
249
|
-
#
|
250
|
-
# source://oauth2//lib/oauth2/authenticator.rb#66
|
251
|
-
def basic_auth_header; end
|
252
|
-
|
253
|
-
class << self
|
254
|
-
# source://oauth2//lib/oauth2/authenticator.rb#39
|
255
|
-
def encode_basic_auth(user, password); end
|
256
|
-
end
|
257
|
-
end
|
258
|
-
|
259
|
-
# The OAuth2::Client class
|
260
|
-
#
|
261
|
-
# source://oauth2//lib/oauth2/client.rb#9
|
262
|
-
class OAuth2::Client
|
263
|
-
# Instantiate a new OAuth 2.0 client using the
|
264
|
-
# Client ID and Client Secret registered to your
|
265
|
-
# application.
|
266
|
-
#
|
267
|
-
# @option options
|
268
|
-
# @option options
|
269
|
-
# @option options
|
270
|
-
# @option options
|
271
|
-
# @option options
|
272
|
-
# @option options
|
273
|
-
# @option options
|
274
|
-
# @option options
|
275
|
-
# @option options
|
276
|
-
# @option options
|
277
|
-
# @option options
|
278
|
-
# @param client_id [String] the client_id value
|
279
|
-
# @param client_secret [String] the client_secret value
|
280
|
-
# @param options [Hash] the options to create the client with
|
281
|
-
# @return [Client] a new instance of Client
|
282
|
-
# @yield [builder] The Faraday connection builder
|
283
|
-
#
|
284
|
-
# source://oauth2//lib/oauth2/client.rb#35
|
285
|
-
def initialize(client_id, client_secret, options = T.unsafe(nil), &block); end
|
286
|
-
|
287
|
-
# source://oauth2//lib/oauth2/client.rb#228
|
288
|
-
def assertion; end
|
289
|
-
|
290
|
-
# The Authorization Code strategy
|
291
|
-
#
|
292
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.1
|
293
|
-
#
|
294
|
-
# source://oauth2//lib/oauth2/client.rb#203
|
295
|
-
def auth_code; end
|
296
|
-
|
297
|
-
# The authorize endpoint URL of the OAuth2 provider
|
298
|
-
#
|
299
|
-
# @param params [Hash] additional query parameters
|
300
|
-
#
|
301
|
-
# source://oauth2//lib/oauth2/client.rb#79
|
302
|
-
def authorize_url(params = T.unsafe(nil)); end
|
303
|
-
|
304
|
-
# The Client Credentials strategy
|
305
|
-
#
|
306
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.4
|
307
|
-
#
|
308
|
-
# source://oauth2//lib/oauth2/client.rb#224
|
309
|
-
def client_credentials; end
|
310
|
-
|
311
|
-
# The Faraday connection object
|
312
|
-
#
|
313
|
-
# source://oauth2//lib/oauth2/client.rb#63
|
314
|
-
def connection; end
|
315
|
-
|
316
|
-
# Sets the attribute connection
|
317
|
-
#
|
318
|
-
# @param value the value to set the attribute connection to.
|
319
|
-
#
|
320
|
-
# source://oauth2//lib/oauth2/client.rb#14
|
321
|
-
def connection=(_arg0); end
|
322
|
-
|
323
|
-
# Initializes an AccessToken by making a request to the token endpoint
|
324
|
-
#
|
325
|
-
# @param params [Hash] a Hash of params for the token endpoint
|
326
|
-
# @param access_token_opts [Hash] access token options, to pass to the AccessToken object
|
327
|
-
# @param access_token_class [Class] class of access token for easier subclassing OAuth2::AccessToken
|
328
|
-
# @return [AccessToken] the initialized AccessToken
|
329
|
-
#
|
330
|
-
# source://oauth2//lib/oauth2/client.rb#155
|
331
|
-
def get_token(params, access_token_opts = T.unsafe(nil), extract_access_token = T.unsafe(nil)); end
|
332
|
-
|
333
|
-
# Returns the value of attribute id.
|
334
|
-
#
|
335
|
-
# source://oauth2//lib/oauth2/client.rb#12
|
336
|
-
def id; end
|
337
|
-
|
338
|
-
# The Implicit strategy
|
339
|
-
#
|
340
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-26#section-4.2
|
341
|
-
#
|
342
|
-
# source://oauth2//lib/oauth2/client.rb#210
|
343
|
-
def implicit; end
|
344
|
-
|
345
|
-
# Returns the value of attribute options.
|
346
|
-
#
|
347
|
-
# source://oauth2//lib/oauth2/client.rb#13
|
348
|
-
def options; end
|
349
|
-
|
350
|
-
# Sets the attribute options
|
351
|
-
#
|
352
|
-
# @param value the value to set the attribute options to.
|
353
|
-
#
|
354
|
-
# source://oauth2//lib/oauth2/client.rb#13
|
355
|
-
def options=(_arg0); end
|
356
|
-
|
357
|
-
# The Resource Owner Password Credentials strategy
|
358
|
-
#
|
359
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.3
|
360
|
-
#
|
361
|
-
# source://oauth2//lib/oauth2/client.rb#217
|
362
|
-
def password; end
|
363
|
-
|
364
|
-
# The redirect_uri parameters, if configured
|
365
|
-
#
|
366
|
-
# The redirect_uri query parameter is OPTIONAL (though encouraged) when
|
367
|
-
# requesting authorization. If it is provided at authorization time it MUST
|
368
|
-
# also be provided with the token exchange request.
|
369
|
-
#
|
370
|
-
# Providing the :redirect_uri to the OAuth2::Client instantiation will take
|
371
|
-
# care of managing this.
|
372
|
-
#
|
373
|
-
# @api semipublic
|
374
|
-
# @return [Hash] the params to add to a request or URL
|
375
|
-
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1
|
376
|
-
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.3
|
377
|
-
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-4.2.1
|
378
|
-
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-10.6
|
379
|
-
#
|
380
|
-
# source://oauth2//lib/oauth2/client.rb#248
|
381
|
-
def redirection_params; end
|
382
|
-
|
383
|
-
# Makes a request relative to the specified site root.
|
384
|
-
#
|
385
|
-
# @option opts
|
386
|
-
# @option opts
|
387
|
-
# @option opts
|
388
|
-
# @option opts
|
389
|
-
# @option opts
|
390
|
-
# @param verb [Symbol] one of :get, :post, :put, :delete
|
391
|
-
# @param url [String] URL path of request
|
392
|
-
# @param opts [Hash] the options to make the request with
|
393
|
-
# @yield [req] The Faraday request
|
394
|
-
#
|
395
|
-
# source://oauth2//lib/oauth2/client.rb#103
|
396
|
-
def request(verb, url, opts = T.unsafe(nil)); end
|
397
|
-
|
398
|
-
# Returns the value of attribute secret.
|
399
|
-
#
|
400
|
-
# source://oauth2//lib/oauth2/client.rb#12
|
401
|
-
def secret; end
|
402
|
-
|
403
|
-
# Returns the value of attribute site.
|
404
|
-
#
|
405
|
-
# source://oauth2//lib/oauth2/client.rb#12
|
406
|
-
def site; end
|
407
|
-
|
408
|
-
# Set the site host
|
409
|
-
#
|
410
|
-
# @param value [String] the OAuth2 provider site host
|
411
|
-
#
|
412
|
-
# source://oauth2//lib/oauth2/client.rb#57
|
413
|
-
def site=(value); end
|
414
|
-
|
415
|
-
# The token endpoint URL of the OAuth2 provider
|
416
|
-
#
|
417
|
-
# @param params [Hash] additional query parameters
|
418
|
-
#
|
419
|
-
# source://oauth2//lib/oauth2/client.rb#87
|
420
|
-
def token_url(params = T.unsafe(nil)); end
|
421
|
-
|
422
|
-
private
|
423
|
-
|
424
|
-
# Returns the authenticator object
|
425
|
-
#
|
426
|
-
# @return [Authenticator] the initialized Authenticator
|
427
|
-
#
|
428
|
-
# source://oauth2//lib/oauth2/client.rb#266
|
429
|
-
def authenticator; end
|
430
|
-
|
431
|
-
# Builds the access token from the response of the HTTP call
|
432
|
-
#
|
433
|
-
# @return [AccessToken] the initialized AccessToken
|
434
|
-
#
|
435
|
-
# source://oauth2//lib/oauth2/client.rb#273
|
436
|
-
def build_access_token(response, access_token_opts, extract_access_token); end
|
437
|
-
|
438
|
-
# source://oauth2//lib/oauth2/client.rb#288
|
439
|
-
def oauth_debug_logging(builder); end
|
440
|
-
end
|
441
|
-
|
442
|
-
# source://oauth2//lib/oauth2/client.rb#256
|
443
|
-
OAuth2::Client::DEFAULT_EXTRACT_ACCESS_TOKEN = T.let(T.unsafe(nil), Proc)
|
444
|
-
|
445
|
-
# source://oauth2//lib/oauth2/client.rb#10
|
446
|
-
OAuth2::Client::RESERVED_PARAM_KEYS = T.let(T.unsafe(nil), Array)
|
447
|
-
|
448
|
-
# source://oauth2//lib/oauth2/client.rb#7
|
449
|
-
class OAuth2::ConnectionError < ::Faraday::ConnectionFailed; end
|
450
|
-
|
451
|
-
# source://oauth2//lib/oauth2/error.rb#4
|
452
|
-
class OAuth2::Error < ::StandardError
|
453
|
-
# standard error values include:
|
454
|
-
# :invalid_request, :invalid_client, :invalid_token, :invalid_grant, :unsupported_grant_type, :invalid_scope
|
455
|
-
#
|
456
|
-
# @return [Error] a new instance of Error
|
457
|
-
#
|
458
|
-
# source://oauth2//lib/oauth2/error.rb#9
|
459
|
-
def initialize(response); end
|
460
|
-
|
461
|
-
# Returns the value of attribute code.
|
462
|
-
#
|
463
|
-
# source://oauth2//lib/oauth2/error.rb#5
|
464
|
-
def code; end
|
465
|
-
|
466
|
-
# Returns the value of attribute description.
|
467
|
-
#
|
468
|
-
# source://oauth2//lib/oauth2/error.rb#5
|
469
|
-
def description; end
|
470
|
-
|
471
|
-
# Makes a error message
|
472
|
-
#
|
473
|
-
# @param response_body [String] response body of request
|
474
|
-
# @param opts [String] :error_description error description to show first line
|
475
|
-
#
|
476
|
-
# source://oauth2//lib/oauth2/error.rb#25
|
477
|
-
def error_message(response_body, opts = T.unsafe(nil)); end
|
478
|
-
|
479
|
-
# Returns the value of attribute response.
|
480
|
-
#
|
481
|
-
# source://oauth2//lib/oauth2/error.rb#5
|
482
|
-
def response; end
|
483
|
-
end
|
484
|
-
|
485
|
-
# source://oauth2//lib/oauth2/mac_token.rb#15
|
486
|
-
class OAuth2::MACToken < ::OAuth2::AccessToken
|
487
|
-
# Initalize a MACToken
|
488
|
-
#
|
489
|
-
# @option [String]
|
490
|
-
# @option opts
|
491
|
-
# @option opts
|
492
|
-
# @option opts
|
493
|
-
# @option opts
|
494
|
-
# @param client [Client] the OAuth2::Client instance
|
495
|
-
# @param token [String] the Access Token value
|
496
|
-
# @param opts [Hash] the options to create the Access Token with
|
497
|
-
# @param [String] [Hash] a customizable set of options
|
498
|
-
# @return [MACToken] a new instance of MACToken
|
499
|
-
#
|
500
|
-
# source://oauth2//lib/oauth2/mac_token.rb#32
|
501
|
-
def initialize(client, token, secret, opts = T.unsafe(nil)); end
|
502
|
-
|
503
|
-
# Returns the value of attribute algorithm.
|
504
|
-
#
|
505
|
-
# source://oauth2//lib/oauth2/mac_token.rb#20
|
506
|
-
def algorithm; end
|
507
|
-
|
508
|
-
# Set the HMAC algorithm
|
509
|
-
#
|
510
|
-
# @param alg [String] the algorithm to use (one of 'hmac-sha-1', 'hmac-sha-256')
|
511
|
-
#
|
512
|
-
# source://oauth2//lib/oauth2/mac_token.rb#99
|
513
|
-
def algorithm=(alg); end
|
514
|
-
|
515
|
-
# Generate the MAC header
|
516
|
-
#
|
517
|
-
# @param verb [Symbol] the HTTP request method
|
518
|
-
# @param url [String] the HTTP URL path of the request
|
519
|
-
# @raise [ArgumentError]
|
520
|
-
#
|
521
|
-
# source://oauth2//lib/oauth2/mac_token.rb#63
|
522
|
-
def header(verb, url); end
|
523
|
-
|
524
|
-
# Get the headers hash (always an empty hash)
|
525
|
-
#
|
526
|
-
# source://oauth2//lib/oauth2/mac_token.rb#55
|
527
|
-
def headers; end
|
528
|
-
|
529
|
-
# Make a request with the MAC Token
|
530
|
-
#
|
531
|
-
# @param verb [Symbol] the HTTP request method
|
532
|
-
# @param path [String] the HTTP URL path of the request
|
533
|
-
# @param opts [Hash] the options to make the request with
|
534
|
-
# @see Client#request
|
535
|
-
#
|
536
|
-
# source://oauth2//lib/oauth2/mac_token.rb#45
|
537
|
-
def request(verb, path, opts = T.unsafe(nil), &block); end
|
538
|
-
|
539
|
-
# Returns the value of attribute secret.
|
540
|
-
#
|
541
|
-
# source://oauth2//lib/oauth2/mac_token.rb#20
|
542
|
-
def secret; end
|
543
|
-
|
544
|
-
# Generate the Base64-encoded HMAC digest signature
|
545
|
-
#
|
546
|
-
# @param timestamp [Fixnum] the timestamp of the request in seconds since epoch
|
547
|
-
# @param nonce [String] the MAC header nonce
|
548
|
-
# @param verb [Symbol] the HTTP request method
|
549
|
-
# @param url [String] the HTTP URL path of the request
|
550
|
-
#
|
551
|
-
# source://oauth2//lib/oauth2/mac_token.rb#82
|
552
|
-
def signature(timestamp, nonce, verb, uri); end
|
553
|
-
|
554
|
-
private
|
555
|
-
|
556
|
-
# Base64.strict_encode64 is not available on Ruby 1.8.7
|
557
|
-
#
|
558
|
-
# source://oauth2//lib/oauth2/mac_token.rb#126
|
559
|
-
def strict_encode64(str); end
|
560
|
-
|
561
|
-
# No-op since we need the verb and path
|
562
|
-
# and the MAC always goes in a header
|
563
|
-
#
|
564
|
-
# source://oauth2//lib/oauth2/mac_token.rb#122
|
565
|
-
def token=(_noop); end
|
566
|
-
|
567
|
-
class << self
|
568
|
-
# Generates a MACToken from an AccessToken and secret
|
569
|
-
#
|
570
|
-
# @option [String]
|
571
|
-
# @param token [AccessToken] the OAuth2::Token instance
|
572
|
-
# @param opts [Hash] the options to create the Access Token with
|
573
|
-
# @param [String] [Hash] a customizable set of options
|
574
|
-
# @see MACToken#initialize
|
575
|
-
#
|
576
|
-
# source://oauth2//lib/oauth2/mac_token.rb#16
|
577
|
-
def from_access_token(token, secret, options = T.unsafe(nil)); end
|
578
|
-
end
|
579
|
-
end
|
580
|
-
|
581
|
-
# OAuth2::Response class
|
582
|
-
#
|
583
|
-
# source://oauth2//lib/oauth2/response.rb#9
|
584
|
-
class OAuth2::Response
|
585
|
-
# Initializes a Response instance
|
586
|
-
#
|
587
|
-
# @option opts
|
588
|
-
# @param response [Faraday::Response] The Faraday response instance
|
589
|
-
# @param opts [Hash] options in which to initialize the instance
|
590
|
-
# @return [Response] a new instance of Response
|
591
|
-
#
|
592
|
-
# source://oauth2//lib/oauth2/response.rb#48
|
593
|
-
def initialize(response, opts = T.unsafe(nil)); end
|
594
|
-
|
595
|
-
# The HTTP response body
|
596
|
-
#
|
597
|
-
# source://oauth2//lib/oauth2/response.rb#64
|
598
|
-
def body; end
|
599
|
-
|
600
|
-
# Attempts to determine the content type of the response.
|
601
|
-
#
|
602
|
-
# source://oauth2//lib/oauth2/response.rb#78
|
603
|
-
def content_type; end
|
604
|
-
|
605
|
-
# Returns the value of attribute error.
|
606
|
-
#
|
607
|
-
# source://oauth2//lib/oauth2/response.rb#11
|
608
|
-
def error; end
|
609
|
-
|
610
|
-
# Sets the attribute error
|
611
|
-
#
|
612
|
-
# @param value the value to set the attribute error to.
|
613
|
-
#
|
614
|
-
# source://oauth2//lib/oauth2/response.rb#11
|
615
|
-
def error=(_arg0); end
|
616
|
-
|
617
|
-
# The HTTP response headers
|
618
|
-
#
|
619
|
-
# source://oauth2//lib/oauth2/response.rb#54
|
620
|
-
def headers; end
|
621
|
-
|
622
|
-
# Returns the value of attribute options.
|
623
|
-
#
|
624
|
-
# source://oauth2//lib/oauth2/response.rb#11
|
625
|
-
def options; end
|
626
|
-
|
627
|
-
# Sets the attribute options
|
628
|
-
#
|
629
|
-
# @param value the value to set the attribute options to.
|
630
|
-
#
|
631
|
-
# source://oauth2//lib/oauth2/response.rb#11
|
632
|
-
def options=(_arg0); end
|
633
|
-
|
634
|
-
# The parsed response body.
|
635
|
-
# Will attempt to parse application/x-www-form-urlencoded and
|
636
|
-
# application/json Content-Type response bodies
|
637
|
-
#
|
638
|
-
# source://oauth2//lib/oauth2/response.rb#71
|
639
|
-
def parsed; end
|
640
|
-
|
641
|
-
# Determines the parser that will be used to supply the content of #parsed
|
642
|
-
#
|
643
|
-
# source://oauth2//lib/oauth2/response.rb#83
|
644
|
-
def parser; end
|
645
|
-
|
646
|
-
# Returns the value of attribute response.
|
647
|
-
#
|
648
|
-
# source://oauth2//lib/oauth2/response.rb#10
|
649
|
-
def response; end
|
650
|
-
|
651
|
-
# The HTTP response status code
|
652
|
-
#
|
653
|
-
# source://oauth2//lib/oauth2/response.rb#59
|
654
|
-
def status; end
|
655
|
-
|
656
|
-
class << self
|
657
|
-
# Adds a new content type parser.
|
658
|
-
#
|
659
|
-
# @param key [Symbol] A descriptive symbol key such as :json or :query.
|
660
|
-
# @param mime_types [Array] One or more mime types to which this parser applies.
|
661
|
-
# @yield [String] A block returning parsed content.
|
662
|
-
#
|
663
|
-
# source://oauth2//lib/oauth2/response.rb#34
|
664
|
-
def register_parser(key, mime_types, &block); end
|
665
|
-
end
|
666
|
-
end
|
667
|
-
|
668
|
-
# source://oauth2//lib/oauth2/strategy/base.rb#4
|
669
|
-
module OAuth2::Strategy; end
|
670
|
-
|
671
|
-
# The Client Assertion Strategy
|
672
|
-
#
|
673
|
-
# Sample usage:
|
674
|
-
# client = OAuth2::Client.new(client_id, client_secret,
|
675
|
-
# :site => 'http://localhost:8080')
|
676
|
-
#
|
677
|
-
# params = {:hmac_secret => "some secret",
|
678
|
-
# # or :private_key => "private key string",
|
679
|
-
# :iss => "http://localhost:3001",
|
680
|
-
# :prn => "me@here.com",
|
681
|
-
# :exp => Time.now.utc.to_i + 3600}
|
682
|
-
#
|
683
|
-
# access = client.assertion.get_token(params)
|
684
|
-
# access.token # actual access_token string
|
685
|
-
# access.get("/api/stuff") # making api calls with access token in header
|
686
|
-
#
|
687
|
-
# @see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-10#section-4.1.3
|
688
|
-
#
|
689
|
-
# source://oauth2//lib/oauth2/strategy/assertion.rb#28
|
690
|
-
class OAuth2::Strategy::Assertion < ::OAuth2::Strategy::Base
|
691
|
-
# Not used for this strategy
|
692
|
-
#
|
693
|
-
# @raise [NotImplementedError]
|
694
|
-
#
|
695
|
-
# source://oauth2//lib/oauth2/strategy/assertion.rb#29
|
696
|
-
def authorize_url; end
|
697
|
-
|
698
|
-
# source://oauth2//lib/oauth2/strategy/assertion.rb#62
|
699
|
-
def build_assertion(params); end
|
700
|
-
|
701
|
-
# source://oauth2//lib/oauth2/strategy/assertion.rb#52
|
702
|
-
def build_request(params); end
|
703
|
-
|
704
|
-
# Retrieve an access token given the specified client.
|
705
|
-
#
|
706
|
-
# pass either :hmac_secret or :private_key, but not both.
|
707
|
-
#
|
708
|
-
# params :hmac_secret, secret string.
|
709
|
-
# params :private_key, private key string.
|
710
|
-
#
|
711
|
-
# params :iss, issuer
|
712
|
-
# params :aud, audience, optional
|
713
|
-
# params :prn, principal, current user
|
714
|
-
# params :exp, expired at, in seconds, like Time.now.utc.to_i + 3600
|
715
|
-
#
|
716
|
-
# @param params [Hash] assertion params
|
717
|
-
# @param opts [Hash] options
|
718
|
-
#
|
719
|
-
# source://oauth2//lib/oauth2/strategy/assertion.rb#47
|
720
|
-
def get_token(params = T.unsafe(nil), opts = T.unsafe(nil)); end
|
721
|
-
end
|
722
|
-
|
723
|
-
# The Authorization Code Strategy
|
724
|
-
#
|
725
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.1
|
726
|
-
#
|
727
|
-
# source://oauth2//lib/oauth2/strategy/auth_code.rb#11
|
728
|
-
class OAuth2::Strategy::AuthCode < ::OAuth2::Strategy::Base
|
729
|
-
# The required query parameters for the authorize URL
|
730
|
-
#
|
731
|
-
# @param params [Hash] additional query parameters
|
732
|
-
#
|
733
|
-
# source://oauth2//lib/oauth2/strategy/auth_code.rb#12
|
734
|
-
def authorize_params(params = T.unsafe(nil)); end
|
735
|
-
|
736
|
-
# The authorization URL endpoint of the provider
|
737
|
-
#
|
738
|
-
# @param params [Hash] additional query parameters for the URL
|
739
|
-
#
|
740
|
-
# source://oauth2//lib/oauth2/strategy/auth_code.rb#19
|
741
|
-
def authorize_url(params = T.unsafe(nil)); end
|
742
|
-
|
743
|
-
# Retrieve an access token given the specified validation code.
|
744
|
-
#
|
745
|
-
# @note that you must also provide a :redirect_uri with most OAuth 2.0 providers
|
746
|
-
# @param code [String] The Authorization Code value
|
747
|
-
# @param params [Hash] additional params
|
748
|
-
# @param opts [Hash] options
|
749
|
-
#
|
750
|
-
# source://oauth2//lib/oauth2/strategy/auth_code.rb#29
|
751
|
-
def get_token(code, params = T.unsafe(nil), opts = T.unsafe(nil)); end
|
752
|
-
end
|
753
|
-
|
754
|
-
# source://oauth2//lib/oauth2/strategy/base.rb#5
|
755
|
-
class OAuth2::Strategy::Base
|
756
|
-
# @return [Base] a new instance of Base
|
757
|
-
#
|
758
|
-
# source://oauth2//lib/oauth2/strategy/base.rb#6
|
759
|
-
def initialize(client); end
|
760
|
-
end
|
761
|
-
|
762
|
-
# The Client Credentials Strategy
|
763
|
-
#
|
764
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.4
|
765
|
-
#
|
766
|
-
# source://oauth2//lib/oauth2/strategy/client_credentials.rb#11
|
767
|
-
class OAuth2::Strategy::ClientCredentials < ::OAuth2::Strategy::Base
|
768
|
-
# Not used for this strategy
|
769
|
-
#
|
770
|
-
# @raise [NotImplementedError]
|
771
|
-
#
|
772
|
-
# source://oauth2//lib/oauth2/strategy/client_credentials.rb#12
|
773
|
-
def authorize_url; end
|
774
|
-
|
775
|
-
# Retrieve an access token given the specified client.
|
776
|
-
#
|
777
|
-
# @param params [Hash] additional params
|
778
|
-
# @param opts [Hash] options
|
779
|
-
#
|
780
|
-
# source://oauth2//lib/oauth2/strategy/client_credentials.rb#20
|
781
|
-
def get_token(params = T.unsafe(nil), opts = T.unsafe(nil)); end
|
782
|
-
end
|
783
|
-
|
784
|
-
# The Implicit Strategy
|
785
|
-
#
|
786
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-26#section-4.2
|
787
|
-
#
|
788
|
-
# source://oauth2//lib/oauth2/strategy/implicit.rb#11
|
789
|
-
class OAuth2::Strategy::Implicit < ::OAuth2::Strategy::Base
|
790
|
-
# The required query parameters for the authorize URL
|
791
|
-
#
|
792
|
-
# @param params [Hash] additional query parameters
|
793
|
-
#
|
794
|
-
# source://oauth2//lib/oauth2/strategy/implicit.rb#12
|
795
|
-
def authorize_params(params = T.unsafe(nil)); end
|
796
|
-
|
797
|
-
# The authorization URL endpoint of the provider
|
798
|
-
#
|
799
|
-
# @param params [Hash] additional query parameters for the URL
|
800
|
-
#
|
801
|
-
# source://oauth2//lib/oauth2/strategy/implicit.rb#19
|
802
|
-
def authorize_url(params = T.unsafe(nil)); end
|
803
|
-
|
804
|
-
# Not used for this strategy
|
805
|
-
#
|
806
|
-
# @raise [NotImplementedError]
|
807
|
-
#
|
808
|
-
# source://oauth2//lib/oauth2/strategy/implicit.rb#26
|
809
|
-
def get_token(*_arg0); end
|
810
|
-
end
|
811
|
-
|
812
|
-
# The Resource Owner Password Credentials Authorization Strategy
|
813
|
-
#
|
814
|
-
# @see http://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-15#section-4.3
|
815
|
-
#
|
816
|
-
# source://oauth2//lib/oauth2/strategy/password.rb#11
|
817
|
-
class OAuth2::Strategy::Password < ::OAuth2::Strategy::Base
|
818
|
-
# Not used for this strategy
|
819
|
-
#
|
820
|
-
# @raise [NotImplementedError]
|
821
|
-
#
|
822
|
-
# source://oauth2//lib/oauth2/strategy/password.rb#12
|
823
|
-
def authorize_url; end
|
824
|
-
|
825
|
-
# Retrieve an access token given the specified End User username and password.
|
826
|
-
#
|
827
|
-
# @param username [String] the End User username
|
828
|
-
# @param password [String] the End User password
|
829
|
-
# @param params [Hash] additional params
|
830
|
-
#
|
831
|
-
# source://oauth2//lib/oauth2/strategy/password.rb#21
|
832
|
-
def get_token(username, password, params = T.unsafe(nil), opts = T.unsafe(nil)); end
|
833
|
-
end
|