gs_phone 0.0.1 → 0.0.2

data/CHANGES.txt

@@ -1,3 +1,12 @@
+Version 0.0.2
+(23 March 2007)
+
+	* Changed the option parsing to use Subverion style commands
+	* Added context based help to each command
+	* Setup a hidden folder in the HOME to store our configuration files
+	* Added a basic generated template file used by gsutil
+
+
 Version 0.0.1
 (05 March 2007)
 

data/TODO.txt

@@ -10,8 +10,8 @@ This is the list of tasks that need to be done or have been completed.
 * Get a list of the ip addresses currently assigned (Currently this works: grep -i '^ip' users.yml | awk '// {print $2}' | sort)
 * Cleanup the option parser
 * Cleanup the output from the program (e.g. remove "GS >")
-* Make --help the default command if no option is given
-* Create a RubyForge Project
+* Allow asterisk intregration
+  * Read user list from extensions.conf and/or sip.conf
 
 = FUTURE
 
@@ -23,3 +23,6 @@ This is the list of tasks that need to be done or have been completed.
 * Add a MAINTAINER file
 * Add a LICENSE file
 * Add a README file
+* Create a RubyForge Project
+* Rework commandline passing to be like Subversion (svn command options)
+* Make --help the default command if no option is given

data/lib/gs_phone/version.rb

@@ -2,7 +2,7 @@ module GsPhone #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/gs_phone.rb

@@ -21,73 +21,82 @@
 
 
 require 'yaml'
-require 'optparse'
 
 class GrandStream
 
   # Default configurations
-  @user_file = "users.yml"
+  @user_file = "#{ENV["HOME"]}/.gs_phone/users.yml"
   @admin_password = "admin"
-  @gsutil = "gsutil"
-  @config_files = "config"
-
+  @gsutil = "#{ENV["HOME"]}/.gs_phone/gsutil"
+  @config_file = "#{ENV["HOME"]}/.gs_phone/settings.yml"
+  @template_files = "#{ENV["HOME"]}/.gs_phone/templates/"
 
   # Setup the help messages with the optparse library
   def initialize(args)
     read_configuration
+    @command = args[0]
     @ip = args[1]
     @current_ip = args[2]
     @admin = args[3]
-    opts = OptionParser.new do |opts|
-      opts.banner = "Usage: #$0 COMMANDS [options]\n\n" +
-        "       'IP' is the ip address you want the phone to use\n" +
-        "       'crtIP' is the ip address the phone currently has\n" +
-        "       'pass' is the current phone password\n\n"
-
-      opts.on("--new 'IP' ['crtIP'|'pass']", "Add new user and setup their phone ") do
-        self.add_user(@ip)
-        self.make(@ip)
-        self.update_config(@ip, @current_ip, @admin)
-        self.reboot_phone(@current_ip)
-      end
-      opts.on('-A', "--add-user", 'Adds a user to the phone database') { self.add_user(@ip) }
-      opts.on('-M', "--make 'IP", 'Generates a config file from the template') { self.make(@ip) }
-      opts.on('--make-all', 'Reboots all phones') { self.make_all }
-      opts.on('-U', "--update 'IP' ['crtIP'|'pass']", "Update the configuration file to the phone") { self.update_config(@ip, @current_ip, @admin) }
-      opts.on('--update-all', 'Updates the configs on all phones') { self.update_all }
-      opts.on('-R', "--reboot 'IP'", 'Reboots a phone') { self.reboot_phone(@ip) }
-      opts.on('--reboot-all', 'Reboots all phones') { self.reboot_all_phones }
-      opts.on('-F', '--find-ip', "Find the ip address in the configuration file") { self.find_ip }
 
+    case @command
+    when "help"
+      help_command = args[1]
+      puts usage_summary(help_command)
+    when "new"
+      self.add_user(@ip)
+      self.make(@ip)
+      self.update_config(@ip, @current_ip, @admin)
+      self.reboot_phone(@ip)
+    when "add"
+      self.add_user(@ip)
+    when "make"
+      self.make(@ip)
+    when "update"
+      self.update_config(@ip, @current_ip, @admin)
+    when "reboot"
+      self.reboot_phone(@ip)
+    when "find"
+      self.find_ip
+    else
+      
     end
-    opts.parse!(args)
   end
 
+  
   # Read the gs_phone configuration file to get the settings
   def read_configuration
 
-    if File.exists?("#{ENV["HOME"]}/.gs_phone")
+    if File.exists?("#{ENV["HOME"]}/.gs_phone/settings.yml")
       settings = Hash.new
