hmx_client 0.0.7 → 0.1.0

data/lib/hmx/helpers.rb

@@ -1,61 +1,76 @@
-require 'cli-colorize'
-
-module HmxClient
-  module Helpers
-     include CLIColorize
-
-     def getFromUser(prompt)
-       content = ''
-       done = false
-       puts prompt
-       while(!done)
-	 line = gets.strip
-         if (line[line.length-1] == '\\')
-	    done = false
-            content = content + line[0 .. line.length-2]
-         else
-            content = content + line
-            done = true
-         end
-       end
-       content
-     end
-     def error(msg)
-      puts(colorize(msg, :red))
-      exit 1
-     end
-    def longest(items)
-      items.map { |i| i.to_s.length }.sort.last
-    end
-
-    def display(msg="", newline=true)
-      if newline
-        puts(msg)
-      else
-        print(msg)
-        STDOUT.flush
-      end
-    end   
-
-   def display_table(objects, columns, headers)
-      lengths = []
-      columns.each_with_index do |column, index|
-        header = headers[index]
-        lengths << longest([header].concat(objects.map { |o| o[column].to_s }))
-      end
-      display_row headers, lengths
-      display_row headers.map { |header| "-" * header.length }, lengths
-      objects.each do |row|
-        display_row columns.map { |column| row[column] }, lengths
-      end
-    end
-
-    def display_row(row, lengths)
-      row.zip(lengths).each do |column, length|
-        format = column.is_a?(Fixnum) ? "%#{length}s  " : "%-#{length}s  "
-        display format % column, false
-      end
-      display
-    end
-   end
-end
+require 'cli-colorize'
+
+module HmxClient
+  module Helpers
+     include CLIColorize
+
+     def getFromUser(prompt)
+       content = ''
+       done = false
+       puts prompt
+       while(!done)
+	 line = gets.strip
+         if (line[line.length-1] == '\\')
+	    done = false
+            content = content + line[0 .. line.length-2]
+         else
+            content = content + line
+            done = true
+         end
+       end
+       content
+     end
+     def error(msg)
+      puts(colorize(msg, :red))
+      exit 1
+     end
+    def longest(items)
+      items.map { |i| i.to_s.length }.sort.last
+    end
+
+    def display(msg="", newline=true)
+      if newline
+        puts(msg)
+      else
+        print(msg)
+        STDOUT.flush
+      end
+    end   
+
+   def display_table(objects, columns, headers)
+      lengths = []
+      columns.each_with_index do |column, index|
+        header = headers[index]
+        lengths << longest([header].concat(objects.map { |o| o[column].to_s }))
+      end
+      display_row headers, lengths
+      display_row headers.map { |header| "-" * header.length }, lengths
+      objects.each do |row|
+        display_row columns.map { |column| row[column] }, lengths
+      end
+    end
+
+    def display_row(row, lengths)
+      row.zip(lengths).each do |column, length|
+        format = column.is_a?(Fixnum) ? "%#{length}s  " : "%-#{length}s  "
+        display format % column, false
+      end
+      display
+    end
+
+    def display_tab(data)
+      resp = ''
+      data.each { | line | 
+                         line.each { | cell | 
+                                if (cell.is_a? Array)
+                                      cell.each { | inner | resp = resp + "%20.20s\t" % inner }
+                                else
+                                      resp = resp + "%20.20s\t" % cell
+                                end
+                         }
+                         resp = resp + "\n"
+                    }
+      dout resp
+    end
+   end
+end

data/lib/hmx/hmx.rb

