has_global_session 1.0 → 1.1.0

data/has_global_session.gemspec

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# -*- mode: ruby; encoding: utf-8 -*-
 
 require 'rubygems'
 
@@ -7,7 +7,7 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
 
   s.name    = 'has_global_session'
-  s.version = '1.0'
+  s.version = '1.1.0'
   s.date    = '2010-07-27'
 
   s.authors = ['Tony Spataro']
@@ -32,7 +32,3 @@ spec = Gem::Specification.new do |s|
             Dir['rails_generators/**/*']
   s.files = candidates.sort
 end
-
-if $PROGRAM_NAME == __FILE__
-   Gem::Builder.new(spec).build
-end

data/lib/has_global_session.rb

@@ -49,6 +49,9 @@ require 'uuidtools'
 require 'json'
 require 'active_support'
 
+#Require Ruby library dependencies
+require 'openssl'
+
 #Require the core suite of HasGlobalSession classes and modules
 basedir = File.dirname(__FILE__)
 require File.join(basedir, 'has_global_session', 'configuration')

data/lib/has_global_session/configuration.rb

@@ -22,6 +22,13 @@ module HasGlobalSession
   #     * name
   #     * domain
   #
+  # === Config Environments
+  # The operational environment of has_global_session defines which section
+  # of the configuration file it gets its settings from. When used with
+  # a web app, the environment should be set to the same environment as
+  # the web app. (If using Rails integration, this happens for you
+  # automatically.)
+  #
   # === Environment-Specific Settings
   # The top level of keys in the configuration hash are special; they provide different
   # sections of settings that apply in different environments. For instance, a Rails
@@ -44,55 +51,38 @@ module HasGlobalSession
   # The name and location of the config file depend on the Web framework with which
   # you are integrating; see HasGlobalSession::Rails for more information.
   #
-  module Configuration
-    # Reader for the environment module-attribute.
-    #
-    # === Return
-    # env(String):: The current configuration environment
-    def self.environment; @environment; end
-
-    # Writer for the environment module-attribute.
-    #
-    # === Parameters
-    # value(String):: Configuration environment from which settings should be read
-    #
-    # === Return
-    # env(String):: The new configuration environment
-    def self.environment=(value); @environment = value; end
-
-    # Reader for the config_file module-attribute.
-    #
-    # === Return
-    # file(String):: Absolute path to configuration file
-    def self.config_file; @config_file; end
-
-    # Writer for the config_file module-attribute.
+  class Configuration
+    # Create a new Configuration objectt
     #
     # === Parameters
-    # value(String):: Absolute path to configuration file
+    # config_File(String):: Absolute path to the configuration file
+    # environment(String):: Config file section from which
     #
-    # === Return
-    # env(String):: The new path to the configuration file
-    def self.config_file=(value); @config_file= value; end
+    # === Raise
+    # MissingConfiguration:: if config file is missing or unreadable
+    # TypeError:: if config file does not contain a YAML-serialized Hash
+    def initialize(config_file, environment)
+      raise MissingConfiguration, "Missing or unreadable configuration file" unless File.readable?(config_file)
+      @config      = YAML.load(File.read(config_file))
+      @environment = environment
+      raise TypeError, "#{config_file} must contain a Hash!" unless Hash === @config
+      validate
+    end
 
     # Reader for configuration elements. The reader first checks
     # the current environment's settings section for the named
     # value; if not found, it checks the common settings section.
     #
     # === Parameters
-    # name(Type):: Description
+    # key(String):: Name of configuration element to retrieve
     #
     # === Return
-    # name(Type):: Description
-    #
-    # === Raise
-    # MissingConfiguration:: if config file location is unset, environment is unset, or config file is missing
-    # TypeError:: if config file does not contain a YAML-serialized Hash
-    def self.[](key)
+    # value(String):: the value of the configuration element
+    def [](key)
       get(key, true)
     end
 
-    def self.validate # :nodoc
+    def validate # :nodoc
       ['attributes/signed', 'integrated', 'cookie/name', 'timeout'].each do |path|
         elements = path.split '/'
         object = get(elements.shift, false)
@@ -108,17 +98,10 @@ module HasGlobalSession
 
     private
 
