hmx_client 0.0.7 → 0.1.0

data/lib/hmx/command/type.rb

@@ -1,45 +1,45 @@
-require "hmx/command/base"
-require 'date'
-
-module HmxClient::Command
-
-  # Display and manage type information in hmx 
-  #
-  class Type < Base
-
-    # type
-    #
-    # Display information about a HMX type
-    def index
-      puts JSON.pretty_generate(hmx.getType(args.shift))
-    end
-
-    # type:create
-    #
-    # Create a type with default settings - no triggers, no entitlements 
-    def create
-       typeInfo = { "name" => args.shift, "triggers" => [], "typeNature" => "CONTENT", "typeIndexScript" => "", "typeAspect" => "JSONDOCUMENT" }
-       hmx.updateType(typeInfo)       
-       puts "Done..."
-    end
-   
-    # type:clone-ent
-    #
-    # Clone the entitlements from one type to another
-    # 
-    # <srcType> <targType>
-    def clone
-         # We basically load the documents for sys.ent/type/[source]/query and sys.ent/type/[source]/query and copy them to the target
-         sourceType = args.shift
-         targetType = args.shift
-         arr = JSON.parse(hmx.getContent(["sys.ent/type/#{ sourceType }/get"]))
-         arr["MXEntitlement"]["entitlementPath"] = "type/#{ targetType }/get"
-         hmx.putSimpleData([ "sys.ent/type/#{ targetType}/get", JSON.generate(arr)])
-
-         arr = JSON.parse(hmx.getContent(["sys.ent/type/#{ sourceType }/query"]))
-         arr["MXEntitlement"]["entitlementPath"] = "type/#{ targetType }/query"
-         hmx.putSimpleData([ "sys.ent/type/#{ targetType}/query", JSON.generate(arr)])
-         puts "Done..."
-    end
-  end
-end
+require "hmx/command/base"
+require 'date'
+
+module HmxClient::Command
+
+  # Display and manage type information in hmx 
+  #
+  class Type < Base
+
+    # type
+    #
+    # Display information about a HMX type
+    def index
+      puts JSON.pretty_generate(hmx.doGetType(args))
+    end
+
+    # type:create
+    #
+    # Create a type with default settings - no triggers, no entitlements 
+    def create
+       typeInfo = { "name" => args.shift, "triggers" => [], "typeNature" => "CONTENT", "typeIndexScript" => ""  }
+       hmx.doUpdateType([typeInfo])       
+       puts "Done..."
+    end
+   
+    # type:clone-ent
+    #
+    # Clone the entitlements from one type to another
+    # 
+    # <srcType> <targType>
+    def clone
+         # We basically load the documents for sys.ent/type/[source]/query and sys.ent/type/[source]/query and copy them to the target
+         sourceType = args.shift
+         targetType = args.shift
+         arr = JSON.parse(hmx.doGetContent(["sys.ent/type/#{ sourceType }/get"]))
+         arr["MXEntitlement"]["entitlementPath"] = "type/#{ targetType }/get"
+         hmx.doPutSimpleData([ "sys.ent/type/#{ targetType}/get", JSON.generate(arr)])
+
+         arr = JSON.parse(hmx.doGetContent(["sys.ent/type/#{ sourceType }/query"]))
+         arr["MXEntitlement"]["entitlementPath"] = "type/#{ targetType }/query"
+         hmx.doPutSimpleData([ "sys.ent/type/#{ targetType}/query", JSON.generate(arr)])
+         puts "Done..."
+    end
+  end
+end

data/lib/hmx/command/user.rb

