h2g_ajaxchat 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5575220d85e86b2c18aabfc6427cb88924328d4fc40c824038108727af5da1
-  data.tar.gz: a39989028a432c1c46d40aaecbe42012787261ef73a3f7cd199e31fb2ecf1e30
+  metadata.gz: 7db5c15f7f4833080876a74afc5aa0a5076e8a08e5401c2d40a5a2b3c5082d89
+  data.tar.gz: 57f9b086460821188a16c3f028abc3528683afcb4efb23be2e460e1b7c84a442
 SHA512:
-  metadata.gz: 27cbfb9a5c8c87de83bd632bd71f98035d3a5c4c666b769f736eadb8a037c53752c4be4ab3b945c1c8d3720cdebc288e6fcb660bcc48a2280d64311d15378699
-  data.tar.gz: 4f00dd6a6f1f5e77e05ed2bc86a1043fcc0889c6663edf6b63b2dd48cacc0d92e9900901e72abf163bc8742b186aedc3e9925defc56bb21c476a1c43825ee545
+  metadata.gz: 1d8252c053581cc82b74299d5fb022ef064a08e1533824725b8af01fd44980bf487731b4653b30f0ed48b817a4ed4452601858af482784251f3115fc70307014
+  data.tar.gz: 340a2b64327b71919d839c9a860343ad55a93fa51f774090d991eec0ef4835c026beb8485f31e12cb6b00e4cf6cce58c3fdc50de0fbb8a2191aca196c8ce9d3d

data/lib/h2g_ajaxchat.rb

@@ -5,6 +5,47 @@
 # description: This gem makes it easier to build an AJAX chat project. 
 #              Designed for Rack-rscript.
 
+require 'erb'
+require 'simple-config'
+
+# This file includes the following classes
+#
+# * AjaxChatPlugin Base class for plugins
+# * DummyRequest (used for testing)
+# * ChatCore  (chat engine)
+# * DummyRws  (used for testing)
+# * WebPage
+# * Index      < WebPage
+# * Login      < WebPage
+# * Logout     < WebPage
+# * LogoutPost < WebPage
+# * AjaxChat (the main class)
+
+
+class AjaxChatPlugin
+
+  # ac = ajaxchat object
+  #
+  def initialize(ac, settings={}, debug: false)    
+    @ac, @settings, @debug = ac, settings, debug
+  end
+
+  # Customises the ajax chat html etc;
+  #
+  def apply()
+  end
+
+  # messages from the plugin to be added to the chat timeline
+  #
+  def messages()
+    []
+  end
+  
+  # messages from the chat timeline
+  #
+  def on_newmessage(time, userid, username, msg)
+  end
+end
 
 class DummyRequest
 
@@ -60,7 +101,6 @@ class ChatCore
     else
 
       return '' unless newmsg
-      puts '_messages: ' + @messages.inspect
       @messages.length - 1
     end
 
@@ -93,15 +133,12 @@ class ChatCore
     
   end
 
-  protected
 
-  def append_message(msg)
-
-    u = @session[:username]
-    id = @session[:session_id].to_s
-    @users[id] = u.to_s
-    
-    @messages << [Time.now, id, u, msg]
+  def append_message(t=Time.now, id=@session[:session_id].to_s, 
+                     u=@session[:username], msg)
+        
+    @users[id] = u.to_s    
+    @messages << [t, id, u, msg]
 
   end
 
@@ -109,22 +146,25 @@ end
 
 class DummyRws
   
-  attr_accessor :req
+  attr_accessor :req, :ac
+  attr_reader :rsc
 
-  def initialize(obj)
+  def initialize(ac=nil, rsc: nil)
 
-    @obj = obj
+    @ac, @rsc = ac, rsc
 
   end
 
   def redirect(s)
-    @obj.method(s.to_sym).call
+    @ac.method(s.to_sym).call
   end
 end
 
 class WebPage
+  
+  attr_accessor :css, :html, :js, :s
 
-  def initialize(h={})
+  def initialize( h={} )
     @h = h
   end
 
@@ -132,13 +172,21 @@ class WebPage
   end
 
   def to_html()
+    b = binding
+
+    ERB.new(html()).result(b)    
   end
 
   def to_js()
+    js()
   end
 
+  def s()
+    @s ||= html_template()
+  end
+  
   def to_s()
-    html_template()
+    s()
   end
 
   protected
@@ -166,146 +214,20 @@ end
 
 
 
