omniauth-identity 3.0.4 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5de20f544ddaf124fc1b80a0ea15d97d56572034cc985e72001e177c3da2c92
-  data.tar.gz: 21e59364dcba511bd658c7503b4dce12fb7c26e37b7f4bec3b05c91d0d1dd4c4
+  metadata.gz: 3eaf9c4edfdb4716551abeeb233e63716d4bbb6a2c90d921129d05e06434c3ed
+  data.tar.gz: ccb786b04aa010387b3d4d7ae369038a3760d52a1b9a7077e76e3051d364ca1f
 SHA512:
-  metadata.gz: ef710bfa64cef76922f89e93ca4292c106bda7e61cb8a49133452227f65163d2c5be70fade9ecc8d973ce35281a812d837edffe27be24689b34646c48109b07a
-  data.tar.gz: 812f288ec96fb46afa30a61fc34caa85b4efbe8857b8fb6dbeaeab9b2c181124db8b8deea40ebbccedcfc8b78d4039dbcad609782d0955a36423e543ba293865
+  metadata.gz: fdbb4c0951fca595a37d1efc13491c6eaba328d77cae2184624260b9bb643c6483a0d167296a36ab168d0dd2afafbc8a3be9df1dfeb6ba9fc7cd83556c02b1c3
+  data.tar.gz: 9d8385b53f5e46ed414f59c6a9acbcb62734b94df6b86224e0fa401da349cd44c1af57ff54d0ec01c100d2ccd8e003ea1c062eb1a7d772b404d82c0c2eda579b

data/CHANGELOG.md

@@ -8,6 +8,79 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.9] - 2021-06-16
+
+### Fixed
+
+- \[Sequel\] Fixes loading the Sequel adapter, issue reported as [#112](https://github.com/omniauth/omniauth-identity/issues/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](https://github.com/omniauth/omniauth-identity/pull/108#issuecomment-804456604)
+  - 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](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

data/README.md

@@ -10,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.
@@ -21,6 +21,15 @@ 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
+* At least 5 different database ORM adapters, which connect to 15 different database clients!
+
+| Databases | Adapter Libraries |
+|--------- | -------- |
+| MySQL, PostgreSQL, SQLite3 | [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html) |
+| CouchDB | [CouchPotato](https://github.com/langalex/couch_potato) |
+| MongoDB | [Mongoid](https://github.com/mongodb/mongoid) |
+| RethinkDB | [NoBrainer](http://nobrainer.io/) |
+| ADO, Amalgalite, IBM_DB, JDBC, MySQL, Mysql2, ODBC, Oracle, PostgreSQL, SQLAnywhere, SQLite3, and TinyTDS | [Sequel](http://sequel.jeremyevans.net) |
 
 ## Installation
 
@@ -93,8 +102,8 @@ Just include `OmniAuth::Identity::Models::Sequel` mixin, and specify
 whatever else you will need.
 
 ```ruby
-class SequelTestIdentity < Sequel::Model
-  include OmniAuth::Identity::Models::Sequel
+class SequelTestIdentity < Sequel::Model(:identities)
+  include ::OmniAuth::Identity::Models::Sequel
   auth_key :email
   # whatever else you want!
 end
@@ -108,8 +117,8 @@ fields that you will need.
 
 ```ruby
 class Identity
-  include Mongoid::Document
-  include OmniAuth::Identity::Models::Mongoid
+  include ::Mongoid::Document
+  include ::OmniAuth::Identity::Models::Mongoid
 
   field :email, type: String
   field :name, type: String
@@ -124,8 +133,9 @@ 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
@@ -147,8 +157,8 @@ fields that you will need.
 
 ```ruby
 class Identity
-  include NoBrainer::Document
-  include OmniAuth::Identity::Models::NoBrainer
+  include ::NoBrainer::Document
+  include ::OmniAuth::Identity::Models::NoBrainer
 
   auth_key :email
 end
@@ -170,7 +180,7 @@ end
 ```
 
 NOTE: In the above example, `MyCustomClass` must have a class method called `auth_key` that returns
- the default (`email`) or custom `auth_key` to use.
+the default (`email`) or custom `auth_key` to use.
 
 ## Customizing Registration Failure
 
@@ -245,12 +255,76 @@ 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.4'
+    VERSION = '3.0.9'
   end
 end

data/lib/omniauth/identity.rb

@@ -14,7 +14,7 @@ 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 :NoBrainer,         'omniauth/identity/models/nobrainer'
       autoload :Sequel,            'omniauth/identity/models/sequel'
     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.
@@ -43,6 +53,56 @@ module OmniAuth
 
           @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

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

@@ -5,9 +5,12 @@ require 'active_record'
 module OmniAuth
   module Identity
     module Models
+      # ActiveRecord is an ORM for MySQL, PostgreSQL, and SQLite3:
+      #   https://guides.rubyonrails.org/active_record_basics.html
+      # NOTE: ActiveRecord is based on ActiveModel.
       class ActiveRecord < ::ActiveRecord::Base
-        include OmniAuth::Identity::Model
-        include OmniAuth::Identity::SecurePassword
+        include ::OmniAuth::Identity::Model
+        include ::OmniAuth::Identity::SecurePassword
 
         self.abstract_class = true
         has_secure_password

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

@@ -5,7 +5,11 @@ require 'couch_potato'
 module OmniAuth
   module Identity
     module Models
-      # can not be named CouchPotato since there is a class with that name
+      # CouchPotato is an ORM adapter for CouchDB:
+      #   https://github.com/langalex/couch_potato
+      # NOTE: CouchPotato is based on ActiveModel.
+      # NOTE: CouchPotato::Persistence must be included before OmniAuth::Identity::Models::CouchPotatoModule
+      # NOTE: Includes "Module" in the name for invalid legacy reasons. Rename only with a major version bump.
       module CouchPotatoModule
         def self.included(base)
           base.class_eval do
@@ -22,6 +26,10 @@ module OmniAuth
             def self.locate(search_hash)
               where(search_hash).first
             end
+
+            def save
+              CouchPotato.database.save(self)
+            end
           end
         end
       end