puavo_organisation 0.0.1

data/README.rdoc

@@ -0,0 +1,34 @@
+Puavo applications need this plugin for configuration of organisations. One Puavo application installation can serve many organisations.
+
+*Configuration* *file*: (config/organisations.yml)
+
+* host
+  * Fully-qualified domain name. This information is used to identify the organisation's (eq. puavo.example.org)
+* ldap_host
+  * LDAP server address
+* ldap_base
+  * Organisation's LDAP base (eq. dc=edu,dc=example,dc=org)
+* locale
+  * Default locale
+* owner
+  * Organisation's owner (this is only needed for Cucumber test)
+* owner_pw
+  * Organisation's onwer password (this is only needed for Cucumber test)
+
+== Copyright
+
+Copyright © 2010 Opinsys Oy
+
+This program is free software; you can redistribute it and/or modify it 
+under the terms of the GNU General Public License as published by the 
+Free Software Foundation; either version 2 of the License, or (at your 
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but 
+WITHOUT ANY WARRANTY; without even the implied warranty of 
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General 
+Public License for more details.
+
+You should have received a copy of the GNU General Public License along 
+with this program; if not, write to the Free Software Foundation, Inc., 
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the puavo_organisation plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the puavo_organisation plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PuavoOrganisation'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/puavo/organisation.rb

@@ -0,0 +1,56 @@
+module Puavo
+  class Organisation
+    @@configurations = YAML.load_file("#{RAILS_ROOT}/config/organisations.yml")
+    @@key_by_host = {}
+    @@configurations.each do |key, value|
+      @@key_by_host[ value["host"] ] = key
+    end
+
+    cattr_accessor :configurations, :key_by_host
+    attr_accessor :organisation_key
+
+    def schools
+      School.all
+    end
+
+    def value_by_key(key)
+      @@configurations[organisation_key][key]
+    end
+
+    def method_missing(method, *args)
+      if @@configurations[organisation_key].has_key?(method.to_s)
+        @@configurations[organisation_key][method.to_s]
+      else
+        super
+      end
+    end
+
+    class << self
+      def find(key)
+        if self.configurations.has_key?(key)
+          organisation = Organisation.new
+          organisation.organisation_key = key
+          organisation
+        else
+          logger.info "Can not find configuration key: #{key}"
+          false
+        end
+      end
+
+      def find_by_host(host)
+        if @@key_by_host.has_key?(host)
+          organisation = Organisation.new
+          organisation.organisation_key = @@key_by_host[host]
+          organisation
+        else
+          logger.info "Can not find organisation by host: #{host}"
+          false
+        end
+      end
+
+      def logger
+        RAILS_DEFAULT_LOGGER
+      end
+    end
+  end
+end

data/lib/puavo_organisation/controllers/helpers.rb

@@ -0,0 +1,52 @@
+module PuavoOrganisation
+  module Controllers
+    module Helpers
+      def self.included(controller)
+        controller.class_eval do  
+          before_filter :set_organisation_to_session, :set_locale
+          helper_method :theme
+        end
+      end
+      def set_organisation_to_session
+        if session[:organisation].nil?
+          # Find organisation by request.host.
+          # If you don't need multiple organisations you have to only set default organisation
+          # with: config/organisations.yml
+          # default
+          #   name: Default organisation
+          #   host: *
+          session[:organisation] = Puavo::Organisation.find_by_host(request.host)
+          # Find default organisation (host == "*") if request host not found from configurations.
+          session[:organisation] = Puavo::Organisation.find_by_host("*") unless session[:organisation]
+          unless session[:organisation]
+            # FATAL error
+            # FIXME: redirect to login page?
+            # FIXME: text localization
+            render :text => "Can't find organisation."
+            return false
+          end
+        else
+          # Compare session host to client host. This is important security check.
+          unless session[:organisation].host == request.host || session[:organisation].host == "*"
+            # This is a serious problem. Some one trying to hack this system.
+            # FIXME, redirect to login page?
+            # FIXME: text localization
+            logger.info "Default organisation not found!"
+            render :text => "Session error"
+            return false
+          end
+        end
+      end
+
+      def set_locale
+        I18n.locale = session[:organisation].value_by_key('locale') ?
+        session[:organisation].value_by_key('locale') : :en
+      end
+
+      def theme
+        # session[:theme] ? session[:theme] : "tea"
+        "gray"
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require 'puavo/organisation'
+require 'puavo_organisation/controllers/helpers'
+
+ActionController::Base.send :include, PuavoOrganisation::Controllers::Helpers

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: puavo_organisation
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jouni Korhonen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-06 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Organisation configuration plugin for Puavo applications
+email: puavo@opinsys.fi
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- init.rb
+- README.rdoc
+- lib/puavo_organisation.rb
+- lib/puavo/organisation.rb
+- lib/puavo_organisation/controllers/helpers.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/opinsys/puavo_organisation
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Organisation configuration plugin for Puavo applications
+test_files: []
+