tokak_engine 0.0.2 → 0.0.3

data/.gitignore

@@ -1 +1,3 @@
 pkg
+doc
+.yardoc

data/README.markdown

@@ -0,0 +1,9 @@
+TokakEngine
+===========
+
+Tokak Engine is the heart of Tokak services.
+
+It consists of authentication system that uses passport.tokak.ru
+for cross-service authentication and some common objects and modules.
+
+Copyright © 2009 [Alexander Semyonov](http://rotuka.com/), released under the MIT license

data/Rakefile

@@ -47,3 +47,5 @@ rescue LoadError
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end
+task :rdoc => :yardoc
+task :doc => :yardoc

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/config/application.yml

@@ -0,0 +1,11 @@
+production: &production
+  canonical_host: service_name.tokak.ru
+  domain: .tokak.ru
+
+development:
+  <<: *production
+  canonical_host: service_name.tokak.local
+  domain: .tokak.local
+
+test:
+  <<: *production

data/lib/canonical_host.rb

@@ -1,3 +1,8 @@
+# Rack middleware to redirect to canonical hosts from www and other ugly subdomain names
+# @author tylerhunt, http://coderack.org/users/tylerhunt
+# @example redirects to canonical host
+#   use CanonicalHost, 'example.com'
+# @see http://coderack.org/users/tylerhunt/entries/6-canonical-host
 class CanonicalHost
   def initialize(app, host=nil, &block)
     @app = app

data/lib/tokak_engine/application.rb

@@ -1,9 +1,50 @@
 module TokakEngine
   module Application
     extend self
+    mattr_accessor :config
 
-    def load_config
-      @@config = YAML.load_file(File.join(Rails.root, 'config', 'application.yml')).to_hash.with_indifferent_access[Rails.env]
+    # Default configuration options
+    def default_config
+      @@default_config = {
+        :canonical_host => 'tokak.ru',
+        :domain => '.tokak.ru'
+      }
+    end
+
+    # Autoload application config from application.yml
+    # @return [Hash] application configuration for current environment
+    def config
+      unless @@config
+        file_name = File.join(Rails.root, 'config', 'application.yml')
+        @@config = if File.exists?(file_name)
+                     YAML.load_file(file_name).
+                       to_hash.
+                       with_indifferent_access[Rails.env]
+                    else
+                      {}
+                    end.reverse_merge!(default_config)
+      end
+      @@config
+    end
+
+    # Retuns configured canonical host
+    def canonical_host
+      config[:canonical_host]
+    end
+
+    # Returns configured session domain
+    def domain
+      config[:domain]
+    end
+
+    def passport_url
+      "http://passport#{domain}/"
+    end
+
+    # Initialize canonical host and cookies (session) domain
+    def init_engine
+      ActionController::Base.session_options[:domain] = domain
+      ActionController::Dispatcher.middleware.use 'CanonicalHost', canonical_host
     end
   end
 end

data/lib/tokak_engine/authentication.rb

@@ -16,57 +16,106 @@ module TokakEngine
     end
 
     module InstanceMethods
+      # Returns current user session
+      #
+      # @return [UserSession, nil] an Authlogic session object or nil if not signed in
       def current_user_session
         return @current_user_session if defined?(@current_user_session)
         @current_user_session = UserSession.find
       end
 
+      # Returns current user
+      #
+      # @return [User, nil] a signed in User or nil if anonymous user
       def current_user
         return @current_user if defined?(@current_user)
         @current_user = current_user_session && current_user_session.user
       end
 
+      # @deprecated Use {#current_user} instead
+      # Does user signed in?
+      #
+      # @return [User, nil]
       def logged_in?
         current_user
       end
 
+      # Filter to allow only signed in users
+      # @return [nil, false] return false to break filter chain and redirect to passport
       def require_user
-        return deny_access unless logged_in?
+        return deny_access unless current_user
       end
 
+      # Filter to allow only anonymous users
+      # @return [nil, false] return false to break filter chain and redirect to account page
       def require_no_user
         return deny_access(:error,
                            'You must be logged out to access this page',
                            account_path) if current_user
       end
 
+      # Denies user access for page, set flash message
+      # @param [Symbol] status of flash message
+      # @param [String] default flash message (without I18n support)
+      # @param [String, Hash] path to redirect
       def deny_access(status = :error, message = 'You must be logged in to access this page', redirect = nil)
         store_location
         set_flash_message!(status, message)
         redirect_to(redirect || signin_path(:return_to => request.request_uri))
         return false
       end
+      
+      # Path to passport signin
+      # @option options [String, Hash] :return_to Path to return to after signin in
+      def signin_path(options = {})
+        passport_path('signin', options)
+      end
+
+      # Path to passport signout
+      # @option options [String, Hash] :return_to Path to return to after signin out
+      def signout_path(options = {})
+        passport_path('signout', options)
+      end
 
     protected
+      def passport_path(relative_path, options = {})
+        returning('') do |url|
+          url << TokakEngine::Application.passport_url
+          url << relative_path
+          unless options.empty?
+            params = options.collect do |param, value|
+                       "#{CGI.escape(param)}=#{CGI.escape(value)}"
+                     end
+            url << "?#{params}"
+          end
+        end
+      end
+
+      # Stores location in session to come back after signing in/out
       def store_location
         if request.get?
-          session[:return_to] = request.request_uri
+          cookies[:return_to] = request.request_uri
         end
       end
 
+      # Redirects back to stored location or default path
+      # @param [String, Hash] default path to redirect to
       def redirect_back_or(default)
         redirect_to(return_to || default)
         clear_return_to
       end
 
+      # Return path to redirect to after signin in/out
       def return_to
-        session[:return_to] || params[:return_to]
+        cookies[:return_to] || params[:return_to]
       end
 
+      # Clears stored location for redirection
       def clear_return_to
-        session[:return_to] = nil
+        cookies.delete(:return_to)
       end
 
+      # Redirects to root_path
       def redirect_to_root
         redirect_to(root_path)
       end

data/lib/tokak_engine/user.rb

@@ -28,18 +28,25 @@ module TokakEngine
     module InstanceMethods
       unloadable
 
+      # Alias for {#avatars}
       def user_avatars(*args)
         self.avatars(*args)
       end
 
+      # Full user’s name
+      # @return [String, nil] name if first name or last one presents, nil if none presents
       def name
-        [self.first_name, self.last_name].compact.join(' ')
+        [self.first_name, self.last_name].compact.join(' ') if self.first_name.present? || self.last_name.present?
       end
 
+      # Returns text representation of user
+      # @return [String] nick name or full name or email
       def to_s
         self.nick_name || self.name || self.email
       end
 
+      # User’s gender
+      # @return [String] user’s gender as I18zed string
       def gender
         I18n.t(GENDERS[self.gender_id], :prefix => 'options.user.gender', :default => GENDERS[self.gender_id].to_s.humanize)
       end

data/lib/tokak_engine.rb

@@ -4,5 +4,5 @@ end
 require 'tokak_engine/authentication'
 require 'tokak_engine/application'
 
-TokakEngine::Application.load_config
+TokakEngine::Application.config
 ActionView::Base.send(:include, TokakHelper)

data/rails/init.rb

@@ -1 +1 @@
-# Include hook code here
+require 'tokak­engine'

data/tokak_engine.gemspec

@@ -5,19 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tokak_engine}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Semyonov"]
-  s.date = %q{2009-11-07}
+  s.date = %q{2009-11-08}
   s.email = %q{rotuka@tokak.ru}
   s.extra_rdoc_files = [
-    "README"
+    "README.markdown"
   ]
   s.files = [
     ".gitignore",
      "MIT-LICENSE",
-     "README",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "app/helpers/tokak_helper.rb",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "app/views/user_avatars/_user_avatar.html.haml",
      "app/views/user_avatars/index.html.haml",
      "app/views/users/_user_bar.html.haml",
+     "config/application.yml",
      "db/migrate/20090926100710_create_users.rb",
      "db/migrate/20091017071436_create_identifiers.rb",
      "db/migrate/20091017071522_create_openid_identifiers.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tokak_engine
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Alexander Semyonov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +03:00
+date: 2009-11-08 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -20,11 +20,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.markdown
 files: 
 - .gitignore
 - MIT-LICENSE
-- README
+- README.markdown
 - Rakefile
 - VERSION
 - app/helpers/tokak_helper.rb
@@ -36,6 +36,7 @@ files:
 - app/views/user_avatars/_user_avatar.html.haml
 - app/views/user_avatars/index.html.haml
 - app/views/users/_user_bar.html.haml
+- config/application.yml
 - db/migrate/20090926100710_create_users.rb
 - db/migrate/20091017071436_create_identifiers.rb
 - db/migrate/20091017071522_create_openid_identifiers.rb

data/README

@@ -1,13 +0,0 @@
-TokakEngine
-===========
-
-Introduction goes here.
-
-
-Example
-=======
-
-Example goes here.
-
-
-Copyright (c) 2009 [name of plugin creator], released under the MIT license