rct 0.6 → 0.7

data/bin/rct

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-#  Copyright 2012-2013 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -23,7 +23,7 @@
 # rct main
 #
 # Runs either a CLI invocation or a test suite depending on arguments.
-# 
+#
 
 require 'rct'
 require 'rct/rct_init'

data/lib/rct/baseutils.rb

@@ -1,5 +1,5 @@
 #
-#  Copyright 2012-2014 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -19,18 +19,24 @@
 
 
 #-----------------------------------------------------------------------------
-# Assorted utility methods of general interest. TODO: cleanup
+# Assorted utility methods of general interest.
 #
 class RCT
 
   @log_level = RESULT
 
 
+  #---------------------------------------------------------------------------
+  # Return current log level.
+  #
   def self.log_level
     @log_level
   end
 
 
+  #---------------------------------------------------------------------------
+  # Set log level (RESULT, INFO, DEBUG; from constants.rb).
+  #
   def self.set_log_level(level)
     @log_level = RESULT if level == RESULT
     @log_level = INFO if level == INFO
@@ -38,11 +44,17 @@ class RCT
   end
 
 
+  #---------------------------------------------------------------------------
+  # Increase log verbosity level by one.
+  #
   def self.increase_log_level
     @log_level += 1
   end
 
 
+  #---------------------------------------------------------------------------
+  # Log a line of output, if appropriate for current log level.
+  #
   def self.log(level, line)
     if (level <= @log_level)
       puts line
@@ -50,23 +62,36 @@ class RCT
   end
 
 
+  #---------------------------------------------------------------------------
+  # Log an error to stdout (prefixed with 'error:')
+  #
   def self.error(msg)
     puts "error: #{msg}"
   end
 
 
+  #---------------------------------------------------------------------------
+  # Log an error to stdout (prefixed with 'error:') and exit.
+  #
   def self.bad_invocation(msg)
     error(msg)
     exit(1)
   end
 
 
+  #---------------------------------------------------------------------------
+  # Log an error to stdout (prefixed with 'error:') and exit.
+  #
   def self.die(msg)
     error(msg)
     exit(1)
   end
 
 
+  #---------------------------------------------------------------------------
+  # Return the value of the flag at position pos in ARGV.
+  # Removes both the value and the flag from ARGV.
+  #
   def self.argv_get(pos)
     value = ARGV[pos + 1]
     ARGV.delete_at(pos + 1)
@@ -75,6 +100,9 @@ class RCT
   end
 
 
+  #---------------------------------------------------------------------------
+  #
+  #
   def self.help
 
     # default is CLI invocation of method name
@@ -160,21 +188,33 @@ class RCT
   end
 
 
+  #---------------------------------------------------------------------------
+  # Set a key,value pair in the global state.
+  #
   def self.sset(key, value, temp=false)
     $STATE.set(key, value, temp)
   end
 
 
+  #---------------------------------------------------------------------------
+  # Set a temporary key,value pair in the global state.
+  #
   def self.ssettmp(key, value)
     $STATE.set(key, value, true)
   end
 
 
+  #---------------------------------------------------------------------------
+  # Get the value of a key from the global state.
+  #
   def self.sget(key)
     $STATE.get(key)
   end
 
 
+  #---------------------------------------------------------------------------
+  # Remove the value of a key from the global state.
+  #
   def self.sdelete(key)
     $STATE.delete(key)
   end

data/lib/rct/constants.rb

@@ -1,5 +1,5 @@
 #
-#  Copyright 2012-2014 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -17,7 +17,7 @@
 #  along with rct.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-RCT_VERSION = '0.6'
+RCT_VERSION = '0.7'
 
 RCT_MODE = '_mode'
 RCT_MODE_CLI = 'cli'

data/lib/rct/rct_cli.rb

@@ -1,5 +1,5 @@
 #
-#  Copyright 2012-2013 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -32,6 +32,16 @@
 class RCTCLI
 
 
+  #----------------------------------------------------------------------------
+  # CLI entry point.
+  #
+  # ARGV[0] must contain string "Class.operation". We'll instantiate 'Class'
+  # and execute CLI operation 'operation'. This operation must be one described
+  # by the 'cli' inspection method.
+  #
+  # The exception is if 'operation' is 'HELP', in which case auto-generated
+  # help output is shown.
+  #
   def self.rct_cli
     method = ARGV.shift
     if (method == nil || method.empty?)
