gs_phone 0.0.3 → 0.0.4

data/CHANGES.txt

@@ -1,3 +1,10 @@
+Version 0.0.4
+(09 May 2007)
+
+	* Added all commands for reboot, update, and make
+        * Marked all internal methods as private
+        * Moved the logic parsing into library as part of the public API
+
 Version 0.0.3
 (25 March 2007)
 

data/INSTALL.txt

@@ -0,0 +1,33 @@
+Adapted from: http://theadmin.org/articles/2007/03/23/gs_phone-ruby-program-to-remotely-configure-grandstream-voip-phone
+
+### How do I get it?
+
+There are three ways to get gs_phone.
+
+1. (Recommended) Grab the gem from Rubyforge.  It is packaged like many other Ruby libraries and this will let you keep up to date and any changes to the program.
+
+    gem install gs_phone
+
+2. Grab the [archive file][1] from Rubyforge.
+
+3. Get the latest Subversion copy.  The repository is public for reading so a quick checkout should work.
+
+    svn checkout https://svn.theadmin.org/public/gs_phone/trunk/ gs_phone
+
+   You can also get the release code in the tags folders
+
+     svn checkout https://svn.theadmin.org/public/gs_phone/tags/release-0.0.2/ gs_phone-0.0.2
+
+In order to use gs_phone you will also need to download [gsutil][2] from Charles Howes.  The main file we are looking for is called gsutil
+
+
+### How do I  use it?
+
+1. First you will need to run gs_phone to have it setup a folder and some files for you.  Currenly they are hardcoded to HOME/.gs_phone but they could change soon.  Just run gs_phone and it should notice you need the files and create them for you.
+2. Next you need to point gs_phone to your gsutil program.  You can either copy gsutil into HOME/.gs_phone or modify the config.yml for gs_phone to point to the correct location.
+3. gs_phone should now work.  Run the help command to get an idea of some of the functions.  You can also run help on a command to see what a specific command does.
+
+Eric Davis
+
+[1]: http://rubyforge.org/frs/?group_id=3216
+[2]: http://www.pkts.ca/gsutil.shtml

data/MAINTAINERS.txt

@@ -0,0 +1,3 @@
+= List of Maintainers
+
+* Eric Davis <edavis10@gmail.com>

data/README.txt

@@ -4,19 +4,28 @@ Copyright (C) 2007 Eric Davis
 
 = Description
 
+Application to mange and configure a group of Grandstream Voip phones.
 
 = Dependencies
 
-YAML and optparse are required.
+YAML is required.
 
 = Installation
 
 RubyGem way:
  $ gem install gs_phone
 
-= Example
+= Usage
 
-Example files are provided in the "examples" directory.
+A shell program, 'gs_phone', is installed by RubyGems and is the primary way to
+use gs_phone.  Running "gs_phone help" will provide usage examples.
+
+Additional the library can be called through the public methods by another Ruby
+application.  See the RDoc for details on how to use the public methods.
+
+= Example configurations
+
+Example configuration files are provided in the "examples" directory.
 
 = Contact
 

data/ROADMAP.txt

@@ -0,0 +1,32 @@
+= Version 0.0.2 =
+
+* Rework command line passing
+
+= Version 0.0.3 =
+
+* Add unit tests
+
+= Version 0.0.4 =
+
+* Separate pubic and private methods
+* Add in the 'all' commands
+
+= Version 0.0.5 =
+
+* Refactor design
+
+= Version 0.0.6 =
+
+* Add in command to get a list of ip addresses
+
+= Version 0.1.0 =
+
+* Beta Release
+* Replace gsutil script
+
+= Version 1.0.0 =
+
+* Stable release
+* ???
+
+

data/Rakefile

@@ -15,7 +15,7 @@ AUTHOR = "Eric Davis"  # can also be an array of Authors
 EMAIL = "edavis10@gmail.com"
 DESCRIPTION = "Application to mange and configure a group of Grandstream Voip phones"
 GEM_NAME = "gs_phone" # what ppl will type to install your gem
-RUBYFORGE_PROJECT = "gs_phone" # The unix name for your project
+RUBYFORGE_PROJECT = "gs-phone" # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 
 NAME = "gs_phone"
@@ -50,7 +50,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   #p.changes        - A description of the release's latest changes.
   #p.extra_deps     - An array of rubygem dependencies.
   p.spec_extras = {
-                    "extra_rdoc_files" => ["CHANGES.txt", "README.txt", "COPYING.txt", "TODO.txt"]
+                    "extra_rdoc_files" => ["CHANGES.txt", "README.txt", "COPYING.txt", "TODO.txt", "MAINTAINERS.txt", "ROADMAP.txt", "INSTALL.txt"]
                   } 
 end
 

