omniauth-identity 3.0.1 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dcc9a20a3a2b96b6a97f6319eae36df210fed3cea3faa2f2251780e37ac1992
-  data.tar.gz: 1c5644fef5b8e3381063228ef0d9d512db76d4358643d4685f19ea35c7efefe0
+  metadata.gz: 469e5989686f13b8e924e7efc5cfbd2f205a13d45da6410f454f2d0b14e884ea
+  data.tar.gz: 38424bbbc877d8d18aa4a35916697c59b31379809e05e5ff620de0089f53759c
 SHA512:
-  metadata.gz: 900adc20c287fd19c5fb1545711a715a5235b51fd5f5cdff9f5e26445efe91e7db7fbdb59035ac64d1621c10b810183ff54beb701e940d6dd8908edb9e15532f
-  data.tar.gz: bb1f0af1551b7f9de8bf3ea602a11780feb2f40390cd752fe201157179d985529ab39df4373803acda4fd1e7927678ed844854ff0493c18d2f527fdc21af3608
+  metadata.gz: 1458cc73c99ca0bb267f9730d5e64daa8d6b7460720dd5790d443292cc8e938434190fcaf55195e5f039ffd50286018045ac2e0ed8c9a8e83eb5cae5878dcb62
+  data.tar.gz: 439a1bd2702a7d5a729be16ad65fdd079a6a867f9ffa26c823b63d675dcaf2127311097b4f51a8c42425c33aba1d490dc46abf92d4bdab6c0185e191952d244c

data/CHANGELOG.md

@@ -6,9 +6,61 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [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
@@ -20,6 +72,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documentation in README.md
 
 ### Removed
+
 - Support for Rubies < 2.4
 - Support for DataMapper, which died long ago.
 - Unwanted git artifacts
@@ -27,10 +80,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [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.1'
+    VERSION = '3.0.6'
   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