@@ -44,18 +54,33 @@ class RCTCLI
     RCT.log(DEBUG, "Requested [#{method}]")
     RCT.log(DEBUG, "CLI class: #{class_name}, method: #{method_name}")
 
+    if (!class_name)
+      RCT.error("No class specified for CLI operation")
+      exit(1)
+    end
+
+    if (!method_name)
+      RCT.error("No method specified for CLI operation")
+      exit(1)
+    end
+
     obj = Object::const_get(class_name).new()
     begin
       cli_info = obj.send('cli')
     rescue Exception => e
       puts e
-      error("#{class_name} does not support CLI operations")
+      RCT.error("#{class_name} does not support CLI operations")
       exit(1)
     end
 
+    if (method_name == "HELP")
+      description = obj.send('description')
+      show_help(description, cli_info)
+    end
+
     method_info = cli_info[method_name]
     if (method_info == nil)
-      error("#{class_name}.#{method_name} not available")
+      RCT.error("#{class_name}.#{method_name} not available")
       exit(1)
     end
 
@@ -77,4 +102,44 @@ class RCTCLI
   end
 
 
+  #----------------------------------------------------------------------------
+  # Show autogenerated help based on cli_info
+  #
+  def self.show_help(description, cli_info)
+
+    puts
+    if (description != nil)
+      puts description
+      puts
+    end
+
+    cli_info.each_key { |key|
+
+      method_info = cli_info[key]
+      description = method_info['description']
+      req = method_info['required']
+      opt = method_info['optional']
+
+      puts
+      puts "#{key}: #{description}"
+
+      if (req != nil && req.length > 0)
+        puts "  Required arguments:"
+        req.each { |key,arg|
+          puts "    #{arg[0]} (#{arg[1]})  : #{arg[2]}"
+        }
+      end
+
+      if (opt != nil && opt.length > 0)
+        puts "  Optional arguments:"
+        opt.each { |key,arg|
+          puts "    #{arg[0]} (#{arg[1]})  : #{arg[2]}"
+        }
+      end
+    }
+
+    exit(0)
+  end
+
+
 end

data/lib/rct/rct_http.rb

@@ -1,5 +1,5 @@
 #
-#  Copyright 2012-2014 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -156,6 +156,12 @@ class RCTHTTP
     end
 
     response = Response.new(res)
+
+    status = response.status
+    if (status == 401)
+      response.add_error("Unauthorized")
+    end
+
     show_response(response)
     return response
   end

data/lib/rct/response.rb

@@ -57,7 +57,7 @@ class Response
       @fail_msg = "#{@fail_msg}; #{msg}"
     end
   end
-  
+
 
   #----------------------------------------------------------------------------
   # Returns true unless this response has been flagged as an error via

data/lib/rct_cli_app.rb

@@ -1,5 +1,5 @@
 #
-#  Copyright 2013 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2013-2015 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -18,7 +18,33 @@
 #
 
 
+#-----------------------------------------------------------------------------
 # CLI scripts built on top of rct can require this file to initialize rct.
+#
+# The common use case for this is when implementing convenience
+# scripts to call the CLI functionality of an rct module (which
+# supports CLI operation). For an example see 'jira' script installed
+# by rct_jira gem.
+#
+# If global $RCT_CLI_APP_CLASS has been set, it is used as the CLI
+# class name to run. This allows convenience script to set their class
+# name so the user can provide only the CLI operation name. If not
+# set, ARGV from caller is not modified. See below.
+#
+
 
 require 'rct'
 require 'rct/rct_init'
+
+
+if ($RCT_CLI_APP_CLASS != nil)
+  if (ARGV.length == 0)
+    ARGV.insert(0, "#{$RCT_CLI_APP_CLASS}.HELP")
+  else
+    method = ARGV.shift
+    ARGV.insert(0, "#{$RCT_CLI_APP_CLASS}.#{method}")
+  end
+end
+
+RCT.parse_global_options()
+RCTCLI.rct_cli()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rct
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies: []
 description: wip
 email: jyri@virkki.com