@@ -1,68 +1,68 @@
-require "hmx/command/base"
-
-module HmxClient::Command
-
-  # Manipulate user entities in hmx
-  #
-  class User < Base
-
-    # user 
-    #
-    # manipulate user enties in hMX 
-    #
-    #
-    def index
-      unless args.size > 0
-        raise CommandFailed, "Usage: hmx user <userId>"
-      end
-      userName = args.shift
-      dout JSON.pretty_generate(hmx.getData(["sys.user/#{userName}"]))
-    end
-
-    # user:list
-    #
-    # Lists all of the users in the system
-
-    def list
-      views = hmx.query("sys.user", nil)
-      views.each { | v |
-                 display v.rpartition('/')[2]
-                } 
-    end
-
-    # user:get
-    #
-    # Retrieves the definition of a user
-    #
-    def get
-       index
-    end
-
-    # user:password
-    #
-    # Sets the password for a user
-    #
-    def password
-      unless args.size > 1
-        raise CommandFailed, "Usage: hmx user:password <userId> <newPassword>"
-      end
-      user = args.shift
-      userName = "sys.user/#{user}"
-      password = Digest::MD5.hexdigest(args.shift)
-      dataDocument = hmx.getData([userName])
-      dataDocument['document']['MXUser']['hashPassword'] = password
-      display hmx.putData([JSON.generate(dataDocument)])
-    end
-
-    # user:delete
-    # 
-    # Removes a user
-    #
-    def delete
-      # We also need to remove the user reference from any groups they belong to (sys.entgroup)
-      # We should be clever and use a custom view for that purpose
-      # something like
-      # (fn[param] (fn[x] (contains (param "user" (.get x '(:document :MXEntitlementGroup :users ))))))
-    end
-   end
-end
+require "hmx/command/base"
+
+module HmxClient::Command
+
+  # Manipulate user entities in hmx
+  #
+  class User < Base
+
+    # user 
+    #
+    # manipulate user enties in hMX 
+    #
+    #
+    def index
+      unless args.size > 0
+        raise CommandFailed, "Usage: hmx user <userId>"
+      end
+      userName = args.shift
+      dout JSON.pretty_generate(hmx.doGetData(["sys.user/#{userName}"]))
+    end
+
+    # user:list
+    #
+    # Lists all of the users in the system
+
+    def list
+      views = hmx.doQuery(["sys.user", nil])
+      views.each { | v |
+                 display v.rpartition('/')[2]
+                } 
+    end
+
+    # user:get
+    #
+    # Retrieves the definition of a user
+    #
+    def get
+       index
+    end
+
+    # user:password
+    #
+    # Sets the password for a user
+    #
+    def password
+      unless args.size > 1
+        raise CommandFailed, "Usage: hmx user:password <userId> <newPassword>"
+      end
+      user = args.shift
+      userName = "sys.user/#{user}"
+      password = Digest::MD5.hexdigest(args.shift)
+      dataDocument = hmx.doGetData([userName])
+      dataDocument['document']['MXUser']['hashPassword'] = password
+      display hmx.doPutData([JSON.generate(dataDocument)])
+    end
+
+    # user:delete
+    # 
+    # Removes a user
+    #
+    def delete
+      # We also need to remove the user reference from any groups they belong to (sys.entgroup)
+      # We should be clever and use a custom view for that purpose
+      # something like
+      # (fn[param] (fn[x] (contains (param "user" (.get x '(:document :MXEntitlementGroup :users ))))))
+    end
+   end
+end

data/lib/hmx/command/view.rb

