omniauth-identity 3.0.8 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26637a55190cccdef70e9a1fc568005e23b7ebff9ba3ec6d2f5ea4398117f04d
-  data.tar.gz: d31d884aae50bd00c0d3820030c107def5bbcaf6507eb5628e068ac090ccc8c7
+  metadata.gz: 3eaf9c4edfdb4716551abeeb233e63716d4bbb6a2c90d921129d05e06434c3ed
+  data.tar.gz: ccb786b04aa010387b3d4d7ae369038a3760d52a1b9a7077e76e3051d364ca1f
 SHA512:
-  metadata.gz: 86f91851a1e9884d95e3b3d765176f8faed5c7acbf7d79e168d803a09275c228a5cfe1221ee5fedd69689fccbc2af04d4857342bf5ae273f7a4d873a5e7e36c7
-  data.tar.gz: 81462770cbbd476db63d133831a36710178fef1702f5277a8a13248c17bf3fd91bba74f81337239b43202b10c079a3196f2ce912452c803e387c13b0c7361214
+  metadata.gz: fdbb4c0951fca595a37d1efc13491c6eaba328d77cae2184624260b9bb643c6483a0d167296a36ab168d0dd2afafbc8a3be9df1dfeb6ba9fc7cd83556c02b1c3
+  data.tar.gz: 9d8385b53f5e46ed414f59c6a9acbcb62734b94df6b86224e0fa401da349cd44c1af57ff54d0ec01c100d2ccd8e003ea1c062eb1a7d772b404d82c0c2eda579b

data/CHANGELOG.md

@@ -8,6 +8,16 @@ 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

data/README.md

@@ -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
 
@@ -171,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
 
@@ -273,40 +282,41 @@ Please contribute some documentation if you have the gumption!  The maintainer's
 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
-   ```
+    - 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

data/lib/omniauth-identity/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module Identity
-    VERSION = '3.0.8'
+    VERSION = '3.0.9'
   end
 end

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

@@ -5,6 +5,9 @@ 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

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

@@ -5,9 +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

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

@@ -5,6 +5,8 @@ require 'mongoid'
 module OmniAuth
   module Identity
     module Models
+      # Mongoid is an ORM adapter for MongoDB:
+      #   https://github.com/mongodb/mongoid
       # NOTE: Mongoid is based on ActiveModel.
       module Mongoid
         def self.included(base)

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

@@ -5,7 +5,8 @@ require 'nobrainer'
 module OmniAuth
   module Identity
     module Models
-      # http://nobrainer.io/ an ORM for RethinkDB
+      # NoBrainer is an ORM adapter for RethinkDB:
+      #   http://nobrainer.io/
       # NOTE: NoBrainer is based on ActiveModel.
       module NoBrainer
         def self.included(base)

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

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'nobrainer'
+require 'sequel'
 
 module OmniAuth
   module Identity
     module Models
-      # http://sequel.jeremyevans.net/ an SQL ORM
+      # Sequel is an ORM adapter for the following databases:
+      #   ADO, Amalgalite, IBM_DB, JDBC, MySQL, Mysql2, ODBC, Oracle, PostgreSQL, SQLAnywhere, SQLite3, and TinyTDS
+      # The homepage is: http://sequel.jeremyevans.net/
       # NOTE: Sequel is *not* based on ActiveModel, but supports the API we need, except for `persisted?`:
       # * create
       # * save
@@ -22,8 +24,6 @@ module OmniAuth
 
             has_secure_password
 
-            alias_method :persisted?, :valid?
-
             def self.auth_key=(key)
               super
               validates_uniqueness_of :key, case_sensitive: false

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

@@ -14,6 +14,7 @@ RSpec.describe(OmniAuth::Identity::Models::ActiveRecord, sqlite3: true) do
         columns: OmniAuth::Identity::Model::SCHEMA_ATTRIBUTES | %w[provider password_digest],
         connection_params: { adapter: 'sqlite3', encoding: 'utf8', database: ':memory:' }
       ) do
+        auth_key :email
         def flower
           '🌸'
         end

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

@@ -18,6 +18,7 @@ RSpec.describe(OmniAuth::Identity::Models::Sequel, sqlite3: true) do
   before do
     sequel_test_identity = Class.new(Sequel::Model(:sequel_test_identities)) do
       include ::OmniAuth::Identity::Models::Sequel
+      auth_key :email
     end
     stub_const('SequelTestIdentity', sequel_test_identity)
   end

data/spec/omniauth/strategies/identity_spec.rb

@@ -17,6 +17,7 @@ RSpec.describe OmniAuth::Strategies::Identity, sqlite3: true do
       columns: OmniAuth::Identity::Model::SCHEMA_ATTRIBUTES | %w[provider password_digest],
       connection_params: { adapter: 'sqlite3', encoding: 'utf8', database: ':memory:' }
     ) do
+      auth_key :email
       def balloon
         '🎈'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-identity
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.0.9
 platform: ruby
 authors:
 - Peter Boling
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -160,7 +160,7 @@ 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.17
 signing_key:
 specification_version: 4
 summary: Traditional username/password based authentication system for OmniAuth