sbsm 1.3.0 → 1.3.1

data/lib/sbsm/time.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 #
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
@@ -22,6 +23,7 @@
 # hwyss@ywesee.com
 #
 # Time -- sbsm -- 20.11.2002 -- hwyss@ywesee.com 
+#++
 
 class Time
 	def rfc1123

data/lib/sbsm/trans_handler.rb

@@ -1,58 +1,87 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 # SBSM::TransHandler -- sbsm -- 25.01.2012 -- mhatakeyama@ywesee.com
 # SBSM::TransHandler -- sbsm -- 23.09.2004 -- hwyss@ywesee.com
+#++
 
 $USING_STRSCAN = true
 require 'cgi'
 require 'singleton'
 require 'yaml'
+require 'rack'
+module Rack
+  class Request
+    attr_accessor :uri # monkey patch for Rack::Request
+  end
+end
+
+
+module Apache
+  DECLINED = -1 unless defined?(DECLINED)
+end
 
 module SBSM
 	class AbstractTransHandler
-		attr_reader :parser_name
-    CONFIG_PATH = '../etc/trans_handler.yml'
+    # * +parser_name+  -      Name defaults to 'uri'
+    attr_reader :parser_name
+    # * +config_file+ -       Full path of YAML configuration file for shortcuts
+    attr_reader :config_file
+    # * +handler_uri+ -       The handler file to be used
+    attr_reader :handler_uri
+    @@empty_check ||= nil
+    @@lang_check ||= nil
+    @@uri_parser ||= nil
 
-		@@empty_check ||= nil
-		@@lang_check ||= nil
-		@@uri_parser ||= nil
-		HANDLER_URI = '/index.rbx'
-		def initialize(name)
-			@parser_name = name
-			@parser_method = "_#{name}_parser"
-			@grammar_path = File.expand_path("../../data/#{name}.grammar", 
-				File.dirname(__FILE__).untaint)
-			@parser_path = File.expand_path("#{name}_parser.rb", 
-				File.dirname(__FILE__).untaint)
-		end
+    #
+    # === arguments
+    #
+    # * +name+ -              Used for checking whether a 'name'.grammar or
+    #   'name'_parser.rb can be loaded
+    # * +config_file+ -       Where the config file can be found. Default to 'etc/trans_handler.yml'
+    # * +handler_ur+ -        The handler to be invoked. defaults to '/index.rbx'
+    #
+    def initialize(name: nil, config_file: nil, handler_uri: nil)
+      @handler_uri = handler_uri ||=  '/index.rbx'
+      config_file ||=  'etc/trans_handler.yml'
+      @config_file = File.expand_path(config_file).untaint
+      @parser_name = name ||= 'uri'
+      @parser_method = "_#{name}_parser"
+      @grammar_path = File.expand_path("../../data/#{name}.grammar",
+        File.dirname(__FILE__).untaint)
+      @parser_path = File.expand_path("#{name}_parser.rb",
+        File.dirname(__FILE__).untaint)
+    end
     def config(request)
-      config = Hash.new { {} } 
-			begin
-        path = File.expand_path(CONFIG_PATH.untaint, request.server.document_root.untaint)
-        path.untaint
-        config.update(YAML.load(File.read(path)))
+      config = Hash.new { {} }
+      begin
+        return config unless @config_file && File.exist?(@config_file)
+        config.update(YAML.load(File.read(@config_file)))
         config
-			rescue StandardError => err
-				fmt = 'Unable to load url configuration: %s'
-				request.server.log_warn(fmt, err.message)
-				fmt = 'Hint: store configuration in a YAML-File at DOCUMENT_ROOT/%s'
-				request.server.log_notice(fmt, CONFIG_PATH)
+      rescue StandardError => err
+        fmt = 'Unable to load url configuration: %s', @config_file
+        fmt = 'Hint: store configuration in a YAML-File'
         config
-			end
+      end
     end
