ssc.nob 0.1.0-java → 0.1.1-java

data/lib/ssc.nob/config.rb

@@ -1,87 +1,107 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Nob.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Nob 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 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Nob 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 SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 
+require 'java'
 require 'psych'
 
 require 'ssc.nob/error'
 require 'ssc.nob/userface'
 require 'ssc.nob/util'
 
+java_import 'java.awt.event.KeyEvent'
+
 
 module SSCNob
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class Config
     include Uface
-    
+
     attr_reader :file
+    attr_accessor :msg_key
     attr_accessor :ssc_dir
     attr_accessor :username
-    
+
     def initialize(file='ssc.nob.yml')
       super()
-      
+
       @file = File.expand_path(file)
+      @msg_key = nil
       @ssc_dir = nil
       @username = nil
     end
-    
-    def build_ssc_log_dir()
+
+    def build_msg_key
+      # Can be a single space ' '.
+      return @msg_key if @msg_key.nil? || @msg_key.length == 1
+
+      fuzzy_key = Util.strip(@msg_key).downcase
+
+      if fuzzy_key.empty?
+        @msg_key = nil
+
+        return @msg_key
+      end
+
+      KeyEvent.constants.each do |c|
+        name = c.to_s.downcase
+
+        if name.start_with?('vk_') && name.include?(fuzzy_key)
+          return KeyEvent.const_get(c)
+        end
+      end
+
+      raise UserError,"that's an invalid msg key{#{@msg_key}}, user."
+    end
+
+    def build_ssc_log_dir
       return File.join(@ssc_dir,'logs')
     end
-    
-    def check_ssc_dir()
+
+    def check_msg_key
+      build_msg_key
+    end
+
+    def check_ssc_dir
       @ssc_dir = Util.strip(@ssc_dir)
-      
-      if @ssc_dir.nil?() || @ssc_dir.empty?()
+
+      if @ssc_dir.nil? || @ssc_dir.empty?
         raise UserError,"that's a blank folder name, user."
       end
-      
+
       @ssc_dir = File.expand_path(@ssc_dir)
-      
+
       if !Dir.exist?(@ssc_dir)
         raise UserError,"that folder{#{@ssc_dir}} doesn't exist, user."
       end
       if !File.directory?(@ssc_dir)
         raise UserError,"that's a file{#{@ssc_dir}}, not a folder, user."
       end
-      
-      ssc_log_dir = build_ssc_log_dir()
-      
+
+      ssc_log_dir = build_ssc_log_dir
+
       if !Dir.exist?(ssc_log_dir) || !File.directory?(ssc_log_dir)
         raise UserError,"why's there no 'logs' folder{#{ssc_log_dir}}, user?"
       end
     end
-    
-    def check_username()
+
+    def check_username
       raise UserError,"that's a blank username, user." if Util.blank?(@username)
     end
-    
+
     def load_file!(mode: 'rt:BOM|UTF-8',**kargs)
       data = File.read(@file,mode: mode,**kargs)
-      
+
       yaml = Psych.safe_load(data,
         aliases: false,
         filename: @file,
@@ -89,63 +109,78 @@ module SSCNob
         symbolize_names: true,
         **kargs,
       )
-      
+
+      @msg_key = yaml[:msg_key]
       @ssc_dir = Util.strip(yaml[:ssc_dir])
-      @ssc_dir = File.expand_path(@ssc_dir) if !@ssc_dir.nil?() && !@ssc_dir.empty?()
+      @ssc_dir = File.expand_path(@ssc_dir) if !@ssc_dir.nil? && !@ssc_dir.empty?
       @username = yaml[:username]
     end
-    
+
     def save_file(mode: 'wt',**kargs)
       File.open(@file,mode: mode,**kargs) do |fout|
-        fout.write(to_s())
+        fout.write(to_s)
       end
     end
-    
-    def user_init!()
+
+    def user_init!
       if File.exist?(@file)
-        load_file!()
+        load_file!
       end
-      
-      if valid?()
-        uface.type("Welcome back, ")
+
+      if valid?
+        uface.type('Welcome back, ')
         puts "#{uface.user(@username)}."
         uface.type("Here's a hot cup of coffee: ")
         puts uface.coffee
       else
         uface.types('Welcome, new user.')
         puts
-        
+
         @username = uface.ask("What's your #{uface.user('username')}? ")
-        check_username()
-        
+        check_username
+
         @ssc_dir = uface.ask("Where's your #{uface.ssc} folder? ")
