entrance 0.1.1 → 0.2.0

data/lib/entrance/model.rb

@@ -1,107 +1,154 @@
 require 'active_support/concern'
 
-module Model
-  extend ActiveSupport::Concern
-
-  included do
-    # verify that username/password attributes are present
-    attrs = Entrance.config.model.constantize.columns.collect(&:name)
-    %w(username_attr password_attr).each do |key|
-      attr = Entrance.config.send(key)
-      raise "Couldn't find '#{attr}' in #{Entrance.config.model} model." unless attrs.include?(attr)
-    end
+module Entrance
+  module Model
+    extend ActiveSupport::Concern
 
-    validates :password, :presence => true, :length => 6..32, :if => :password_required?
-    validates :password, :confirmation => true, :if => :password_required?
-    validates :password_confirmation, :presence => true, :if => :password_required?
-  end
+    included do
+
+      # if the target model class does not have a Model.where() method, 
+      # then login_by_session wont work, nor the ClassMethods below.
+      # won't work so we cannot continue.
+      unless respond_to?(:where)
+        raise "#{Entrance.config.model} does not have a class .where() method. Cannot continue."
+      end
+
+      fields = if self.respond_to?(:columns)   # ActiveRecord::Base
+        self.columns.collect(&:name)
+      elsif self.respond_to?(:keys)            # MongoMapper::Document
+        self.keys.keys
+      else                                     # just get setters in the class
+        self.instance_methods(false).select { |m| m[/\=$/] }.map { |s| s.sub('=', '') }
+      end.map { |el| el.to_sym }
+
+      %w(username_attr password_attr).each do |key|
+        field = Entrance.config.send(key)
+        unless fields.include?(field.to_sym)
+          raise "Couldn't find '#{field}' in #{Entrance.config.model} model." 
+        end
+      end
+
+      %w(remember reset).each do |what|
+        if field = Entrance.config.send("#{what}_token_attr")
 
-  module ClassMethods
+          unless fields.include?(field.to_sym)
+            raise "No #{Entrance.config.send("#{what}_token_attr")} field found. \
+                   Set the config.#{what}_token_attr option to nil to disable the #{what} option."
+          end
 
-    def authenticate(username, password)
-      return if username.blank? or password.blank?
+          Entrance.config.can?(what, true)
+          include what.to_sym == :remember ? RememberMethods : ResetMethods
+        end
+      end
 
-      query = {}
-      query[Entrance.config.username_attr] = username.downcase.strip
-      if u = where(query).first
-        return u.authenticated?(password) ? u : nil
+      if respond_to?(:validates)
+        validates :password, :presence => true, :length => 6..32, :if => :password_required?
+        validates :password, :confirmation => true, :if => :password_required?
+        validates :password_confirmation, :presence => true, :if => :password_required?
       end
+
     end
 
-    def with_password_reset_token(token)
-      return if token.blank?
+    module ClassMethods
+
+      def authenticate(username, password)
+        return if username.blank? or password.blank?
 
-      query = {}
-      query[Entrance.config.reset_token_attr] = token.strip
-      if u = where(query).first \
-        and (!Doorman.config.reset_until_attr || u.send(Doorman.config.reset_until_attr) > Time.now)
-          return u
+        query = {}
+        query[Entrance.config.username_attr] = username.to_s.downcase.strip
+        if u = where(query).first
+          return u.authenticated?(password) ? u : nil
+        end
       end
+
+      def with_password_reset_token(token)
+        Entrance.config.permit!(:reset)
+        return if token.blank?
+
+        query = {}
+        query[Entrance.config.reset_token_attr] = token.to_s.strip
+        if u = where(query).first \
+          and (!Doorman.config.reset_until_attr || u.send(Doorman.config.reset_until_attr) > Time.now)
+            return u
+        end
+      end
+
     end
 
-  end
+    module ResetMethods
+
+      def request_password_reset!
+        send(Entrance.config.reset_token_attr + '=', Entrance.generate_token)
+        if Doorman.config.reset_until_attr
+          update_attribute(Entrance.config.reset_until_attr, Entrance.config.reset_password_window.from_now)
+        end
+        if save(:validate => false)
+          method = Entrance.config.reset_password_method
+          Entrance.config.reset_password_mailer.constantize.send(method, self).deliver
+        end
+      end
 
-  def authenticated?(string)
-    password === encrypt_password(string)
-  end
+    end
 
-  def remember_me!(until_date = nil)
-    update_attribute(Entrance.config.remember_token_attr, Entrance.generate_token)
-    update_remember_token_expiration!(until_date)
-  end
+    module RememberMethods
 
