zen 0.2.8 → 0.3b

data/lib/zen/package/users/lib/users/helper/access.rb

@@ -0,0 +1,102 @@
+module Ramaze
+  module Helper
+    ##
+    # Whenever this module is included into a controller *all* its methods
+    # require the user to be logged in. If you want to make certain methods
+    # available to non logged in users you can do so using
+    # {Ramaze::Helper::Access::ClassMethods#allow}:
+    #
+    #     class Users < Zen::Controller::AdminController
+    #       allow [:login]
+    #
+    #       def login
+    #
+    #       end
+    #     end
+    #
+    # @since 0.3
+    #
+    module Access
+      # Hash containing various controllers and methods that the user can access
+      # without logging in.
+      PUBLIC_ACTIONS = {}
+
+      ##
+      # Called whenever this module is included into a controller.
+      #
+      # @since 0.3
+      #
+      def self.included(into)
+        into.extend(ClassMethods)
+      end
+
+      ##
+      # Adds the stacked block to a given class.
+      #
+      # since  0.3
+      # @param [Class] klass The class to add the block to.
+      #
+      def self.add_block(klass)
+        klass.stacked_before_all(:validate_user_login) do
+          deny   = true
+          klass  = self.class
+          method = action.method
+
+          if method
+            method = method.to_sym
+
+            if PUBLIC_ACTIONS.key?(klass) \
+            and PUBLIC_ACTIONS[klass].include?(method)
+              deny = false
+            end
+
+            if deny == true and logged_in? == false
+              message(:error, lang('zen_general.errors.require_login'))
+              redirect(::Users::Controller::Users.r(:login))
+            end
+          end
+        end
+      end
+
+      ##
+      # Module that contains various class methods for the including controller.
+      #
+      # @since 0.3
+      #
+      module ClassMethods
+        ##
+        # Called whenever the class that included this module is extended.
+        #
+        # @since 07-11-2011
+        # @param [Class] by The class that extended the current class.
+        #
+        def inherited(by)
+          Ramaze::Helper::Access.add_block(by)
+        end
+
+        ##
+        # Allows users to access the given methods without having to log in.
+        #
+        # @example
+        #  class Users < Zen::Controller::AdminController
+        #    allow [:login]
+        #
+        #    # The user can access this method without having to log in.
+        #    def login
+        #
+        #    end
+        #  end
+        #
+        # @since 0.3
+        # @param [Array] actions An array of action names that users can access.
+        #
+        def allow(actions)
+          actions = actions.map { |a| a.to_sym  }
+
+          Ramaze::Helper::Access::PUBLIC_ACTIONS[self] ||= []
+          Ramaze::Helper::Access::PUBLIC_ACTIONS[self]  += actions
+        end
+      end # ClassMethods
+    end # Access
+  end # Helper
+end # Ramaze

data/lib/zen/package/users/lib/users/helper/acl.rb

@@ -0,0 +1,113 @@
+module Ramaze
+  module Helper
+    ##
+    # The ACL helper makes it easy for developers to allow or deny access to
+    # certain resources based on the permissions of a user. This helper is
+    # loaded by default and provides the following two methods:
+    #
+    # * user_authorized?()
+    # * authorize_user!()
+    #
+    # ## Example
+    #
+    #     class Foo < Zen::Controller::AdminController
+    #       map '/admin/foo'
+    #
+    #       def index
+    #         authorize_user!(:show_foo)
+    #       end
+    #     end
+    #
+    # @since  0.1
+    #
+    module ACL
+      ##
+      # Checks if a user has all the specified permissions and returns a
+      # TrueClass or FalseClass based on the results. Note that since Zen 0.3
+      # *all* permissions set will be required, you're no longer able to
+      # specify a list of which only 1 permission is required.
+      #
+      # This method is useful for hiding certain elements of a page based on a
+      # user's permissions. If you want to deny access to an entire method or
+      # class you should use ``Ramaze::Helper::ACL#authorize_user!()`` instead.
+      #
+      # @example
+      #  if user_authorized?(:show_user)
+      #    # ...
+      #  end
+      #
+      # @since  0.1
+      # @param  [Array] *required An array of permissions that are required.
+      # @return [TrueClass|FalseClass]
+      #
+      def user_authorized?(*required)
+        super_group, permissions = get_permissions
+
+        required.each do |req|
+          req = req.to_sym if req.respond_to?(:to_sym)
+
+          if !permissions.include?(req) and super_group == false
+            return false
+          end
+        end
+
+        return true
+      end
+
+      ##
+      # Method that checks if the user has the given permissions. If this isn't
+      # the case an error message is displayed and the user won't be able to
+      # access the page.
+      #
+      # @example
+      #  authorize_user!(:edit_user)
+      #
+      # @since  0.2.8
+      # @param  [Array] *args An array of permissions that are required.
+      #
+      def authorize_user!(*args)
+        if !user_authorized?(*args)
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+      end
+
+      private
+
+      ##
+      # Retrieves all the permissions of the currently logged in user and stores
+      # them in the session.
+      #
+      # @since  0.3
+      # @return [Array] An array where the first item is a TrueClass or
+      #  FalseClass that indicates if the user is member of a super group or
+      #  not. The second item is an array of all the user's permissions (each
+      #  permission is a symbol).
+      #
+      def get_permissions
+        if !session[:super_group].nil? or !session[:permissions].nil?
+          return [session[:super_group], session[:permissions]]
+        end
+
+        super_group = false
+        perms       = user.permissions.map { |p| p.permission.to_sym }
+        group_ids   = []
+
+        user.user_groups.each do |group|
+          super_group = true if group.super_group == true
+          group_ids << group.id
+        end
+
+        ::Users::Model::Permission \
+          .filter(:user_group_id => group_ids) \
+          .each { |p| perms << p.permission.to_sym }
+
+        perms = perms.uniq
+
+        session[:super_group] = super_group
+        session[:permissions] = perms
+
+        return [session[:super_group], session[:permissions]]
+      end
+    end # ACL
+  end # Helper
+end # Ramaze