-        check_ssc_dir()
-        
+        check_ssc_dir
+
+        puts(<<~MSGKEY)
+          What's your #{uface.color('Message Key').aqua.bold}?
+          - Can input a key code, like 'VK_TAB' or 'TAB'
+          - Can input a letter, like 'm'
+          - Can input nothing
+        MSGKEY
+        @msg_key = uface.ask('> ')
+        check_msg_key
+
         puts
         puts uface.gt(@file)
         if uface.agree('Save this configuration (y/n)? ')
-          save_file()
+          save_file
         end
       end
     end
-    
-    def valid?()
+
+    def valid?
       begin
-        check_ssc_dir()
-        check_username()
-      rescue UserError
+        check_msg_key
+        check_ssc_dir
+        check_username
+      rescue UserError => e
+        puts e.to_s.capitalize
+        puts
+
         return false
       end
-      
+
       return true
     end
-    
-    def to_s()
+
+    def to_s
       yaml = {
+        'msg_key' => @msg_key,
         'username' => @username,
         'ssc_dir' => @ssc_dir,
       }
-      
+
       return Psych.dump(yaml,header: true)
     end
   end

data/lib/ssc.nob/error.rb

@@ -1,32 +1,20 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Nob.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Nob 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 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Nob 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 SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 
 module SSCNob
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class Error < ::StandardError; end
-  
+
   class UserError < Error; end
 end

data/lib/ssc.nob/ssc_bot.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of SSC.Nob.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# SSC.Nob 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 3 of the License, or
-# (at your option) any later version.
-# 
-# SSC.Nob 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 SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 
@@ -36,129 +24,118 @@ java_import 'java.awt.event.KeyEvent'
 
 module SSCNob
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class SSCBot
     MESSAGE_FLOOD_COUNT = 8
-    MESSAGE_FLOOD_TIME = 5
-    
+    MESSAGE_FLOOD_TIME = 6
+
     attr_accessor :auto_delay_time
     attr_reader :char_codes
     attr_reader :clipboard
     attr_reader :last_message_time
     attr_reader :message_count
-    attr_accessor :message_key
     attr_reader :robot
-    
-    # TODO: save message_key in config
-    def initialize(auto_delay_time: 0.2,message_key: KeyEvent::VK_TAB)
+
+    def initialize(auto_delay_time: 0.1)
       super()
-      
+
       @auto_delay_time = auto_delay_time
       @char_codes = {}
-      @clipboard = Toolkit.getDefaultToolkit().getSystemClipboard()
-      @last_message_time = Time.now()
+      @clipboard = Toolkit.getDefaultToolkit.getSystemClipboard
+      @last_message_time = Time.now
       @message_count = 0
-      @message_key = message_key
-      @robot = Robot.new()
-      
+      @robot = Robot.new
+
       @robot.setAutoDelay(0) # Don't use Java's, too slow
-      
-      build_char_codes()
+
+      build_char_codes
     end
-    
-    def auto_delay()
+
+    def auto_delay
       sleep(@auto_delay_time)
-      
+
       return self
     end
-    
+
     def chat_message(channel,msg)
       return pub_message(";#{channel};#{msg}")
     end
-    
+
     def copy(str)
-      @clipboard.setContents(StringSelection.new(str),nil);
-      
+      @clipboard.setContents(StringSelection.new(str),nil)
+
       return self
     end
-    
-    def enter()
+
+    def enter
       return type_key(KeyEvent::VK_ENTER)
     end
-    
+
     def paste(str=nil)
-      copy(str) unless str.nil?()
-      
+      copy(str) unless str.nil?
+
       # FIXME: change to VK_META for macOS
       roll_keys(KeyEvent::VK_CONTROL,KeyEvent::VK_V)
-      
+
       return self
     end
-    
-    def prevent_flooding()
+
+    def prevent_flooding
       @message_count += 1
-      
+
       if @message_count >= MESSAGE_FLOOD_COUNT
-        time_diff = Time.now() - @last_message_time
-        
-        if time_diff <= MESSAGE_FLOOD_TIME
-          sleep(MESSAGE_FLOOD_TIME - time_diff)
-        end
-        
+        time_diff = Time.now - @last_message_time
+        time_diff = (MESSAGE_FLOOD_TIME - time_diff).round
+        time_diff = 1 if time_diff < 1 # Always sleep for at least 1 sec
+
+        sleep(time_diff)
+
         @message_count = 0
       end