-  def update_remember_token_expiration!(until_date = nil)
-    timestamp = until_date || Entrance.config.remember_for
-    update_attribute(Entrance.config.remember_until_attr, timestamp.from_now)
-  end
+      def remember_me!(until_date = nil)
+        update_attribute(Entrance.config.remember_token_attr, Entrance.generate_token)
+        update_remember_token_expiration!(until_date)
+      end
 
-  def forget_me!
-    update_attribute(Entrance.config.remember_token_attr, nil)
-    update_attribute(Entrance.config.remember_until_attr, nil)
-  end
+      def update_remember_token_expiration!(until_date = nil)
+        timestamp = until_date || Entrance.config.remember_for
+        update_attribute(Entrance.config.remember_until_attr, timestamp.from_now)
+      end
 
-  def password
-    @password || Entrance.config.cipher.read(send(Entrance.config.password_attr))
-  end
+      def forget_me!
+        update_attribute(Entrance.config.remember_token_attr, nil)
+        update_attribute(Entrance.config.remember_until_attr, nil)
+      end
 
-  def password=(new_password)
-    return if new_password.blank?
+    end
 
-    @password = new_password # for validation
-    @password_changed = true
+    def authenticated?(string)
+      Entrance.config.cipher.match?(read_password, string, get_salt)
+    end
 
-    # if we're using salt and it is empty, generate one
-    if Entrance.config.salt_attr \
-      and send(Entrance.config.salt_attr).blank?
-        self.send(Entrance.config.salt_attr + '=', Entrance.generate_token)
+    def password
+      @password || read_password
     end
 
-    self.send(Entrance.config.password_attr + '=', encrypt_password(new_password))
-  end
+    def password=(new_password)
+      return if new_password.blank?
+
+      @password = new_password # for validation
+      @password_changed = true
+
+      # if we're using salt and it is empty, generate one
+      if Entrance.config.salt_attr \
+        and send(Entrance.config.salt_attr).blank?
+          self.send(Entrance.config.salt_attr + '=', Entrance.generate_token)
+      end
 
-  def request_password_reset!
-    send(Entrance.config.reset_token_attr + '=', Entrance.generate_token)
-    if Doorman.config.reset_until_attr
-      update_attribute(Entrance.config.reset_until_attr, Entrance.config.reset_password_window.from_now)
+      self.send(Entrance.config.password_attr + '=', encrypt_password(new_password))
     end
-    if save(:validate => false)
-      method = Entrance.config.reset_password_method
-      Entrance.config.reset_password_mailer.constantize.send(method, self).deliver
+
+    private
+
+    def read_password
+      send(Entrance.config.password_attr)
     end
-  end
 
-  private
+    def encrypt_password(string)
+      Entrance.config.cipher.encrypt(string, get_salt)
+    end
 
-  def get_salt
-    Entrance.config.salt_attr && send(Entrance.config.salt_attr)
-  end
+    def get_salt
+      Entrance.config.salt_attr && send(Entrance.config.salt_attr)
+    end
 
-  def encrypt_password(string)
-    Entrance.config.cipher.encrypt(string, get_salt)
-  end
+    def password_required?
+      password.blank? || @password_changed
+    end
 
-  def password_required?
-    password.blank? or @password_changed
   end
-
 end

data/lib/entrance/version.rb

@@ -1,7 +1,7 @@
 module Entrance
   MAJOR = 0
-  MINOR = 1
-  PATCH = 1
+  MINOR = 2
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/lib/entrance.rb

@@ -1,6 +1,7 @@
 require 'entrance/controller'
 require 'entrance/model'
 require 'entrance/ciphers'
+require 'entrance/config'
 
 require 'active_support/core_ext/numeric/time'
 
@@ -12,6 +13,11 @@ module Entrance
 
   def self.configure
     yield config
+    config.validate!
+  end
+
+  def self.model
+    @model ||= config.model.constantize
   end
 
   def self.generate_token(length = 40)

metadata

@@ -1,82 +1,164 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: entrance
-version: !ruby/object:Gem::Version
-  version: 0.1.1
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
-- Tomás Pollak
+authors: 
+- "Tom\xC3\xA1s Pollak"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2015-01-07 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bcrypt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
 description: Doesn't fiddle with your controllers and routes.
-email:
+email: 
 - tomas@forkhq.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
+
+files: 
+- .gitignore
 - README.md
 - Rakefile
 - entrance.gemspec