data/lib/zen/package/users/lib/users/helper/users.rb

@@ -1,39 +1,16 @@
-#:nodoc:
 module Ramaze
-  #:nodoc:
   module Helper
     ##
     # Helper for the users package. Note that this helper is called "Users"
     # rather than "User" as otherwise Ramaze could get confused and load the
     # incorrect helper (as it already comes with a helper named "User").
     #
-    # @author Yorick Peterse
     # @since  0.2.8
     #
     module Users
-      ##
-      # Checks if an access rule is valid and returns it if ithis is the case.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.8
-      # @param  [Fixnum] access_rule_id The ID of the access rule to validate.
-      # @return [Users::Model::AccessRule]
-      #
-      def validate_access_rule(access_rule_id)
-        rule = ::Users::Model::AccessRule[access_rule_id]
-
-        if rule.nil?
-          message(:error, lang('access_rules.errors.invalid_rule'))
-          redirect(::Users::Controller::AccessRules.r(:index))
-        else
-          return rule
-        end
-      end
-
       ##
       # Checks if a user group is valid and returns it if this is the case.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @param  [Fixnum] user_group_id The ID of the user group to validate.
       # @return [Users::Model::UserGroup]
@@ -52,7 +29,6 @@ module Ramaze
       ##
       # Validates a user and returns the object if it's a valid user.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @param  [Fixnum] user_id The ID of the user to validate.
       # @return [Users::Model::User]
@@ -67,6 +43,47 @@ module Ramaze
           return user
         end
       end
+
+      ##
+      # Updates the permissions for a user or a user group.
+      #
+      # @example
+      #  update_permissions(:user_id, 5, [:show_user], [:edit_user])
+      #
+      # @since  0.3
+      # @param  [Symbol] column The name of the column to use in the permissions
+      #  table. Can either be :user_id or :user_group_id.
+      # @param  [Fixnum] id The primary value of the column attribute.
+      # @param  [Array] new_perms An array of new permissions.
+      # @param  [Array] old_perms An array of existing permissions.
+      #
+      def update_permissions(column, id, new_perms = [], old_perms = [])
+        add_perms = []
+        rm_perms  = []
+
+        # Insert all the new permissions
+        new_perms.each do |perm|
+          if !old_perms.include?(perm)
+            add_perms << {column => id, :permission => perm}
+          end
+        end
+
+        # Remove permissions if they weren't checked
+        old_perms.each do |perm|
+          if !new_perms.include?(perm)
+            rm_perms << {column => id, :permission => perm}
+          end
+        end
+
+        ::Users::Model::Permission.insert_multiple(add_perms)
+        ::Users::Model::Permission.filter(
+          column      => rm_perms.map { |p| p[column] },
+          :permission => rm_perms.map { |p| p[:permission] }
+        ).delete
+
+        session[:super_group] = nil
+        session[:permissions] = nil
+      end
     end # Users
   end # Helper
 end # Ramaze

