authentication-logic 0.1.0

data/lib/auth/logic/errors.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Authentication
+  module Logic
+    # Parent class of all Authentication::Logic errors.
+    class Error < StandardError
+    end
+
+    # :nodoc:
+    class InvalidCryptoProvider < Error
+    end
+
+    # :nodoc:
+    class NilCryptoProvider < InvalidCryptoProvider
+      def message
+        <<~EOS
+          In version 5, Authentication::Logic used SCrypt by default. As of version 6, there
+          is no default. We still recommend SCrypt. If you previously relied on
+          this default, then, in your User model (or equivalent), please set the
+          following:
+
+              acts_as_authentic do |c|
+                c.crypto_provider = ::Authentication::Logic::CryptoProviders::SCrypt
+              end
+
+          Furthermore, the Authentication::Logic gem no longer depends on the scrypt gem. In
+          your Gemfile, please add scrypt.
+
+              gem "scrypt", "~> 3.0"
+
+          We have made this change in Authentication::Logic 6 so that users of other crypto
+          providers no longer need to install the scrypt gem.
+        EOS
+      end
+    end
+
+    # :nodoc:
+    class ModelSetupError < Error
+      def message
+        <<-EOS
+        You must establish a database connection and run the migrations before
+        using acts_as_authentic. If you need to load the User model before the
+        database is set up correctly, please set the following:
+
+            acts_as_authentic do |c|
+              c.raise_on_model_setup_error = false
+            end
+        EOS
+      end
+    end
+  end
+end

data/lib/auth/logic/i18n/translator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Authentication
+  module Logic
+    module I18n
+      # The default translator used by auth/logic/i18n.rb
+      class Translator
+        # If the I18n gem is present, calls +I18n.translate+ passing all
+        # arguments, else returns +options[:default]+.
+        def translate(key, options = {})
+          if defined?(::I18n)
+            ::I18n.translate key, **options
+          else
+            options[:default]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auth/logic/i18n.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Authentication
+  module Logic
+    # This class allows any message in Authentication::Logic to use internationalization. In
+    # earlier versions of Authentication::Logic each message was translated via configuration.
+    # This cluttered up the configuration and cluttered up Authentication::Logic. So all
+    # translation has been extracted out into this class. Now all messages pass
+    # through this class, making it much easier to implement in I18n library /
+    # plugin you want. Use this as a layer that sits between Authentication::Logic and
+    # whatever I18n library you want to use.
+    #
+    # By default this uses the rails I18n library, if it exists. If it doesn't
+    # exist it just returns the default English message. The Authentication::Logic I18n class
+    # works EXACTLY like the rails I18n class. This is because the arguments are
+    # delegated to this class.
+    #
+    # Here is how all messages are translated internally with Authentication::Logic:
+    #
+    #   Authentication::Logic::I18n.t('error_messages.password_invalid', :default => "is invalid")
+    #
+    # If you use a different I18n library just replace the build-in
+    # I18n::Translator class with your own. For example:
+    #
+    #   class MyAuthentication::LogicI18nTranslator
+    #     def translate(key, options = {})
+    #       # you will have key which will be something like:
+    #       # "error_messages.password_invalid"
+    #       # you will also have options[:default], which will be the default
+    #       # English version of the message
+    #       # do whatever you want here with the arguments passed to you.
+    #     end
+    #   end
+    #
+    #   Authentication::Logic::I18n.translator = MyAuthentication::LogicI18nTranslator.new
+    #
+    # That it's! Here is a complete list of the keys that are passed. Just define
+    # these however you wish:
+    #
+    #   Authentication::Logic:
+    #     error_messages:
+    #       login_blank: can not be blank
+    #       login_not_found: is not valid
+    #       login_invalid: should use only letters, numbers, spaces, and .-_@+ please.
+    #       consecutive_failed_logins_limit_exceeded: >
+    #         Consecutive failed logins limit exceeded, account is disabled.
+    #       email_invalid: should look like an email address.
+    #       email_invalid_international: should look like an international email address.
+    #       password_blank: can not be blank
+    #       password_invalid: is not valid
+    #       not_active: Your account is not active
+    #       not_confirmed: Your account is not confirmed
+    #       not_approved: Your account is not approved
+    #       no_authentication_details: You did not provide any details for authentication.
+    #       general_credentials_error: Login/Password combination is not valid
+    #       session_invalid: Your session is invalid and has the following errors:
+    #     models:
+    #       user_session: UserSession (or whatever name you are using)
+    #     attributes:
+    #       user_session: (or whatever name you are using)
+    #         login: login
+    #         email: email
+    #         password: password
+    #         remember_me: remember me
+    module I18n
+      @@scope = :auth_logic
+      @@translator = nil
+
+      class << self
+        # Returns the current scope. Defaults to :auth_logic
+        def scope
+          @@scope
+        end
+
+        # Sets the current scope. Used to set a custom scope.
+        def scope=(scope)
+          @@scope = scope
+        end
+
+        # Returns the current translator. Defaults to +Translator+.
+        def translator
+          @@translator ||= Translator.new
+        end
+
+        # Sets the current translator. Used to set a custom translator.
+        def translator=(translator)
+          @@translator = translator
+        end
+
+        # All message translation is passed to this method. The first argument is
+        # the key for the message. The second is options, see the rails I18n
+        # library for a list of options used.
+        def translate(key, options = {})
+          translator.translate key, { scope: I18n.scope }.merge(options)
+        end
+        alias t translate
+      end
+    end
+  end
+end

data/lib/auth/logic/random.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Authentication
+  module Logic
+    # Generates random strings using ruby's SecureRandom library.
+    module Random
+      def self.hex_token
+        SecureRandom.hex(64)
+      end
+
+      # Returns a string in base64url format as defined by RFC-3548 and RFC-4648.
+      # We call this a "friendly" token because it is short and safe for URLs.
+      def self.friendly_token
+        SecureRandom.urlsafe_base64(15)
+      end
+    end
+  end
+end