+- examples/rails-app/.gitignore
+- examples/rails-app/Gemfile
+- examples/rails-app/Gemfile.lock
+- examples/rails-app/README.rdoc
+- examples/rails-app/Rakefile
+- examples/rails-app/app/assets/images/.keep
+- examples/rails-app/app/assets/javascripts/application.js
+- examples/rails-app/app/assets/stylesheets/application.css
+- examples/rails-app/app/controllers/application_controller.rb
+- examples/rails-app/app/controllers/concerns/.keep
+- examples/rails-app/app/controllers/sessions_controller.rb
+- examples/rails-app/app/controllers/users_controller.rb
+- examples/rails-app/app/controllers/welcome_controller.rb
+- examples/rails-app/app/helpers/application_helper.rb
+- examples/rails-app/app/mailers/.keep
+- examples/rails-app/app/models/.keep
+- examples/rails-app/app/models/concerns/.keep
+- examples/rails-app/app/models/user.rb
+- examples/rails-app/app/views/layouts/application.html.erb
+- examples/rails-app/app/views/sessions/new.html.erb
+- examples/rails-app/app/views/users/new.html.erb
+- examples/rails-app/app/views/welcome/index.html.erb
+- examples/rails-app/bin/bundle
+- examples/rails-app/bin/rails
+- examples/rails-app/bin/rake
+- examples/rails-app/config.ru
+- examples/rails-app/config/application.rb
+- examples/rails-app/config/boot.rb
+- examples/rails-app/config/database.yml
+- examples/rails-app/config/environment.rb
+- examples/rails-app/config/environments/development.rb
+- examples/rails-app/config/environments/production.rb
+- examples/rails-app/config/environments/test.rb
+- examples/rails-app/config/initializers/backtrace_silencers.rb
+- examples/rails-app/config/initializers/entrance.rb
+- examples/rails-app/config/initializers/filter_parameter_logging.rb
+- examples/rails-app/config/initializers/inflections.rb
+- examples/rails-app/config/initializers/mime_types.rb
+- examples/rails-app/config/initializers/secret_token.rb
+- examples/rails-app/config/initializers/session_store.rb
+- examples/rails-app/config/initializers/wrap_parameters.rb
+- examples/rails-app/config/locales/en.yml
+- examples/rails-app/config/routes.rb
+- examples/rails-app/db/migrate/20150107032724_create_users.rb
+- examples/rails-app/db/schema.rb
+- examples/rails-app/db/seeds.rb
+- examples/rails-app/lib/assets/.keep
+- examples/rails-app/lib/tasks/.keep
+- examples/rails-app/log/.keep
+- examples/rails-app/public/404.html
+- examples/rails-app/public/422.html
+- examples/rails-app/public/500.html
+- examples/rails-app/public/favicon.ico
+- examples/rails-app/public/robots.txt
+- examples/rails-app/test/controllers/.keep
+- examples/rails-app/test/fixtures/.keep
+- examples/rails-app/test/fixtures/users.yml
+- examples/rails-app/test/helpers/.keep
+- examples/rails-app/test/integration/.keep
+- examples/rails-app/test/mailers/.keep
+- examples/rails-app/test/models/.keep
+- examples/rails-app/test/models/user_test.rb
+- examples/rails-app/test/test_helper.rb
+- examples/rails-app/vendor/assets/javascripts/.keep
+- examples/rails-app/vendor/assets/stylesheets/.keep
 - lib/entrance.rb
 - lib/entrance/ciphers.rb
 - lib/entrance/config.rb
 - lib/entrance/controller.rb
 - lib/entrance/model.rb
 - lib/entrance/version.rb
+has_rdoc: true
 homepage: https://github.com/tomas/entrance
 licenses: []
-metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: entrance
-rubygems_version: 2.2.0
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Lean authentication alternative for Rails and Sinatra.
 test_files: []
-has_rdoc: 
+

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: f661a4633af896da4a51983077f91da1bb209252
-  data.tar.gz: cc99cf9bd7d25ebb0bceb68094e4ca58aaad7501
-SHA512:
-  metadata.gz: 0e8c8342e325fe52064b63805519a3ba4d860a5e9f9f2939da4f78cc9cb2f4b48b2248c4397dcd7dc377780063c094c7acf3c6e118e8c7a5b68d0415424687a5
-  data.tar.gz: a9b6bf64afe93cb6a757c1f06421fdd37948a9eddde63fc122ba8d8e219f89223e6a1a1d8c3b35528385890e1b3ecd703c68ad0ef36bd7962e82642dfdc1f52f