data/TODO.txt

@@ -4,6 +4,7 @@ This is the list of tasks that need to be done or have been completed.
 
 = CURRENT
 
+* Refactor design
 * Announce package
 * Get a list of the ip addresses currently assigned (Currently this works: grep -i '^ip' users.yml | awk '// {print $2}' | sort)
 * Allow asterisk intregration
@@ -28,3 +29,5 @@ This is the list of tasks that need to be done or have been completed.
 * Add unit tests
 * Cleanup the option parser
 * Cleanup the output from the program (e.g. remove "GS >")
+* Make methods private
+* BUG: No interface to the all commands (e.g. reboot all)

data/bin/gs_phone

@@ -10,39 +10,4 @@ require 'gs_phone'
 
 
 gs = GrandStream.new
-
-if not ARGV.nil? and ARGV.include?("-v")
-  gs.verbose = true
-  ARGV.delete_if { |a| a == "-v"}
-end
-
-@command = ARGV[0]
-@ip = ARGV[1]
-@current_ip = ARGV[2]
-@admin = ARGV[3]
-
-case @command
-when "help"
-  response = gs.help(ARGV[1])
-when "new"
-  # Don't use response because we want to give feeback throughout this process
-  puts gs.add_user(@ip)
-  puts gs.make(@ip)
-  puts gs.update_config(@ip, @current_ip, @admin)
-  puts gs.reboot_phone(@ip)
-when "add"
-  response = gs.add_user(@ip)
-when "make"
-  response = gs.make(@ip)
-when "update"
-  response = gs.update_config(@ip, @current_ip, @admin)
-when "reboot"
-  response = gs.reboot_phone(@ip)
-when "find"
-  response = gs.find_ip
-else
-  response = gs.help  
-end
-
-# Print out any responses, used for verbose options
-puts response unless response.nil?
+puts gs.parse_arguements(ARGV)

data/lib/gs_phone.rb

@@ -50,7 +50,77 @@ class GrandStream
     # TODO: need to find a way to stop printing this in TEST
     # puts @new_config_created unless @new_config_created.nil?
   end
+  
+  # This is the main event handler.  Send it an array of arguements that match
+  # the following signatures.  Arguements marked with * are optional:
+  #
+  #   help => "help", *command
+  #   new => "new", ip, *current_ip, *admin_password
+  #   add => "add", *username, *password, *mac_address
+  #   make => "make", *ip
+  #   make all => "make", "all"
+  #   update => "update", *ip
+  #   update all => "update", "all"
+  #   reboot => "reboot", *ip
+  #   reboot all => "reboot", "all"
+  #   find => "find", *ip
+  #
+  def parse_arguements(arguements)
+    if not arguements.nil? and arguements.include?("-v")
+      @verbose = true
+      arguements.delete_if { |a| a == "-v"}
+    end
 
+    @command = arguements[0]
+    @ip = arguements[1]
+    @current_ip = arguements[2]
+    @admin = arguements[3]
+
+    case @command
+    when "help"
+      response = help(arguements[1])
+    when "new"
+      # Don't use response because we want to give feeback throughout this process
+      puts add_user(@ip)
+      puts make(@ip)
+      puts update_config(@ip, @current_ip, @admin)
+      puts reboot_phone(@ip)
+    when "add"
+      username = arguements[2]
+      password = arguements[3]
+      extension = arguements[3] # TODO: assuming password and extensions are the same.
+      mac_addy = arguements[4]
+      response = add_user(@ip,username,password,mac_addy)
+    when "make"
+      if @ip != "all"
+        response = make(@ip)
+      else
+        response = make_all
+      end
+    when "update"
+      if @ip != "all"
+        response = update_config(@ip, @current_ip, @admin)
+      else
+        response = update_all
+      end
+    when "reboot"
+      if @ip != "all"
+        response = reboot_phone(@ip)
+      else
+        response = reboot_all
+      end
+    when "find"
+      response = find_ip(@ip)
+    else
+      response = help  
+    end
+
+    # Print out any responses, used for verbose options
+    return response unless response.nil?
+  end
+
+  private
+  
   def help(command=nil)
     usage_summary(command)
   end
@@ -184,9 +254,21 @@ class GrandStream
     data = YAML::load_documents(users) do |element|
       @user_list[element['ext']] = element['ip']
     end
+
+    responses = String.new
     @user_list.each do |ext,ip|
