Changelog

SemVer 2.0.0 Keep-A-Changelog 1.0.0

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning,
and yes, platform and engine support are part of the public API.
Please file a bug if you notice a violation of semantic versioning.

Unreleased

Added

Changed

Deprecated

Removed

Fixed

Security

3.1.5 - 2025-10-13

  • TAG: v3.1.5
  • COVERAGE: 93.58% – 437/467 lines in 14 files
  • BRANCH COVERAGE: 81.00% – 81/100 branches in 14 files
  • 92.39% documented

Added

  • Adapter support for Hanami and ROM
  • Complete YARD documentation
  • kettle-dev for easier maintenance & dev tooling

3.1.4 - 2025-07-28

  • TAG: v3.1.4
  • COVERAGE: 92.06% – 348/378 lines in 15 files
  • BRANCH COVERAGE: 79.49% – 62/78 branches in 15 files
  • 44.44% documented

Added

  • More documentation
  • Tracking maintainability and coverage with QLTY.sh
  • Documentation site
    • https://omniauth-identity.galtzo.com
  • Test against bson v5.1.1
  • Test against locked and unlocked, runtime and development, dependencies

Changed

  • gemspec metadata
  • Test against latest bundler
  • Develop on ruby@3.4.5
  • Switch to Appraisal2

3.1.3 - 2025-06-08

  • TAG: v3.1.3
  • COVERAGE: 92.06% – 348/378 lines in 15 files
  • BRANCH COVERAGE: 79.49% – 62/78 branches in 15 files
  • 44.44% documented

Added

  • More documentation by @pboling
  • Expanded test suite, covering many more points of the dependency matrix by @pboling
  • Test workflows with latest dependencies and more platform and dep HEADs

Changed

  • Updated Code of Conduct to Contributor Covenant v2.1

Fixed

  • Set SKIP_GEM_SIGNING in env to allow gem build without cryptographic signing requirement by @pboling
    • Useful for linux distros whose package managers sign packages independently

3.1.2 - 2025-05-07

  • TAG: v3.1.2
  • COVERAGE: 92.02% – 346/376 lines in 15 files
  • BRANCH COVERAGE: 79.49% – 62/78 branches in 15 files

Added

  • 20 year signing cert expires 2045-04-29 by @pboling
  • Added CITATION.cff by @pboling
  • devcontainer for easier maintenance by @pboling
  • Improved documentation by @pboling
  • Greatly improved spec suite and CI config by @pboling
    • Testing against JRuby 9.2, 9.3, 9.4, 10.0, and head
    • Testing against many more combinations of Databases, ORMs, Rails, and Ruby versions

Changed

  • Upgraded Code of Conduct based on Contributor Covenant v2.1 by @pboling

3.1.1 - 2024-11-18

  • TAG: v3.1.1
  • COVERAGE: 92.00% – 345/375 lines in 15 files
  • BRANCH COVERAGE: 80.26% – 61/76 branches in 15 files
  • 44.44% documented

Added

  • PR 130 Add SECURITY.md policy by @pboling
  • PR 130 Add Maintainer contact email by @pboling

Changed

  • PR 130 Require MFA to publish to RubyGems.org by @pboling

3.1.0 - 2024-11-18

  • TAG: v3.1.0
  • COVERAGE: 91.98% – 344/374 lines in 15 files
  • BRANCH COVERAGE: 80.26% – 61/76 branches in 15 files
  • 44.44% documented

Added

  • PR #123 Improve readability in #identity method of OmniAuth::Strategies::Identity by @Xeragus
  • PR #124 Modernized gem structure, and updated dependencies for development by @pboling
    • Gem releases are now cryptographically signed
    • All ORM adapters (except NoBrainer) are tested in CI
  • PR #127 Improved documentation by @pboling
  • PR #128 Instructions for contributing by @pboling

Changed

  • Deprecate require 'omniauth/identity' by @pboling
    • in favor of require 'omniauth-identity' (matching the gem name)

Fixed

  • PR #120 Fix: handling of SCRIPT_NAME for registration_path by @btalbot
  • PR #122 Compatibility with rack v3.1+: use req.params[] instead of req[] by @emon
    • See: https://github.com/rack/rack/pull/2183

3.0.9 - 2021-06-16

Fixed

  • [Sequel] Fixes loading the Sequel adapter, issue reported as #112

Added

  • 📝 Document the Database adapters and drivers the gem currently works with

3.0.8 - 2021-03-24