-class AjaxChat
-  
-  attr_reader :rws
-
-  def initialize(chatobj, rws=DummyRws.new(self), debug: false)
-    @chat, @rws, @debug = chatobj, rws, debug
-  end
-  
-  def chatter(newmsg=nil)
-    
-    id, users = @rws.req.session[:session_id].to_s, @chat.users
-
-    @chat.chatter(@rws.req, newmsg) do  |t, uid, username, msg|
-          
-      s2 = if id == uid then
-        "you: %s" % msg
-      else
-        "%s: %s" % [users[uid], msg]
-      end
-      
-      "<p><span id='time'>%s</span> %s</p>" % [t.strftime("%H:%M:%S"), s2]
-      
-    end        
-    
-    
-  end
-
-  def login()
-
-    wp = WebPage.new
-
-    def wp.to_html()
-'
-	<div id="loginform">
-	<form action="login" method="post">
-		<p>Please enter your name to continue:</p>
-		<label for="name">Name:</label>
-		<input type="text" name="name" id="name" autofocus="true"/>
-		<input type="submit" name="enter" id="enter" value="Enter" />
-	</form>
-	</div>
-'
-
-    end
-
-    def wp.to_s()
-      to_html()
-    end
-
-    return wp
-
-  end
-
-  def login_post(username)
-
-    @chat.login @rws.req, username
-    @rws.redirect 'index'
-
-  end
-  
-  def logout()
-
-    wp = WebPage.new
-
-    def wp.to_html()
-'
-	<div id="logoutform">
-	<form action="logout" method="post">
-		<p>Are you sure you want to logout?</p>
-		<input type="submit" name="enter" id="enter" value="Yes" />
-	</form>
-	<a href="index">no, return to the chat page</a>
-	</div>
-	'
-
-    end
-
-    def wp.to_s()
-      to_html()
-    end
-
-    return wp
 
-  end  
+class Index < WebPage
   
-  def logout_post()
-
-    @chat.logout @rws.req
-            
-    wp = WebPage.new
-
-    def wp.to_s()
-      'You have successfully logged out'
-    end
-
-    return wp    
-
-  end  
-
-  def index()
-
-    @rws.req.session[:username] ? view_index() : login()
-
-  end
-  
-  def messages()
-    @chat.messages
-  end  
-  
-  def req(obj)
-    @rws.req = obj
-    self
+  def initialize(h)
+    @h = h
   end
   
