omniauth-identity 3.0.2 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e337a130887896ec09b2aa2a66fa1064a87b5aad59d1e068d484a2d2666f691
-  data.tar.gz: 7cdf49c8f0dc5db0d481233c91f9800932880d243f2c8311dc9336d3830d1296
+  metadata.gz: 89bd05bb3cf63c0a47e41c8f955f9b076d5c6b4ae0704eda10819f801eaa6059
+  data.tar.gz: a272f35f9bcc0de8937279904e2bde912865b50ac3a7752dada19f0ec7d6868c
 SHA512:
-  metadata.gz: 83e043a28067c4e22ce4be6932901eea262846000623626e73f9b6efa3ee2cd8a63263d93240d81173533d8db4e3a86815bf653814b26ced28b16b29e4787762
-  data.tar.gz: b12161b52c4d4f3b2d5e19d954ad965f0a7c73d4622a50f8004c2659ccd06445f19e20db23c81926f3ff9dc74930739f3f31d69c4da351e1208ea055832700a6
+  metadata.gz: 26286ae10ba06b45b815bd21892ac27378eb338e446f0dcbe96037a8aa51d4097b55243ae12f5feef133577b1d793ce4732f636f930a6773c6b7e154e6256b4c
+  data.tar.gz: 11fc92beba0b8b849c1ce15784870bf4318aeaea14e5c7172f9c26b1891e357ba9603106765a5b2554c20d177a17c5e820bdb01733de169f3e67ec192f8d42e4

data/CHANGELOG.md

@@ -8,6 +8,80 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.7] - 2021-03-23
+
+### Fixed
+
+- \[ActiveRecord\] Fixed [#110](https://github.com/omniauth/omniauth-identity/issues/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](https://github.com/rails/rails/blob/6-1-stable/activemodel/lib/active_model/secure_password.rb)
+  - 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](https://github.com/omniauth/omniauth-identity/pull/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](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

data/README.md

@@ -1,5 +1,7 @@
 # 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)
@@ -8,7 +10,7 @@
 [![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.
@@ -17,7 +19,7 @@ basic construct for user management and then gets out of the way.
 
 This gem is compatible with, as of Feb 2021, version 3:
 
-* Latest released version of omniauth, v2.0.2 
+* Latest released version of omniauth, v2.0.2
 * Ruby 2.4, 2.5, 2.6, 2.7, 3.0, ruby-head
 
 ## Installation
@@ -56,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
@@ -76,57 +85,48 @@ 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(:identities)
+  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
-  include CouchPotato::Persistence
-  include OmniAuth::Identity::Models::CouchPotatoModule
+  # NOTE: CouchPotato::Persistence must be included before OmniAuth::Identity::Models::CouchPotatoModule
+  include ::CouchPotato::Persistence
+  include ::OmniAuth::Identity::Models::CouchPotatoModule
 
   property :email
   property :password_digest
@@ -139,13 +139,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
 
@@ -234,12 +246,75 @@ 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. 😭
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am ‘Added some feature’`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
+   - NOTE: In order to run *all* the tests you will need to have the following databases installed, configured, and running.
+     1. [RethinkDB](https://rethinkdb.com), an open source, real-time, web database, [installed](https://rethinkdb.com/docs/install/) and [running](https://rethinkdb.com/docs/start-a-server/), e.g.
+      ```bash
+      brew install rethinkdb
+      rethinkdb
+      ```
+      2. [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
+      ```bash
+      brew tap mongodb/brew
+      brew install mongodb-community@4.4
+      mongod --config /usr/local/etc/mongod.conf
+      ```
+      3. [CouchDB](https://couchdb.apache.org) (download the .app)
+   To run all tests on all databases:
+   ```bash
+   bundle exec rake
+   ```
+   To run a specific DB:
+   ```bash
+   # CouchDB / CouchPotato
+   bundle exec rspec spec spec_orms --tag 'couchdb'
+
+   # ActiveRecord and Sequel, as they both use the in-memory SQLite driver.
+   bundle exec rspec spec spec_orms --tag 'sqlite3'
+
+   # NOTE - mongoid and nobrainer specs can't be isolated with "tag" because it still loads everything,
+   #        and the two libraries are fundamentally incompatible.
+
+   # MongoDB / Mongoid
+   bundle exec rspec spec_orms/mongoid_spec.rb
+
+   # RethinkDB / NoBrainer
+   bundle exec rspec spec_orms/nobrainer_spec.rb
+   ```
+6. Create new Pull Request
+
 ## 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/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module Identity
-    VERSION = '3.0.2'
+    VERSION = '3.0.7'
   end
 end

data/lib/omniauth/identity.rb

@@ -14,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/nobrainer'
+      autoload :Sequel,            'omniauth/identity/models/sequel'
     end
   end
 end

data/lib/omniauth/identity/model.rb

@@ -4,24 +4,34 @@ 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
+        base.extend ClassCreateApi unless base.respond_to?(:create)
+        im = base.instance_methods
+        base.include InstanceSaveApi unless im.include?(:save)
+        base.include InstancePersistedApi unless im.include?(:persisted?)
       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
-
         # Authenticate a user with the given key and password.
         #
         # @param [String] key The unique login key provided for a given identity.
@@ -39,10 +49,60 @@ 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
+
+        # 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
+
+      module ClassCreateApi
+        # Persists a new Identity object to the ORM.
+        # Only included if the class doesn't define create, as a reminder to define create.
+        # 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
+        end
+      end
+
+      module InstanceSaveApi
+        # Persists a new Identity object to the ORM.
+        # Default raises an error.  Override as needed per ORM.
+        # This base version's arguments are modeled after ActiveModel
+        #   since it is a pattern many ORMs follow
+        #
+        # @abstract
+        # @return [Model] An instance of the identity model class.
+        # @since 3.0.5
+        def save(**_options, &_block)
+          raise NotImplementedError
+        end
+      end
+
+      module InstancePersistedApi
+        # Checks if the Identity object is persisted in the ORM.
+        # Default raises an error.  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
+        end
       end
 
       # Returns self if the provided password is correct, false
@@ -51,26 +111,10 @@ module OmniAuth
       # @abstract
       # @param [String] password The password to check.
       # @return [self or false] Self if authenticated, false if not.
-      def authenticate(password)
+      def authenticate(_password)
         raise NotImplementedError
       end
 
-      SCHEMA_ATTRIBUTES = %w[name email nickname first_name last_name location description image phone].freeze
-      # 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.
       #
@@ -113,6 +157,25 @@ module OmniAuth
           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
+        info = {}
+        SCHEMA_ATTRIBUTES.each_with_object(info) do |attribute, hash|
+          hash[attribute] = send(attribute) if respond_to?(attribute)
+        end
+        info['name'] ||= [info['first_name'], info['last_name']].join(' ').strip if info['first_name'] || info['last_name']
+        info['name'] ||= info['nickname']
+        info
+      end
     end
   end
 end