-      
-      @last_message_time = Time.now()
-      
-      return self
-    end
-    
-    def pub_message(msg)
-      type_key(@message_key).paste(msg).enter()
-      
-      sleep(1.2)
-      
+
+      @last_message_time = Time.now
+
       return self
     end
-    
+
     def roll_keys(*key_codes)
-      key_codes.each() do |key_code|
+      key_codes.each do |key_code|
         @robot.keyPress(key_code)
-        auto_delay()
+        auto_delay
       end
-      
+
       (key_codes.length - 1).downto(0) do |i|
         @robot.keyRelease(key_codes[i])
-        auto_delay()
+        auto_delay
       end
-      
+
       return self
     end
-    
+
     def type(str)
-      str.each_char() do |c|
+      str.each_char do |c|
         key_codes = @char_codes[c]
-        
-        next if key_codes.nil?()
-        
+
+        next if key_codes.nil?
+
         roll_keys(*key_codes)
       end
-      
+
       return self
     end
-    
+
     def type_key(key_code)
       @robot.keyPress(key_code)
-      auto_delay()
+      auto_delay
       @robot.keyRelease(key_code)
-      auto_delay()
-      
+      auto_delay
+
       return self
     end
-    
-    def build_char_codes()
+
+    def build_char_codes
       @char_codes.store("\b",[KeyEvent::VK_BACK_SPACE])
       @char_codes.store("\f",[KeyEvent::VK_PAGE_DOWN])
       @char_codes.store("\n",[KeyEvent::VK_ENTER])
@@ -167,15 +144,15 @@ module SSCNob
       @char_codes.store(' ',[KeyEvent::VK_SPACE])
       @char_codes.store('!',[KeyEvent::VK_SHIFT,KeyEvent::VK_EXCLAMATION_MARK])
       @char_codes.store('"',[KeyEvent::VK_SHIFT,KeyEvent::VK_QUOTEDBL])
-      @char_codes.store('#',[KeyEvent::VK_SHIFT,KeyEvent::VK_3])
-      @char_codes.store('$',[KeyEvent::VK_SHIFT,KeyEvent::VK_4])
+      @char_codes.store('#',[KeyEvent::VK_SHIFT,KeyEvent::VK_NUMBER_SIGN])
+      @char_codes.store('$',[KeyEvent::VK_SHIFT,KeyEvent::VK_DOLLAR])
       @char_codes.store('%',[KeyEvent::VK_SHIFT,KeyEvent::VK_5])
-      @char_codes.store('&',[KeyEvent::VK_SHIFT,KeyEvent::VK_7])
+      @char_codes.store('&',[KeyEvent::VK_SHIFT,KeyEvent::VK_AMPERSAND])
       @char_codes.store('\'',[KeyEvent::VK_QUOTE])
-      @char_codes.store('(',[KeyEvent::VK_SHIFT,KeyEvent::VK_9])
-      @char_codes.store(')',[KeyEvent::VK_SHIFT,KeyEvent::VK_0])
-      @char_codes.store('*',[KeyEvent::VK_SHIFT,KeyEvent::VK_8])
-      @char_codes.store('+',[KeyEvent::VK_SHIFT,KeyEvent::VK_EQUALS])
+      @char_codes.store('(',[KeyEvent::VK_SHIFT,KeyEvent::VK_LEFT_PARENTHESIS])
+      @char_codes.store(')',[KeyEvent::VK_SHIFT,KeyEvent::VK_RIGHT_PARENTHESIS])
+      @char_codes.store('*',[KeyEvent::VK_SHIFT,KeyEvent::VK_ASTERISK])
+      @char_codes.store('+',[KeyEvent::VK_SHIFT,KeyEvent::VK_PLUS])
       @char_codes.store(',',[KeyEvent::VK_COMMA])
       @char_codes.store('-',[KeyEvent::VK_MINUS])
       @char_codes.store('.',[KeyEvent::VK_PERIOD])
@@ -259,6 +236,8 @@ module SSCNob
       @char_codes.store('|',[KeyEvent::VK_SHIFT,KeyEvent::VK_BACK_SLASH])
       @char_codes.store('}',[KeyEvent::VK_SHIFT,KeyEvent::VK_BRACERIGHT])
       @char_codes.store('~',[KeyEvent::VK_SHIFT,KeyEvent::VK_BACK_QUOTE])
+      @char_codes.store('¡',[KeyEvent::VK_SHIFT,KeyEvent::VK_INVERTED_EXCLAMATION_MARK])
+      @char_codes.store('€',[KeyEvent::VK_SHIFT,KeyEvent::VK_EURO_SIGN])
     end
   end
 end