omniauth-identity 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e337a130887896ec09b2aa2a66fa1064a87b5aad59d1e068d484a2d2666f691
-  data.tar.gz: 7cdf49c8f0dc5db0d481233c91f9800932880d243f2c8311dc9336d3830d1296
+  metadata.gz: 629d1327cd3aa697de7139825ca429e8829886526da60aa233937643a56caf54
+  data.tar.gz: f8fa65f35a26646fcec82b86208da5a511e7639be3388997ede74e0b8df98ca8
 SHA512:
-  metadata.gz: 83e043a28067c4e22ce4be6932901eea262846000623626e73f9b6efa3ee2cd8a63263d93240d81173533d8db4e3a86815bf653814b26ced28b16b29e4787762
-  data.tar.gz: b12161b52c4d4f3b2d5e19d954ad965f0a7c73d4622a50f8004c2659ccd06445f19e20db23c81926f3ff9dc74930739f3f31d69c4da351e1208ea055832700a6
+  metadata.gz: 35d08b45518df49d12131b94fdd26110448161809153f782f709369f85488a30dda1bc2fc38121e19beda06c048bf1c8db5b2f901540ab10133bd52925cfe941
+  data.tar.gz: dc462e3a8e3733565d2d660bcf6495460e77376469f2cab70d140bff22a07c5f63b0fb3b09b94774956f1c9f47f67f2cbffdcf797e653cc112f31460a26b004a

data/CHANGELOG.md

@@ -8,6 +8,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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)
@@ -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
@@ -92,33 +101,6 @@ class Identity
 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
-
-Include the `OmniAuth::Identity::Models::DataMapper` 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
-
-  attr_accessor :password_confirmation
-end
-```
-
 ### CouchPotato
 
 Include the `OmniAuth::Identity::Models::CouchPotatoModule` mixin and specify fields that you will need.
@@ -139,13 +121,24 @@ 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
 

data/lib/omniauth-identity/version.rb

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

data/lib/omniauth/identity.rb

@@ -14,6 +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'
     end
   end
 end

data/lib/omniauth/identity/model.rb

@@ -39,7 +39,7 @@ 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

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'nobrainer'
+
+module OmniAuth
+  module Identity
+    module Models
+      # http://nobrainer.io/ an ORM for RethinkDB
+      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/strategies/identity.rb

@@ -9,27 +9,23 @@ module OmniAuth
       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
 
@@ -60,17 +56,11 @@ 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
 
@@ -81,15 +71,23 @@ module OmniAuth
         if model.respond_to?(:column_names) && model.column_names.include?('provider')
           attributes.reverse_merge!(provider: 'identity')
         end
-        @identity = model.create(attributes)
-        if @identity.persisted?
+        @identity = model.new(attributes)
+
+        # on_validation may run a Captcha or other validation mechanism
+        # Must return true when validation passes, false otherwise
+        if options[:on_validation] && !options[:on_validation].call(env: env)
+          if options[:on_failed_registration]
+            env['omniauth.identity'] = @identity
+            options[:on_failed_registration].call(env)
+          else
+            validation_message = 'Validation failed'
+            registration_form(validation_message)
+          end
+        elsif @identity.save && @identity.persisted?
           env['PATH_INFO'] = callback_path
           callback_phase
-        elsif options[:on_failed_registration]
-          env['omniauth.identity'] = @identity
-          options[:on_failed_registration].call(env)
         else
-          registration_form
+          show_custom_options_or_default
         end
       end
 
@@ -117,6 +115,42 @@ 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 show_custom_options_or_default
+        if options[:on_failed_registration]
+          env['omniauth.identity'] = @identity
+          options[:on_failed_registration].call(env)
+        else
+          validation_message = 'One or more fields were invalid'
+          registration_form(validation_message)
+        end
+      end
     end
   end
 end

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

@@ -5,7 +5,7 @@ RSpec.describe(OmniAuth::Identity::Models::ActiveRecord, db: true) 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,12 +1,14 @@
 # frozen_string_literal: true
 
-RSpec.describe(OmniAuth::Identity::Models::CouchPotatoModule, db: true) do
-  class CouchPotatoTestIdentity
-    include CouchPotato::Persistence
-    include OmniAuth::Identity::Models::CouchPotatoModule
-    auth_key :ham_sandwich
-  end
+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,13 +1,15 @@
 # frozen_string_literal: true
 
-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
+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/strategies/identity_spec.rb

@@ -8,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
@@ -203,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
 
@@ -226,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
 
@@ -250,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-identity
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Peter Boling
@@ -68,6 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: nobrainer
+  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: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -141,12 +155,14 @@ 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/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/secure_password_spec.rb
 - spec/omniauth/strategies/identity_spec.rb
 - spec/spec_helper.rb
@@ -179,6 +195,7 @@ test_files:
 - 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/secure_password_spec.rb
 - spec/omniauth/strategies/identity_spec.rb
 - spec/spec_helper.rb