zen 0.2.8 → 0.3b

data/lib/zen/package/users/lib/users/language/nl/user_groups.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'user_groups'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Gebruikers groepen'
+    t['titles.edit']  = 'Gebruikers groep aanpassen'
+    t['titles.new']   = 'Gebruikers groep aanmaken'
+
+    t['labels.id']          = '#'
+    t['labels.name']        = 'Naam'
+    t['labels.slug']        = 'Slug'
+    t['labels.description'] = 'Beschrijving'
+    t['labels.super_group'] = 'Beheerders groep'
+
+    t['messages.no_groups'] = 'Er zijn geen gebruikers groepen gevonden.'
+
+    t['success.new']    = 'De gebruikers groep is aangemaakt.'
+    t['success.save']   = 'De gebruikers groep is aangepast.'
+    t['success.delete'] = 'De geselecteerde groepen zijn verwijderd.'
+
+    t['errors.new']    = 'De gebruikers groep kon niet worden aangemaakt.'
+    t['errors.save']   = 'De gebruikers groep kon niet worden aangepast.'
+    t['errors.delete'] = 'De gebruikers groep met ID #%s kon niet ' \
+      'worden verwijderd.'
+    t['errors.no_delete'] = 'U moet ten minste 1 groep specificeren ' \
+      'om te verwijderen.'
+    t['errors.invalid_group'] = 'De opgegeven gebruikers groep is ongeldig.'
+
+    t['buttons.new']    = 'Groep toevoegen'
+    t['buttons.delete'] = 'Geselecteerde groepen verwijderen'
+    t['buttons.save']   = 'Groep opslaan'
+
+    t['permissions.show']   = 'Groep weergeven'
+    t['permissions.edit']   = 'Groep aanpassen'
+    t['permissions.new']    = 'Groep aanmaken'
+    t['permissions.delete'] = 'Groep verwijderen'
+  end
+end

data/lib/zen/package/users/lib/users/language/nl/users.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'users'
+
+  trans.translate do |t|
+    t['titles.index']    = 'Gebruikers'
+    t['titles.edit']     = 'Gebruiker aanpassen'
+    t['titles.new']      = 'Gebruiker aanmaken'
+    t['titles.login']    = 'Inloggen'
+    t['titles.register'] = 'Registreren'
+
+    t['labels.id']                 = '#'
+    t['labels.email']              = 'Email'
+    t['labels.name']               = 'Naam'
+    t['labels.website']            = 'Website'
+    t['labels.password']           = 'Wachtwoord'
+    t['labels.confirm_password']   = 'Bevestig wachtwoord'
+    t['labels.status']             = 'Status'
+    t['labels.created_at']         = 'Aanmaak datum'
+    t['labels.updated_at']         = 'Aanpas datum'
+    t['labels.last_login']         = 'Login datum'
+    t['labels.user_groups']        = 'Gebruikers groepen'
+    t['labels.language']           = 'Taal'
+    t['labels.frontend_language']  = 'Bezoekers taal'
+    t['labels.date_format']        = 'Datum formaat'
+    t['labels.allow_registration'] = 'Registratie toegestaan'
+
+    t['descriptions.date_format'] = 'Het formaat van de datums in het ' \
+      'admin gedeelte.'
+    t['descriptions.allow_registration'] = 'Sta niet geregistreerde gebruikers ' \
+      'toe om een account te registreren.'
+
+    t['special.status_hash.active'] = 'Actief'
+    t['special.status_hash.closed'] = 'Gesloten'
+
+    t['messages.no_users'] = 'Er zijn geen gebruikers gevonden.'
+
+    t['success.new']     = 'De gebruiker is aangemaakt.'
+    t['success.save']    = 'De gebruiker is aangepast.'
+    t['success.delete']  = 'Alle gespecificeerde gebruikers zijn verwijderd.'
+    t['success.login']   = 'U bent nu ingelogd.'
+    t['success.logout']  = 'U bent nu uitgelogd.'
+    t['success.success'] = 'De account is geregistreerd.'
+
+    t['errors.new']       = 'De gebruiker kon niet worden aangemaakt.'
+    t['errors.save']      = 'De gebruiker kon niet worden aangepast.'
+    t['errors.delete']    = 'De gebruiker met ID #%s kon niet worden verwijderd.'
+    t['errors.no_delete'] = 'U moet ten minste 1 gebruiker specificeren ' \
+      'om te verwijderen.'
+    t['errors.no_password_match'] = 'De opgegeven wachtwoorden komen niet overeen.'
+    t['errors.login']   = 'U kon niet worden ingelogd.'
+    t['errors.logout']  = 'U kon niet worden uitgelogd, misschien bent ' \
+      'u al uitgelogd.'
+    t['errors.invalid_user'] = 'De opgegeven gebruiker is ongeldig.'
+    t['errors.register']     = 'De account kon niet worden geregistreerd.'
+
+    t['buttons.login']    = 'Inloggen'
+    t['buttons.new']      = 'Gebruiker toevoegen'
+    t['buttons.save']     = 'Gebruiker opslaan'
+    t['buttons.delete']   = 'Geselecteerde gebruikers verwijderen'
+    t['buttons.register'] = 'Registreer'
+
+    t['description'] = 'Beheer gebruikers, gebruikers groepen en rechten.'
+
+    t['permissions.show']   = 'Rechten weergeven'
+    t['permissions.edit']   = 'Rechten aanpassen'
+    t['permissions.new']    = 'Rechten aanmaken'
+    t['permissions.delete'] = 'Rechten verwijderen'
+
+    t['tabs.settings'] = 'Gebruikers instellingen'
+  end
+end

