New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new userinfo method for auth endpoints #130

Merged

joshcanhelp merged 1 commit into master from add-auth-userinfo-method

Oct 12, 2018

Contributor

joshcanhelp commented Sep 26, 2018

Add new userinfo method for Auth0::Api::AuthenticationEndpoints
Add the ability to include additional headers in get method in Auth0::Mixins::HTTPProxy
Add note to deprecate previous user_info method

joshcanhelp added the CH: Added label

joshcanhelp added this to the v4-Next milestone

machuga reviewed

View reviewed changes

lib/auth0/mixins/httpproxy.rb Outdated

                         safe_path = URI.escape(path)
                         body = body.delete_if { |_, v| v.nil? }
                         result = if [:get, :delete].include?(method)
-                                   call(method, url(safe_path), timeout, add_headers(params: body))
+                                   add_headers(extra_headers.nil? ? {params: body} : extra_headers )

machuga Sep 26, 2018

Is this usage of add_headers compatible with the existing one? Does add_headers return a value or does it mutate something?

Contributor Author

joshcanhelp Sep 28, 2018

Is this usage of add_headers compatible with the existing one?

Yes. That's there to ... add headers but the current implementation uses it to add URL params by setting :params to be the body that's passed in for GET requests. It's a bit confusing in it's current state but I think this is a good compromise between necessary functionality and legacy support.

Does add_headers return a value or does it mutate something?

Both. It mutates the module's @headers property and returns it. I'm using it just to mutate, then pass the property to that call() method.

spec/lib/auth0/api/authentication_endpoints_spec.rb Outdated

+                  it { expect(@instance).to respond_to(:userinfo) }
+                  it 'is expected to make a GET request to /userinfo' do
+                    expect(@instance).to receive(:get).with('/userinfo', nil, {Authorization: 'Bearer access-token'})
+                    @instance.userinfo 'access-token'

machuga Sep 26, 2018

What is this doing?

spec/lib/auth0/api/authentication_endpoints_spec.rb Outdated

@@ @@ -330,6 +330,14 @@ @@
                   end
                 end
+                context '.userinfo' do
+                  it { expect(@instance).to respond_to(:userinfo) }

machuga Sep 26, 2018

If you setup something like subject { @instance }, you could even shorten this to it { is_expected.to respond_to(:user_info) }, I believe. Not suggesting you need to do this, just showing you some fun RSpec stuff 👍

joshcanhelp force-pushed the add-auth-userinfo-method branch from 993d26c to 5f299fc Compare

September 28, 2018 22:29

joshcanhelp added the Ready for Review label

Gubio approved these changes

View reviewed changes

joshcanhelp force-pushed the add-auth-userinfo-method branch 2 times, most recently from 8a0fc2f to eee645c Compare

October 10, 2018 23:33

Contributor Author

joshcanhelp commented Oct 10, 2018

@machuga - Added integration tests and swapped out the new Client ID. Removed Client Secret and API Token out of the recordings 👍

joshcanhelp force-pushed the add-auth-userinfo-method branch 2 times, most recently from 7feb9c2 to c4be5da Compare

October 11, 2018 01:31

joshcanhelp commented

View reviewed changes

...ettes/Auth0_Api_AuthenticationEndpoints/_change_password/should_trigger_a_password_reset.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

...cassettes/Auth0_Api_AuthenticationEndpoints/_saml_metadata/should_retrieve_SAML_metadata.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

...ssettes/Auth0_Api_AuthenticationEndpoints/_wsfed_metadata/should_retrieve_WSFED_metadata.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/create_test_user.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

spec/fixtures/vcr_cassettes/Auth0_Api_AuthenticationEndpoints/delete_test_user.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

...ttes/Auth0_Api_V2_Blacklists/_add_token_to_blacklist/should_add_a_token_to_the_blacklist.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

...uth0_Api_V2_Blacklists/_blacklisted_tokens/should_get_the_added_token_from_the_blacklist.yml

                     Content-Type:
                     - application/json
                     Auth0-Client:
                     - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjUuMCJ9
                     Authorization:
-                    - Bearer eyJ0eXAiOiJKV1QiLCJhbGc.eyJpc3MiOiJodHRwczovL2F1dGgwLXNkay10ZXN0cy5hdXRoMC5jb20vIiwic3ViIjoiQjRvUEhsMDA3VmExR0JkWlhpU0hhRUNVcVZXa2Q5WGtAY2xpZW50cyIsIm.PxfZjVd4wTb_bFbSTENdTmbj13CDQaPK352w3UNL3i3DnWcVJa6qSiA0hCr_tSU_uC34mHkK52O8tFVeZjxCYSeM9yOZUcKVya5N0I7G90X

Contributor Author

joshcanhelp Oct 11, 2018

Dummy API token, replacing with something more clearly fake

joshcanhelp commented

View reviewed changes

spec/spec_helper.rb

                 config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
                 config.configure_rspec_metadata!
                 config.hook_into :webmock
+                config.filter_sensitive_data('CLIENT_SECRET') { ENV['CLIENT_SECRET'] }

Contributor Author

joshcanhelp Oct 11, 2018

🎉

joshcanhelp force-pushed the add-auth-userinfo-method branch from c4be5da to cd8b1d4 Compare

October 11, 2018 01:34

machuga approved these changes

View reviewed changes

machuga left a comment

LGTM!

joshcanhelp removed the Ready for Review label


          Add new userinfo method for auth endpoints

545c63c

joshcanhelp force-pushed the add-auth-userinfo-method branch from cd8b1d4 to 545c63c Compare

October 12, 2018 18:58

joshcanhelp merged commit 085ee53 into master

joshcanhelp mentioned this pull request

Incorrect request_params for username-password login #109

Closed

joshcanhelp deleted the add-auth-userinfo-method branch

October 13, 2018 19:57

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels