Skip to content

Commit

Permalink
Add documentation and bump minor version for new feature
Browse files Browse the repository at this point in the history
  • Loading branch information
pond committed Jul 8, 2024
1 parent 66087dd commit fda1bd6
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log

## v2.2.0 (2024-07-09)

[Implements](https://github.com/RIPAGlobal/omniauth-azure-activedirectory-v2/pull/26) support for specifying `scope` via the authorisation URL, in addition to the prior support for static configuration or configuration via a custom provider class - thanks @nbgoodall!

## v2.1.0 (2023-09-16)

[Implements](https://github.com/RIPAGlobal/omniauth-azure-activedirectory-v2/pull/19) support for custom policies when using Microsoft Azure AD - thanks @stevenchanin!
Expand Down
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,15 @@ gem 'omniauth-azure-activedirectory-v2'

And then execute:

$ bundle install
```shell
$ bundle install
```

Or install it yourself as:

$ gem install omniauth-azure-activedirectory-v2

```shell
$ gem install omniauth-azure-activedirectory-v2
```


## Usage
Expand Down Expand Up @@ -162,6 +165,14 @@ In method `#authorize_params` above, the request object is used to look for a `l

> **NB:** Naming things is hard! The predecessor gem used the name `YouTenantProvider` since it was focused on custom tenant provision, but if using this in a more generic way, perhaps consider a more generic name such as, say, `CustomOmniAuthAzureProvider`.
#### Special case scope override

If required and more convenient, you can specify a custom `scope` value via generation of an authorisation URL including that required `scope`, rather than by using a custom provider class with `def scope...end` method. Include the `scope` value in your call to generate the URL thus:

```ruby
omniauth_authorize_url('resource_name_eg_user', 'azure_activedirectory_v2', scope: '...')
```



## Contributing
Expand All @@ -182,6 +193,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/RIPAGl
* Add tests and check that `bundle exec rspec` still runs successfully
* For new features (rather than bug fixes), update `README.md` with details



## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Expand Down
4 changes: 2 additions & 2 deletions lib/omniauth/azure_activedirectory_v2/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ module OmniAuth
module Azure
module Activedirectory
module V2
VERSION = "2.1.0"
DATE = "2023-09-16"
VERSION = "2.2.0"
DATE = "2024-07-09"
end
end
end
Expand Down

0 comments on commit fda1bd6

Please sign in to comment.