-  def users()
-    @chat.users
-  end
-
-  private
-
-  def view_index()
-
-    h = {username: @rws.req.session[:username]}
-
-    wp = WebPage.new h
-
-    def wp.to_css()
-'
-body {font-family: Arial;}
-#chatbox {overflow: scroll; height: 40%}
-div p span {colour: #dde}
-'
-    end
-
-    def wp.to_html()
-<<EOF
+  def html()
+    
+@html ||= <<EOF
 <body onload="refresh()">
   <div id="wrapper">
 	  <div id="menu">
-		  <p class="welcome">Welcome, <b> #{@h[:username]} </b></p>
+		  <p class="welcome">Welcome, <b> <%= @h[:username] %> </b></p>
 		  <p class="logout"><a id="exit" href="logout">Exit Chat</a></p>
 		  <div style="clear:both"></div>
 	  </div>	
@@ -313,12 +235,26 @@ div p span {colour: #dde}
     <input name="usermsg" type="text" id="usermsg" size="33" onkeyup='ajaxCall1(event.keyCode, this)' autofocus='true'/>
 
   </div>      
-
 EOF
-    end
 
-    def wp.to_js()
-<<EOF
+  end
+  
+  def to_css()
+@css ||= '
+body {font-family: Arial;}
+#chatbox {overflow: scroll; height: 40%}
+div p span {colour: #dde}
+'
+  end  
+
+  def to_html()
+    
+    super()
+  end
+  
+  def js()
+    
+@js ||= <<EOF
   
 function updateScroll(){
     var element = document.getElementById("chatbox");
@@ -365,12 +301,230 @@ function ajaxCall2() {
 
 EOF
 
+  end  
 
-    end
+  
+end
+
+class Login < WebPage
+  
+  def initialize(h={})
 
-    return wp
+  end
+
+  def html()
+
+    @html ||= '
+<div id="loginform">
+<form action="login" method="post">
+  <p>Please enter your name to continue:</p>
+  <label for="name">Name:</label>
+  <input type="text" name="name" id="name" autofocus="true"/>
+  <input type="submit" name="enter" id="enter" value="Enter" />
+</form>
+</div>
+'
 
   end
+  
+  
+end
 
+class Logout < WebPage
+  
+  def initialize(h={})
+
+  end
+
+  def html()
+
+    @html ||= '
+	<div id="logoutform">
+	<form action="logout" method="post">
+		<p>Are you sure you want to logout?</p>
+		<input type="submit" name="enter" id="enter" value="Yes" />
+	</form>
+	<a href="index">no, return to the chat page</a>
+	</div>
+	'
+
+  end
+  
+  
+end
+
+class LogoutPost < WebPage
+  
+  def initialize(h={})
+
+  end
+
+  def s()
+
+    @s ||= 'You have successfully logged out'
+
+  end
+
+  
 end
 
+
+class AjaxChat
+  
+  attr_reader :rws, :views
+
+  def initialize(chatobj=ChatCore.new, rws: DummyRws.new(self), config: nil, 
+                 debug: false)
+    
+    @chat, @rws, @debug = chatobj, rws, debug    
+
+    @plugins =  if config then
+    
+      SimpleConfig.new(config).to_h.map do |name, settings|
+        
+        puts 'name: ' + name.inspect if @debug
+        settings = {} if settings.is_a? String
+              
+        next if settings[:disabled]
+        pluginklass_name = 'AjaxChatPlugin' + name.to_s
+        
+        #Kernel.const_get(pluginklass_name).new(self, settings, debug: false)
+        eval("#{pluginklass_name}.new(self, #{settings}, debug: false)")
+        
+      end.compact  
+      
+    else
+      
+      []
+      
+    end
+    
+    @h = {}
+    
+    @index, @login, @logout, @logout_post  = \
+        [Index, Login, Logout, LogoutPost].map do |klass|
+      
+      klass.new @h
+      
+    end
+    
+    @views = {
+      index: @index,
+      login: @login,
+      logout: @logout,
+      logout_post: @logout_post
+    }
+    
+    @plugins.each {|plugin| plugin.apply if plugin.respond_to? :apply }
+    
+  end
+  
+  def chatter(newmsg=nil)
+    
+    id, users = @rws.req.session[:session_id].to_s, @chat.users
+    
+    chat = @chat
+
+    # check for new messages to be added via the plugins
+    @plugins.each do |plugin|
+      
+      next unless plugin.respond_to? :messages
+      plugin.messages.each {|x| chat.append_message *x }
+      
+    end    
+    
+    plugins = @plugins
+
+    @chat.chatter(@rws.req, newmsg) do  |t, uid, username, msg|
+            
+      plugins.each do |x|
+                  
+        x.on_newmessage(t, uid, username, msg) if x.respond_to? :on_newmessage
+        
+      end   
+          
+      s2 = if id == uid then
+        "you: %s" % msg
+      else
+        "%s: %s" % [users[uid], msg]
+      end
+      
+      "<p><span id='time'>%s</span> %s</p>" % [t.strftime("%H:%M:%S"), s2]
+      
+    end        
+        
+  end
+
+  def login()
+
+    view @login
+
+  end
+
+  def login_post(username)
+
+    @chat.login @rws.req, username
+    @h[:username] = username
+    @rws.redirect 'index'
+
+  end
+  
+  def logout()
+
+    view @logout
+
+  end  
+  
+  def logout_post()
+
+    @chat.logout @rws.req            
+    view @logout_post 
+
+  end  
+
+  def index()
+
+    if @rws.req.session[:username] then
+      
+      @h[:username] = @rws.req.session[:username]
+      view @index
+      
+    else
+      
+      @rws.redirect 'login'
+      
+    end
+
+  end
+
+  # used for debugging
+  def messages()
+    @chat.messages
+  end  
+  
+  def req(obj)
+    
+    @rws.req = obj
+    self
+    
+  end
+  
+  # used for debugging
+  def users()
+    @chat.users
+  end
+  
+  private
+  
+  def view(obj)
+    
+    puts 'inside view obj: ' + obj.inspect if @debug
+    
+    if obj.to_s.length > 0 then
+      obj.to_s
+    else
+      obj
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: h2g_ajaxchat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - James Robertson
@@ -35,8 +35,28 @@ cert_chain:
   PrknRa5wCOkWn6MNeaZ10MuRCv0E4IRGb8q/2WczGDXI3lmwDWOzPzia3/A32vdt
   hlwWFeE0gWND9J9tivS5qxBI
   -----END CERTIFICATE-----
-date: 2020-07-04 00:00:00.000000000 Z
-dependencies: []
+date: 2020-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: 
 email: james@jamesrobertson.eu
 executables: []