-      settings = YAML::load(File.open("#{ENV["HOME"]}/.gs_phone"))
+      settings = YAML::load(File.open("#{ENV["HOME"]}/.gs_phone/settings.yml"))
       
       @user_file = settings["user_file"] if settings.include?("user_file")
       @admin_password = settings["admin_password"]
       @gsutil = settings["gsutil"]
-      @config_files = settings["config_files"]
+      @config_file = settings["config_file"]
+      @template_files = settings["template_files"]
     else
       puts "You have no default configuration file.  We will create one for you"
       settings = {
         "admin_password" => "admin",
-        "user_file" => "users.yml",
-        "gsutil" => "gsutil",
-        "config_files" => "config"
+        "user_file" => "#{ENV["HOME"]}/.gs_phone/users.yml",
+        "gsutil" => "#{ENV["HOME"]}/.gs_phone/gsutil",
+        "config_file" => "#{ENV["HOME"]}/.gs_phone/settings.yml",
+        "template_files" => "#{ENV["HOME"]}/.gs_phone/templates/"
       }
 
-      file = File.new("#{ENV["HOME"]}/.gs_phone","w")
+      Dir.mkdir("#{ENV["HOME"]}/.gs_phone")
+      Dir.mkdir("#{ENV["HOME"]}/.gs_phone/templates")
+      cfg_template = File.new("#{ENV["HOME"]}/.gs_phone/templates/template.cfg", "w")
+      cfg_template.puts add_template
+      cfg_template.close
+      
+      file = File.new("#{ENV["HOME"]}/.gs_phone/settings.yml","w")
       file.puts settings.to_yaml
       file.close
 
-      puts "File #{ENV["HOME"]}/.gs_phone has been created.  Please make sure the"
+      puts "File #{ENV["HOME"]}/.gs_phone/ has been created.  Please make sure the"
       puts " settings are correct."
       exit
 
@@ -147,7 +156,7 @@ class GrandStream
         # needs it this way
         ip1, ip2, ip3, ip4 = ip.split('.')
         
-        templated = IO.readlines(@config_files + "template.cfg")
+        templated = IO.readlines(@template_files + "template.cfg")
         phone_config = ""
 
         # Substitue in the user fields into their config 
@@ -156,7 +165,7 @@ class GrandStream
           phone_config << line.gsub(/<<ext>>/, exten).gsub(/<<name>>/, name).gsub(/<<password>>/, password).gsub(/<<ip1>>/, ip1).gsub(/<<ip2>>/, ip2).gsub(/<<ip3>>/, ip3).gsub(/<<ip4>>/, ip4)
         end
         # Write out the string to a file now
-        File.open("#{@config_files}#{ip}.cfg", "w+") do |file|
+        File.open("#{@template_files}#{ip}.cfg", "w+") do |file|
           file.puts phone_config
         end
         puts "GS< Made config for extension #{exten.to_s}"
@@ -194,7 +203,7 @@ class GrandStream
       current_ip = ip_address
     end
     # Setup the string to shell out to the gsutil script to scrape the webforms
-    cmd = "#{@gsutil} -p '#{admin}' -r '#{current_ip}' < #{@config_files}#{ip_address}.cfg"
+    cmd = "#{@gsutil} -p '#{admin}' -r '#{current_ip}' < #{@template_files}#{ip_address}.cfg"
     `#{cmd}`.to_s    # Evil eval().
     puts "GS< Config sent to phone"
   end
@@ -270,5 +279,313 @@ class GrandStream
       end        
     end
   end