-    def self.get(key, validated) # :nodoc
-      unless @config
-        raise MissingConfiguration, "config_file is nil; cannot read configuration" unless config_file
-        raise MissingConfiguration, "environment is nil; must be specified" unless environment
-        @config = YAML.load(File.read(config_file))
-        raise TypeError, "#{config_file} must contain a Hash!" unless Hash === @config
-        validate if validated
-      end
-      if @config.has_key?(environment) &&
-         @config[environment].has_key?(key)
-        return @config[environment][key]
+    def get(key, validated) # :nodoc
+      if @config.has_key?(@environment) &&
+         @config[@environment].has_key?(key)
+        return @config[@environment][key]
       else
         @config['common'][key]
       end

data/lib/has_global_session/directory.rb

@@ -29,7 +29,7 @@ module HasGlobalSession
   # at initialization time.
   #
   class Directory
-    attr_reader :authorities, :private_key, :local_authority_name
+    attr_reader :configuration, :authorities, :private_key, :local_authority_name
 
     # Create a new Directory.
     #
@@ -38,7 +38,8 @@ module HasGlobalSession
     #
     # ===Raise
     # ConfigurationError:: if too many or too few keys are found, or if *.key/*.pub files are malformatted
-    def initialize(keystore_directory)
+    def initialize(configuration, keystore_directory)
+      @configuration = configuration
       certs = Dir[File.join(keystore_directory, '*.pub')]
       keys  = Dir[File.join(keystore_directory, '*.key')]
       raise ConfigurationError, "Excepted 0 or 1 key files, found #{keys.size}" unless [0, 1].include?(keys.size)
@@ -51,7 +52,7 @@ module HasGlobalSession
         raise ConfigurationError, "Expected #{basename} to contain an RSA public key" unless @authorities[authority].public?
       end
 