@@ -1,155 +1,161 @@
-require "hmx/command/base"
-
-module HmxClient::Command
-
-  # Display the results of a view and list all views
-  #
-  class View < Base
-
-    # view 
-    #
-    # run a view in hmx, passing in a view name and an input to the filter function 
-    #
-    #
-    def index
-      unless args.size > 0
-        raise CommandFailed, "Usage: hmx view <viewName> <filterContext>" 
-      end
-      viewData = hmx.runView(args.shift, JSON.parse(args.shift))
-      resp = ''
-      viewData.each { | line | 
-                         line.each { | cell | resp = resp + "%20.20s\t" % cell }
-                         resp = resp + "\n"
-                    }
-      dout resp
-    end
-
-    # view:list
-    #
-    # Lists all of the views in the system
-
-    def list
-      views = hmx.query("sys.view", nil)
-      views.each { | v |
-                 display v.rpartition('/')[2]
-                } 
-    end
-
-    # view:get
-    #
-    # Retrieves the definition of a view
-    #
-    def get
-       unless args.size > 0
-        raise CommandFailed, "Usage: hmx view:get <viewName>" 
-      end
-      typeName = "sys.view/#{args.shift}"
-      display "Retrieving #{ typeName }"
-      dout JSON.pretty_generate(hmx.getData([typeName]))
-    end
-
-    # view:create
-    #
-    # Create a new (initially blank) view.
-    # You will then need to call update to set the filter function, map function, query params and 
-    # result columns.
-    # 
-    # Views are based on types, for create define a name and the type
-    def create
-      unless args.size > 1
-        raise CommanFailed, "Usage: hmx view:create <viewName> <typeName>"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-      typeName = args.shift
-      
-      dataDocument = { 
-                              "MXView" => {
-                                  :typeName => typeName,
-                                  :parameterNames => [],
-                                  :filterFn => "",
-                                  :mappingFn => "",
-                                  :resultColumns => [],
-                                  :viewName => view
-                              }
-                   }
-
-      dout JSON.pretty_generate(hmx.putSimpleData([viewName, JSON.generate(dataDocument)]))
-    end
-   
-    # view:updateFilter 
-    # 
-    # Set the filter function for a view
-    #
-    def updateFilter
-      unless args.size > 1
-       raise CommandFailed, "Usage: hmx view:updateFilter <viewName> <filterFn>"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-      filterFn = args.shift
-
-      dataDocument = hmx.getData([viewName])
-      puts dataDocument
-      dataDocument['document']['MXView']['filterFn'] = filterFn
-      display hmx.putData([JSON.generate(dataDocument)])
-    end 
-    # view:updateMap 
-    # 
-    # Set the map function for a view
-    #
-    def updateMap
-      unless args.size > 1
-       raise CommandFailed, "Usage: hmx view:updateMap <viewName> <filterFn>"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-      mapFn = args.shift
-      dataDocument = hmx.getData([viewName])
-      dataDocument['document']['MXView']['mappingFn'] = mapFn
-      display hmx.putData([JSON.generate(dataDocument)])
-    end 
-    # view:updateParam 
-    # 
-    # Set the parameter names for a view
-    #
-    def updateParam
-      unless args.size > 1
-       raise CommandFailed, "Usage: hmx view:updateParam <viewName> <param> [<param2> ...]"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-      dataDocument = hmx.getData([viewName])
-      dataDocument['document']['MXView']['parameterNames'] = args
-      display hmx.putData([JSON.generate(dataDocument)])
-    end 
-    # view:updateResult 
-    # 
-    # Set the result names for a view
-    #
-    def updateResult
-      unless args.size > 1
-       raise CommandFailed, "Usage: hmx view:updateResult <viewName> <param> [<param2> ...]"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-
-      dataDocument = hmx.getData([viewName])
-      dataDocument['document']['MXView']['resultColumns'] = args
-      display hmx.putData([JSON.generate(dataDocument)])
-    end 
-    # view:delete
-    #
-    # Delete a view definition
-    #
-    def delete
-      unless args.size >0 
-       raise CommandFailed, "Usage: hmx view:delete <viewName>"
-      end
-      view = args.shift
-      viewName = "sys.view/#{view}"
-      display hmx.deleteData(viewName)
-    end 
-    
-  end
-end
+require "hmx/command/base"
+
+module HmxClient::Command
+
+  # Display the results of a view and list all views
+  #
+  class View < Base
+
+    # view 
+    #
+    # run a view in hmx, passing in a view name and an input to the filter function 
+    #
+    #
+    def index
+      unless args.size > 0
+        raise CommandFailed, "Usage: hmx view <viewName> <filterContext>" 
+      end
+      viewData = hmx.doRunView([args.shift, JSON.parse(args.shift)])
+      resp = ''
+      viewData.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
+
+    # view:list
+    #
+    # Lists all of the views in the system
+
+    def list
+      views = hmx.doQuery(["sys.view", nil])
+      views.each { | v |
+                 display v.rpartition('/')[2]
+                } 
+    end
+
+    # view:get
+    #
+    # Retrieves the definition of a view
+    #
+    def get
+       unless args.size > 0
+        raise CommandFailed, "Usage: hmx view:get <viewName>" 
+      end
+      typeName = "sys.view/#{args.shift}"
+      display "Retrieving #{ typeName }"
+      dout JSON.pretty_generate(hmx.doGetData([typeName]))
+    end
+
+    # view:create
+    #
+    # Create a new (initially blank) view.
+    # You will then need to call update to set the filter function, map function, query params and 
+    # result columns.
+    # 
+    # Views are based on types, for create define a name and the type
+    def create
+      unless args.size > 1
+        raise CommanFailed, "Usage: hmx view:create <viewName> <typeName>"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+      typeName = args.shift
+      
+      dataDocument = { 
+                              "MXView" => {
+                                  :typeName => typeName,
+                                  :parameterNames => [],
+                                  :filterFn => "",
+                                  :mappingFn => "",
+                                  :resultColumns => [],
+                                  :viewName => view
+                              }
+                   }
+
+      dout JSON.pretty_generate(hmx.doPutSimpleData([viewName, JSON.generate(dataDocument)]))
+    end
+   
+    # view:updateFilter 
+    # 
+    # Set the filter function for a view
+    #
+    def updateFilter
+      unless args.size > 1
+       raise CommandFailed, "Usage: hmx view:updateFilter <viewName> <filterFn>"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+      filterFn = args.shift
+
+      dataDocument = hmx.doGetData([viewName])
+      puts dataDocument
+      dataDocument['document']['MXView']['filterFn'] = filterFn
+      display hmx.doPutData([JSON.generate(dataDocument)])
+    end 
+    # view:updateMap 
+    # 
+    # Set the map function for a view
+    #
+    def updateMap
+      unless args.size > 1
+       raise CommandFailed, "Usage: hmx view:updateMap <viewName> <filterFn>"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+      mapFn = args.shift
+      dataDocument = hmx.doGetData([viewName])
+      dataDocument['document']['MXView']['mappingFn'] = mapFn
+      display hmx.doPutData([JSON.generate(dataDocument)])
+    end 
+    # view:updateParam 
+    # 
+    # Set the parameter names for a view
+    #
+    def updateParam
+      unless args.size > 1
+       raise CommandFailed, "Usage: hmx view:updateParam <viewName> <param> [<param2> ...]"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+      dataDocument = hmx.doGetData([viewName])
+      dataDocument['document']['MXView']['parameterNames'] = args
+      display hmx.doPutData([JSON.generate(dataDocument)])
+    end 
+    # view:updateResult 
+    # 
+    # Set the result names for a view
+    #
+    def updateResult
+      unless args.size > 1
+       raise CommandFailed, "Usage: hmx view:updateResult <viewName> <param> [<param2> ...]"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+
+      dataDocument = hmx.doGetData([viewName])
+      dataDocument['document']['MXView']['resultColumns'] = args
+      display hmx.doPutData([JSON.generate(dataDocument)])
+    end 
+    # view:delete
+    #
+    # Delete a view definition
+    #
+    def delete
+      unless args.size >0 
+       raise CommandFailed, "Usage: hmx view:delete <viewName>"
+      end
+      view = args.shift
+      viewName = "sys.view/#{view}"
+      display hmx.doDeleteData([viewName])
+    end 
+    
+  end
+end