data/lib/zen/package/users/lib/users/model/permission.rb

@@ -0,0 +1,28 @@
+module Users
+  module Model
+    ##
+    # Model for managing permissions.
+    #
+    # @since  0.3
+    #
+    class Permission < Sequel::Model
+      many_to_one :user      , :class => 'Users::Model::User'
+      many_to_one :user_group, :class => 'Users::Model::UserGroup'
+
+      ##
+      # Validates the model's attributes before saving it.
+      #
+      # @since  0.3
+      #
+      def validate
+        validates_presence(:permission)
+
+        if self.user_id.nil?
+          validates_presence(:user_group_id)
+        else
+          validates_presence(:user_id)
+        end
+      end
+    end # Permission
+  end # Model
+end # Users

data/lib/zen/package/users/lib/users/model/user.rb

@@ -1,75 +1,72 @@
-#:nodoc:
 module Users
   #:nodoc:
   module Model
     ##
-    # Model that represents the very important user. This model
-    # can be used for both CRUD actions as well as authenticating a user.
-    # Passwords are encrypted using Bcrypt using the Ruby Bcrypt gem.
+    # Model that represents a single user.
     #
-    # This model has the following relations:
-    #
-    # * user groups (many to many), eager loads all access rules
-    # * access rules (one to many)
-    #
-    # The following plugins are used by this model:
-    #
-    # * timestamps
-    #
-    # @author Yorick Peterse
     # @since  0.1
     #
     class User < Sequel::Model
-      class << self
-        include ::Innate::Trinity
-      end
+      # Regex to do some basic Email validation. Emails such as foo@bar,
+      # foo@bar.com and foo@bar.a.b are all valid but foo bar@bar.com isn't.
+      EMAIL_REGEX = '^[^@]\S+@\S+(\.[a-z]+)*[^.]$'
+
+      include Zen::Model::Helper
+
+      many_to_many :user_groups, :class => 'Users::Model::UserGroup',
+        :eager => [:permissions]
+
+      many_to_one :user_status, :class => 'Users::Model::UserStatus'
+      one_to_many :permissions, :class => 'Users::Model::Permission'
 
       plugin :timestamps, :create => :created_at, :update => :updated_at
-      
-      many_to_many(
-        :user_groups, 
-        :class => "Users::Model::UserGroup", 
-        :eager => [:access_rules]
-      )
-      
-      one_to_many(:access_rules, :class => "Users::Model::AccessRule")
-      
+      plugin :association_dependencies, :permissions => :delete
+
       ##
-      # Try to authenticate the user based on the specified credentials.
-      # If the user credentials were incorrect false will be returned,
-      # true otherwise.
+      # Searches for a set of users that match the given query.
       #
-      # Note that this method will NOT perform any sanitizing, that should be 
-      # handled by the controller instead.
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Mixed]
+      #
+      def self.search(query)
+        return filter(
+          search_column(:name, query) | search_column(:email, query)
+        )
+      end
+
+      ##
+      # Try to authenticate the user based on the specified credentials..
       #
-      # @author Yorick Peterse
       # @since  0.1
       # @param  [Hash] creds The specified credentials
-      # @return [Object/Boolean] new instance of the given user.
+      # @return [Users::Model::User|FalseClass]
       #
       def self.authenticate(creds)
         email    = creds['email']
         password = creds['password']
 
-        return false if email.nil? or password.nil?
+        if email.nil? or password.nil?
+          return false
+        end
 
         user = self[:email => email]
 
-        if !user.nil? and user.password == password and user.status == 'open'
+        if !user.nil? and user.password == password \
+        and user.user_status.allow_login == true
           # Overwrite all the global settings with the user specific ones
           [:language, :frontend_language, :date_format].each do |setting|
-            value = Zen::Plugin.plugin(:settings, :get, setting).value
+            value = get_setting(setting).value
 
             if user.respond_to?(setting)
               got = user.send(setting)
-              
+
               if got.nil? or got.empty?
                 user.send("#{setting}=", value)
               end
             end
           end
 
-          action.node.session[:user] = user
           return user
         else
           return false
@@ -77,48 +74,90 @@ module Users
       end
 
       ##
-      # Generates a new hash based on the specified password. Each
-      # password is generated with a cost of 15, this makes the login
-      # process slower but also more secure.
+      # Generates a new BCrypt hash and saves it in the model. The hash is
+      # *only* generated when the password isn't nil or empty.
       #
-      # @author Yorick Peterse
       # @since  0.1
-      # @param  [String] raw_password The raw password
-      # @return [Void]
+      # @param  [String] password The raw password
       #
