omniauth-identity 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6fae0f25aadccc74594334c90cf581c141a7fb68cbe50f26638648aa0fbbe4
-  data.tar.gz: 6998b461e27a72cc4da0cd4ca80f63e284fbf9fbff466b40ec1df736e511516d
+  metadata.gz: e486fff1d58be9ad944402aa2952bfceca493c6e78f1ba8c1e29cf6142543b01
+  data.tar.gz: a4be9557b902ff9dfe779baea964477aaf127519f8e389b82aa3cd83af3041da
 SHA512:
-  metadata.gz: e209c51695fef0b79d0b57360acb1f9dc464a0424f96e1ab87b9847c0de7350c677a057c7cedb7e587428465c6fb8eaefb53a644fae18b5a9c574d82a0fdaf86
-  data.tar.gz: 542dd3902564af08c6c6653b381ce545278ef759e0b0861df62a8e19a118cabf022143db267c81525a26e944679770f8e8b62c1a4f93282c55505bcc56442dd4
+  metadata.gz: 3f4d5a82e3ee782716992b1183cac66e6a29cee8037a8491a56bb8dd832ee9f22946eee7900d9e1d8d20d9bc5dcce3336652f25f606f027e87d79be6a9a00c6d
+  data.tar.gz: f2de6f02475fe119947bd6ba2f66e9585664b522833180e5327fcda8aa3b92c8fcb95d3bfb6baf45724851c1dd6c2a8144fe473f70715c6399b8025d73b195b2

data/CHANGELOG.md