Fixed

  • [Model] Fixes 2 issues raised in a comment on PR #108
    • When options[:on_validation] is set new/save/persisted? logic is used.
    • When options[:on_validation] is not set create/persisted? logic is used.

3.0.7 - 2021-03-23

Fixed

  • [ActiveRecord] Fixed #110 which prevented OmniAuth::Identity::Models::ActiveRecord-based records from saving.
  • [CouchPotato] Fixed OmniAuth::Identity::Models::CouchPotato’s #save.
  • [Sequel] Fixed OmniAuth::Identity::Models::Sequel’s #save.
  • [Model] Only define ::create, #save, and #persisted? when not already defined.
  • [Model] Restore original info functionality which set name based on first_name, last_name, or nickname

Changed

  • Upgraded to a newer OmniAuth::Identity::SecurePassword ripped from Rails 6-1-stable
    • Aeons ago the original was ripped from Rails 3.1, and frozen in time.
      While writing specs, it was discovered to be incompatible with this gem’s Sequel adapter.
    • Specs validate that the new version does work.
      In any case, the ripped version is only used when the has_secure_password macro is not yet defined in the class.

Added

  • New specs to cover real use cases and implementations of each ORM model adapter that ships with the gem:
    • ActiveRecord (Polyglot - Many Relational Databases)
    • Sequel (Polyglot - Many Relational Databases)
    • CouchPotato (CouchDB)
    • Mongoid (MongoDB)
    • NoBrainer (RethinkDB)

3.0.6 - 2021-03-20

Fixed

  • Fix breaking changes introduced by #108 which prevented :on_validation from firing

Added

  • New (or finally documented) options:
    • :create_identity_link_text defaults to 'Create an Identity'
    • :registration_failure_message defaults to 'One or more fields were invalid'
    • :validation_failure_message defaults to 'Validation failed'
    • :title defaults to 'Identity Verification'
    • :registration_form_title defaults to 'Register Identity'

3.0.5 - 2021-03-19

Fixed

  • Fix breaking changes introduced by #86’s introduction of :on_validation

Added

  • Define #save, #persisted? and ::create on Omniauth::Identity::Model
  • Add @since YARD tags to interface methods
  • Refactor Omniauth::Strategies::Identity.registration_phase to support Omniauth::Identity::Model-inheriting classes that do not define #save.
    • This support will be dropped in v4.0.

3.0.4 - 2021-02-14

Added

3.0.3 - 2021-02-14

Added

  • Add option :on_validation, which can be used to add a Captcha
  • Add support for nobrainer, an ORM for RethinkDB
  • Validation error message on invalid registration form submission

Removed

  • ruby-head build… simply too slow

3.0.2 - 2021-02-14

Fixed

  • Github Actions CI Build for Ruby 2.4, 3.0 and ruby-head
  • Updated copyright
  • Code style cleanup
  • Added Code Climate “Quality”
  • Updated Readme

3.0.1 - 2021-02-14

Fixed

  • Github Actions CI Build for various Rubies

3.0.0 - 2021-02-13

Added

  • Compatibility with Ruby 3
  • Add option :enable_login to bypass OmniAuth disabling of GET method (default true)
    • NOTE: This restores compatibility between this gem and the current, core, omniauth gem!
  • README updates, including a rename to README.md
  • CODE_OF_CONDUCT.md using v2
  • Rubocop
  • Github Actions for Continuous Integration
  • Minimum Ruby version = 2.4
  • Automatically adds “provider” => “identity” when “provider” column is detected
  • Documentation in README.md

Removed

  • Support for Rubies < 2.4
  • Support for DataMapper, which died long ago.
  • Unwanted git artifacts

2.0.0 - 2020-09-01

Added

  • CHANGELOG to maintain a history of changes.
  • Include mongoid-rspec gem.

Changed

  • Fix failing Specs
  • Update Spec syntax to RSpec 3
  • Fix deprecation Warnings
  • Updated mongoid_spec.rb to leverage mongoid-rspec features.
  • Fix security warning about missing secret in session cookie.
  • Dependency version limits so that the most up-to-date gem dependencies are used. (rspec 3+, mongo 2+, mongoid 7+, rake 13+, rack 2+, json 2+)
  • Updated copyright information.
  • Updated MongoMapper section of README to reflect its discontinued support.

Removed

  • Gemfile.lock file
  • MongoMapper support; unable to satisfy dependencies of both MongoMapper and Mongoid now that MongoMapper is no longer actively maintained.