-		def handle_shortcut(request, config)
-			if(notes = config['shortcut'][request.uri])
-				notes.each { |key, val|
-					request.notes.add(key, val)
-				}
-				request.uri = HANDLER_URI
-			end
-		end
+    # * +request+ -    A Rack::Request with our monkey patch to access :uri
+    # * +config+ -     config values for shortcuts (Hash of Hash)
+    def handle_shortcut(request, config)
+      if(params = config['shortcut'][request.path])
+        params.each do |key, val|
+          request.params[key.to_s] = val ? val : ''
+        end
+        request.uri = @handler_uri
+      end
+    end
+    # * +uri+ - uri to be parsed, e.g. /language/flavor/event/key/value/key/value/...
+    #
+    # language, flavor and event are added as special keys, else
+    # values are inserted as string
     def simple_parse(uri)
-      # /language/flavor/event/key/value/key/value/...
+      values = {}
       items = uri.split('/')
       items.shift
-      values = {}
       lang = items.shift
       values.store(:language, lang) if lang
       flavor = items.shift
@@ -66,16 +95,21 @@ module SBSM
       end
       values
     end
+    # * +request+ -    A Rack::Request with our monkey patch to access :uri
     def simple_parse_uri(request)
-			values = request.notes
-      simple_parse(request.uri).each do |key, value|
-        values.add(key.to_s, CGI.unescape(value.to_s))
+			# values = request.params
+      simple_parse(request.path).each do |key, value|
+          request.env[key.to_s] = value ? value : ''
+        request.update_param(key.to_s, CGI.unescape(value.to_s))
       end
     end
+    # The default parser for an URI
+    # === arguments
+    # * +request+ -    A Rack::Request with our monkey patch to access :uri
 		def parse_uri(request)
-			@uri_parser ||= self.uri_parser 
-			ast = @uri_parser.parse(request.uri)
-			values = request.notes
+			@uri_parser ||= self.uri_parser
+			ast = @uri_parser.parse(request.path)
+			values = request.params
 			ast.children_names.each { |name|
 				case name
 				when'language', 'flavor', 'event', 'zone'
@@ -88,27 +122,29 @@ module SBSM
 						else
 							''
 						end
-						values.add(key, val)
+						request.update_param(key, val)
 					}
 				end
 			}
 		end
+    # * +request+ -    A Rack::Request with our monkey patch to access :uri
 		def translate_uri(request)
 			@@empty_check ||= Regexp.new('^/?$')
 			@@lang_check ||= Regexp.new('^/[a-z]{2}(/|$)')
+      uri = request.path
+      request.uri ||= uri
       config = config(request)
       handle_shortcut(request, config)
-      uri = request.uri
       case uri
       when @@empty_check
-        request.uri = config['redirect']['/'] || HANDLER_URI
+        request.uri = config['redirect']['/'] ||= @handler_uri
       when @@lang_check
         begin
           self.parse_uri(request)
         rescue LoadError
-          simple_parse_uri(request)
+          res = simple_parse_uri(request)
         end
-        request.uri = HANDLER_URI
+        request.uri = @handler_uri
       end
       Apache::DECLINED
 		end
@@ -130,8 +166,5 @@ module SBSM
 	end
 	class TransHandler < AbstractTransHandler
 		include Singleton
-		def initialize
-			super('uri')
-		end
 	end
 end

data/lib/sbsm/turing.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 # Turing -- SBSM -- 15.05.2009 -- hwyss@ywesee.com
+#++
 # Use a Hash instead of a PStore to manage Captchas
-
 require 'turing'
 require 'thread'
 

data/lib/sbsm/user.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 #
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
@@ -22,6 +23,7 @@
 # hwyss@ywesee.com
 #
 # User -- sbsm -- 20.11.2002 -- hwyss@ywesee.com 
+#++
 
 module SBSM
 	class User

data/lib/sbsm/validator.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 #
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
@@ -22,6 +23,7 @@
 # hwyss@ywesee.com
 #
 # Validator -- sbsm -- 15.11.2002 -- hwyss@ywesee.com 