-      def password= raw_password
-        pwd = BCrypt::Password.create(raw_password, :cost => 10)
-        super(pwd)
+      def password=(password)
+        return if password.nil? or password.empty?
+
+        password = BCrypt::Password.create(password, :cost => 10)
+
+        super(password)
       end
-      
+
       ##
-      # Returns the current password
+      # Returns the current password.
       #
-      # @author Yorick Peterse
       # @since  0.1
-      # @return [String]
+      # @return [BCrypt::Password|NilClass]
       #
       def password
-        BCrypt::Password.new(super)
+        val = super
+
+        return BCrypt::Password.new(val) unless val.nil?
       end
-      
+
+      ##
+      # Hook run before creating or updating an object.
+      #
+      # @since  0.3
+      #
+      def before_save
+        if self.user_status_id.nil?
+          self.user_status_id = Users::Model::UserStatus[:name => 'closed'].id
+        end
+
+        super
+      end
+
       ##
       # Specifies all validation rules
       #
-      # @author Yorick Peterse
       # @since  0.1
-      # @todo   Email validation using regular expressions is bad, a DNS call 
-      # would be much better.
       #
       def validate
-        validates_presence [:email, :name]
-        validates_presence :status unless new?
-        validates_presence :password if new?
-        
-        validates_format(
-          /[a-zA-Z0-9\.\_\%\+\-]+@[a-zA-Z0-9\.\-]+\.[a-zA-Z]{2,4}/, :email
+        validates_presence([:email, :name])
+        validates_unique(:email)
+        validates_format(Regexp.new(EMAIL_REGEX), :email)
+        validates_presence(:password) if new?
+        validates_max_length(255, [:email, :name, :website])
+      end
+
+      ##
+      # Gets the name of the user's status and returns it in the current
+      # language.
+      #
+      # @since  03-11-2011
+      # @return [String]
+      #
+      def user_status_name
+        return lang("users.special.status_hash.#{user_status.name}")
+      end
+
+      ##
+      # Activates the user.
+      #
+      # @since 03-11-2011
+      #
+      def activate!
+        update(
+          :user_status_id => Users::Model::UserStatus[:name => 'active'].id
+        )
+      end
+
+      ##
+      # Closes the user account.
+      #
+      # @since 03-11-2011
+      #
+      def close!
+        update(
+          :user_status_id => Users::Model::UserStatus[:name => 'closed'].id
         )
       end
-    end
-  end
-end
+    end # User
+  end # Model
+end # Users

data/lib/zen/package/users/lib/users/model/user_group.rb

@@ -1,41 +1,45 @@
-#:nodoc:
 module Users
   #:nodoc:
   module Model
     ##
-    # Model that represents a single user group. This model has the following
-    # relations:
+    # Model that represents a single user group.
     #
-    # * users (many to many)
-    # * access rules (one to many)
-    #
-    # This model uses the following plugins:
-    #
-    # * sluggable
-    # 
-    # @author Yorick Peterse
     # @since  0.1
     #
     class UserGroup < Sequel::Model
-      many_to_many(:users      , :class => "Users::Model::User")
-      one_to_many(:access_rules, :class => "Users::Model::AccessRule")
-      
-      plugin :sluggable , :source => :name, :freeze => false
-      
+      include Zen::Model::Helper
+
+      many_to_many :users      , :class => 'Users::Model::User'
+      one_to_many  :permissions, :class => 'Users::Model::Permission'
+
+      plugin :sluggable, :source => :name, :freeze => false
+      plugin :association_dependencies, :permissions => :delete,
+        :users => :nullify
+
+      ##
+      # Searches for a set of users that match the given query.
+      #
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Mixed]
+      #
+      def self.search(query)
+        return filter(search_column(:name, query))
+      end
+
       ##
       # Validation rules for each user group used when
       # creating or updating a group.
       #
-      # @author Yorick Peterse
       # @since  0.1
       #
       def validate
-        validates_presence [:name, :super_group]
-        validates_presence :slug unless new?
-        validates_unique   :slug
+        validates_presence([:name, :super_group])
+        validates_max_length(255, :name)
+        validates_unique(:slug)
 
-        validates_type TrueClass, :super_group
+        validates_type(TrueClass, :super_group)
       end
-    end
-  end
-end
+    end # UserGroup
+  end # Model
+end # Users

data/lib/zen/package/users/lib/users/model/user_status.rb

@@ -0,0 +1,27 @@
+module Users
+  module Model
+    ##
+    # Model used for user statuses such as "Open" and "Unconfirmed".
+    #
+    # @since 03-11-2011
+    #
+    class UserStatus < Sequel::Model
+      ##
+      # Returns a hash where the keys are the IDs of the various statuses and
+      # the values the translations.
+      #
+      # @since  03-11-2011
+      # @return [Hash]
+      #
+      def self.dropdown
+        hash = {}
+
+        select(:id, :name).each do |row|
+          hash[row.id] = lang("users.special.status_hash.#{row.name}")
+        end
+
+        return hash
+      end
+    end # UserStatus
+  end # Model
+end # Users