@@ -8,22 +8,84 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.5] - 2021-03-19
+
+### Fixed
+
+- Fix breaking changes introduced by [#86's](https://github.com/omniauth/omniauth-identity/pull/86) 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
+
+- Add support for [sequel ORM](http://sequel.jeremyevans.net/)
+
+## [3.0.3] - 2021-02-14
+
+### Added
+
+- Add option `:on_validation`, which can be used to add a Captcha
+  - See [example here](https://github.com/omniauth/omniauth-identity/pull/86#issue-63225122)
+- 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] - 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
-- Removed support for DataMapper, which died long ago.
-- Cleanup (removal) of unwanted git artifacts
+
+- Support for Rubies < 2.4
+- Support for DataMapper, which died long ago.
+- Unwanted git artifacts
 
 ## [2.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

data/LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2020- Andrew Roberts, and Jellybooks Ltd.
+Copyright (c) 2021 OmniAuth-Identity Maintainers
+Copyright (c) 2020 Peter Boling, Andrew Roberts, and Jellybooks Ltd.
 Copyright (c) 2010-2015 Michael Bleigh and Intridea, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,16 +1,26 @@
 # OmniAuth Identity
 
+[![Version](https://img.shields.io/gem/v/omniauth-identity.svg)](https://rubygems.org/gems/omniauth-identity)
+[![Depfu](https://badges.depfu.com/badges/6c9b45362951b872127f9e46d39bed76/count.svg)](https://depfu.com/github/omniauth/omniauth-identity?project_id=22381)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fomniauth%2Fomniauth-identity%2Fbadge&style=flat)](https://actions-badge.atrox.dev/omniauth/omniauth-identity/goto)
+[![Maintainability](https://api.codeclimate.com/v1/badges/621d6211cb2e0959ce00/maintainability)](https://codeclimate.com/github/omniauth/omniauth-identity/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/621d6211cb2e0959ce00/test_coverage)](https://codeclimate.com/github/omniauth/omniauth-identity/test_coverage)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Open Source Helpers](https://www.codetriage.com/omniauth/omniauth-identity/badges/users.svg)](https://www.codetriage.com/omniauth/omniauth-identity)
+[![Downloads Rank](https://img.shields.io/gem/rd/omniauth-identity.svg)](https://rubygems.org/gems/omniauth-identity)
+
 The OmniAuth Identity gem provides a way for applications to utilize a
-traditional login/password based authentication system without the need
+traditional username/password based authentication system without the need
 to give up the simple authentication flow provided by OmniAuth. Identity
 is designed on purpose to be as featureless as possible: it provides the
 basic construct for user management and then gets out of the way.
 
 ## Compatibility
 
-This gem is compatible with, as of Feb 2021:
-• latest released version of omniauth, v2.0.2
-• Ruby 2.4, 2.5, 2.6, 2.7
+This gem is compatible with, as of Feb 2021, version 3:
+
+* Latest released version of omniauth, v2.0.2
+* Ruby 2.4, 2.5, 2.6, 2.7, 3.0, ruby-head
 
 ## Installation
 
@@ -48,6 +58,13 @@ with `:model` argument above) that will be able to persist the information
 provided by the user. Luckily for you, there are pre-built models for popular
 ORMs that make this dead simple.
 
+Once you've got an `Identity` persistence model and the strategy up and
+running, you can point users to `/auth/identity` and it will request
+that they log in or give them the opportunity to sign up for an account.
+Once they have authenticated with their identity, OmniAuth will call
+through to `/auth/identity/callback` with the same kinds of information
+it would had the user authenticated through an external provider.
+
 **Note:** OmniAuth Identity is different from many other user authentication
 systems in that it is *not* built to store authentication information in your primary
 `User` model. Instead, the `Identity` model should be **associated** with your
@@ -68,52 +85,42 @@ class Identity < OmniAuth::Identity::Models::ActiveRecord
 end
 ```
 
-### Mongoid
+### Sequel
 
-Include the `OmniAuth::Identity::Models::Mongoid` mixin and specify
-fields that you will need.
+[Sequel](http://sequel.jeremyevans.net/) is an alternative to ActiveRecord.
 
-```ruby
-class Identity
-  include Mongoid::Document
-  include OmniAuth::Identity::Models::Mongoid
+Just include `OmniAuth::Identity::Models::Sequel` mixin, and specify
+whatever else you will need.
 
-  field :email, type: String
-  field :name, type: String
-  field :password_digest, type: String
+```ruby
+class SequelTestIdentity < Sequel::Model
+  include OmniAuth::Identity::Models::Sequel
+  auth_key :email
+  # whatever else you want!
 end
 ```
 
-### MongoMapper
-
-Unfortunately MongoMapper is **not supported** in `omniauth-identity` from >= v2.0 as a result of it
-not being maintained for several years.
 
-It wasn't possible to include Mongoid *and* MongoMapper due to incompatible gem version
-requirements. Therefore precedence was given to Mongoid as it is significantly more
-popular and actively maintained.
-
-### DataMapper
+### Mongoid
 
-Include the `OmniAuth::Identity::Models::DataMapper` mixin and specify
+Include the `OmniAuth::Identity::Models::Mongoid` mixin and specify
 fields that you will need.
 
 ```ruby
 class Identity
-  include DataMapper::Resource
-  include OmniAuth::Identity::Models::DataMapper
-
-  property :id,              Serial
-  property :email,           String
-  property :password_digest, Text
+  include Mongoid::Document
+  include OmniAuth::Identity::Models::Mongoid
 
-  attr_accessor :password_confirmation
+  field :email, type: String
+  field :name, type: String
+  field :password_digest, type: String
 end
 ```
 
 ### CouchPotato
 
-Include the `OmniAuth::Identity::Models::CouchPotatoModule` mixin and specify fields that you will need.
+Include the `OmniAuth::Identity::Models::CouchPotatoModule` mixin and specify
+fields that you will need.
 
 ```ruby
 class Identity
@@ -131,13 +138,25 @@ class Identity
 end
 ```
 
-Once you've got an `Identity` persistence model and the strategy up and
-running, you can point users to `/auth/identity` and it will request
-that they log in or give them the opportunity to sign up for an account.
-Once they have authenticated with their identity, OmniAuth will call
-through to `/auth/identity/callback` with the same kinds of information
-it would had the user authenticated through an external provider.
-Simple!
+### NoBrainer
+
+[NoBrainer](http://nobrainer.io/) is an ORM for [RethinkDB](https://rethinkdb.com/).
+
+Include the `OmniAuth::Identity::Models::NoBrainer` mixin and specify
+fields that you will need.
+
+```ruby
+class Identity
+  include NoBrainer::Document
+  include OmniAuth::Identity::Models::NoBrainer
+
+  auth_key :email
+end
+```
+
+### Ruby Object Mapper
+
+Would love to add a mixin for the [Ruby Object Mapper (ROM)](https://rom-rb.org/) if anyone wants to work on it!
 
 ## Custom Auth Model
 
@@ -226,12 +245,32 @@ Note: Be careful when customizing `locate_conditions`.  The best way to modify t
 to copy the default value, and then add to the hash.  Removing the default condition will almost
 always break things!
 
+## Customizing Other Things
+
+From the code - here are the options we have for you, a couple of which are documented above, and the rest are documented... in the specs we hope!?
+```
+option :fields, %i[name email]
+
+      # Primary Feature Switches:
+option :enable_registration, true   # See #other_phase and #request_phase
+option :enable_login, true          # See #other_phase
+
+      # Customization Options:
+option :on_login, nil               # See #request_phase
+option :on_validation, nil          # See #registration_phase
+option :on_registration, nil        # See #registration_phase
+option :on_failed_registration, nil # See #registration_phase
+option :locate_conditions, ->(req) { { model.auth_key => req['auth_key'] } }
+```
+
+Please contribute some documentation if you have the gumption!  The maintainer's time is limited, and sometimes the authors of PRs with new options don't update the _this_ readme. 😭
+
 ## License
 
 MIT License. See LICENSE for details.
 
 ## Copyright
 
-Copyright (c) 2021 OmniAuth-Identity Maintainers
-Copyright (c) 2020 Peter Boling, Andrew Roberts, and Jellybooks Ltd.
-Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.
+* Copyright (c) 2021 OmniAuth-Identity Maintainers
+* Copyright (c) 2020 Peter Boling, Andrew Roberts, and Jellybooks Ltd.
+* Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.

data/lib/omniauth-identity.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'omniauth-identity/version'
 require 'omniauth/identity'

data/lib/omniauth-identity/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Identity
-    VERSION = '3.0.0'
+    VERSION = '3.0.5'
   end
 end

data/lib/omniauth/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'omniauth'
 
 module OmniAuth
@@ -12,6 +14,8 @@ module OmniAuth
       autoload :ActiveRecord,      'omniauth/identity/models/active_record'
       autoload :Mongoid,           'omniauth/identity/models/mongoid'
       autoload :CouchPotatoModule, 'omniauth/identity/models/couch_potato'
+      autoload :NoBrainer,         'omniauth/identity/models/no_brainer'
+      autoload :Sequel,            'omniauth/identity/models/sequel'
     end
   end
 end

data/lib/omniauth/identity/model.rb

@@ -1,24 +1,34 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Identity
     # This module provides an includable interface for implementing the
     # necessary API for OmniAuth Identity to properly locate identities
-    # and provide all necessary information. All methods marked as
-    # abstract must be implemented in the including class for things to
-    # work properly.
+    # and provide all necessary information.
+    #
+    # All methods marked as abstract must be implemented in the
+    # including class for things to work properly.
+    #
+    ### Singleton API
+    #
+    # * locate(key)
+    # * create(*args) - Deprecated in v3.0.5; Will be removed in v4.0
+    #
+    ### Instance API
+    #
+    # * save
+    # * persisted?
+    # * authenticate(password)
+    #
     module Model
+      SCHEMA_ATTRIBUTES = %w[name email nickname first_name last_name location description image phone].freeze
+
       def self.included(base)
         base.extend ClassMethods
       end
 
       module ClassMethods
-        # Locate an identity given its unique login key.
-        #
-        # @abstract
-        # @param [String] key The unique login key.
-        # @return [Model] An instance of the identity model class.
-        def locate(key)
-          raise NotImplementedError
-        end
+        extend Gem::Deprecate
 
         # Authenticate a user with the given key and password.
         #
@@ -37,10 +47,57 @@ module OmniAuth
         # @return [String] The method name.
         def auth_key(method = false)
           @auth_key = method.to_s unless method == false
-          @auth_key = nil if @auth_key == ''
+          @auth_key = nil if !defined?(@auth_key) || @auth_key == ''
 
           @auth_key || 'email'
         end
+
+        # Persists a new Identity object to the ORM.
+        # Defaults to calling super.  Override as needed per ORM.
+        #
+        # @deprecated v4.0 will begin using {#new} with {#save} instead.
+        # @abstract
+        # @param [Hash] args Attributes of the new instance.
+        # @return [Model] An instance of the identity model class.
+        # @since 3.0.5
+        def create(*args)
+          raise NotImplementedError unless defined?(super)
+
+          super
+        end
+
+        # Locate an identity given its unique login key.
+        #
+        # @abstract
+        # @param [String] key The unique login key.
+        # @return [Model] An instance of the identity model class.
+        def locate(key)
+          raise NotImplementedError
+        end
+      end
+
+      # Persists a new Identity object to the ORM.
+      # Default raises an error.  Override as needed per ORM.
+      #
+      # @abstract
+      # @return [Model] An instance of the identity model class.
+      # @since 3.0.5
+      def save
+        raise NotImplementedError unless defined?(super)
+
+        super
+      end
+
+      # Checks if the Identity object is persisted in the ORM.
+      # Defaults to calling super.  Override as needed per ORM.
+      #
+      # @abstract
+      # @return [true or false] true if object exists, false if not.
+      # @since 3.0.5
+      def persisted?
+        raise NotImplementedError unless defined?(super)
+
+        super
       end
 
       # Returns self if the provided password is correct, false
@@ -53,22 +110,6 @@ module OmniAuth
         raise NotImplementedError
       end
 
-      SCHEMA_ATTRIBUTES = %w[name email nickname first_name last_name location description image phone]
-      # A hash of as much of the standard OmniAuth schema as is stored
-      # in this particular model. By default, this will call instance
-      # methods for each of the attributes it needs in turn, ignoring
-      # any for which `#respond_to?` is `false`.
-      #
-      # If `first_name`, `nickname`, and/or `last_name` is provided but
-      # `name` is not, it will be automatically calculated.
-      #
-      # @return [Hash] A string-keyed hash of user information.
-      def info
-        SCHEMA_ATTRIBUTES.each_with_object({}) do |attribute, hash|
-          hash[attribute] = send(attribute) if respond_to?(attribute)
-        end
-      end
-
       # An identifying string that must be globally unique to the
       # application. Defaults to stringifying the `id` method.
       #
@@ -104,13 +145,28 @@ module OmniAuth
       # @param [String] value The value to which the auth key should be
       #   set.
       def auth_key=(value)
-        auth_key_setter = (self.class.auth_key + '=').to_sym
+        auth_key_setter = "#{self.class.auth_key}=".to_sym
         if respond_to?(auth_key_setter)
           send(auth_key_setter, value)
         else
           raise NotImplementedError
         end
       end
+
+      # A hash of as much of the standard OmniAuth schema as is stored
+      # in this particular model. By default, this will call instance
+      # methods for each of the attributes it needs in turn, ignoring
+      # any for which `#respond_to?` is `false`.
+      #
+      # If `first_name`, `nickname`, and/or `last_name` is provided but
+      # `name` is not, it will be automatically calculated.
+      #
+      # @return [Hash] A string-keyed hash of user information.
+      def info
+        SCHEMA_ATTRIBUTES.each_with_object({}) do |attribute, hash|
+          hash[attribute] = send(attribute) if respond_to?(attribute)
+        end
+      end
     end
   end
 end

data/lib/omniauth/identity/models/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 module OmniAuth

data/lib/omniauth/identity/models/couch_potato.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'couch_potato'
 
 module OmniAuth
   module Identity
     module Models
       # can not be named CouchPotato since there is a class with that name
+      # NOTE: CouchPotato is based on ActiveModel.
       module CouchPotatoModule
         def self.included(base)
           base.class_eval do

data/lib/omniauth/identity/models/mongoid.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 
 module OmniAuth
   module Identity
     module Models
+      # NOTE: Mongoid is based on ActiveModel.
       module Mongoid
         def self.included(base)
           base.class_eval do

data/lib/omniauth/identity/models/no_brainer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'nobrainer'
+
+module OmniAuth
+  module Identity
+    module Models
+      # http://nobrainer.io/ an ORM for RethinkDB
+      # NOTE: NoBrainer is based on ActiveModel.
+      module NoBrainer
+        def self.included(base)
+          base.class_eval do
+            include ::OmniAuth::Identity::Model
+            include ::OmniAuth::Identity::SecurePassword
+
+            has_secure_password
+
+            def self.auth_key=(key)
+              super
+              validates_uniqueness_of key, case_sensitive: false
+            end
+
+            def self.locate(search_hash)
+              where(search_hash).first
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/identity/models/sequel.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'nobrainer'
+
+module OmniAuth
+  module Identity
+    module Models
+      # http://sequel.jeremyevans.net/ an SQL ORM
+      # NOTE: Sequel is *not* based on ActiveModel, but supports the API we need, except for `persisted`:
+      # * create
+      # * save, but save is deprecated in favor of `save_changes`
+      module Sequel
+        def self.included(base)
+          base.class_eval do
+            # NOTE: Using the deprecated :validations_class_methods because it defines
+            #       validates_confirmation_of, while current :validation_helpers does not.
+            # plugin :validation_helpers
+            plugin :validation_class_methods
+
+            include OmniAuth::Identity::Model
+            include ::OmniAuth::Identity::SecurePassword
+
+            has_secure_password
+
+            alias_method :persisted?, :valid?
+
+            def self.auth_key=(key)
+              super
+              validates_uniqueness_of :key, case_sensitive: false
+            end
+
+            def self.locate(search_hash)
+              where(search_hash).first
+            end
+
+            def persisted?
+              exists?
+            end
+
+            def save
+              save_changes
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/identity/secure_password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bcrypt'
 
 module OmniAuth

data/lib/omniauth/strategies/identity.rb

@@ -1,33 +1,31 @@
+# frozen_string_literal: true
+
 module OmniAuth
   module Strategies
     # The identity strategy allows you to provide simple internal
     # user authentication using the same process flow that you
     # use for external OmniAuth providers.
     class Identity
+      DEFAULT_REGISTRATION_FIELDS = %i[password password_confirmation].freeze
       include OmniAuth::Strategy
-
       option :fields, %i[name email]
-      option :enable_login, true # See #other_phase documentation
-      option :on_login, nil
-      option :on_registration, nil
-      option :on_failed_registration, nil
-      option :enable_registration, true
+
+      # Primary Feature Switches:
+      option :enable_registration, true   # See #other_phase and #request_phase
+      option :enable_login, true          # See #other_phase
+
+      # Customization Options:
+      option :on_login, nil               # See #request_phase
+      option :on_validation, nil          # See #registration_phase
+      option :on_registration, nil        # See #registration_phase
+      option :on_failed_registration, nil # See #registration_phase
       option :locate_conditions, ->(req) { { model.auth_key => req['auth_key'] } }
 
       def request_phase
         if options[:on_login]
           options[:on_login].call(env)
         else
-          OmniAuth::Form.build(
-            title: (options[:title] || 'Identity Verification'),
-            url: callback_path
-          ) do |f|
-            f.text_field 'Login', 'auth_key'
-            f.password_field 'Password', 'password'
-            if options[:enable_registration]
-              f.html "<p align='center'><a href='#{registration_path}'>Create an Identity</a></p>"
-            end
-          end.to_response
+          build_omniauth_login_form.to_response
         end
       end
 
@@ -58,36 +56,32 @@ module OmniAuth
         end
       end
 
-      def registration_form
+      def registration_form(validation_message = nil)
         if options[:on_registration]
           options[:on_registration].call(env)
         else
-          OmniAuth::Form.build(title: 'Register Identity') do |f|
-            options[:fields].each do |field|
-              f.text_field field.to_s.capitalize, field.to_s
-            end
-            f.password_field 'Password', 'password'
-            f.password_field 'Confirm Password', 'password_confirmation'
-          end.to_response
+          build_omniauth_registration_form(validation_message).to_response
         end
       end
 
       def registration_phase
-        attributes = (options[:fields] + %i[password password_confirmation]).each_with_object({}) do |k, h|
+        attributes = (options[:fields] + DEFAULT_REGISTRATION_FIELDS).each_with_object({}) do |k, h|
           h[k] = request[k.to_s]
         end
         if model.respond_to?(:column_names) && model.column_names.include?('provider')
           attributes.reverse_merge!(provider: 'identity')
         end
-        @identity = model.create(attributes)
-        if @identity.persisted?
-          env['PATH_INFO'] = callback_path
-          callback_phase
-        elsif options[:on_failed_registration]
+        if saving_instead_of_creating?
+          @identity = model.new(attributes)
           env['omniauth.identity'] = @identity
-          options[:on_failed_registration].call(env)
+          if !validating? || valid?
+            @identity.save
+            registration_result
+          else
+            registration_failure('Validation failed')
+          end
         else
-          registration_form
+          deprecated_registration(attributes)
         end
       end
 
@@ -115,6 +109,80 @@ module OmniAuth
       def model
         options[:model] || ::Identity
       end
+
+      private
+
+      def build_omniauth_login_form
+        OmniAuth::Form.build(
+          title: (options[:title] || 'Identity Verification'),
+          url: callback_path
+        ) do |f|
+          f.text_field 'Login', 'auth_key'
+          f.password_field 'Password', 'password'
+          if options[:enable_registration]
+            f.html "<p align='center'><a href='#{registration_path}'>Create an Identity</a></p>"
+          end
+        end
+      end
+
+      def build_omniauth_registration_form(validation_message)
+        OmniAuth::Form.build(title: 'Register Identity') do |f|
+          f.html "<p style='color:red'>#{validation_message}</p>" if validation_message
+          options[:fields].each do |field|
+            f.text_field field.to_s.capitalize, field.to_s
+          end
+          f.password_field 'Password', 'password'
+          f.password_field 'Confirm Password', 'password_confirmation'
+        end
+      end
+
+      def saving_instead_of_creating?
+        model.respond_to?(:save) && model.respond_to?(:persisted?)
+      end
+
+      # Validates the model before it is persisted
+      #
+      # @return [truthy or falsey] :on_validation option is truthy or falsey
+      def validating?
+        options[:on_validation]
+      end
+
+      # Validates the model before it is persisted
+      #
+      # @return [true or false] result of :on_validation call
+      def valid?
+        # on_validation may run a Captcha or other validation mechanism
+        # Must return true when validation passes, false otherwise
+        !!options[:on_validation].call(env: env)
+      end
+
+      def registration_failure(message)
+        if options[:on_failed_registration]
+          options[:on_failed_registration].call(env)
+        else
+          registration_form(message)
+        end
+      end
+
+      def registration_result
+        if @identity.persisted?
+          env['PATH_INFO'] = callback_path
+          callback_phase
+        else
+          registration_failure('One or more fields were invalid')
+        end
+      end
+
+      def deprecated_registration(attributes)
+        warn <<~CREATEDEP
+          [DEPRECATION] Please define '#{model.class}#save'.
+                        Behavior based on '#{model.class}.create' will be removed in omniauth-identity v4.0.
+                        See lib/omniauth/identity/model.rb
+        CREATEDEP
+        @identity = model.create(attributes)
+        env['omniauth.identity'] = @identity
+        registration_result
+      end
     end
   end
 end

data/spec/omniauth/identity/model_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ExampleModel
   include OmniAuth::Identity::Model
 end

data/spec/omniauth/identity/models/active_record_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe(OmniAuth::Identity::Models::ActiveRecord, db: true) do
   describe 'model', type: :model do
     subject(:model_klass) do
       AnonymousActiveRecord.generate(
         parent_klass: 'OmniAuth::Identity::Models::ActiveRecord',
-        columns: %w[name provider],
+        columns: OmniAuth::Identity::Model::SCHEMA_ATTRIBUTES | %w[provider password_digest],
         connection_params: { adapter: 'sqlite3', encoding: 'utf8', database: ':memory:' }
       ) do
         def flower

data/spec/omniauth/identity/models/couch_potato_spec.rb

@@ -1,10 +1,14 @@
-RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, db: true) do
-  class CouchPotatoTestIdentity
-    include CouchPotato::Persistence
-    include OmniAuth::Identity::Models::CouchPotatoModule
-    auth_key :ham_sandwich
-  end
+# frozen_string_literal: true
+
+require 'couch_potato'
 
+class CouchPotatoTestIdentity
+  include CouchPotato::Persistence
+  include OmniAuth::Identity::Models::CouchPotatoModule
+  auth_key :ham_sandwich
+end
+
+RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, db: true) do
   describe 'model', type: :model do
     subject { CouchPotatoTestIdentity }
 

data/spec/omniauth/identity/models/mongoid_spec.rb

@@ -1,11 +1,15 @@
-RSpec.describe(OmniAuth::Identity::Models::Mongoid, db: true) do
-  class MongoidTestIdentity
-    include Mongoid::Document
-    include OmniAuth::Identity::Models::Mongoid
-    auth_key :ham_sandwich
-    store_in database: 'db1', collection: 'mongoid_test_identities', client: 'secondary'
-  end
+# frozen_string_literal: true
+
+require 'mongoid'
 
+class MongoidTestIdentity
+  include Mongoid::Document
+  include OmniAuth::Identity::Models::Mongoid
+  auth_key :ham_sandwich
+  store_in database: 'db1', collection: 'mongoid_test_identities', client: 'secondary'
+end
+
+RSpec.describe(OmniAuth::Identity::Models::Mongoid, db: true) do
   describe 'model', type: :model do
     subject { MongoidTestIdentity }
 

data/spec/omniauth/identity/models/no_brainer_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'nobrainer'
+
+class NobrainerTestIdentity
+  include NoBrainer::Document
+  include OmniAuth::Identity::Models::NoBrainer
+  auth_key :ham_sandwich
+end
+
+RSpec.describe(OmniAuth::Identity::Models::NoBrainer, db: true) do
+  it 'delegates locate to the where query method' do
+    allow(NobrainerTestIdentity).to receive(:where).with('ham_sandwich' => 'open faced',
+                                                         'category' => 'sandwiches').and_return(['wakka'])
+    expect(NobrainerTestIdentity.locate('ham_sandwich' => 'open faced', 'category' => 'sandwiches')).to eq('wakka')
+  end
+end

data/spec/omniauth/identity/models/sequel_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'sequel'
+# Connect to an in-memory sqlite3 database.
+DB = Sequel.sqlite
+DB.create_table :sequel_test_identities do
+  primary_key :id
+  String :ham_sandwich, null: false
+  String :password_digest, null: false
+end
+
+class SequelTestIdentity < Sequel::Model
+  include OmniAuth::Identity::Models::Sequel
+  auth_key :ham_sandwich
+end
+
+RSpec.describe(OmniAuth::Identity::Models::Sequel, db: true) do
+  it 'delegates locate to the where query method' do
+    allow(SequelTestIdentity).to receive(:where).with('ham_sandwich' => 'open faced',
+                                                      'category' => 'sandwiches').and_return(['wakka'])
+    expect(SequelTestIdentity.locate('ham_sandwich' => 'open faced', 'category' => 'sandwiches')).to eq('wakka')
+  end
+end

data/spec/omniauth/identity/secure_password_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HasTheMethod
   def self.has_secure_password; end
 end
@@ -8,17 +10,17 @@ end
 RSpec.describe OmniAuth::Identity::SecurePassword do
   it 'extends with the class methods if it does not have the method' do
     expect(DoesNotHaveTheMethod).to receive(:extend).with(OmniAuth::Identity::SecurePassword::ClassMethods)
-    DoesNotHaveTheMethod.include OmniAuth::Identity::SecurePassword
+    DoesNotHaveTheMethod.include described_class
   end
 
   it 'does not extend if the method is already defined' do
     expect(HasTheMethod).not_to receive(:extend)
-    HasTheMethod.include OmniAuth::Identity::SecurePassword
+    HasTheMethod.include described_class
   end
 
   it 'responds to has_secure_password afterwards' do
     [HasTheMethod, DoesNotHaveTheMethod].each do |klass|
-      klass.send(:include, OmniAuth::Identity::SecurePassword)
+      klass.send(:include, described_class)
       expect(klass).to be_respond_to(:has_secure_password)
     end
   end

data/spec/omniauth/strategies/identity_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe OmniAuth::Strategies::Identity do
   attr_accessor :app
 
@@ -6,7 +8,8 @@ RSpec.describe OmniAuth::Strategies::Identity do
   let(:identity_options) { {} }
   let(:anon_ar) do
     AnonymousActiveRecord.generate(
-      columns: %w[name provider],
+      parent_klass: 'OmniAuth::Identity::Models::ActiveRecord',
+      columns: OmniAuth::Identity::Model::SCHEMA_ATTRIBUTES | %w[provider password_digest],
       connection_params: { adapter: 'sqlite3', encoding: 'utf8', database: ':memory:' }
     ) do
       def balloon
@@ -201,16 +204,10 @@ RSpec.describe OmniAuth::Strategies::Identity do
         }
       end
 
-      before do
-        allow(anon_ar).to receive('auth_key').and_return('email')
-        m = double(uid: 'abc', name: 'Awesome Dude', email: 'awesome@example.com',
-                   info: { name: 'DUUUUDE!' }, persisted?: true)
-        expect(anon_ar).to receive(:create).with(properties).and_return(m)
-      end
-
       it 'sets the auth hash' do
         post '/auth/identity/register', properties
-        expect(auth_hash['uid']).to eq('abc')
+        expect(auth_hash['uid']).to match(/\d+/)
+        expect(auth_hash['provider']).to eq('identity')
       end
     end
 
@@ -224,16 +221,17 @@ RSpec.describe OmniAuth::Strategies::Identity do
           provider: 'identity'
         }
       end
-      let(:invalid_identity) { double(persisted?: false) }
+      let(:invalid_identity) { double(persisted?: false, save: false) }
 
       before do
-        expect(anon_ar).to receive(:create).with(properties).and_return(invalid_identity)
+        expect(anon_ar).to receive(:new).with(properties).and_return(invalid_identity)
       end
 
       context 'default' do
         it 'shows registration form' do
           post '/auth/identity/register', properties
           expect(last_response.body).to be_include('Register Identity')
+          expect(last_response.body).to be_include('One or more fields were invalid')
         end
       end
 
@@ -248,6 +246,7 @@ RSpec.describe OmniAuth::Strategies::Identity do
           post '/auth/identity/register', properties
           expect(identity_hash).to eq(invalid_identity)
           expect(last_response.body).to be_include("FAIL'DOH!")
+          expect(last_response.body).not_to be_include('One or more fields were invalid')
         end
       end
     end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'simplecov' if ruby_version >= Gem::Version.new('2.7') && RUBY_ENGINE ==
 require 'rack/test'
 require 'mongoid-rspec'
 require 'sqlite3'
+require 'sequel'
 require 'anonymous_active_record'
 require 'byebug' if RUBY_ENGINE == 'ruby'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-identity
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.5
 platform: ruby
 authors:
 - Peter Boling
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -41,61 +41,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: anonymous_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: anonymous_active_record
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.8
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: nobrainer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -139,132 +131,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Internal authentication handlers for OmniAuth.
+        version: '1.4'
+description: Traditional username/password based authentication system for OmniAuth
 email:
 executables: []
 extensions: []
@@ -281,12 +175,16 @@ files:
 - lib/omniauth/identity/models/active_record.rb
 - lib/omniauth/identity/models/couch_potato.rb
 - lib/omniauth/identity/models/mongoid.rb
+- lib/omniauth/identity/models/no_brainer.rb
+- lib/omniauth/identity/models/sequel.rb
 - lib/omniauth/identity/secure_password.rb
 - lib/omniauth/strategies/identity.rb
 - spec/omniauth/identity/model_spec.rb
 - spec/omniauth/identity/models/active_record_spec.rb
 - spec/omniauth/identity/models/couch_potato_spec.rb
 - spec/omniauth/identity/models/mongoid_spec.rb
+- spec/omniauth/identity/models/no_brainer_spec.rb
+- spec/omniauth/identity/models/sequel_spec.rb
 - spec/omniauth/identity/secure_password_spec.rb
 - spec/omniauth/strategies/identity_spec.rb
 - spec/spec_helper.rb
@@ -310,15 +208,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.2.9
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Internal authentication handlers for OmniAuth.
+summary: Traditional username/password based authentication system for OmniAuth
 test_files:
-- spec/spec_helper.rb
-- spec/omniauth/identity/models/mongoid_spec.rb
+- spec/omniauth/identity/model_spec.rb
 - spec/omniauth/identity/models/active_record_spec.rb
 - spec/omniauth/identity/models/couch_potato_spec.rb
+- spec/omniauth/identity/models/mongoid_spec.rb
+- spec/omniauth/identity/models/no_brainer_spec.rb
+- spec/omniauth/identity/models/sequel_spec.rb
 - spec/omniauth/identity/secure_password_spec.rb
-- spec/omniauth/identity/model_spec.rb
 - spec/omniauth/strategies/identity_spec.rb
+- spec/spec_helper.rb