ixtlan 0.2.4 → 0.3.0

data/lib/ixtlan/rails/error_handling.rb

@@ -9,7 +9,7 @@ module Ixtlan
       end
 
       def internal_server_error(exception)
-        dump_error(exception, Object.full_const_get(::Ixtlan::Models.CONFIGURATION).instance)
+        dump_error(exception)
         status = :internal_server_error
         error_page(:internal_server_error, exception) do |exception|
           "internal server error: #{exception.class.name}"
@@ -17,19 +17,27 @@ module Ixtlan
       end
 
       def error_page(status, exception, &block)
-        respond_to do |format| 
-          format.html { 
+        respond_to do |format|
+          format.html {
             @notice = block.call(exception)
             if logged_in?
-              render :template => "errors/error", :status => status
+              render_error_page_with_session(status)
             else
-              render :template => "sessions/login", :status => status
+              render_error_page(status)
             end
           }
           format.xml { head status }
         end
       end
 
+      def render_error_page_with_session(status)
+        render :template => "errors/error", :status => status
+      end
+
+      def render_error_page(status)
+        render :template => "sessions/login", :status => status
+      end
+
       def page_not_found(exception)
         log_user_error(exception)
         status = rescue_responses[exception.class.name]
@@ -39,44 +47,37 @@ module Ixtlan
 
       def stale_resource(exception)
         log_user_error(exception)
-        respond_to do |format| 
-          format.html { 
+        respond_to do |format|
+          format.html {
             render :template => "errors/stale", :status => :conflict
           }
           format.xml { head :conflict }
         end
       end
 
-      def dump_error(exception, config)
+      def dump_error(exception)
         log_user_error(exception)
-        dumper = DumpError.new(config.notification_sender_email, 
-                               config.notification_recipient_email)
+        begin
+          config = Object.full_const_get(::Ixtlan::Models::CONFIGURATION).instance
+          dumper = DumpError.new(config.notification_sender_email,
+                                 config.notification_recipient_emails,
+                                 config.errors_dump_directory)
+        rescue => e
+          # maybe that gives a double entry in the log file
+          log_user_error(e)
+          # at least dump the file !!
+          dumper = DumpError.new
+        end
         dumper.dump(self, exception)
       end
     end
-    
-    class ErrorNotifier < ActionMailer::Base
-      require 'pathname'
-
-      def error_notification(email_from, email_to, exception, error_file)
-        @subject    = exception.to_s
-        @body       = {:text => "#{error_file}"}
-        @recipients = email_to
-        @from       = email_from
-        @sent_on    = Time.now
-        @headers    = {}
-        path = Pathname(__FILE__).parent.dirname.to_s
-        view_paths << path unless view_paths.member? path
-        @template   = "error_notification.rhtml"
-      end
 
-    end
-    
     class DumpError
-      
-      def initialize(email_from, email_to, errors_dir = "#{RAILS_ROOT}/log/errors")
-        FileUtils.mkdir_p(errors_dir)
-        @errors_dir = File.new(errors_dir)
+
+      def initialize(email_from = nil, email_to = nil, errors_dir = nil)
+        errors_dir ||= "#{RAILS_ROOT}/log/errors"
+        FileUtils.mkdir_p(errors_dir || "#{RAILS_ROOT}/log/errors")
+        @errors_dir = Dir.new(errors_dir)
         @email_from = email_from
         @email_to = email_to
       end
@@ -84,35 +85,35 @@ module Ixtlan
       def dump(controller, exception)
         time = Time.now
         error_log_id = "#{time.tv_sec}#{time.tv_usec}"
-        
+
         log_file = File.join(@errors_dir.path.to_s, "error-#{error_log_id}.log")
         logger = Logger.new(log_file)
-        
+
         dump_environment(logger, exception, controller)
-        ErrorNotifier.deliver_error_notification(@email_from, @email_to, exception, log_file) unless @email_to.blank?
+        Ixtlan::Mailer.deliver_error_notification(@email_from, @email_to, exception, log_file) unless (@email_to.blank? || @email_from.blank?)
         log_file
-      end 
+      end
 
       private
 
       def dump_environment_header(logger, header)
         logger.error("\n===================================================================\n#{header}\n===================================================================\n");
       end
-      
+
       def dump_environment(logger, exception, controller)
         dump_environment_header(logger, "REQUEST DUMP");
         dump_hashmap(logger, controller.request.env)
-        
+
         dump_environment_header(logger, "RESPONSE DUMP");
         dump_hashmap(logger, controller.response.headers)
-        
+
         dump_environment_header(logger, "SESSION DUMP");
         dump_hashmap(logger, controller.session)
-        
+
         dump_environment_header(logger, "PARAMETER DUMP");
         map = {}
         dump_hashmap(logger, controller.params.each{ |k,v| map[k]=v })
-        
+
         dump_environment_header(logger, "EXCEPTION");
         logger.error("#{exception.class}:#{exception.message}")
         logger.error("\t" + exception.backtrace.join("\n\t"))

data/lib/ixtlan/rails/guard.rb

@@ -8,4 +8,3 @@ module Erector
     include Ixtlan::Allowed
   end
 end
-

data/lib/ixtlan/rails/migrations.rb

@@ -0,0 +1,75 @@
+module Ixtlan
+  module Rails
+    class Migrations
+
+      # assume no namespaces !!!
+      USER = Object.const_get(Ixtlan::Models::USER)
+      GROUP = Object.const_get(Ixtlan::Models::GROUP)
+      LOCALE = Object.const_get(Ixtlan::Models::LOCALE)
+      DOMAIN = Object.const_get(Ixtlan::Models::DOMAIN)
+      CONFIGURATION = Object.const_get(Ixtlan::Models::CONFIGURATION)
+
+      def self.create_user
+        USER.auto_migrate!
+        LOCALE.auto_migrate!
+        GROUP.auto_migrate!
+        Ixtlan::Models::GroupUser.auto_migrate!
+        Ixtlan::Models::GroupLocaleUser.auto_migrate!
+        Ixtlan::Models::DomainGroupUser.auto_migrate!
+        
+        u = USER.new(:login => 'root', :email => 'root@example.com', :name => 'Superuser', :id => 1)
+        u.created_at = DateTime.now
+        u.updated_at = u.created_at
+        u.created_by_id = 1
+        u.updated_by_id = 1
+        u.reset_password
+        u.save!
+
+        g = GROUP.create(:name => 'root', :current_user => u)
+        u.groups << g
+        u.save
+        
+        a = USER.create(:login => 'admin', :email => 'admin@example.com', :name => 'Administrator', :id => 2, :current_user => u)
+        a.reset_password
+        a.save!      
+        a.groups << GROUP.create(:name => 'admin', :current_user => u)
+        a.save
+ 
+        users = GROUP.create(:name => 'users', :current_user => u)
+        locales = GROUP.create(:name => 'locales', :current_user => u)
+        domains = GROUP.create(:name => 'domains', :current_user => u)
+        
+        File.open("root", 'w') { |f| f.puts "root\n#{u.password}\n\nadmin\n#{a.password}\n\n" }
+      end
+
+      def self.create_configuration
+        Ixtlan::Models::ConfigurationLocale.auto_migrate!
+        CONFIGURATION.auto_migrate!
+        CONFIGURATION.create(:session_idle_timeout => 10, :keep_audit_logs => 3, :current_user => USER.first)
+      end
+
+      def self.create_locale
+        LOCALE.auto_migrate!
+        # get/create default locale
+        LOCALE.create(:code => LOCALE::DEFAULT, :current_user => USER.first)
+        # get/create "every" locale
+        LOCALE.create(:code => LOCALE::ALL, :current_user => USER.first)
+        
+        # root user has access to ALL locales
+        Ixtlan::Models::GroupLocaleUser.create(:group => Group.first, :user => USER.first, :locale => LOCALE.every)
+      end
+
+      def self.create_domain
+        DOMAIN.auto_migrate!
+        # get/create "every" domain
+        DOMAIN.create(:name => DOMAIN::ALL, :current_user => User.first)
+        
+        Ixtlan::Models::DomainGroupUser.create(:group => Group.first, :user => USER.first, :domain => DOMAIN.every)
+      end
+
+      def self.create_text
+        I18nText.auto_migrate!
+      end
+    end
+  end
+end

data/lib/ixtlan/rails/session_timeout.rb

@@ -5,7 +5,7 @@ module Ixtlan
       def self.included(base)
         base.send(:include, InstanceMethods)
       end
-      
+
       module InstanceMethods
         private
 
@@ -14,16 +14,16 @@ module Ixtlan
         def session_user_logger
           @session_user_logger ||= UserLogger.new(Ixtlan::Rails::SessionTimeout)
         end
-        
+
         def expire_session
           session.clear
           #      reset_session
           render_session_timeout
           return false
         end
-        
+
         public
-        
+
         def check_session_expiry
           if !session[:expires_at].nil? and session[:expires_at] < DateTime.now
             # Session has expired.
@@ -35,23 +35,25 @@ module Ixtlan
             return true
           end
         end
-        
+
+        # IP binding is not very useful in the wild since some ISP use 
+        # a different IP for each request, i.e. the session uses many IPs
         def check_session_ip_binding
           if !session[:session_ip].nil? and session[:session_ip] != request.headers['REMOTE_ADDR']
             # client IP has changed
             session_user_logger.log(self, "IP changed from #{session[:session_ip]} to #{request.headers['REMOTE_ADDR']}")
             expire_session
           else
-            # Assign client IP 
+            # Assign client IP
             session[:session_ip] = request.headers['REMOTE_ADDR']
             return true
           end
         end
-        
+
         def check_session
-          check_session_ip_binding and check_session_expiry
+          check_session_browser_signature && check_session_expiry
         end
-        
+
         def check_session_browser_signature
           if !session[:session_browser_signature].nil? and session[:session_browser_signature] != retrieve_browser_signature
             # browser signature has changed
@@ -64,24 +66,24 @@ module Ixtlan
             return true
           end
         end
-        
+
         def retrieve_browser_signature
           [request.headers['HTTP_USER_AGENT'],
            request.headers['HTTP_ACCEPT_LANGUAGE'],
            request.headers['HTTP_ACCEPT_ENCODING'],
            request.headers['HTTP_ACCEPT']].join('|')
         end
-        
+
         def render_session_timeout
-          respond_to do |format| 
-            format.html { 
+          respond_to do |format|
+            format.html {
               @notice = "session timeout" unless @notice
               render :template => "sessions/login"
             }
             format.xml { head :unauthorized }
           end
         end
-        
+
         def session_timeout
           CONFIG.instance.session_idle_timeout
         end

data/lib/ixtlan/rails/timestamps_modified_by_filter.rb

@@ -6,7 +6,7 @@ module Ixtlan
           base.prepend_around_filter(Filter)
         end
       end
-      
+
       class Filter
         def self.filter(controller)
           name = controller.params[:controller]

data/lib/ixtlan/rails/unrestful_authentication.rb

@@ -21,7 +21,7 @@ module Rails
     def current_user
       session[:user] = login_from_session if logged_in? and session[:user].nil?
       session[:user]
-    end 
+    end
 
     def current_user=(new_user)
       session[:user_id] = new_user ? new_user.id : nil
@@ -45,13 +45,13 @@ module Rails
         end
       else
         case(request.method)
-        when :get   
+        when :get
           session.clear
           render_login_page
         when :post
           user = login_from_params
           if user.instance_of? String
-            authentication_logger.log_user(params[:login], user + " from IP #{request.headers['REMOTE_ADDR']}")
+            authentication_logger.log_user(params[:login] || params[:authentication][:login], user + " from IP #{request.headers['REMOTE_ADDR']}")
             session.clear
             render_access_denied
           else
@@ -128,7 +128,7 @@ module Rails
         end
         format.xml { head :ok }
       end
-    end    
+    end
   end
 end
 end

data/lib/ixtlan/rolling_file.rb

@@ -1,9 +1,9 @@
 require 'logging'
 
 module Ixtlan
-  
+
   class RollingFile < ::Logging::Appenders::RollingFile
-    
+
     def current_logfile
       "#{@filename_base}_#{Time.now.strftime(@date_pattern)}.#{@extension}"
     end
@@ -31,7 +31,7 @@ module Ixtlan
           ::File.delete file
         end
       end
-    end 
+    end
 
     def write( event )
       str = event.instance_of?(::Logging::LogEvent) ?

data/lib/ixtlan/session.rb

@@ -1,7 +1,7 @@
 require 'rack_datamapper/session/abstract/store'
 module Ixtlan
   class Session < DataMapper::Session::Abstract::Session
- 
+
     def data=(data)
       d = {}
       data.each{|k,v| d[k.to_sym] = v}
@@ -10,9 +10,10 @@ module Ixtlan
       @expires_at = d.delete(:expires_at)
       attribute_set(:data, ::Base64.encode64(Marshal.dump(d)))
     end
-    
+
     def data
-      Marshal.load(::Base64.decode64(attribute_get(:data))).merge({:user => @user, :flash => @flash, :expires_at => @expires_at})
+      # user string for flash entry to allow the rails falsh to work properly !
+      Marshal.load(::Base64.decode64(attribute_get(:data))).merge({:user => @user, "flash" => @flash, :expires_at => @expires_at})
     end
   end
 end

data/lib/ixtlan/user_logger.rb

@@ -1,20 +1,20 @@
 require 'slf4r'
 module Ixtlan
-  
+
   class UserLogger
-    
+
     def initialize(arg)
       @logger = Slf4r::LoggerFacade.new(arg)
     end
 
-    private 
+    private
 
     def login_from(controller)
       user = controller.respond_to?(:current_user) ? controller.send(:current_user) : nil
       user.nil? ? nil: user.login
     end
 
-    public 
+    public
 
     def log(controller, message = nil, &block)
       log_user(login_from(controller), message, &block)
@@ -30,20 +30,24 @@ module Ixtlan
           else
             audit = controller.instance_variable_get("@#{controller.params[:controller].singular.to_sym}")
             if(audit)
-              "#{controller.params[:controller]}##{controller.params[:action]} #{audit.model}(#{audit.key})#{as_xml}#{message}"
+              errors = if(audit.respond_to?(:errors) && !audit.errors.empty?)
+                         " - errors: " + audit.errors.full_messages.join(", ")
+                       end
+              audit_log = audit.respond_to?(:to_log) ? audit.to_log : "#{audit.model}(#{audit.key})"
+              "#{controller.params[:controller]}##{controller.params[:action]} #{audit_log}#{as_xml}#{message}#{errors}"
             else
               "#{controller.params[:controller]}##{controller.params[:action]}#{as_xml}#{message}"
             end
           end
         else
-          "params=#{controller.params.inspect}"
+          "params=#{controller.params.inspect}#{message}"
         end
       end
     end
-     
+
     def log_user(user, message = nil, &block)
-      user = "???" unless user
-      @logger.info {"[#{user}] #{message}#{block.call if block}" } 
+      user ||= "???"
+      @logger.info {"[#{user}] #{message}#{block.call if block}" }
     end
   end
 end

data/lib/ixtlan/version.rb

@@ -1,3 +1,3 @@
 class Ixtlan
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/authentication_spec.rb

@@ -24,7 +24,7 @@ describe Ixtlan::Models::Authentication do
 
   it "should" do
     xml = @authentication.to_xml
-    xml.gsub!(/[0-9-]{10}T[0-9+-:]{14}/, "").gsub!(/ type='[^']+'/, '').gsub!(/<created_at><\/created_at>/, "<created_at/>").should == "<authentication><login>marvin2</login><user><id>1356</id><login>marvin2</login><name>marvin the robot</name><email>marvin@universe.example.com</email><language>xx</language><created_at/><updated_at></updated_at><created_by_id>1356</created_by_id><updated_by_id>1356</updated_by_id><groups><group><id>1356</id><name>marvin2_root</name><created_at/><created_by_id>1356</created_by_id><updated_by_id>1356</updated_by_id><locales><locale><code>DEFAULT</code><created_at/></locale><locale><code>en</code><created_at/></locale></locales></group></groups></user></authentication>"
+    xml.gsub!(/[0-9-]{10}T[0-9+-:]{14}/, "").gsub!(/ type='[^']+'/, '').gsub!(/<created_at><\/created_at>/, "<created_at/>").gsub!(/<locale><id>[0-9]*<\/id>/, "<locale>").should == "<authentication><id>1</id><login>marvin2</login><user><id>1356</id><login>marvin2</login><name>marvin the robot</name><email>marvin@universe.example.com</email><language>xx</language><created_at/><updated_at></updated_at><created_by_id>1356</created_by_id><updated_by_id>1356</updated_by_id><groups><group><id>1356</id><name>marvin2_root</name><created_at/><created_by_id>1356</created_by_id><updated_by_id>1356</updated_by_id><locales><locale><code>DEFAULT</code><created_at/></locale><locale><code>en</code><created_at/></locale></locales></group></groups></user></authentication>"
   end
 
 end

data/spec/guard_spec.rb

@@ -7,13 +7,13 @@ module ActionView
 end
 module Erector
   class Widget
-    
+
     attr_writer :controller
-    
+
     class Helpers
       attr_accessor :controller
     end
-    
+
     def helpers
       @helpers ||= Helpers.new
       @helpers.controller = @controller
@@ -38,7 +38,7 @@ describe Ixtlan::Models::Permission do
 
 end
 
-class Controller 
+class Controller
   include ActionController::Base
 end
 

data/spec/guards/samples.rb

@@ -1,12 +1,12 @@
-Ixtlan::Guard.initialize(:permissions, 
-                         { :show => [:guest], 
-                           :edit => [:root, :admin], 
-                           :update => [:root, :admin], 
+Ixtlan::Guard.initialize(:permissions,
+                         { :show => [:guest],
+                           :edit => [:root, :admin],
+                           :update => [:root, :admin],
                            :destroy => [:root] }
                          )
 
-Ixtlan::Guard.initialize(:configurations, 
-                         { :show => [:admin], 
-                           :edit => [:root], 
+Ixtlan::Guard.initialize(:configurations,
+                         { :show => [:admin],
+                           :edit => [:root],
                            :update => [:root] }
                          )

data/spec/modified_by_spec.rb

@@ -0,0 +1,82 @@
+require 'pathname'
+require Pathname(__FILE__).dirname + 'spec_helper.rb'
+require 'ixtlan' / 'modified_by'
+
+class User
+  include DataMapper::Resource
+
+  property :login, String, :key => true
+end
+
+class AuditedName
+  include DataMapper::Resource
+
+  # TODO remove serial
+  property :id, Serial
+  property :name, String, :length => 2..255#, :key => true
+
+  modified_by User
+end
+
+describe Ixtlan::ModifiedBy do
+
+  before :each do
+    @user = User.create(:login => 'spock')
+    @second = User.create(:login => 'dr pill')
+    @name = AuditedName.create(:name => 'kirk', :current_user => @user)
+  end
+
+  it 'should create resource with modified by properties' do
+    @name.new?.should be_false
+    @name.instance_variable_get(:@current_user).should be_nil
+    @name.created_by.should == @user
+    @name.updated_by.should == @user
+  end
+
+  it 'should new/save resource with modified by properties' do
+    name = AuditedName.new(:name => 'seven of nine')
+    name.current_user = @user
+    name.save.should be_true
+    name.created_by.should == @user
+    name.updated_by.should == @user
+  end
+
+  it 'should modify updated_by on change' do
+    @name.current_user = @second
+    @name.name = "scotty"
+    @name.save.should be_true
+    @name.created_by.should == @user
+    @name.updated_by.should == @second
+  end
+
+  it 'should modify updated_by on update' do
+    @name.update(:name => "captain kirk", :current_user => @second)
+    @name.instance_variable_get(:@current_user).should be_nil
+    @name.updated_by.should == @second
+  end
+
+  it 'should not modify updated_by on update without change' do
+    @name.update(:name => "kirk", :current_user => @second)
+    @name.updated_by.should == @user
+    @name.instance_variable_get(:@current_user).should be_nil
+  end
+
+  it 'should modify updated_by on update with current_user' do
+    @name.current_user = @second
+    @name.update(:name => "captain kirk")
+    @name.updated_by.should == @second
+  end
+
+  it 'should fail create without current_user' do
+    lambda { AuditedName.create(:name => "ohura") }.should raise_error(DataMapper::MissingCurrentUserError)
+  end
+
+  it 'should fail save without current_user' do
+    @name.name = "ohura"
+    lambda { @name.save }.should raise_error(DataMapper::MissingCurrentUserError)
+  end
+
+  it 'should fail update without current_user' do
+    lambda { @name.update(:name => "ohura") }.should raise_error(DataMapper::MissingCurrentUserError)
+  end
+end

data/spec/optimistic_persistence_spec.rb

@@ -0,0 +1,58 @@
+require 'pathname'
+require Pathname(__FILE__).dirname + 'spec_helper.rb'
+
+require 'ixtlan/optimistic_persistence'
+
+class Name
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String, :length => 2..255
+
+  timestamps :updated_at
+end
+
+class Number
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :number, Integer
+end
+
+describe "Ixtlan::OptimisticPersistence" do
+
+  before :each do
+    @name = Name.create(:name => "frodo")
+    @second = Name.get(@name.id)
+    @number = Number.first_or_create(:number => 123)
+    @other = Number.first
+  end
+
+  it 'should save' do
+    @name.name = "gandalf"
+    @name.save.should be_true
+  end
+
+  it 'should fail' do
+    @name.name = "gandalf"
+    sleep 1
+    @name.save.should be_true
+    @second.name = "saroman"
+    lambda { @second.save }.should raise_error(DataMapper::StaleResourceError)
+  end
+
+  it 'should fail on key change' do
+    pending "maybe bug in datamapper"
+    @name.id = 11
+    @name.save.should be_true
+    @second.id = 111
+    lambda { @second.save }.should raise_error(DataMapper::StaleResourceError)
+  end
+
+  it 'should treat non optimistic resources as usual' do
+    @number.number = 345
+    @number.save.should be_true
+    @other.number = 987
+    @other.save.should be_true
+  end
+end