From d7bc5dfaa01d2e203623a546d41b383bfa40e1d0 Mon Sep 17 00:00:00 2001 From: Matthew Kloster Date: Thu, 2 Apr 2020 15:21:40 -0700 Subject: [PATCH] Azure AD -> Azure rename --- README.md | 8 ++++---- .../app/controllers/sessions_controller.rb | 2 +- examples/rails-todo-list-app/app/models/user.rb | 2 +- .../rails-todo-list-app/config/initializers/omniauth.rb | 2 +- examples/rails-todo-list-app/config/routes.rb | 2 +- examples/sinatra-multiple-providers-app/app.rb | 2 +- examples/sinatra-multiple-providers-app/config.ru | 2 +- lib/omniauth-azure-activedirectory.rb | 2 +- lib/omniauth/{azure_activedirectory.rb => azure.rb} | 4 ++-- lib/omniauth/{azure_activedirectory => azure}/version.rb | 2 +- .../strategies/{azure_activedirectory.rb => azure.rb} | 8 ++++---- omniauth-azure-activedirectory.gemspec | 4 ++-- spec/omniauth/strategies/azure_activedirectory_spec.rb | 2 +- 13 files changed, 21 insertions(+), 21 deletions(-) rename lib/omniauth/{azure_activedirectory.rb => azure.rb} (92%) rename lib/omniauth/{azure_activedirectory => azure}/version.rb (97%) rename lib/omniauth/strategies/{azure_activedirectory.rb => azure.rb} (97%) diff --git a/README.md b/README.md index b71e07d..fe203ca 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ For example, in Rails you would add this in `config/initializers/omniauth.rb`: ```ruby Rails.application.config.middleware.use OmniAuth::Builder do - provider :azure_activedirectory, ENV['AAD_CLIENT_ID'], ENV['AAD_TENANT'] + provider :azure, ENV['AAD_CLIENT_ID'], ENV['AAD_TENANT'] # other providers here end ``` @@ -51,11 +51,11 @@ If you are using Sinatra or something else that requires you to configure Rack y ```ruby use OmniAuth::Builder do - provider :azure_activedirectory, ENV['AAD_CLIENT_ID'], ENV['AAD_TENANT'] + provider :azure, ENV['AAD_CLIENT_ID'], ENV['AAD_TENANT'] end ``` -When you want to authenticate the user, simply redirect them to `/auth/azureactivedirectory`. From there, OmniAuth will takeover. Once the user authenticates (or fails to authenticate), they will be redirected to `/auth/azureactivedirectory/callback` or `/auth/azureactivedirectory/failure`. The authentication result is available in `request.env['omniauth.auth']`. +When you want to authenticate the user, simply redirect them to `/auth/azure`. From there, OmniAuth will takeover. Once the user authenticates (or fails to authenticate), they will be redirected to `/auth/azure/callback` or `/auth/azure/failure`. The authentication result is available in `request.env['omniauth.auth']`. If you are supporting multiple OmniAuth providers, you will likely have something like this in your code: @@ -77,7 +77,7 @@ OmniAuth AzureAD tries to be consistent with the auth hash schema recommended by Here's an example of an authentication hash available in the callback. You can access this hash as `request.env['omniauth.auth']`. ``` - :provider => "azureactivedirectory", + :provider => "azure", :uid => "123456abcdef", :info => { :name => "John Smith", diff --git a/examples/rails-todo-list-app/app/controllers/sessions_controller.rb b/examples/rails-todo-list-app/app/controllers/sessions_controller.rb index 33b72d5..9f64bda 100644 --- a/examples/rails-todo-list-app/app/controllers/sessions_controller.rb +++ b/examples/rails-todo-list-app/app/controllers/sessions_controller.rb @@ -2,7 +2,7 @@ class SessionsController < ApplicationController skip_before_filter :verify_authenticity_token def new - redirect_to '/auth/azureactivedirectory' + redirect_to '/auth/azure' end def create diff --git a/examples/rails-todo-list-app/app/models/user.rb b/examples/rails-todo-list-app/app/models/user.rb index eebfec6..07916fb 100644 --- a/examples/rails-todo-list-app/app/models/user.rb +++ b/examples/rails-todo-list-app/app/models/user.rb @@ -17,7 +17,7 @@ def self.from_omniauth(auth_hash) if auth_hash[:credentials]['code'] user.redeem_code( auth_hash[:credentials]['code'], - 'https://localhost:9292/auth/azureactivedirectory/callback') + 'https://localhost:9292/auth/azure/callback') end user.save! user diff --git a/examples/rails-todo-list-app/config/initializers/omniauth.rb b/examples/rails-todo-list-app/config/initializers/omniauth.rb index b6e2903..67f6580 100644 --- a/examples/rails-todo-list-app/config/initializers/omniauth.rb +++ b/examples/rails-todo-list-app/config/initializers/omniauth.rb @@ -1,3 +1,3 @@ Rails.application.config.middleware.use OmniAuth::Builder do - provider :azure_activedirectory, ENV['CLIENT_ID'], ENV['TENANT'] + provider :azure, ENV['CLIENT_ID'], ENV['TENANT'] end diff --git a/examples/rails-todo-list-app/config/routes.rb b/examples/rails-todo-list-app/config/routes.rb index 9793782..6b5e405 100644 --- a/examples/rails-todo-list-app/config/routes.rb +++ b/examples/rails-todo-list-app/config/routes.rb @@ -6,7 +6,7 @@ resources :tasks, only: [:index, :update, :create, :destroy, :post] # This is where we send people to authenticate with OmniAuth. - get '/auth/azureactivedirectory', as: :sign_in + get '/auth/azure', as: :sign_in # This is where we are redirected if OmniAuth successfully authenicates # the user. diff --git a/examples/sinatra-multiple-providers-app/app.rb b/examples/sinatra-multiple-providers-app/app.rb index b242359..a0f96e7 100644 --- a/examples/sinatra-multiple-providers-app/app.rb +++ b/examples/sinatra-multiple-providers-app/app.rb @@ -31,7 +31,7 @@ <<-HTML

