challah 1.6.1 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c23a580c2dfe4d78653d75a44f1a1f5f0c54b3d62c7091ce0089621e35add4
-  data.tar.gz: 839e41cf3038d7e8319d476268abad5004a8adbbedcf5eba2fbb1119ddef9b23
+  metadata.gz: 0b260522736245710527baecf3c8060c67609feee2619eb460c36771350aa8ac
+  data.tar.gz: f94497f70a4ad972954284a54ebfe997757d5d08ae7c2dc320f947fc147731f5
 SHA512:
-  metadata.gz: f91ad595ae383d6775e533f1cc60053be1221d824ff351b6ea6f24a22eed1e9ea6ff3172f82f6930a7aa522e6e910d0bb3b0e3a86a457a5e5d79368196c86938
-  data.tar.gz: c5b43537d21543b4d9d3eb2aa3791b669c9d91c26050f4211a07c5bf7bea5f5b9f5081e0de239fb8519cef8c61fdba3e9a05bbf18ec2c5a2a3341b86011af93a
+  metadata.gz: 66bb3654fc8a8204075bb6e5645486a233a591eb57e37a20b3b979bab4961ab2b67c6b130479b977796eef88aadef49e4b7ec4b114b90fbbfcfac2809884234d
+  data.tar.gz: f93ed733130b3b69a128fde0cd8c4bc36e9989b4ac340410c72fa32b2e6498838860f4cc18e2c780adc3b2129d069efe3fe9e8be086c7f407770b39bcae4a16c

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Challah 2.0.0.beta1
+
+This version introduces the following breaking changes, and therefore a new major version number:
+
+* Plugins no longer supported. This was never fully baked and was only used for the now defunct challah-rolls library, which is no longer maintained.
+* Drops support for Rails 4
+* Drops support for Ruby prior to 2.5.0
+* Removes legacy support for boolean-based User#active column in favor of enums on User#status
+
+Plus the following new changes:
+
+* Support for Rails 6.0
+* Authorizations table is now properly set as a foreign key to users (for new installations only, for existing tables you can do this yourself)
+
 ## Challah 1.6.1
 
 * Prevent an email address that is blank from saving the `User#email_hash` attribute

data/README.md

@@ -1,6 +1,6 @@
 # Challah
 