-      if (authority_name = Configuration['authority'])
+      if (authority_name = @configuration['authority'])
         key_file = keys.detect { |kf| kf =~ /#{authority_name}.key$/ }
         raise ConfigurationError, "Key file #{authority_name}.key not found" unless key_file        
         @private_key  = OpenSSL::PKey::RSA.new(File.read(key_file))
@@ -69,7 +70,7 @@ module HasGlobalSession
     # === Return
     # trusted(true|false):: whether the local system trusts sessions signed by the specified authority
     def trusted_authority?(authority)
-      Configuration['trust'].include?(authority)
+      @configuration['trust'].include?(authority)
     end
 
     # Determine whether the given session UUID is valid. The default implementation only considers

data/lib/has_global_session/global_session.rb

@@ -29,8 +29,9 @@ module HasGlobalSession
     # MalformedCookie:: if the cookie was corrupt or malformed
     # SecurityError:: if signature is invalid or cookie is not signed by a trusted authority
     def initialize(directory, cookie=nil, valid_signature_digest=nil)
-      @schema_signed   = Set.new((Configuration['attributes']['signed']))
-      @schema_insecure = Set.new((Configuration['attributes']['insecure']))
+      @configuration   = directory.configuration
+      @schema_signed   = Set.new((@configuration['attributes']['signed']))
+      @schema_insecure = Set.new((@configuration['attributes']['insecure']))
       @directory       = directory
 
       if cookie && !cookie.empty?
@@ -200,7 +201,7 @@ module HasGlobalSession
     # true:: Always returns true
     def renew!
       authority_check
-      @expired_at = Configuration['timeout'].to_i.minutes.from_now.utc
+      @expired_at = @configuration['timeout'].to_i.minutes.from_now.utc
       @dirty_secure = true
     end
 

data/lib/has_global_session/integrated_session.rb

@@ -105,5 +105,19 @@ module HasGlobalSession
       @global.each_pair(&block)
       @local.each_pair(&block)
     end
+
+    def respond_to?(meth) # :nodoc:
+      return @global.respond_to?(meth) || @local.respond_to?(meth) || super
+    end
+    
+    def method_missing(meth, *args) # :nodoc:
+      if @global.respond_to?(meth)
+        @global.__send__(meth, *args)
+      elsif @local.respond_to?(meth)
+        @local.__send__(meth, *args)
+      else
+        super
+      end
+    end
   end
 end

data/lib/has_global_session/rails.rb

@@ -1,4 +1,5 @@
 basedir = File.dirname(__FILE__)
 
 #Require the files necessary for Rails integration
+require File.join(basedir, 'rails', 'action_controller_class_methods')
 require File.join(basedir, 'rails', 'action_controller_instance_methods')

data/lib/has_global_session/rails/action_controller_class_methods.rb

@@ -0,0 +1,25 @@
+module HasGlobalSession
+  module Rails
+    # Module that is mixed into ActionController's eigenclass; provides access to shared
+    # app-wide data such as the configuration object.
+    module ActionControllerClassMethods
+      def global_session_config
+        unless @global_session_config
+          config_file = File.join(RAILS_ROOT, 'config', 'global_session.yml')
+          @global_session_config = HasGlobalSession::Configuration.new(config_file, RAILS_ENV)
+          @global_session_config.config_file = config_file
+        end
+
+        return @global_session_config
+      end
+
+      def global_session_config=(config)
+        @global_session_config = config
+      end
+
+      def has_global_session
+        include HasGlobalSession::Rails::ActionControllerInstanceMethods
+      end
+    end
+  end
+end

data/lib/has_global_session/rails/action_controller_instance_methods.rb

@@ -21,6 +21,15 @@ module HasGlobalSession
         base.after_filter  :global_session_update_cookie
       end
 
+      # Shortcut accessor for global session configuration object. Simply delegates to
+      # the class method of the same name defined by ActionController::Base.
+      #
+      # === Return
+      # config(HasGlobalSession::Configuration)
+      def global_session_config
+        ActionController::Base.global_session_config
+      end
+
       # Global session reader.
       #
       # === Return
@@ -35,7 +44,7 @@ module HasGlobalSession
       # === Return
       # session(IntegratedSession):: the integrated session
       def session_with_global_session
-        if Configuration['integrated'] && @global_session
+        if global_session_config['integrated'] && @global_session
           unless @integrated_session &&
                  (@integrated_session.local == session_without_global_session) && 
                  (@integrated_session.global == @global_session)
@@ -56,7 +65,7 @@ module HasGlobalSession
       # true:: Always returns true
       def global_session_read_cookie
         directory   = global_session_create_directory
-        cookie_name = Configuration['cookie']['name']
+        cookie_name = global_session_config['cookie']['name']
         cookie      = cookies[cookie_name]
 
         begin
@@ -89,7 +98,7 @@ module HasGlobalSession
       # true:: Always returns true
       def global_session_auto_renew
         #Auto-renew session if needed
-        renew = Configuration['renew']
+        renew = global_session_config['renew']
         if @global_session &&
            renew &&
            @global_session.directory.local_authority_name &&
@@ -105,13 +114,13 @@ module HasGlobalSession
       # === Return
       # true:: Always returns true
       def global_session_update_cookie
-        name   = Configuration['cookie']['name']
-        domain = Configuration['cookie']['domain'] || request.env['SERVER_NAME']
+        name   = global_session_config['cookie']['name']
+        domain = global_session_config['cookie']['domain'] || request.env['SERVER_NAME']
 
         begin
           if @global_session && @global_session.valid?
             value   = @global_session.to_s
-            expires = Configuration['ephemeral'] ? nil : @global_session.expired_at
+            expires = global_session_config['ephemeral'] ? nil : @global_session.expired_at
 
             unless (cookies[name] == value)
               #Update the cookie only if its value has changed
@@ -172,7 +181,7 @@ module HasGlobalSession
       private
 
       def global_session_create_directory # :nodoc:
-        if (klass = Configuration['directory'])
+        if (klass = global_session_config['directory'])
           klass = klass.constantize
         else
           klass = Directory

data/rails/init.rb

@@ -1,21 +1,13 @@
 basedir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 libdir  = File.join(basedir, 'lib')
-require File.join(libdir, 'has_global_session')
-
 config_file = File.join(RAILS_ROOT, 'config', 'global_session.yml')
 
 if File.exist?(config_file)
-  # Tie the Configuration module to Rails' filesystem structure
-  # and operating environment.
-  HasGlobalSession::Configuration.config_file = config_file
-  HasGlobalSession::Configuration.environment = RAILS_ENV
-  
+  require File.join(libdir, 'has_global_session')
   require File.join(libdir, 'has_global_session', 'rails')
 
   # Enable ActionController integration.
-  class ActionController::Base
-    def self.has_global_session
-      include HasGlobalSession::Rails::ActionControllerInstanceMethods
-    end
+  class <<ActionController::Base
+    include HasGlobalSession::Rails::ActionControllerClassMethods
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_global_session
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  version: "1.0"
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tony Spataro
@@ -133,6 +134,7 @@ files:
 - lib/has_global_session/global_session.rb
 - lib/has_global_session/integrated_session.rb
 - lib/has_global_session/rails.rb
+- lib/has_global_session/rails/action_controller_class_methods.rb
 - lib/has_global_session/rails/action_controller_instance_methods.rb
 - rails/init.rb
 - rails_generators/global_session_authority/USAGE