Hello there!

Sign in with Amazon - Sign in with AzureAD + Sign in with AzureAD Sign in with Github Sign in with Google HTML diff --git a/examples/sinatra-multiple-providers-app/config.ru b/examples/sinatra-multiple-providers-app/config.ru index 80bded5..73ed72b 100644 --- a/examples/sinatra-multiple-providers-app/config.ru +++ b/examples/sinatra-multiple-providers-app/config.ru @@ -37,7 +37,7 @@ use Rack::Session::Cookie, secret: 'top secret' use OmniAuth::Builder do provider :amazon, ENV['AMAZON_KEY'], ENV['AMAZON_SECRET'] - provider :azure_activedirectory, ENV['AAD_KEY'], ENV['AAD_TENANT'] + provider :azure, ENV['AAD_KEY'], ENV['AAD_TENANT'] provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET'] provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'] end diff --git a/lib/omniauth-azure-activedirectory.rb b/lib/omniauth-azure-activedirectory.rb index 7244309..6dd2758 100644 --- a/lib/omniauth-azure-activedirectory.rb +++ b/lib/omniauth-azure-activedirectory.rb @@ -20,4 +20,4 @@ # THE SOFTWARE. #------------------------------------------------------------------------------- -require 'omniauth/azure_activedirectory' +require 'omniauth/azure' diff --git a/lib/omniauth/azure_activedirectory.rb b/lib/omniauth/azure.rb similarity index 92% rename from lib/omniauth/azure_activedirectory.rb rename to lib/omniauth/azure.rb index 4cd64de..846ef7f 100644 --- a/lib/omniauth/azure_activedirectory.rb +++ b/lib/omniauth/azure.rb @@ -20,5 +20,5 @@ # THE SOFTWARE. #------------------------------------------------------------------------------- -require 'omniauth/azure_activedirectory/version' -require 'omniauth/strategies/azure_activedirectory' +require 'omniauth/azure/version' +require 'omniauth/strategies/azure' diff --git a/lib/omniauth/azure_activedirectory/version.rb b/lib/omniauth/azure/version.rb similarity index 97% rename from lib/omniauth/azure_activedirectory/version.rb rename to lib/omniauth/azure/version.rb index b007acd..baa4b2a 100644 --- a/lib/omniauth/azure_activedirectory/version.rb +++ b/lib/omniauth/azure/version.rb @@ -22,7 +22,7 @@ module OmniAuth # The release version. - module AzureActiveDirectory + module Azure VERSION = '1.0.0' end end diff --git a/lib/omniauth/strategies/azure_activedirectory.rb b/lib/omniauth/strategies/azure.rb similarity index 97% rename from lib/omniauth/strategies/azure_activedirectory.rb rename to lib/omniauth/strategies/azure.rb index 49cd905..3611e7d 100644 --- a/lib/omniauth/strategies/azure_activedirectory.rb +++ b/lib/omniauth/strategies/azure.rb @@ -28,8 +28,8 @@ module OmniAuth module Strategies # A strategy for authentication against Azure Active Directory. - class AzureActiveDirectory - include OmniAuth::AzureActiveDirectory + class Azure + include OmniAuth::Azure include OmniAuth::Strategy class OAuthError < StandardError; end @@ -42,7 +42,7 @@ class OAuthError < StandardError; end # require 'omniauth-azure-activedirectory' # # use OmniAuth::Builder do - # provider :azure_activedirectory, ENV['AAD_KEY'], ENV['AAD_TENANT'] + # provider :azure, ENV['AAD_KEY'], ENV['AAD_TENANT'] # end # args [:client_id, :tenant] @@ -332,4 +332,4 @@ def verify_options end end -OmniAuth.config.add_camelization 'azure_activedirectory', 'AzureActiveDirectory' +OmniAuth.config.add_camelization 'azure', 'Azure' diff --git a/omniauth-azure-activedirectory.gemspec b/omniauth-azure-activedirectory.gemspec index 5fd46ad..22526a4 100644 --- a/omniauth-azure-activedirectory.gemspec +++ b/omniauth-azure-activedirectory.gemspec @@ -1,9 +1,9 @@ $LOAD_PATH.push File.expand_path('../lib', __FILE__) -require 'omniauth/azure_activedirectory/version' +require 'omniauth/azure/version' Gem::Specification.new do |s| s.name = 'omniauth-azure-activedirectory' - s.version = OmniAuth::AzureActiveDirectory::VERSION + s.version = OmniAuth::Azure::VERSION s.author = 'Microsoft Corporation' s.email = 'nugetaad@microsoft.com' s.summary = 'Azure Active Directory strategy for OmniAuth' diff --git a/spec/omniauth/strategies/azure_activedirectory_spec.rb b/spec/omniauth/strategies/azure_activedirectory_spec.rb index dbdc791..7e79c10 100644 --- a/spec/omniauth/strategies/azure_activedirectory_spec.rb +++ b/spec/omniauth/strategies/azure_activedirectory_spec.rb @@ -25,7 +25,7 @@ # This was fairly awkward to test. I've stubbed every endpoint and am simulating # the state of the request. Especially large strings are stored in fixtures. -describe OmniAuth::Strategies::AzureActiveDirectory do +describe OmniAuth::Strategies::Azure do let(:app) { -> _ { [200, {}, ['Hello world.']] } } let(:x5c) { File.read(File.expand_path('../../../fixtures/x5c.txt', __FILE__)) }