-[![Build Status](https://travis-ci.org/jdtornow/challah.svg?branch=master)](https://travis-ci.org/jdtornow/challah) [![Code Climate](https://codeclimate.com/github/jdtornow/challah/badges/gpa.svg)](https://codeclimate.com/github/jdtornow/challah) [![Gem Version](https://badge.fury.io/rb/challah.svg)](https://badge.fury.io/rb/challah)
+[![CircleCI](https://circleci.com/gh/jdtornow/challah.svg?style=svg)](https://circleci.com/gh/jdtornow/challah) [![Code Climate](https://codeclimate.com/github/jdtornow/challah/badges/gpa.svg)](https://codeclimate.com/github/jdtornow/challah) [![Gem Version](https://badge.fury.io/rb/challah.svg)](https://badge.fury.io/rb/challah)
 
 Challah (pronounced HAH-lah) is a simple Rails authentication gem that provides users a way to authenticate with your app. Most of the functionality within the gem lives within a Rails engine and tries to stay out of the way of your app.
 
@@ -8,9 +8,8 @@ Challah doesn't provide any fancy controllers or views that clutter your app or
 
 ## Requirements
 
-* Ruby 2.2.2+
-* Bundler
-* Rails 5.0+
+* Ruby 2.5.0+
+* Rails 5.2+
 
 ## Installation
 
@@ -35,7 +34,7 @@ This will copy over the necessary migrations to your app and migrate the databas
 If you would prefer to handle these steps manually, you can do so by using these rake tasks instead:
 
 ```bash
-rails g challah
+rails generate challah
 rails challah:unpack:user
 rails db:migrate
 ```
@@ -187,7 +186,7 @@ curl -H "X-App-User: abc123" \
 
 _Note: Custom HTTP headers should always start with X-_
 
-## ActionCable in Rails 5
+## ActionCable
 
 Challah works well with securing your ActionCable channels since Rails 5. Here is a sample `ApplicationCable::Connection` file to secure connections to a valid signed-in user:
 
@@ -215,38 +214,6 @@ module ApplicationCable
 end
 ```
 
-## Upgrading to Challah 1.4+
-
-In Challah 1.4, the `active` boolean column changed to a `status` Rails enum with "active" as the default option. To upgrade a users table, use the following migration example:
-
-```bash
-rails g migration ConvertUsersActiveToEnum
-```
-
-```ruby
-class ConvertUsersActiveToEnum < ActiveRecord::Migration
-  def up
-    add_column :users, :status, :integer, default: 0
-
-    say_with_time "Converting users to status enum" do
-      User.where(active: false).update_all(status: User.statuses[:inactive])
-    end
-
-    remove_column :users, :active
-  end
-
-  def down
-    add_column :users, :active, :boolean, default: true
-
-    say_with_time "Converting users to active boolean" do
-      User.where(status: User.statuses[:inactive]).update_all(active: false)
-    end
-
-    remove_column :users, :status
-  end
-end
-```
-
 ## User Validations
 
 By default, the `first_name`, `last_name`, and `email` fields are required on the user model. If you'd prefer to add your own validations and leave the defaults off, you can use the following option within an initializer:

data/VERSION

@@ -1 +1 @@
-1.6.1
+2.0.0.beta1

data/app/controllers/sessions_controller.rb

@@ -3,6 +3,7 @@ if File.exist?(Rails.root.join("controllers/application_controller"))
 end
 
 class SessionsController < (defined?(ApplicationController) ? ApplicationController : ActionController::Base)
+
   before_action :destroy_session, except: :create
 
   # GET /login
@@ -20,7 +21,7 @@ class SessionsController < (defined?(ApplicationController) ? ApplicationControl
     if @session.save
       redirect_to return_to_path
     else
-      redirect_to signin_path, alert: I18n.translate('sessions.create.failed_login')
+      redirect_to signin_path, alert: I18n.translate("sessions.create.failed_login")
     end
   end
 
@@ -32,14 +33,14 @@ class SessionsController < (defined?(ApplicationController) ? ApplicationControl
 
   protected
 
-  def destroy_session
-    current_user_session.destroy
-  end
+    def destroy_session
+      current_user_session.destroy
+    end
 
-  def return_to_path(default_path = '/')
-    result = session[:return_to]
-    result = nil if result and result == "http://#{request.domain}/"
-    result || default_path
-  end
-end
+    def return_to_path(default_path = "/")
+      result = session[:return_to]
+      result = nil if result && (result == "http://#{ request.domain }/")
+      result || default_path
+    end
 
+end

data/app/models/authorization.rb

@@ -1,3 +1,5 @@
 class Authorization < ActiveRecord::Base
+
   include Challah::Authorizeable
+
 end

data/lib/challah/audit.rb

@@ -28,6 +28,7 @@ module Challah
   #       end
   #
   module Audit
+
     extend ActiveSupport::Concern
 
     included do
@@ -58,53 +59,54 @@ module Challah
 
     private
 
-    def before_save_audit
-      if new_record?
-        all_audit_attributes.map(&:to_s).each do |column|
-          if respond_to?(column) && respond_to?("#{ column }=")
-            write_attribute(column, current_user_id)
+      def before_save_audit
+        if new_record?
+          all_audit_attributes.map(&:to_s).each do |column|
+            if respond_to?(column) && respond_to?("#{ column }=")
+              write_attribute(column, current_user_id)
+            end
           end
-        end
-      else
-        audit_attributes_for_update.map(&:to_s).each do |column|
-          if respond_to?(column) && respond_to?("#{ column }=")
-            next if attribute_changed?(column) # don't update the column if we already manually did
-            write_attribute(column, current_user_id)
+        else
+          audit_attributes_for_update.map(&:to_s).each do |column|
+            if respond_to?(column) && respond_to?("#{ column }=")
+              next if attribute_changed?(column) # don't update the column if we already manually did
+              write_attribute(column, current_user_id)
+            end
           end
         end
       end
-    end
-
-    # @private
-    def audit_attributes_for_update
-      [ :updated_by, :modifed_by, :updated_user_id ]
-    end
 
-    # @private
-    def audit_attributes_for_create
-      [ :created_by, :created_user_id ]
-    end
+      # @private
+      def audit_attributes_for_update
+        [ :updated_by, :modifed_by, :updated_user_id ]
+      end
 
-    # @private
-    def all_audit_attributes
-      audit_attributes_for_update + audit_attributes_for_create
-    end
+      # @private
+      def audit_attributes_for_create
+        [ :created_by, :created_user_id ]
+      end
 
-    # Clear attributes and changed_attributes
-    def clear_audit_attributes
-      all_audit_attributes.each do |attribute_name|
-        if respond_to?(attribute_name) && respond_to?("#{ attribute_name }=")
-          write_attribute(attribute_name, nil)
-        end
+      # @private
+      def all_audit_attributes
+        audit_attributes_for_update + audit_attributes_for_create
       end
 
-      @changed_attributes = changed_attributes.reduce(ActiveSupport::HashWithIndifferentAccess.new) do |result, (key, value)|
-        unless all_audit_attributes.include?(key.to_sym)
-          result[key] = value
+      # Clear attributes and changed_attributes
+      def clear_audit_attributes
+        all_audit_attributes.each do |attribute_name|
+          if respond_to?(attribute_name) && respond_to?("#{ attribute_name }=")
+            write_attribute(attribute_name, nil)
+          end
         end
 
-        result
+        @changed_attributes = changed_attributes.reduce(ActiveSupport::HashWithIndifferentAccess.new) do |result, (key, value)|
+          unless all_audit_attributes.include?(key.to_sym)
+            result[key] = value
+          end
+
+          result
+        end
       end
-    end
+
   end
 end

data/lib/challah/authenticators/api_key.rb

@@ -1,9 +1,11 @@
 module Challah
   module Authenticators
     class ApiKey
+
       def self.match?(user, provider, api_key)
-        user.api_key ==  api_key.to_s.strip
+        user.api_key == api_key.to_s.strip
       end
+
     end
   end
-end
+end

data/lib/challah/authenticators/password.rb

@@ -1,6 +1,7 @@
 module Challah
   module Authenticators
     class Password
+
       def self.match?(user, provider, plain_password)
         if !!provider
           crypted_password = provider.fetch(:token)
@@ -9,6 +10,7 @@ module Challah
 
         false
       end
+
     end
   end
-end
+end

data/lib/challah/authenticators.rb

@@ -1,8 +1,9 @@
-require 'challah/authenticators/api_key'
-require 'challah/authenticators/password'
+require "challah/authenticators/api_key"
+require "challah/authenticators/password"
 
 module Challah
   module Authenticators
+
     # Register a new authenticator.
     #
     # Usage:
@@ -19,5 +20,6 @@ module Challah
     def authenticators
       @authenticators.dup
     end
+
   end
-end
+end

data/lib/challah/concerns/authorizeable.rb

@@ -1,5 +1,6 @@
 module Challah
   module Authorizeable
+
     extend ActiveSupport::Concern
 
     included do
@@ -12,6 +13,7 @@ module Challah
     end
 
     module ClassMethods
+
       def hashable_attributes
         protected_attributes = %w( user_id provider last_session_at last_session_ip session_count created_at updated_at )
         @hashable_attributes ||= self.columns.map(&:name) - protected_attributes
@@ -63,6 +65,8 @@ module Challah
       def user_model
         @user_model ||= Challah.user
       end
+
     end
+
   end
 end

data/lib/challah/concerns/user/attributeable.rb

@@ -1,5 +1,6 @@
 module Challah
   module UserAttributeable
+
     extend ActiveSupport::Concern
 
     included do
@@ -30,50 +31,51 @@ module Challah
 
     protected
 
-    # Ensure that all system-generated columns aren't blank on each save
-    def ensure_user_tokens
-      ensure_api_key_presence
-      ensure_email_hash_presence
-      ensure_persistence_token_presence
-    end
+      # Ensure that all system-generated columns aren't blank on each save
+      def ensure_user_tokens
+        ensure_api_key_presence
+        ensure_email_hash_presence
+        ensure_persistence_token_presence
+      end
 
-    # Store a random seed for this user's api key
-    def ensure_api_key_presence
-      if respond_to?("api_key=")
-        if self.api_key.to_s.blank?
-          self.api_key = Random.token(50)
+      # Store a random seed for this user's api key
+      def ensure_api_key_presence
+        if respond_to?("api_key=")
+          if self.api_key.to_s.blank?
+            self.api_key = Random.token(50)
+          end
         end
       end
-    end
 
-    # Store a hashed email if the column exists
-    def ensure_email_hash_presence
-      if respond_to?("email_hash=")
-        if email_changed?
-          self.email_hash = generate_email_hash
+      # Store a hashed email if the column exists
+      def ensure_email_hash_presence
+        if respond_to?("email_hash=")
+          if email_changed?
+            self.email_hash = generate_email_hash
+          end
         end
       end
-    end
 
-    # Store a random token to identify user in persisted objects
-    def ensure_persistence_token_presence
-      if respond_to?("persistence_token=")
-        if self.persistence_token.to_s.blank?
-          self.persistence_token = Random.token(125)
+      # Store a random token to identify user in persisted objects
+      def ensure_persistence_token_presence
+        if respond_to?("persistence_token=")
+          if self.persistence_token.to_s.blank?
+            self.persistence_token = Random.token(125)
+          end
         end
       end
-    end
 
-    def generate_email_hash
-      if self.email.present?
-        Encrypter.md5(email.to_s.downcase.strip)
+      def generate_email_hash
+        if self.email.present?
+          Encrypter.md5(email.to_s.downcase.strip)
+        end
+      end
+
+      # Downcase email and strip if of whitespace
+      # Ex: "   HELLO@example.com   " => "hello@example.com"
+      def normalize_user_email
+        self.email = self.email.to_s.downcase.strip
       end
-    end
 
-    # Downcase email and strip if of whitespace
-    # Ex: "   HELLO@example.com   " => "hello@example.com"
-    def normalize_user_email
-      self.email = self.email.to_s.downcase.strip
-    end
   end
 end

data/lib/challah/concerns/user/authenticateable.rb

@@ -1,5 +1,6 @@
 module Challah
   module UserAuthenticateable
+
     # Generic authentication method. By default, this just checks to see if the password
     # given matches this user. You can also pass in the first parameter as the method
     # to use for a different type of authentication.
@@ -39,5 +40,6 @@ module Challah
       self.save
       self.increment!(:session_count, 1)
     end
+
   end
 end

data/lib/challah/concerns/user/authorizable.rb

@@ -1,5 +1,6 @@
 module Challah
   module UserAuthorizable
+
     extend ActiveSupport::Concern
 
     included do
@@ -8,25 +9,28 @@ module Challah
       before_destroy :clear_authorizations_before_destroy
     end
 
-    protected
-
     def authorizations
       return [] if new_record?
       self.class.authorization_model.where(user_id: self.id)
     end
 
-    def clear_authorizations_before_destroy
-      authorizations.destroy_all
-    end
+    protected
 
-    module ClassMethods
-      def authorizations_table_name
-        @authorizations_table_name ||= authorization_model.table_name
+      def clear_authorizations_before_destroy
+        authorizations.destroy_all
       end
 
-      def authorization_model
-        @authorization_model ||= ::Authorization
+      module ClassMethods
+
+        def authorizations_table_name
+          @authorizations_table_name ||= authorization_model.table_name
+        end
+
+        def authorization_model
+          @authorization_model ||= ::Authorization
+        end
+
       end
-    end
+
   end
-end
+end