-      make(ip)
+      response = make(ip)
+      if response
+        responses << response
+      end
+    end
+    
+    if not @verbose
+      return nil
+    else
+      return responses
     end
+
   end
 
 
@@ -256,7 +338,7 @@ class GrandStream
   end
 
   # Reboot all phones
-  def reboot_all_phones
+  def reboot_all
     puts "Rebooting all phones" if @verbose
     @user_list = Hash.new
 
@@ -323,10 +405,12 @@ EOADD
       usage =<<EOMAKE
 Usage: make IP_ADDRESS
       
-Creates the configuration file for the phone at IP_ADDRESS
+Creates the configuration file for the phone at IP_ADDRESS.  'all' can be used
+as the IP_ADDRESS to make configurations all of the systems.
 
 Ex:
   make 192.168.1.200
+  make all
 
 EOMAKE
       
@@ -334,7 +418,8 @@ EOMAKE
       usage =<<EOUPDATE
 Usage: update IP_ADDRESS [CURRENT_ADDRESS] [ADMIN_PASSWORD]
       
-Sends the updated configuration file for IP_ADDRESS to the phone.
+Sends the updated configuration file for IP_ADDRESS to the phone. 'all' can be
+ used as the IP_ADDRESS to update all of the systems.
 
 Optionally, a phone configuration can be sent to a phone that currently has
 a different ip address by using CURRENT_ADDRESS
@@ -345,20 +430,23 @@ 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
+  update all
 
 
 EOUPDATE
       
     when "reboot"
       usage =<<EOREBOOT
-Usage: reboot COMMAND IP_ADDRESS
+Usage: reboot IP_ADDRESS
       
-Reboots the phone at IP_ADDRESS.
+Reboots the phone at IP_ADDRESS.  'all' can be used as the IP_ADDRESS to reboot
+all of the systems.
 
 CAUTION: Some firmware will allow the phone to be rebooted while it is in use!
 
 Ex:
   reboot 192.168.1.200
+  reboot all
 
 EOREBOOT
       

data/lib/gs_phone/version.rb

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

data/test/gs_phone_test.rb

@@ -70,7 +70,7 @@ class GrandstreamTest < Test::Unit::TestCase
   def test_add_user
     create_new_settings
     gs = GrandStream.new
-    gs.add_user("192.168.100.23","John Doe","200","000B820B0A7C")
+    gs.parse_arguements(["add","192.168.100.23","John Doe","200","000B820B0A7C"])
 
     assert File.exists?("tmp/users.yml")
     users = YAML::load(File.open("tmp/users.yml"))
@@ -85,10 +85,10 @@ class GrandstreamTest < Test::Unit::TestCase
   def test_make
     create_new_settings
     gs = GrandStream.new
-    gs.add_user("192.168.100.23","John Doe","200","000B820B0A7C")
+    gs.parse_arguements(["add","192.168.100.23","John Doe","200","000B820B0A7C"])
     
     # Make the file and check that it is correct
-    gs.make("192.168.100.23")
+    assert_equal "Made config for extension 200",gs.parse_arguements(['make','192.168.100.23'])
     assert File.exists?("tmp/templates/192.168.100.23.cfg")
     
     config = File.read("tmp/templates/192.168.100.23.cfg")
@@ -122,12 +122,12 @@ class GrandstreamTest < Test::Unit::TestCase
 
     # Create some users
     userlist.each do |ip,user|
-      gs.add_user(ip,user,rand(300).to_s,"000B820B0A7C")
+      gs.parse_arguements(["add",ip,user,rand(300).to_s,"000B820B0A7C"])
     end
 
     # Make all of the files
-    gs.make_all
-
+    assert_nil gs.parse_arguements(['make','all'])
+    
     # Check that they are all there and correct
     userlist.each do |ip, user|
       assert File.exists?("tmp/templates/#{ip}.cfg")
@@ -140,9 +140,9 @@ class GrandstreamTest < Test::Unit::TestCase
   def test_find_ip
     create_new_settings
     gs = GrandStream.new
-    gs.add_user("192.168.100.23","John Doe","200","000B820B0A7C")
+    gs.parse_arguements(["add","192.168.100.23","John Doe","200","000B820B0A7C"])
 
-    assert_equal "192.168.100.23", gs.find_ip("200")
+    assert_equal "192.168.100.23", gs.parse_arguements(['find','200'])
   end
 
   # Reboot the phone
@@ -151,7 +151,7 @@ class GrandstreamTest < Test::Unit::TestCase
     # Change the admin password so the mock will work
     change_admin_password
     gs = GrandStream.new