@@ -1,215 +1,148 @@
-require 'rubygems'
-require 'rest_client'
-require 'json'
-require 'digest/md5'
-
-module HmxClient
-
-include HmxClient::Helpers
-
-class HmxException < Exception 
-  attr :msg
-  def initialize(msg)
-    @msg = msg
-  end
-end
-
-class Hmx
-
-  def loginApi(url, urlapi)
-    @urlapi = urlapi
-    @context = JSON.parse (RestClient.get url).to_str
-  end
-  def login(config) 
-    puts config if $debug
-    @context = nil;
-    @urlapi = config[:api]
-    if config.has_key?(:context)
-      @context = JSON.parse(config[:context])
-      #Do a null check
-      begin
-        performDistRequest(:info, []) 
-      rescue => e
-        @context = nil;
-      end  
-    end   
-    if (@context.nil?)
-      session = requestSession(config[:partition], config[:user])
-      salty = session['MXSession']['salty']
-      sendString = config[:password] + ':' + salty
-      digestToSend = Digest::MD5.hexdigest(sendString)
-      @context = validateUser(config[:partition], config[:user], digestToSend, session['MXSession']['sessionId'])
-      config[:context] = JSON.generate(@context)
-    end
-  end
-  def initialize
-    @distMap = {
-          :getPartitions => [ 'admin', 'GETPARTITIONS', 'partitions', []],
-          :clonePartition => [ 'admin', 'CLONEPARTITION', 'partition', [ { :pos => 0, :name => 'destination' }, { :pos => 1, :name => 'copyStyle' } ] ],
-          :info => [ 'user', 'INFO', 'response', []],
-          :getData => [ 'user', 'GETDATA', 'data', [ { :pos => 0, :name => 'displayName' } ]],
-          :getContent  => [ 'user', 'GETCONTENT', 'content', [ { :pos  => 0, :name => 'displayName' }]],
-	  :putData => ['user', 'PUTDATA', 'data', [ { :pos => 0, :name => 'data', :file => 1, :json => 1 }]],
-          :putSimpleData => [ 'user', 'PUTSIMPLEDATA', 'data', [ { :pos => 0, :name => 'displayName'}, { :pos => 1, :name => 'content', :file => 1}]],
-          :query => [ 'user', 'QUERY', 'result', [ { :pos => 0, :name => 'index' }, { :pos => 1, :name => 'params' }]],
-          :dynquery => ['user', 'DYNQUERY', 'result', [ { :pos => 0, :name => 'typeName' }, { :pos => 1, :name => 'filterFn' }, { :pos => 2, :name => 'mapFn' } ]],
-          :deleteData => [ 'user', 'DELETEDATA', 'data', [ { :pos => 0, :name => 'displayName' } ]],
-          :getSequenceSize => [ 'user', 'GETSEQUENCESIZE', 'size', [ { :pos => 0, :name => 'typeName' }]],
-          :execPartSeq => [ 'user', 'EXECPARTIALSEQUENCE', 'response', [ { :pos => 0, :name => 'typeName' }, 
-                                                   { :pos => 1, :name => 'fn' },
-  						   { :pos => 2, :name => 'start' },
-						   { :pos => 3, :name => 'size' } ] ] ,
-          :requestSession => [ 'user', 'REQUESTSESSION', 'session', [ { :pos => 0, :name => 'partition' }, { :pos => 1, :name => 'user'}]],
-          :validateUser => [ 'user', 'VALIDATEUSER', 'context', [ { :pos => 0, :name => 'partition' },
-								{ :pos => 1, :name => 'user' },
-								{ :pos => 2, :name => 'hashPassword' },
-								{ :pos => 3, :name => 'session' }
-					]],
-          :submitTask => [ 'user', 'SUBMITTASK', 'task', [ { :pos => 0, :name => 'task' } ]],
-          :runView => [ 'user', 'RUNVIEW', 'response', [ { :pos => 0, :name => 'view' }, { :pos => 1, :name => 'params' } ] ],
-	  :getTypes => [ 'admin', 'GETTYPES', 'types', []],
-          :getType => [ 'admin', 'GETTYPE', 'type', [ { :pos => 0, :name => 'typeName' } ]],
-          :updateType => [ 'admin', 'UPDATETYPE', 'type', [ { :pos => 0, :name => 'type' }]],
-	  :getFn => [ 'user', 'GETFN', 'fnContent', [ { :pos =>0, :name => 'fnName' } ]],
-          :putFn => [ 'user', 'PUTFN', 'response', [ { :pos => 0, :name => 'fnName' }, { :pos => 1, :name => 'fnContent', :file => 1 } ]],
-	  :expireSessions => [ 'admin', 'EXPIRESESSIONS', 'sessions', []],
-          :getAllTasks => [ 'task', 'GETALLTASKS', 'tasks', []],
-          :getTask => [ 'task', 'GETTASK', 'task', [ { :pos=> 0, :name => 'taskId' } ]],
-          :purgeTasks => [ 'task', 'PURGETASKS', 'response', []],
-          :getFountainState => [ 'admin', 'GETFOUNTAINSTATE', 'state', []],
-          :setFountainId => [ 'admin', 'SETFOUNTAINID', 'dummy', [ { :pos => 0, :name => 'fountain' }, { :pos => 1, :name=> 'value' }]],
-          :getFountain => [ 'user', 'AUTOID', 'id', [ { :pos => 0, :name => 'fountain' } ]],
-          :bootstrap => ['special', 'BOOTSTRAP', 'response', []]
-    }
-  end
-  def performDistRequest(cmd, args)
-     spec = @distMap[cmd]
-     hash = getSenderHash()
-     spec[3].each { | param |
-			# if the args has enough , use that
-                        # otherwise, prompt for the parameter
-                        if (args.length > param[:pos])
-			  hash[param[:name]] = args[param[:pos]] 
-			elsif (param.has_key?(:file) && !HmxClient::Command.fileIn.nil?)
-			  # Content comes from file
-  			  realFile = File.expand_path(HmxClient::Command.fileIn)
-                          puts "Reading #{ realFile } to get parameter #{ param[:name] }"
-                          hash[param[:name]] = File.open(realFile) { | f | 
-							c = ''
-                                                        while(line = f.gets)
-                                                            c = c + line
-                                                        end
-							c
-                                                  }
-                        else
-			  hash[param[:name]] = getFromUser("Please enter the value of #{ param[:name] }")
-                        end
-                        if (param.has_key?(:json))
-                          hash[param[:name]] = JSON.parse(hash[param[:name]])
-                        end
-                   }
-     standardRequest(spec[0], spec[1], hash, spec[2])
-  end
-  def performRequest(prefix, function, command)
-    puts "Send data #{ JSON.generate(command) }" if HmxClient::Command.debug?
-    puts "URL is #{ @urlapi+'/'+prefix } " if HmxClient::Command.debug?
-    response = RestClient.post @urlapi+'/'+prefix, :function=>function, :params=>JSON.generate(command), :multipart=>true
-    puts "Raw response is #{ response.to_str }" if HmxClient::Command.debug?
-    return JSON.parse(response.to_str)
-  end
-  def standardRequest(prefix, commandName, params, returnPart)
-    response = performRequest(prefix, commandName, params)
-    puts "JSON response is #{ response }" if HmxClient::Command.debug?
-    if response['inError']
-       raise HmxException.new(response['exception']), "Error returned from server" 
-    end
-    return response[returnPart]
-  end
-  def getSenderHash()
-    hash = Hash.new
-    hash['context'] = @context if @context
-    return hash
-  end
-  def getData(args)
-    performDistRequest(:getData, args)
-  end
-  def getContent(args)
-    performDistRequest(:getContent, args)
-  end
-  def putData(args)
-    performDistRequest(:putData, args)
-  end
-  def putSimpleData(args)
-    performDistRequest(:putSimpleData, args)
-  end
-  def query(*args)
-    performDistRequest(:query, args)
-  end
-  def dynquery(*args)
-    performDistRequest(:dynquery, args)
-  end
-  def deleteData(*args)
-    performDistRequest(:deleteData, args)
-  end
-  def getSequenceSize(*args)
-    performDistRequest(:getSequenceSize, args)
-  end
-  def execPartialSequence(*args)
-    performDistRequest(:execPartSeq, args)
-  end
-  def requestSession(*args)
-    performDistRequest(:requestSession, args)
-  end
-  def validateUser(*args)
-    performDistRequest(:validateUser, args)
-  end
-  def runView(*args)
-    performDistRequest(:runView, args)
-  end
-  def getTypes(*args)
-    performDistRequest(:getTypes, args)
-  end
-  def updateType(*args)
-    performDistRequest(:updateType, args)
-  end
-  def getType(*args)
-    performDistRequest(:getType, args)
-  end
-  def getFn(args)
-    performDistRequest(:getFn, args)
-  end
-  def putFn(args)
-    performDistRequest(:putFn, args)
-  end
-  def expireSessions(args)
-    performDistRequest(:expireSessions, args)
-  end
-  def getAllTasks(args)
-    performDistRequest(:getAllTasks, args)
-  end
-  def getTask(args)
-    performDistRequest(:getTask, args)
-  end
-  def purgeTasks(args)
-    performDistRequest(:purgeTasks, args)
-  end
-  def getFountainState(args)
-    performDistRequest(:getFountainState, args)
-  end
-  def setFountainId(args)
-    performDistRequest(:setFountainId, args)
-  end
-  def getFountain(args)
-    performDistRequest(:getFountain, args)
-  end
-  def bootstrap
-    performDistRequest(:bootstrap, [])
-  end
-  def getPartitions
-    performDistRequest(:getPartitions, [])
-  end
-  def clonePartition(*args)
-    performDistRequest(:clonePartition, args)
-  end
-end
-end
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'digest/md5'
+
+module HmxClient
+
+include HmxClient::Helpers
+
+class HmxException < Exception 
+  attr :msg
+  def initialize(msg)
+    @msg = msg
+  end
+end
+
+class Hmx
+
+  def loginApi(url, urlapi)
+    @urlapi = urlapi
+    @context = JSON.parse (RestClient.get url).to_str
+  end
+  def login(config) 
+    puts config if $debug
+    @context = nil;
+    @urlapi = config[:api]
+    if config.has_key?(:context)
+      @context = JSON.parse(config[:context])
+      #Do a null check
+      begin
+        doInfo([])
+      rescue => e
+        @context = nil;
+      end  
+    end   
+    if (@context.nil?)
+      session = doRequestSession([config[:partition], config[:user]])
+      salty = session['MXSession']['salty']
+      sendString = config[:password] + ':' + salty
+      digestToSend = Digest::MD5.hexdigest(sendString)
+      @context = doValidateUser([config[:partition], config[:user], digestToSend, session['MXSession']['sessionId']])
+      config[:context] = JSON.generate(@context)
+    end
+  end
+   @@distMap = {
+          :GetPartitions => [ 'admin', 'GETPARTITIONS', 'partitions', []],
+          :ClonePartition => [ 'admin', 'CLONEPARTITION', 'partition', [ { :pos => 0, :name => 'destination' }, { :pos => 1, :name => 'copyStyle' } ] ],
+          :Info => [ 'user', 'INFO', 'response', []],
+          :GetData => [ 'user', 'GETDATA', 'data', [ { :pos => 0, :name => 'displayName' } ]],
+          :GetContent  => [ 'user', 'GETCONTENT', 'content', [ { :pos  => 0, :name => 'displayName' }]],
+	  :PutData => ['user', 'PUTDATA', 'data', [ { :pos => 0, :name => 'data', :file => 1, :json => 1 }]],
+          :PutSimpleData => [ 'user', 'PUTSIMPLEDATA', 'data', [ { :pos => 0, :name => 'displayName'}, { :pos => 1, :name => 'content', :file => 1}]],
+          :Query => [ 'user', 'QUERY', 'result', [ { :pos => 0, :name => 'index' }, { :pos => 1, :name => 'params' }]],
+          :Dynquery => ['user', 'DYNQUERY', 'result', [ { :pos => 0, :name => 'typeName' }, { :pos => 1, :name => 'filterFn' }, { :pos => 2, :name => 'mapFn' } ]],
+          :DeleteData => [ 'user', 'DELETEDATA', 'data', [ { :pos => 0, :name => 'displayName' } ]],
+          :GetSequenceSize => [ 'user', 'GETSEQUENCESIZE', 'size', [ { :pos => 0, :name => 'typeName' }]],
+          :ExecPartSeq => [ 'user', 'EXECPARTIALSEQUENCE', 'response', [ { :pos => 0, :name => 'typeName' }, 
+                                                   { :pos => 1, :name => 'fn' },
+  						   { :pos => 2, :name => 'start' },
+						   { :pos => 3, :name => 'size' } ] ] ,
+          :RequestSession => [ 'user', 'REQUESTSESSION', 'session', [ { :pos => 0, :name => 'partition' }, { :pos => 1, :name => 'user'}]],
+          :ValidateUser => [ 'user', 'VALIDATEUSER', 'context', [ { :pos => 0, :name => 'partition' },
+								{ :pos => 1, :name => 'user' },
+								{ :pos => 2, :name => 'hashPassword' },
+								{ :pos => 3, :name => 'session' }
+					]],
+          :SubmitTask => [ 'user', 'SUBMITTASK', 'task', [ { :pos => 0, :name => 'task' } ]],
+          :RunView => [ 'user', 'RUNVIEW', 'response', [ { :pos => 0, :name => 'view' }, { :pos => 1, :name => 'params' } ] ],
+	  :GetTypes => [ 'admin', 'GETTYPES', 'types', []],
+          :GetType => [ 'admin', 'GETTYPE', 'type', [ { :pos => 0, :name => 'typeName' } ]],
+          :UpdateType => [ 'admin', 'UPDATETYPE', 'type', [ { :pos => 0, :name => 'type' }]],
+	  :GetFn => [ 'user', 'GETFN', 'fnContent', [ { :pos =>0, :name => 'fnName' } ]],
+          :PutFn => [ 'user', 'PUTFN', 'response', [ { :pos => 0, :name => 'fnName' }, { :pos => 1, :name => 'fnContent', :file => 1 }, { :pos => 2, :name => 'fnLanguage'} ]],
+	  :ExpireSessions => [ 'admin', 'EXPIRESESSIONS', 'sessions', []],
+          :GetAllTasks => [ 'task', 'GETALLTASKS', 'tasks', []],
+          :GetTask => [ 'task', 'GETTASK', 'task', [ { :pos=> 0, :name => 'taskId' } ]],
+          :PurgeTasks => [ 'task', 'PURGETASKS', 'response', []],
+          :GetFountainState => [ 'admin', 'GETFOUNTAINSTATE', 'state', []],
+          :SetFountainId => [ 'admin', 'SETFOUNTAINID', 'dummy', [ { :pos => 0, :name => 'fountain' }, { :pos => 1, :name=> 'value' }]],
+          :GetFountain => [ 'user', 'AUTOID', 'id', [ { :pos => 0, :name => 'fountain' } ]],
+          :Bootstrap => ['special', 'BOOTSTRAP', 'response', []]
+    }
+    # Meta initialize the class methods
+    @@distMap.keys.each { | commandName | 
+		method_name = ( "do" + commandName.to_s).to_sym
+                define_method method_name do | arg |
+			performDistRequest(commandName.to_sym, arg)		
+                end
+    } 
+   def initialize
+   end
+  # Implementation note - the doXXX commands are defined in the section above and basically
+  # call performDistRequest for the symbol :XXX with the arguments provided. So by adding to
+  # @@distMap we automatically provide hmx.doXXX support for that call
+  def performDistRequest(cmd, args)
+     spec = @@distMap[cmd]
+     hash = getSenderHash()
+     spec[3].each { | param |
+			# if the args has enough , use that
+                        # otherwise, prompt for the parameter
+                        if (args.length > param[:pos])
+			  hash[param[:name]] = args[param[:pos]] 
+			elsif (param.has_key?(:file) && !HmxClient::Command.fileIn.nil?)
+			  # Content comes from file
+  			  realFile = File.expand_path(HmxClient::Command.fileIn)
+                          puts "Reading #{ realFile } to get parameter #{ param[:name] }"
+                          hash[param[:name]] = File.open(realFile) { | f | 
+							c = ''
+                                                        while(line = f.gets)
+                                                            c = c + line
+                                                        end
+							c
+                                                  }
+                        else
+			  hash[param[:name]] = getFromUser("Please enter the value of #{ param[:name] }")
+                        end
+                        if (param.has_key?(:json))
+                          hash[param[:name]] = JSON.parse(hash[param[:name]])
+                        end
+                   }
+     standardRequest(spec[0], spec[1], hash, spec[2])
+  end
+  def performRequest(prefix, function, command)
+    puts "Send data #{ JSON.generate(command) }" if HmxClient::Command.debug?
+    puts "URL is #{ @urlapi+'/'+prefix } " if HmxClient::Command.debug?
+    response = RestClient.post @urlapi+'/'+prefix, :function=>function, :params=>JSON.generate(command), :multipart=>true
+    puts "Raw response is #{ response.to_str }" if HmxClient::Command.debug?
+    if (response.length > 0) 
+    	return JSON.parse(response.to_str)
+    else
+        return ""
+    end
+  end
+  def standardRequest(prefix, commandName, params, returnPart)
+    response = performRequest(prefix, commandName, params)
+    puts "JSON response is #{ response }" if HmxClient::Command.debug?
+    if response['inError']
+       raise HmxException.new(response['exception']), "Error returned from server" 
+    end
+    return response[returnPart]
+  end
+  def getSenderHash()
+    hash = Hash.new
+    hash['context'] = @context if @context
+    return hash
+  end
+end
+end