+#++
 
 require 'digest/md5'
 require 'mail'

data/lib/sbsm/version.rb

@@ -1,3 +1,3 @@
 module SBSM
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/lib/sbsm/viralstate.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
+#--
 #
 # State Based Session Management
 # Copyright (C) 2004 Hannes Wyss
@@ -22,6 +23,7 @@
 # hwyss@ywesee.com
 #
 # ViralState -- sbsm -- 16.04.2004 -- hwyss@ywesee.com 
+#++
 
 module SBSM
 	module ViralState

data/sbsm.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
   spec.add_dependency 'mail'
   spec.add_dependency 'hpricot'
+  spec.add_dependency 'chrono_logger'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
@@ -33,7 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "watir"
   spec.add_development_dependency "watir-webdriver"
-  # gem 'page-object'
-
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "rack-test"
 end
 

data/test/simple_sbsm.rb

@@ -0,0 +1,207 @@
+#!/usr/local/bin/ruby
+# Niklaus Giger, November 2016
+# A simple example on how to use SBSM with webrick
+require 'drb/drb'
+require 'sbsm/logger'
+require 'sbsm/session'
+require 'sbsm/validator'
+require 'sbsm/drbserver'
+require 'sbsm/state'
+
+SERVER_URI  = 'druby://localhost:9876'
+SERVER_NAME = 'localhost:9878'
+
+# Some string shared with the unit test
+HOME_HTML_CONTENT = 'Überall zu Hause' # mit UTF-8!
+ABOUT_HTML_CONTENT = 'About SBSM: TDD ist great!'
+FEEDBACK_HTML_CONTENT = 'Give us your feedback about SBSM'
+CONFIRM_HTML_CONTENT = 'Please confirm your feedback'
+SENT_HTML_CONTENT = 'Thanks for you feedback! Hope to see you soon'
+
+
+module Demo
+  class GlobalState < SBSM::State
+  end
+  class Validator < SBSM::Validator
+    EVENTS = %i{
+      home
+      about
+      feedback
+    }
+    STRINGS = %i{
+      anrede
+      name
+    }
+  end
+
+  class HomeState < GlobalState
+    EVENTS = %i{
+      home
+      about
+      feedback
+    }
+    @@class_counter = 0
+    def initialize(session, user)
+      SBSM.info "HomeState #{session} DRb.front is #{DRb.front}"
+      @session = session
+      @member_counter = 0
+      super(session, user)
+    end
+    def to_html(cgi)
+      @@class_counter += 1
+      @member_counter += 1
+      SBSM.info "@member_counter now #{@member_counter}"
+      info = ["State is Home" ,
+      "pid is #{Process.pid}",
+      "request_path is #{@request_path}" ,
+      "@member_counter is #{@member_counter}",
+      "@@class_counter is #{@@class_counter}",
+      HOME_HTML_CONTENT,
+      ]
+      info.join("\n")
+    end
+  end
+  class AboutState < GlobalState
+    def initialize(session, user)
+      SBSM.info "AboutState #{session}"
+      super(session, user)
+    end
+    def to_html(cgi)
+      'About SBSM: TDD ist great!'
+    end
+  end
+  class FeedbackMail
+    attr_accessor :errors
+    attr_reader :email, :anrede, :name, :vorname, :firma, :adresse, :ort,
+                :telefon, :bestell_diss, :bestell_pedi, :text
+
+    def initialize(session)
+      @errors       = []
+      @session      = session
+      @email        = @session.user_input(:email)
+      @anrede       = @session.user_input(:anrede)
+      @name         = @session.user_input(:name)
+      @vorname      = @session.user_input(:vorname)
+      @firma        = @session.user_input(:firma)
+      @adresse      = @session.user_input(:adresse)
+      @ort          = @session.user_input(:ort)
+      @telefon      = @session.user_input(:telefon)
+      @bestell_diss = @session.user_input(:bestell_diss)
+      @bestell_pedi = @session.user_input(:bestell_pedi)
+      @text         = @session.user_input(:text)
+    end
+
+    def body
+      width = 25
+      body = []
+      body << 'Email-Adresse:'.ljust(width) + @email
+      body << 'Anrede:'.ljust(width) + @anrede
+      body << 'Name:'.ljust(width) + @name
+      body << 'Vorname:'.ljust(width) + @vorname
+      body << 'Firma:'.ljust(width) + @firma
+      body << 'Adresse:'.ljust(width) + @adresse
+      body << 'Ort:'.ljust(width) + @ort
+      body << 'Telefon:'.ljust(width) + @telefon
+      body << 'Bestellung Dissertion:'.ljust(width) + @bestell_diss
+      body << 'Bestellung Pädiatrie:'.ljust(width) + @bestell_pedi
+      body << 'Ihre Mitteilung:'.ljust(width) + @text
+      body.join("\n")
+    end
+
+    def error?(key)
+      @errors.include?(key)
+    end
+
+    def ready?
+      unless @email
+        false
+      else
+        true
+      end
+    end
+
+    def do_sendmail
+      smtp = Net::SMTP.new(Steinwies.config.mailer['server'])
+      smtp.start(
+        Steinwies.config.mailer['domain'],
+        Steinwies.config.mailer['user'],
+        Steinwies.config.mailer['pass'],
+        Steinwies.config.mailer['auth']
+      )
+      smtp.ready(@email, Steinwies.config.mailer['to']) {  |a|
+        a.write("Content-Type: text/plain; charset='UTF-8'\n")
+        a.write("Subject: Email von Deiner Webseite.\n")
+        a.write("\n")
+        a.write(body)
+      }
+    end
+  end
+  class SentState < GlobalState
+    def to_html(cgi)
+      SENT_HTML_CONTENT
+    end
+  end
+  class ConfirmState < GlobalState
+    DIRECT_EVENT = :confirm
+
+    def sendmail
+      @model.do_sendmail
+      SentState.new(@session, nil)
+    end
+
+    def back
+      KontaktState.new(@session, @model)
+    end
+    def to_html(cgi)
+      CONFIRM_HTML_CONTENT
+    end
+  end
+  class FeedbackState < GlobalState
+    DIRECT_EVENT = :feedback
+
+    def initialize(session, model)
+      SBSM.info "state/feedback.rb #{__LINE__} Steinwies init #{session.class} model #{model.class}"
+      super(session, model)
+    end
+    def to_html(cgi)
+      FEEDBACK_HTML_CONTENT
+    end
+    def confirm
+      mail = FeedbackMail.new(@session)
+      puts "state/feedback.rb #{__LINE__} confirm #{mail.inspect} #{mail.ready?.inspect}"
+      if mail.ready?
+        ConfirmState.new(@session, mail)
+      else
+        puts "Pushed error"
+        mail.errors.push(:email)
+        @model = mail
+        self
+      end
+    end
+  end
+  class GlobalState < SBSM::State
+    GLOBAL_MAP = {
+      :home         => Demo::HomeState,
+      :about        => Demo::AboutState,
+      :feedback     => Demo::FeedbackState,
+    }
+    DIRECT_EVENT = nil
+    # VIEW         = ::Demo::Home
+  end
+  class Session < SBSM::Session
+    DEFAULT_STATE    = HomeState
+    def initialize(key, app, validator=Validator.new)
+      SBSM.info "Session #{app}"
+      super(key, app, validator)
+    end
+  end
+  class SimpleSBSM < SBSM::App
+    SESSION = Session
+    attr_reader :drb_uri
+    def initialize
+      @drb_uri = SERVER_URI
+      SBSM.info "SimpleSBSM.new"
+      super(:app => self, :validator => Validator.new, :trans_handler => SBSM::TransHandler.instance)
+    end
+  end
+end