data/lib/zen/package/users/lib/users/language/en/permissions.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'permissions'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Permissions'
+
+    t['permissions.show'] = 'Show permissions'
+    t['permissions.edit'] = 'Edit permissions'
+
+    t['buttons.allow_all'] = 'Allow all'
+    t['buttons.deny_all']  = 'Deny all'
+  end
+end

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

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'user_groups'
+
+  trans.translate do |t|
+    t['titles.index'] = 'User Groups'
+    t['titles.edit']  = 'Edit User Group'
+    t['titles.new']   = 'Add User Group'
+
+    t['labels.id']          = '#'
+    t['labels.name']        = 'Name'
+    t['labels.slug']        = 'Slug'
+    t['labels.description'] = 'Description'
+    t['labels.super_group'] = 'Super group'
+
+    t['messages.no_groups'] = 'No user groups were found.'
+
+    t['errors.new']           = 'Failed to create a new user group.'
+    t['errors.save']          = 'Failed to modify the user group.'
+    t['errors.delete']        = 'Failed to delete the user group with ID #%s.'
+    t['errors.no_delete']     = 'You have to specify at least one group to delete.'
+    t['errors.invalid_group'] = 'The specified user group is invalid.'
+
+    t['success.new']    = 'The new user group has been created.'
+    t['success.save']   = 'The user group has been modified.'
+    t['success.delete'] = 'All selected user groups have been deleted.'
+
+    t['buttons.new']    = 'New group'
+    t['buttons.delete'] = 'Delete selected groups'
+    t['buttons.save']   = 'Save group'
+
+    t['permissions.show']   = 'Show group'
+    t['permissions.edit']   = 'Edit group'
+    t['permissions.new']    = 'Add group'
+    t['permissions.delete'] = 'Delete group'
+  end
+end

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

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'users'
+
+  trans.translate do |t|
+    t['titles.index']    = 'Users'
+    t['titles.edit']     = 'Edit User'
+    t['titles.new']      = 'Add User'
+    t['titles.login']    = 'Login'
+    t['titles.register'] = 'Register'
+
+    t['labels.id']                 = '#'
+    t['labels.email']              = 'Email'
+    t['labels.name']               = 'Name'
+    t['labels.website']            = 'Website'
+    t['labels.password']           = 'Password'
+    t['labels.confirm_password']   = 'Confirm password'
+    t['labels.status']             = 'Status'
+    t['labels.created_at']         = 'Created'
+    t['labels.updated_at']         = 'Updated'
+    t['labels.last_login']         = 'Last login'
+    t['labels.user_groups']        = 'User groups'
+    t['labels.language']           = 'Language'
+    t['labels.frontend_language']  = 'Frontend language'
+    t['labels.date_format']        = 'Date format'
+    t['labels.allow_registration'] = 'Allow registration'
+
+    t['descriptions.date_format'] = 'A custom format to use for all dates ' \
+      'displayed in the backend.'
+    t['descriptions.allow_registration'] = 'Allow non registered users to ' \
+      'register a new account.'
+
+    t['special.status_hash.active'] = 'Active'
+    t['special.status_hash.closed'] = 'Closed'
+
+    t['messages.no_users'] = 'No users were found.'
+
+    t['errors.new']       = 'Failed to create the new user.'
+    t['errors.save']      = 'Failed to save the user.'
+    t['errors.delete']    = 'Failed to delete the user with ID #%s.'
+    t['errors.no_delete']  = 'You have to specify at least one user to delete.'
+    t['errors.no_password_match'] = 'The specified passwords did not match.'
+    t['errors.login']   = 'Failed to log in with the specified details.'
+    t['errors.logout']  = 'Failed to log out, perhaps you are already ' \
+      'logged out.'
+    t['errors.invalid_user'] = 'The specified user is invalid.'
+    t['errors.register']     = 'The account could not be registered.'
+
+    t['success.new']      = 'The new user has been created.'
+    t['success.save']     = 'The user has been modified.'
+    t['success.delete']   = 'All selected users have been deleted.'
+    t['success.login']    = 'You have been successfully logged in.'
+    t['success.logout']   = 'You have been successfully logged out.'
+    t['success.register'] = 'The account has been registered.'
+
+    t['buttons.login']    = 'Login'
+    t['buttons.new']      = 'Add user'
+    t['buttons.delete']   = 'Delete selected users'
+    t['buttons.save']     = 'Save user'
+    t['buttons.register'] = 'Register'
+
+    t['description'] = 'Manage users, user groups and permissions.'
+
+    t['permissions.show']   = 'Show user'
+    t['permissions.edit']   = 'Edit user'
+    t['permissions.new']    = 'Add user'
+    t['permissions.delete'] = 'Delete user'
+
+    t['tabs.settings'] = 'User Settings'
+  end
+end

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

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'permissions'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Rechten'
+
+    t['permissions.show'] = 'Rechten weergeven'
+    t['permissions.edit'] = 'Rechten aanpassen'
+
+    t['buttons.allow_all'] = 'Sta alles toe'
+    t['buttons.deny_all']  = 'Sta niks toe'
+  end
+end