+
+    def usage_summary(command)
+    usage = ""
+    case command
+    when "new"
+      usage =<<EONEW
+Usage: new
+      
+Goes through all the steps to setup a new phone:
+  "add", "make", "update", "reboot"
+
+EONEW
+
+    when "add"
+      usage =<<EOADD
+Usage: add IP_ADDRESS
+      
+Adds a user who has a phone at IP_ADDRESS
+
+Ex:
+  add 192.168.1.200
+
+EOADD
+      
+    when "make"
+      usage =<<EOMAKE
+Usage: make IP_ADDRESS
+      
+Creates the configuration file for the phone at IP_ADDRESS
+
+Ex:
+  make 192.168.1.200
+
+EOMAKE
+      
+    when "update"
+      usage =<<EOUPDATE
+Usage: update IP_ADDRESS [CURRENT_ADDRESS] [ADMIN_PASSWORD]
+      
+Sends the updated configuration file for IP_ADDRESS to the phone.
+
+Optionaly, a phone configuration can be sent to a phone that currently has
+a different ip address by using CURRENT_ADDRESS
+
+The admin password from the configuration file can also be overridden
+
+Ex:
+  update 192.168.1.200
+  update 192.168.1.200 192.168.1.10  <= Send '200's update to the phone at '10'
+  update 192.168.1.200 192.168.1.10 admin <= Also uses the factory password
+
+
+EOUPDATE
+      
+    when "reboot"
+      usage =<<EOREBOOT
+Usage: reboot COMMAND IP_ADDRESS
+      
+Reboots the phone at IP_ADDRESS.
+
+CAUTION: Some firmware will allow the phone to be rebooted while it is in use!
+
+Ex:
+  reboot 192.168.1.200
+
+EOREBOOT
+      
+    when "find"
+      usage =<<EOFIND
+Usage: find
+      
+Searches the user.yml file to get the ipaddress of an extension.
+
+EOFIND
+      
+    else
+      usage =<<EOHELP
+Usage: COMMAND [options]
+      
+IP is the ip address you want the phone to use crtIP is the ip address
+the phone currently has pass is the current phone password
+
+COMMANDS       DESCRIPTION
+new            Add new user and setup their phone 
+add            Adds a user to the phone database
+make           Generates a config file from the template
+update         Uploads the configuration file to the phone
+reboot         Reboots a phone 
+find           Find the ip address in the configuration file
+
+EOHELP
+    end
+    return usage
+  end
+
+    
+  def add_template
+    template = <<TEMPLATE
+admin_password = admin
+end_user_password = \<<ext>>
+account_active_1 = 1
+account_name_1 = <<name>>
+sip_server = 192.168.1.1
+outbound_proxy = 192.168.1.1
+sip_userid = <<ext>>
+authenticate_id = <<ext>>
+authenticate_password = <<password>>
+name = <<name>>
+static_ipaddress_true = 1
+static_ipaddress_1 = <<ip1>>
+static_ipaddress_2 = <<ip2>>
+static_ipaddress_3 = <<ip3>>
+static_ipaddress_4 = <<ip4>>
+static_subnet_1 = 255
+static_subnet_2 = 255
+static_subnet_3 = 255
+static_subnet_4 = 0
+static_router_1 = 192
+static_router_2 = 168
+static_router_3 = 1
+static_router_4 = 1
+static_dns1_1 = 192
+static_dns1_2 = 168
+static_dns1_3 = 1
+static_dns1_4 = 1
+static_dns2_1 = 0
+static_dns2_2 = 0
+static_dns2_3 = 0
+static_dns2_4 = 0
+silence_suppression = 0
+voice_frames_per_tx = 2
+layer3_QoS = 48
+layer2_QoS_vlan_tag = 0
+layer2_QoS_priority_value = 0
+no_key_entry_timeout = 4
+use_hash_as_dial_key = 1
+local_rtp_port = 5004
+use_random_port = 0
+keepalive_interval = 20
+use_nat_ip = 
+nat_traversal_stun_server = 
+firmware_upgrade = 0
+http_upgrade_url = 
+config_server_path = 
+firmware_file_prefix = 
+firmware_file_postfix = 
+config_file_prefix = 
+config_file_postfix = 
+dhcp_option_66_bootserver = 0
+automatic_http_upgrade = 1
+automatic_http_upgrade_days = 10080
+always_check_for_new_firmware = 0
+auth_config_file = 0
+dtmf_payload_type = 101
+syslog_server = 
+syslog_level = 0
+ntp_server = 192.168.1.1
+dhcp_option_42_timeserver_override = 0
+custom_ring_tone_1_caller_id = 
+custom_ring_tone_2_caller_id = 
+custom_ring_tone_3_caller_id = 
+disable_call_waiting = 0
+lock_keypad_update = 0
+PPPoE_id = 
+PPPoE_password = 
+dhcp_option_12_hostname = 
+dhcp_option_15_domain = 
+dhcp_dns_server_1 = 0
+dhcp_dns_server_2 = 0
+dhcp_dns_server_3 = 0
+dhcp_dns_server_4 = 0
+static_dns2_4 = 0
+time_zone = 240
+dhcp_option_2_timezone_override = 1
+daylight_savings_time = 0
+date_display_format = 1
+device_mode = 0
+wan_side_http_access = 0
+replay_to_icmp_in_wan = 0
+cloned_wan_mac_addr_1 = 
+cloned_wan_mac_addr_2 = 
+cloned_wan_mac_addr_3 = 
+cloned_wan_mac_addr_4 = 
+cloned_wan_mac_addr_5 = 
+cloned_wan_mac_addr_6 = 
+lan_subnet_mask = 
+lan_dhcp_base_ip = 
+dhcp_ip_lease_time = 24
+dmz_ip = 
+port_fw_port_num_1 = 0
+port_fw_lan_ip_1 = 
+port_fw_lan_port_1 = 0
+port_fw_lan_proto_1 = 0
+port_fw_port_num_2 = 0
+port_fw_lan_ip_2 = 
+port_fw_lan_port_2 = 0
+port_fw_lan_proto_2 = 0
+port_fw_port_num_3 = 0
+port_fw_lan_ip_3 = 
+port_fw_lan_port_3 = 0
+port_fw_lan_proto_3 = 0
+port_fw_port_num_4 = 0
+port_fw_lan_ip_4 = 
+port_fw_lan_port_4 = 0
+port_fw_lan_proto_4 = 0
+port_fw_port_num_5 = 0
+port_fw_lan_ip_5 = 
+port_fw_lan_port_5 = 0
+port_fw_lan_proto_5 = 0
+port_fw_port_num_6 = 0
+port_fw_lan_ip_6 = 
+port_fw_lan_port_6 = 0
+port_fw_lan_proto_6 = 0
+port_fw_port_num_7 = 0
+port_fw_lan_ip_7 = 
+port_fw_lan_port_7 = 0
+port_fw_lan_proto_7 = 0
+port_fw_port_num_8 = 8888
+port_fw_lan_ip_9 = 10.10.10.8
+port_fw_lan_port_8 = 80
+port_fw_lan_proto_8 = 1
+use_dns_srv = 0
+userid_is_phone_number = 0
+sip_registration = 1
+unregister_on_reboot = 0
+register_expiration = 60
+local_sip_port = 5060
+sip_t1_timeout = 100
+sip_t2_interval = 400
+nat_traversal_true = 1
+subscribe_for_mwi = 1
+proxy_require = 
+voicemail_userid = *97
+send_dtmf_mode = 0
+early_dial = 0
+dial_plan_prefix = 
+enable_call_features = 1
+session_expiration_1 = 180
+min_session_expiration_1 = 90
+caller_request_timer_1 = 0
+callee_request_timer_1 = 0
+force_timer_1 = 0
+uac_specify_refresher_1 = 0
+uas_specify_refresher_1 = 1
+force_invite_1 = 0
+enable_100rel_1 = 0
+default_ring_tone = 0
+send_anonymous = 0
+auto_answer = 0
+allow_auto_answer_by_call_info = 0
+turn_off_speaker_on_remote_disconnect = 0
+special_feature_1 = 100
+account_active_2 = 1
+account_name_2 = 
+sip_server_2 = 
+outbound_proxy_2 = 
+sip_userid_2 = 
+authenticate_id_2 = 
+authenticate_password_2 = 
+name_2 = 
+use_dns_srv_2 = 0
+userid_is_phone_number_2 = 0
+sip_registration_2 = 1
+unregister_on_reboot_2 = 0
+register_expiration_2 = 60
+local_sip_port_2 = 5062
+sip_t1_imeout = 100
+sip_t2_interval = 400
+nat_traversal_true_2 = 1
+subscribe_for_mwi_2 = 0
+proxy_require_2 = 
+voicemail_userid_2 = 
+send_dtmf_2 = 0
+early_dial_2 = 0
+dial_plan_prefix_2 = 
+enable_call_features_2 = 1
+session_expiration_2 = 180
+min_session_expiration_2 = 90
+caller_request_timer_2 = 0
+callee_request_timer_2 = 0
+force_timer_2 = 0
+uac_specify_refresher_2 = 0
+uas_specify_refresher_2 = 1
+force_invite_2 = 0
+enable_100rel_2 = 0
+account_ring_tone_2 = 0
+send_anonymous_2 = 0
+auto_answer_2 = 0
+allow_auto_answer_by_caller_info = 0
+turn_off_speaker_on_remote_disconnect = 0
+vocoder_1_2 = 0
+vocoder_2_2 = 8
+vocoder_3_2 = 4
+vocoder_4_2 = 18
+vocoder_5_2 = 3
+vocoder_6_2 = 0
+vocoder_7_2 = 0
+vocoder_8_2 = 0
+special_feature_2 = 100
+
+TEMPLATE
+    
+    
+  end
+
+
+
 end # Class
 
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: gs_phone
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-03-06 00:00:00 -08:00
+  version: 0.0.2
+date: 2007-03-23 00:00:00 -07:00
 summary: Application to mange and configure a group of Grandstream Voip phones
 require_paths: 
 - lib