omniauth-identity 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae0c6e9acba482e20f1284d42f157beb243b7efe00913b420e1d97ee158d0d2
-  data.tar.gz: c113d2a6e9f701ae8b7a524e7aede16bfce000f593f194e577b38a2cb02a10c0
+  metadata.gz: 3f6fae0f25aadccc74594334c90cf581c141a7fb68cbe50f26638648aa0fbbe4
+  data.tar.gz: 6998b461e27a72cc4da0cd4ca80f63e284fbf9fbff466b40ec1df736e511516d
 SHA512:
-  metadata.gz: 4f8cbd06676c3b16661651bf161e4bf819e8b48529aec572d2a7ddb52e5a4dde87bf52e71933be86af22486f03b4a4d5710417db79803b1bba93357258122330
-  data.tar.gz: 36a5d520208b6d0754d5d3e7fb7990b27b9bd967b598039bf6d37bf0e8167e2e8c7689df79a8aeee9a6d9187b2a1d2653d02e99025444157183d0072323807ae
+  metadata.gz: e209c51695fef0b79d0b57360acb1f9dc464a0424f96e1ab87b9847c0de7350c677a057c7cedb7e587428465c6fb8eaefb53a644fae18b5a9c574d82a0fdaf86
+  data.tar.gz: 542dd3902564af08c6c6653b381ce545278ef759e0b0861df62a8e19a118cabf022143db267c81525a26e944679770f8e8b62c1a4f93282c55505bcc56442dd4

data/CHANGELOG.md

@@ -6,9 +6,20 @@ 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]
+
+### Added
+- 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
+
+### Removed
+- Removed support for DataMapper, which died long ago.
+- Cleanup (removal) of unwanted git artifacts
+
 ## [2.0] - 2020-09-01
 
-### Added 
+### Added
 - CHANGELOG to maintain a history of changes.
 - Include mongoid-rspec gem.
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/{README.markdown → README.md}

