1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
|
# coding: utf-8
# frozen_string_literal: true
require 'nkf'
RSpec.describe OAuth2::Client do
subject(:instance) do
described_class.new('abc', 'def', {site: 'https://api.example.com'}.merge(options)) do |builder|
builder.adapter :test do |stub|
stub.get('/success') { |_env| [200, {'Content-Type' => 'text/awesome'}, 'yay'] }
stub.get('/reflect') { |env| [200, {}, env[:body]] }
stub.post('/reflect') { |env| [200, {}, env[:body]] }
stub.get('/unauthorized') { |_env| [401, {'Content-Type' => 'application/json'}, JSON.dump(error: error_value, error_description: error_description_value)] }
stub.get('/conflict') { |_env| [409, {'Content-Type' => 'text/plain'}, 'not authorized'] }
stub.get('/redirect') { |_env| [302, {'Content-Type' => 'text/plain', 'location' => '/success'}, ''] }
stub.get('/redirect_no_loc') { |_env| [302, {'Content-Type' => 'text/plain'}, ''] }
stub.post('/redirect') { |_env| [303, {'Content-Type' => 'text/plain', 'location' => '/reflect'}, ''] }
stub.get('/error') { |_env| [500, {'Content-Type' => 'text/plain'}, 'unknown error'] }
stub.get('/empty_get') { |_env| [204, {}, nil] }
stub.get('/different_encoding') { |_env| [500, {'Content-Type' => 'application/json'}, NKF.nkf('-We', JSON.dump(error: error_value, error_description: '∞'))] }
stub.get('/ascii_8bit_encoding') { |_env| [500, {'Content-Type' => 'application/json'}, JSON.dump(error: 'invalid_request', error_description: 'é').force_encoding('ASCII-8BIT')] }
stub.get('/unhandled_status') { |_env| [600, {}, nil] }
end
end
end
let!(:error_value) { 'invalid_token' }
let!(:error_description_value) { 'bad bad token' }
let(:options) { {} }
describe '#initialize' do
it 'assigns id and secret' do
expect(subject.id).to eq('abc')
expect(subject.secret).to eq('def')
end
it 'assigns site from the options hash' do
expect(subject.site).to eq('https://api.example.com')
end
it 'assigns Faraday::Connection#host' do
expect(subject.connection.host).to eq('api.example.com')
end
it 'leaves Faraday::Connection#ssl unset' do
expect(subject.connection.ssl).to be_empty
end
it 'is able to pass a block to configure the connection' do
builder = double('builder')
allow(Faraday).to receive(:new).and_yield(builder)
allow(builder).to receive(:response)
expect(builder).to receive(:adapter).with(:test)
described_class.new('abc', 'def') do |client|
client.adapter :test
end.connection
end
it 'defaults raise_errors to true' do
expect(subject.options[:raise_errors]).to be true
end
it 'allows true/false for raise_errors option' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', raise_errors: false)
expect(client.options[:raise_errors]).to be false
client = described_class.new('abc', 'def', site: 'https://api.example.com', raise_errors: true)
expect(client.options[:raise_errors]).to be true
end
it 'allows override of raise_errors option' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', raise_errors: true) do |builder|
builder.adapter :test do |stub|
stub.get('/notfound') { |_env| [404, {}, nil] }
end
end
expect(client.options[:raise_errors]).to be true
expect { client.request(:get, '/notfound') }.to raise_error(OAuth2::Error)
response = client.request(:get, '/notfound', raise_errors: false)
expect(response.status).to eq(404)
end
it 'allows get/post for access_token_method option' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', access_token_method: :get)
expect(client.options[:access_token_method]).to eq(:get)
client = described_class.new('abc', 'def', site: 'https://api.example.com', access_token_method: :post)
expect(client.options[:access_token_method]).to eq(:post)
end
it 'does not mutate the opts hash argument' do
opts = {site: 'http://example.com/'}
opts2 = opts.dup
described_class.new 'abc', 'def', opts
expect(opts).to eq(opts2)
end
end
describe '#site=(val)' do
subject(:site) { instance.site = new_site }
let(:options) do
{site: 'https://example.com/blog'}
end
let(:new_site) { 'https://example.com/sharpie' }
it 'sets site' do
block_is_expected.to change(instance, :site).from('https://example.com/blog').to('https://example.com/sharpie')
end
context 'with connection' do
before do
instance.connection
end
it 'allows connection to reset with new url prefix' do
block_is_expected.to change { instance.connection.url_prefix }.from(URI('https://example.com/blog')).to(URI('https://example.com/sharpie'))
end
end
end
%w[authorize token].each do |url_type|
describe ":#{url_type}_url option" do
it "defaults to a path of /oauth/#{url_type}" do
expect(subject.send("#{url_type}_url")).to eq("https://api.example.com/oauth/#{url_type}")
end
it "is settable via the :#{url_type}_url option" do
subject.options[:"#{url_type}_url"] = '/oauth/custom'
expect(subject.send("#{url_type}_url")).to eq('https://api.example.com/oauth/custom')
end
it 'allows a different host than the site' do
subject.options[:"#{url_type}_url"] = 'https://api.foo.com/oauth/custom'
expect(subject.send("#{url_type}_url")).to eq('https://api.foo.com/oauth/custom')
end
context 'when a URL with path is used in the site' do
let(:options) do
{site: 'https://example.com/blog'}
end
it 'generates an authorization URL relative to the site' do
expect(subject.send("#{url_type}_url")).to eq("https://example.com/blog/oauth/#{url_type}")
end
end
end
end
describe ':redirect_uri option' do
let(:auth_code_params) do
{
'client_id' => 'abc',
'client_secret' => 'def',
'code' => 'code',
'grant_type' => 'authorization_code',
}
end
context 'when blank' do
it 'there is no redirect_uri param added to authorization URL' do
expect(subject.authorize_url('a' => 'b')).to eq('https://api.example.com/oauth/authorize?a=b')
end
it 'does not add the redirect_uri param to the auth_code token exchange request' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', auth_scheme: :request_body) do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token', auth_code_params) do
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
client.auth_code.get_token('code')
end
end
context 'when set' do
before { subject.options[:redirect_uri] = 'https://site.com/oauth/callback' }
it 'adds the redirect_uri param to authorization URL' do
expect(subject.authorize_url('a' => 'b')).to eq('https://api.example.com/oauth/authorize?a=b&redirect_uri=https%3A%2F%2Fsite.com%2Foauth%2Fcallback')
end
it 'adds the redirect_uri param to the auth_code token exchange request' do
client = described_class.new('abc', 'def', redirect_uri: 'https://site.com/oauth/callback', site: 'https://api.example.com', auth_scheme: :request_body) do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token', auth_code_params.merge('redirect_uri' => 'https://site.com/oauth/callback')) do
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
client.auth_code.get_token('code')
end
end
describe 'custom headers' do
context 'string key headers' do
it 'adds the custom headers to request' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', auth_scheme: :request_body) do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token') do |env|
expect(env.request_headers).to include('CustomHeader' => 'CustomHeader')
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
header_params = {'headers' => {'CustomHeader' => 'CustomHeader'}}
client.auth_code.get_token('code', header_params)
end
end
context 'symbol key headers' do
it 'adds the custom headers to request' do
client = described_class.new('abc', 'def', site: 'https://api.example.com', auth_scheme: :request_body) do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token') do |env|
expect(env.request_headers).to include('CustomHeader' => 'CustomHeader')
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
header_params = {headers: {'CustomHeader' => 'CustomHeader'}}
client.auth_code.get_token('code', header_params)
end
end
context 'string key custom headers with basic auth' do
it 'adds the custom headers to request' do
client = described_class.new('abc', 'def', site: 'https://api.example.com') do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token') do |env|
expect(env.request_headers).to include('CustomHeader' => 'CustomHeader')
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
header_params = {'headers' => {'CustomHeader' => 'CustomHeader'}}
client.auth_code.get_token('code', header_params)
end
end
context 'symbol key custom headers with basic auth' do
it 'adds the custom headers to request' do
client = described_class.new('abc', 'def', site: 'https://api.example.com') do |builder|
builder.adapter :test do |stub|
stub.post('/oauth/token') do |env|
expect(env.request_headers).to include('CustomHeader' => 'CustomHeader')
[200, {'Content-Type' => 'application/json'}, '{"access_token":"token"}']
end
end
end
header_params = {headers: {'CustomHeader' => 'CustomHeader'}}
client.auth_code.get_token('code', header_params)
end
end
end
end
describe '#connection' do
context 'when debugging' do
include_context 'with stubbed env'
before do
stub_env('OAUTH_DEBUG' => debug_value)
end
context 'when OAUTH_DEBUG=true' do
let(:debug_value) { 'true' }
it 'smoothly handles successive requests' do
silence_all do
# first request (always goes smoothly)
subject.request(:get, '/success')
end
expect do
# second request (used to throw Faraday::RackBuilder::StackLocked)
subject.request(:get, '/success')
end.not_to raise_error
end
it 'prints both request and response bodies to STDOUT' do
printed = capture(:stdout) do
subject.request(:get, '/success')
subject.request(:get, '/reflect', body: 'this is magical')
end
expect(printed).to match 'request: GET https://api.example.com/success'
expect(printed).to match 'response: Content-Type:'
expect(printed).to match 'response: yay'
expect(printed).to match 'request: this is magical'
expect(printed).to match 'response: this is magical'
end
end
context 'when OAUTH_DEBUG=false' do
let(:debug_value) { 'false' }
it 'smoothly handles successive requests' do
silence_all do
# first request (always goes smoothly)
subject.request(:get, '/success')
end
expect do
# second request (used to throw Faraday::RackBuilder::StackLocked)
subject.request(:get, '/success')
end.not_to raise_error
end
it 'prints nothing to STDOUT' do
printed = capture(:stdout) do
subject.request(:get, '/success')
subject.request(:get, '/reflect', body: 'this is magical')
end
expect(printed).to eq ''
end
end
end
end
describe '#request' do
it 'works with a null response body' do
expect(subject.request(:get, 'empty_get').body).to eq('')
end
it 'returns on a successful response' do
response = subject.request(:get, '/success')
expect(response.body).to eq('yay')
expect(response.status).to eq(200)
expect(response.headers).to eq('Content-Type' => 'text/awesome')
end
context 'with ENV' do
include_context 'with stubbed env'
context 'when OAUTH_DEBUG=true' do
before do
stub_env('OAUTH_DEBUG' => 'true')
end
it 'outputs to $stdout when OAUTH_DEBUG=true' do
output = capture(:stdout) do
subject.request(:get, '/success')
end
logs = [
'request: GET https://api.example.com/success',
'response: Status 200',
'response: Content-Type: "text/awesome"',
]
expect(output).to include(*logs)
end
end
end
it 'posts a body' do
response = subject.request(:post, '/reflect', body: 'foo=bar')
expect(response.body).to eq('foo=bar')
end
it 'follows redirects properly' do
response = subject.request(:get, '/redirect')
expect(response.body).to eq('yay')
expect(response.status).to eq(200)
expect(response.headers).to eq('Content-Type' => 'text/awesome')
expect(response.response.env.url.to_s).to eq('https://api.example.com/success')
end
it 'redirects using GET on a 303' do
response = subject.request(:post, '/redirect', body: 'foo=bar')
expect(response.body).to be_empty
expect(response.status).to eq(200)
expect(response.response.env.url.to_s).to eq('https://api.example.com/reflect')
end
it 'raises an error if a redirect has no Location header' do
expect { subject.request(:get, '/redirect_no_loc') }.to raise_error(OAuth2::Error, 'Got 302 status code, but no Location header was present')
end
it 'obeys the :max_redirects option' do
max_redirects = subject.options[:max_redirects]
subject.options[:max_redirects] = 0
response = subject.request(:get, '/redirect')
expect(response.status).to eq(302)
subject.options[:max_redirects] = max_redirects
end
it 'returns if raise_errors is false' do
subject.options[:raise_errors] = false
response = subject.request(:get, '/unauthorized')
expect(response.status).to eq(401)
expect(response.headers).to eq('Content-Type' => 'application/json')
end
%w[/unauthorized /conflict /error /different_encoding /ascii_8bit_encoding].each do |error_path|
it "raises OAuth2::Error on error response to path #{error_path}" do
pending_for(engine: 'jruby', reason: 'https://github.com/jruby/jruby/issues/4921') if error_path == '/different_encoding'
expect { subject.request(:get, error_path) }.to raise_error(OAuth2::Error)
end
end
it 're-encodes response body in the error message' do
expect { subject.request(:get, '/ascii_8bit_encoding') }.to raise_error do |ex|
expect(ex.message).to eq("invalid_request: é\n{\"error\":\"invalid_request\",\"error_description\":\"��\"}")
expect(ex.message.encoding.name).to eq('UTF-8')
end
end
it 'parses OAuth2 standard error response' do
expect { subject.request(:get, '/unauthorized') }.to raise_error do |ex|
expect(ex.code).to eq(error_value)
expect(ex.description).to eq(error_description_value)
expect(ex.to_s).to match(/#{error_value}/)
expect(ex.to_s).to match(/#{error_description_value}/)
end
end
it 'provides the response in the Exception' do
expect { subject.request(:get, '/error') }.to raise_error do |ex|
expect(ex.response).not_to be_nil
expect(ex.to_s).to match(/unknown error/)
end
end
it 'informs about unhandled status code' do
expect { subject.request(:get, '/unhandled_status') }.to raise_error do |ex|
expect(ex.response).not_to be_nil
expect(ex.to_s).to match(/Unhandled status code value of 600/)
end
end
context 'when errors are raised by Faraday' do
let(:connection) { instance_double(Faraday::Connection, build_url: double) }
before do
allow(connection).to(
receive(:run_request).and_raise(faraday_exception)
)
allow(subject).to receive(:connection).and_return(connection) # rubocop:disable RSpec/SubjectStub
end
shared_examples 'failed connection handler' do
it 'rescues the exception' do
expect { subject.request(:get, '/redirect') }.to raise_error do |e|
expect(e.class).to eq(expected_exception)
expect(e.message).to eq(faraday_exception.message)
end
end
end
context 'with Faraday::ConnectionFailed' do
let(:faraday_exception) { Faraday::ConnectionFailed.new('fail') }
let(:expected_exception) { OAuth2::ConnectionError }
it_behaves_like 'failed connection handler'
end
context 'with Faraday::TimeoutError' do
let(:faraday_exception) { Faraday::TimeoutError.new('timeout') }
let(:expected_exception) { OAuth2::TimeoutError }
it_behaves_like 'failed connection handler'
end
end
end
describe '#get_token' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token({})
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
end
context 'when parse: :automatic' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token(parse: :automatic)
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
end
end
context 'when parse: :xml but response is JSON' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
expect { client.get_token(parse: :xml) }.to raise_error(
MultiXml::ParseError,
'The document "{\"access_token\":\"the-token\"}" does not have a valid root'
)
end
end
context 'when parse is fuzzed' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token(parse: 'random')
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
end
end
context 'when parse is correct' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token(parse: :json)
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
end
end
context 'when snaky is falsy, but response is snaky' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token(snaky: false)
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
expect(token.response.parsed.to_h).to eq('access_token' => 'the-token')
end
end
context 'when snaky is falsy, but response is not snaky' do
it 'returns a configured AccessToken' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('accessToken' => 'the-token')]
end
end
token = client.get_token({snaky: false}, {param_name: 'accessToken'})
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
expect(token.response.parsed.to_h).to eq('accessToken' => 'the-token')
end
end
it 'authenticates with request parameters' do
client = stubbed_client(auth_scheme: :request_body) do |stub|
stub.post('/oauth/token', 'client_id' => 'abc', 'client_secret' => 'def') do |_env|
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
client.get_token({})
end
it 'authenticates with Basic auth' do
client = stubbed_client(auth_scheme: :basic_auth) do |stub|
stub.post('/oauth/token') do |env|
raise Faraday::Adapter::Test::Stubs::NotFound unless env[:request_headers]['Authorization'] == OAuth2::Authenticator.encode_basic_auth('abc', 'def')
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
client.get_token({})
end
it 'authenticates with JSON' do
client = stubbed_client(auth_scheme: :basic_auth) do |stub|
stub.post('/oauth/token') do |env|
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
client.get_token(headers: {'Content-Type' => 'application/json'})
end
it 'sets the response object on the access token' do
client = stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
token = client.get_token({})
expect(token.response).to be_a OAuth2::Response
expect(token.response.parsed).to eq('access_token' => 'the-token')
end
context 'when the :raise_errors flag is set to false' do
let(:body) { nil }
let(:status_code) { 500 }
let(:content_type) { 'application/json' }
let(:client) do
stubbed_client(raise_errors: false) do |stub|
stub.post('/oauth/token') do
[status_code, {'Content-Type' => content_type}, body]
end
end
end
context 'when the request body is nil' do
subject(:get_token) { client.get_token({}) }
it 'raises error JSON::ParserError' do
block_is_expected { get_token }.to raise_error(JSON::ParserError)
end
context 'when extract_access_token raises an exception' do
let(:status_code) { 200 }
let(:extract_proc) { proc { |client, hash| raise ArgumentError } }
it 'returns a nil :access_token' do
expect(client.get_token({}, {}, extract_proc)).to eq(nil)
end
end
end
context 'when status code is 200' do
let(:status_code) { 200 }
context 'when the request body is not nil' do
let(:body) { JSON.dump('access_token' => 'the-token') }
it 'returns the parsed :access_token from body' do
token = client.get_token({})
expect(token.response).to be_a OAuth2::Response
expect(token.response.parsed).to eq('access_token' => 'the-token')
end
end
context 'when Content-Type is not JSON' do
let(:content_type) { 'text/plain' }
let(:body) { 'hello world' }
it 'returns the parsed :access_token from body' do
expect(client.get_token({})).to be_nil
end
end
end
end
describe 'with custom access_token_class option' do
let(:options) { {access_token_class: CustomAccessToken} }
let(:payload) { {'custom_token' => 'the-token'} }
let(:content_type) { 'application/json' }
let(:client) do
stubbed_client(options) do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => content_type}, JSON.dump(payload)]
end
end
end
before do
custom_class = Class.new(OAuth2::AccessToken) do
attr_accessor :response
def self.from_hash(client, hash)
new(client, hash.delete('custom_token'))
end
def self.contains_token?(hash)
hash.key?('custom_token')
end
end
stub_const('CustomAccessToken', custom_class)
end
it 'returns the parsed :custom_token from body' do
client.get_token({})
end
context 'when the :raise_errors flag is set to true' do
let(:options) { {access_token_class: CustomAccessToken, raise_errors: true} }
let(:payload) { {} }
it 'raises an error' do
expect { client.get_token({}) }.to raise_error(OAuth2::Error)
end
context 'when the legacy extract_access_token' do
let(:extract_access_token) do
proc do |client, hash|
token = hash['data']['access_token']
OAuth2::AccessToken.new(client, token, hash)
end
end
let(:options) { {raise_errors: true} }
let(:payload) { {} }
it 'raises an error' do
expect { client.get_token({}, {}, extract_access_token) }.to raise_error(OAuth2::Error)
end
end
end
context 'when status code is 200' do
let(:status_code) { 200 }
context 'when the request body is blank' do
let(:payload) { {} }
it 'raises an error' do
expect { client.get_token({}) }.to raise_error(OAuth2::Error)
end
end
context 'when Content-Type is not JSON' do
let(:content_type) { 'text/plain' }
let(:body) { 'hello world' }
it 'raises an error' do
expect { client.get_token({}) }.to raise_error(OAuth2::Error)
end
end
end
context 'when access token instance responds to response=' do
let(:options) { {access_token_class: CustomAccessToken, raise_errors: false} }
it 'sets response' do
expect(client.get_token({}).response).to be_a(OAuth2::Response)
end
end
context 'when request has a block' do
subject(:request) do
client.get_token({}) do |req|
raise 'Block is executing'
end
end
let(:options) { {access_token_class: CustomAccessToken, raise_errors: false} }
it 'sets response' do
block_is_expected.to raise_error('Block is executing')
end
end
end
describe 'abnormal custom access_token_class option' do
let(:payload) { {'custom_token' => 'the-token'} }
let(:content_type) { 'application/json' }
let(:client) do
stubbed_client(options) do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => content_type}, JSON.dump(payload)]
end
end
end
before do
custom_class = Class.new do
def initialize(client, hash)
end
def self.from_hash(client, hash)
new(client, hash.delete('custom_token'))
end
def self.contains_token?(hash)
hash.key?('custom_token')
end
end
stub_const('StrangeAccessToken', custom_class)
end
context 'when the :raise_errors flag is set to true' do
let(:options) { {access_token_class: StrangeAccessToken, raise_errors: true} }
let(:payload) { {} }
it 'raises an error' do
expect { client.get_token({}) }.to raise_error(OAuth2::Error)
end
end
context 'when access token instance does not responds to response=' do
let(:options) { {access_token_class: StrangeAccessToken} }
let(:payload) { {'custom_token' => 'the-token'} }
it 'sets response' do
token_access = client.get_token({})
expect(token_access).to be_a(StrangeAccessToken)
expect(token_access).not_to respond_to(:response=)
expect(token_access).not_to respond_to(:response)
end
end
context 'when request has a block' do
subject(:request) do
client.get_token({}) do |req|
raise 'Block is executing'
end
end
let(:options) { {access_token_class: StrangeAccessToken} }
it 'sets response' do
block_is_expected.to raise_error('Block is executing')
end
end
end
describe 'with extract_access_token option' do
let(:client) do
stubbed_client(extract_access_token: extract_access_token) do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('data' => {'access_token' => 'the-token'})]
end
end
end
let(:extract_access_token) do
proc do |client, hash|
token = hash['data']['access_token']
OAuth2::AccessToken.new(client, token, hash)
end
end
it 'returns a configured AccessToken' do
token = client.get_token({})
expect(token).to be_a OAuth2::AccessToken
expect(token.token).to eq('the-token')
end
context 'with deprecation' do
subject(:printed) do
capture(:stderr) do
client.get_token({})
end
end
it 'warns on STDERR' do
msg = <<-MSG.lstrip
OAuth2::Client#initialize argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class`.
MSG
expect(printed).to eq(msg)
end
context 'on request' do
subject(:printed) do
capture(:stderr) do
client.get_token({}, {}, extract_access_token)
end
end
let(:client) do
stubbed_client do |stub|
stub.post('/oauth/token') do
[200, {'Content-Type' => 'application/json'}, JSON.dump('data' => {'access_token' => 'the-token'})]
end
end
end
it 'warns on STDERR' do
msg = <<-MSG.lstrip
OAuth2::Client#get_token argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class` on #initialize.
MSG
expect(printed).to eq(msg)
end
end
end
end
it 'forwards given token parameters' do
client = stubbed_client(auth_scheme: :request_body) do |stub|
stub.post('/oauth/token', 'arbitrary' => 'parameter', 'client_id' => 'abc', 'client_secret' => 'def') do |_env|
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
client.get_token({'arbitrary' => 'parameter'}) # rubocop:disable Style/BracesAroundHashParameters
end
context 'when token_method is set to post_with_query_string' do
it 'uses the http post method and passes parameters in the query string' do
client = stubbed_client(token_method: :post_with_query_string) do |stub|
stub.post('/oauth/token?state=abc123') do |_env|
[200, {'Content-Type' => 'application/json'}, JSON.dump('access_token' => 'the-token')]
end
end
client.get_token({'state' => 'abc123'}) # rubocop:disable Style/BracesAroundHashParameters
end
end
def stubbed_client(params = {}, &stubs)
params = {site: 'https://api.example.com'}.merge(params)
OAuth2::Client.new('abc', 'def', params) do |builder|
builder.adapter :test, &stubs
end
end
end
it 'instantiates an HTTP Method with this client' do
expect(subject.http_method).to be_kind_of(Symbol)
end
it 'instantiates an AuthCode strategy with this client' do
expect(subject.auth_code).to be_kind_of(OAuth2::Strategy::AuthCode)
end
it 'instantiates an Implicit strategy with this client' do
expect(subject.implicit).to be_kind_of(OAuth2::Strategy::Implicit)
end
context 'with SSL options' do
subject do
cli = described_class.new('abc', 'def', site: 'https://api.example.com', ssl: {ca_file: 'foo.pem'})
cli.connection = Faraday.new(cli.site, cli.options[:connection_opts]) do |b|
b.adapter :test
end
cli
end
it 'passes the SSL options along to Faraday::Connection#ssl' do
expect(subject.connection.ssl.fetch(:ca_file)).to eq('foo.pem')
end
end
context 'without a connection-configuration block' do
subject do
described_class.new('abc', 'def', site: 'https://api.example.com')
end
it 'applies default faraday middleware to the connection' do
expect(subject.connection.builder.handlers).to include(Faraday::Request::UrlEncoded)
end
end
end
|