-    assert_nil gs.reboot_phone("192.168.1.25") # a nil return means no error
+    assert_nil gs.parse_arguements(['reboot',"192.168.1.25"]) # a nil return means no error
 
   end
 
@@ -159,7 +159,7 @@ class GrandstreamTest < Test::Unit::TestCase
   def test_reboot_incorrect_password
     create_new_settings
     gs = GrandStream.new
-    assert_equal "ERROR: Failed to reboot phone", gs.reboot_phone("192.168.1.25")
+    assert_equal "ERROR: Failed to reboot phone", gs.parse_arguements(['reboot',"192.168.1.25"])
 
   end
 
@@ -170,10 +170,10 @@ class GrandstreamTest < Test::Unit::TestCase
     # Change the admin password so the mock will work
     change_admin_password
     gs = GrandStream.new
-    gs.add_user("192.168.1.25","John Doe1","200","000B820B0A7C")
-    gs.add_user("192.168.1.25","John Doe2","201","000B820B0A7C")
+    gs.parse_arguements(["add","192.168.1.25","John Doe1","200","000B820B0A7C"])
+    gs.parse_arguements(["add","192.168.1.25","John Doe2","201","000B820B0A7C"])
     
-    assert_nil gs.reboot_all_phones # a nil return means no error
+    assert_nil gs.parse_arguements(['reboot','all'])
 
   end
 
@@ -183,10 +183,10 @@ class GrandstreamTest < Test::Unit::TestCase
     # Change the admin password so the mock will work
     change_admin_password
     gs = GrandStream.new
-    gs.add_user("192.168.1.25","John Doe","200","000B820B0A7C")
-    gs.make("192.168.1.25")
-    
-    assert_nil gs.update_config("192.168.1.25") # nil means no error
+    gs.parse_arguements(["add","192.168.1.25","John Doe","200","000B820B0A7C"])
+    assert_equal "Made config for extension 200", gs.parse_arguements(['make','192.168.1.25'])
+        
+    assert_nil gs.parse_arguements(['update','192.168.1.25']) # nil means no error
     
   end
 
@@ -194,10 +194,10 @@ class GrandstreamTest < Test::Unit::TestCase
   def test_update_incorrect_password
     create_new_settings
     gs = GrandStream.new
-    gs.add_user("192.168.1.25","John Doe","200","000B820B0A7C")
-    gs.make("192.168.1.25")
+    gs.parse_arguements(["add","192.168.1.25","John Doe","200","000B820B0A7C"])
+    assert_equal "Made config for extension 200", gs.parse_arguements(['make','192.168.1.25'])
     
-    assert_equal "ERROR: Failed to send config", gs.update_config("192.168.1.25")
+    assert_equal "ERROR: Failed to send config", gs.parse_arguements(['update','192.168.1.25'])
     
   end
 
@@ -215,24 +215,67 @@ class GrandstreamTest < Test::Unit::TestCase
 
     # Create some users
     userlist.each do |ip,user|
-      gs.add_user(ip,user,rand(300).to_s,"000B820B0A7C")
+      gs.parse_arguements(["add",ip,user,rand(300).to_s,"000B820B0A7C"])
     end
 
     # Make all of the files
-    gs.make_all
-    
-    assert_nil gs.update_all # nil means no error
+    assert_nil gs.parse_arguements(['make','all'])
+    assert_nil gs.parse_arguements(['update','all'])
     
   end
 
-  
   #####
   # Help sections
   #####
   def test_help
     create_new_settings
     gs = GrandStream.new
-    help =<<EOHELP
+    assert_equal help_text, gs.parse_arguements([])
+  end
+
+    def test_help_new
+    create_new_settings
+    gs = GrandStream.new
+    assert_equal help_text_new, gs.parse_arguements(["help","new"])
+  end
+
+  def test_help_add
+    create_new_settings
+    gs = GrandStream.new
+
+    assert_equal help_text_add, gs.parse_arguements(["help","add"])
+  end
+
+  def test_help_make
+    create_new_settings
+    gs = GrandStream.new
+
+    assert_equal help_text_make, gs.parse_arguements(["help","make"])
+  end
+    
+  def test_help_update
+    create_new_settings
+    gs = GrandStream.new
+    
+    assert_equal help_text_update, gs.parse_arguements(["help","update"])
+  end
+  
+  def test_help_reboot
+    create_new_settings
+    gs = GrandStream.new
+
+    assert_equal help_text_reboot, gs.parse_arguements(["help","reboot"])
+  end
+
+  def test_help_find
+    create_new_settings
+    gs = GrandStream.new
+
+    assert_equal help_text_find, gs.parse_arguements(["help","find"])
+  end
+
+  def help_text
+        help =<<EOHELP
 Usage: COMMAND [options]
       
 COMMANDS       DESCRIPTION