@@ -6,24 +6,47 @@ 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
+
+## Installation
+
+To acquire the latest release from RubyGems add the following to your `Gemfile`:
+
+```ruby
+gem 'omniauth-identity'
+```
+
+If the git repository has new commits not yet in an official release, simply specify the repo instead:
+
+```ruby
+gem 'omniauth-identity', git: 'https://github.com/intridea/omniauth-identity.git'
+```
+
 ## Usage
 
 This can be a bit hard to understand the first time. Luckily, Ryan Bates made
 a [Railscast](http://railscasts.com/episodes/304-omniauth-identity) about it!
 
 You use `omniauth-identity` just like you would any other OmniAuth provider: as a
-Rack middleware. The basic setup for a email/password authentication would
-look something like this:
+Rack middleware. In rails, this would be created by an initializer, such as
+`config/initializers/omniauth.rb`. The basic setup for a email/password authentication would look something like this:
 
 ```ruby
 use OmniAuth::Builder do
-  provider :identity, :fields => [:email]
+  provider :identity,                        #mandatory: tells OA that the Identity strategy is being used
+           model: Identity,                  # optional: specifies the name of the "Identity" model. Defaults to "Identity"
+           fields: %i[email custom1 custom2] # optional: list of custom fields that are in the model's table
 end
 ```
 
-Next, you need to create a model (called `Identity by default`) 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.
+Next, you need to create a model (called `Identity` by default, or specified
+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.
 
 **Note:** OmniAuth Identity is different from many other user authentication
 systems in that it is *not* built to store authentication information in your primary
@@ -38,7 +61,10 @@ in the database for all of the fields you are using.
 
 ```ruby
 class Identity < OmniAuth::Identity::Models::ActiveRecord
-  # Add whatever you like!
+  auth_key :email    # optional: specifies the field within the model that will be used during the login process
+                     # defaults to email, but may be username, uid, login, etc.
+
+  # Anything else you want!
 end
 ```
 
@@ -60,12 +86,12 @@ end
 
 ### MongoMapper
 
-Unfortunately MongoMapper is **not supported** in `omniauth-identity` from >= v2.0 as a result of it 
+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. 
+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
 
@@ -82,7 +108,6 @@ class Identity
   property :password_digest, Text
 
   attr_accessor :password_confirmation
-
 end
 ```
 
@@ -98,15 +123,15 @@ class Identity
   property :email
   property :password_digest
 
-  def self.where search_hash
-    CouchPotato.database.view Identity.by_email(:key => search_hash)
+  def self.where(search_hash)
+    CouchPotato.database.view(Identity.by_email(key: search_hash))
   end
 
-  view :by_email, :key => :email
+  view :by_email, key: :email
 end
 ```
 
-Once you've got an Identity persistence model and the strategy up and
+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
@@ -121,14 +146,17 @@ different class.
 
 ```ruby
 use OmniAuth::Builder do
-  provider :identity, :fields => [:email], :model => MyCustomClass
+  provider :identity, fields: [:email], model: MyCustomClass
 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.
+
 ## Customizing Registration Failure
 
 To use your own custom registration form, create a form that POSTs to
-'/auth/identity/register' with 'password', 'password_confirmation', and your
+`/auth/identity/register` with `password`, `password_confirmation`, and your
 other fields.
 
 ```erb
@@ -144,7 +172,7 @@ other fields.
 Beware not to nest your form parameters within a namespace. This strategy
 looks for the form parameters at the top level of the post params. If you are
 using [simple\_form](https://github.com/plataformatec/simple_form), then you
-can avoid the params nesting by specifying <tt>:input_html</tt>.
+can avoid the params nesting by specifying `:input_html`.
 
 ```erb
 <%= simple_form_for @identity, :url => '/auth/identity/register' do |f| %>
@@ -159,13 +187,13 @@ can avoid the params nesting by specifying <tt>:input_html</tt>.
 
 Next you'll need to let OmniAuth know what action to call when a registration
 fails. In your OmniAuth configuration, specify any valid rack endpoint in the
-<tt>:on_failed_registration</tt> option.
+`:on_failed_registration` option.
 
 ```ruby
 use OmniAuth::Builder do
   provider :identity,
-    :fields => [:email],
-    :on_failed_registration => UsersController.action(:new)
+           fields: [:email],
+           on_failed_registration: UsersController.action(:new)
 end
 ```
 
@@ -182,15 +210,19 @@ within a particular subdomain.  To do so, add :locate_conditions to your config.
 The default value is:
 
 ```ruby
-:locate_conditions => lambda { |req| { model.auth_key => req['auth_key']} }
+use OmniAuth::Builder do
+  provider :identity,
+           locate_conditions: ->(req) { { model.auth_key => req['auth_key'] } }
+    # ...
+end
 ```
 
-locate_conditions takes a Proc object, and must return a hash.  The resulting hash is used
-as a parameter in the locate method for your ORM.  The proc is evaluated in the
-callback context, and has access to the Identity model (using `model`) and receives the request
-object as a parameter.  Note  that model.auth_key defaults to 'email', but is also configurable.
+`locate_conditions` takes a `Proc` object, and must return a `Hash` object, which will be used
+as the argument to the locate method for your ORM.  The proc is evaluated in the
+callback context, and has access to your `Identity` model (using `model`) and receives the request
+object as a parameter.  Note  that `model.auth_key` defaults to `email`, but is also configurable.
 
-Note: Be careful when customizing locate_conditions.  The best way to modify the conditions is
+Note: Be careful when customizing `locate_conditions`.  The best way to modify the conditions is
 to copy the default value, and then add to the hash.  Removing the default condition will almost
 always break things!
 
@@ -200,5 +232,6 @@ MIT License. See LICENSE for details.
 
 ## Copyright
 
-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.

data/lib/omniauth-identity/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Identity
-    VERSION = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

data/lib/omniauth/identity.rb

@@ -11,7 +11,6 @@ module OmniAuth
     module Models
       autoload :ActiveRecord,      'omniauth/identity/models/active_record'
       autoload :Mongoid,           'omniauth/identity/models/mongoid'
-      autoload :DataMapper,        'omniauth/identity/models/data_mapper'
       autoload :CouchPotatoModule, 'omniauth/identity/models/couch_potato'
     end
   end

data/lib/omniauth/identity/model.rb

@@ -28,6 +28,7 @@ module OmniAuth
         def authenticate(conditions, password)
           instance = locate(conditions)
           return false unless instance
+
           instance.authenticate(password)
         end
 
@@ -52,22 +53,20 @@ module OmniAuth
         raise NotImplementedError
       end
 
-      SCHEMA_ATTRIBUTES = %w(name email nickname first_name last_name location description image phone)
+      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 
+      # 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.inject({}) do |hash,attribute|
+        SCHEMA_ATTRIBUTES.each_with_object({}) do |attribute, hash|
           hash[attribute] = send(attribute) if respond_to?(attribute)
-          hash
         end
-        info
       end
 
       # An identifying string that must be globally unique to the
@@ -76,16 +75,17 @@ module OmniAuth
       # @return [String] An identifier string unique to this identity.
       def uid
         if respond_to?(:id)
-          return nil if self.id.nil?
-          self.id.to_s
+          return nil if id.nil?
+
+          id.to_s
         else
-          raise NotImplementedError 
+          raise NotImplementedError
         end
       end
 
       # Used to retrieve the user-supplied authentication key (e.g. a
       # username or email). Determined using the class method of the same name,
-      # defaults to `:email`. 
+      # defaults to `:email`.
       #
       # @return [String] An identifying string that will be entered by
       #   users upon sign in.

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

@@ -12,10 +12,11 @@ module OmniAuth
 
         def self.auth_key=(key)
           super
-          validates_uniqueness_of key, :case_sensitive => false
+          validates_uniqueness_of key, case_sensitive: false
         end
 
         def self.locate(search_hash)
+          search_hash = search_hash.reverse_merge!('provider' => 'identity') if column_names.include?('provider')
           where(search_hash).first
         end
       end

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

@@ -5,11 +5,8 @@ module OmniAuth
     module Models
       # can not be named CouchPotato since there is a class with that name
       module CouchPotatoModule
-
         def self.included(base)
-
           base.class_eval do
-
             include ::OmniAuth::Identity::Model
             include ::OmniAuth::Identity::SecurePassword
 
@@ -17,7 +14,7 @@ module OmniAuth
 
             def self.auth_key=(key)
               super
-              validates_uniqueness_of key, :case_sensitive => false
+              validates_uniqueness_of key, case_sensitive: false
             end
 
             def self.locate(search_hash)