@@ -244,13 +287,11 @@ reboot         Reboots a phone
 find           Find the ip address in the configuration file
 
 EOHELP
-    
-    assert_equal help, gs.help
+    return help
   end
 
-    def test_help_new
-    create_new_settings
-    gs = GrandStream.new
+  def help_text_new
+
     help =<<EONEW
 Usage: new
       
@@ -258,13 +299,12 @@ Goes through all the steps to setup a new phone:
   "add", "make", "update", "reboot"
 
 EONEW
-    
-    assert_equal help, gs.help("new")
+
+   return help 
   end
 
-  def test_help_add
-    create_new_settings
-    gs = GrandStream.new
+
+  def help_text_add
     help =<<EOADD
 Usage: add IP_ADDRESS
       
@@ -275,32 +315,31 @@ Ex:
 
 EOADD
 
-    assert_equal help, gs.help("add")
+    return help
   end
 
-  def test_help_make
-    create_new_settings
-    gs = GrandStream.new
+  def help_text_make
     help =<<EOMAKE
 Usage: make IP_ADDRESS
       
-Creates the configuration file for the phone at IP_ADDRESS
+Creates the configuration file for the phone at IP_ADDRESS.  'all' can be used
+as the IP_ADDRESS to make configurations all of the systems.
 
 Ex:
   make 192.168.1.200
+  make all
 
 EOMAKE
 
-    assert_equal help, gs.help("make")
+    return help
   end
-    
-  def test_help_update
-    create_new_settings
-    gs = GrandStream.new
+
+  def help_text_update
     help =<<EOUPDATE
 Usage: update IP_ADDRESS [CURRENT_ADDRESS] [ADMIN_PASSWORD]
       
-Sends the updated configuration file for IP_ADDRESS to the phone.
+Sends the updated configuration file for IP_ADDRESS to the phone. 'all' can be
+ used as the IP_ADDRESS to update all of the systems.
 
 Optionally, a phone configuration can be sent to a phone that currently has
 a different ip address by using CURRENT_ADDRESS
@@ -311,34 +350,35 @@ 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
+  update all
 
 
 EOUPDATE
-    
-    assert_equal help, gs.help("update")
+
+    return help
   end
   
-  def test_help_reboot
-    create_new_settings
-    gs = GrandStream.new
+  def help_text_reboot
     help =<<EOREBOOT
-Usage: reboot COMMAND IP_ADDRESS
+Usage: reboot IP_ADDRESS
       
-Reboots the phone at IP_ADDRESS.
+Reboots the phone at IP_ADDRESS.  'all' can be used as the IP_ADDRESS to reboot
+all of the systems.
 
 CAUTION: Some firmware will allow the phone to be rebooted while it is in use!
 
 Ex:
   reboot 192.168.1.200
+  reboot all
 
 EOREBOOT
-
-    assert_equal help, gs.help("reboot")
+    
+    
+    
+    return help    
   end
 
-  def test_help_find
-    create_new_settings
-    gs = GrandStream.new
+  def help_text_find
     help =<<EOFIND
 Usage: find
       
@@ -346,7 +386,7 @@ Searches the user.yml file to get the ipaddress of an extension.
 
 EOFIND
 
-    assert_equal help, gs.help("find")
+    return help
   end
-
+  
 end

metadata

@@ -3,14 +3,14 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: gs_phone
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-03-25 00:00:00 -07:00
+  version: 0.0.4
+date: 2007-05-09 00:00:00 -07:00
 summary: Application to mange and configure a group of Grandstream Voip phones
 require_paths: 
 - lib
 email: edavis10@gmail.com
-homepage: http://gs_phone.rubyforge.org
-rubyforge_project: gs_phone
+homepage: http://gs-phone.rubyforge.org
+rubyforge_project: gs-phone
 description: Application to mange and configure a group of Grandstream Voip phones
 autorequire: 
 default_executable: 
@@ -42,6 +42,9 @@ files:
 - CHANGES.txt
 - COPYING.txt
 - TODO.txt
+- MAINTAINERS.txt
+- ROADMAP.txt
+- INSTALL.txt
 test_files: 
 - test/gs_phone_test.rb
 rdoc_options: []
@@ -51,6 +54,9 @@ extra_rdoc_files:
 - README.txt
 - COPYING.txt
 - TODO.txt
+- MAINTAINERS.txt
+- ROADMAP.txt
+- INSTALL.txt
 executables: 
 - gs_phone
 extensions: []