usd 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dc348116c2ad35950bcea88ca80863c751b7b50c8d30e9f7e1b61555f6d08dd
-  data.tar.gz: 4fb82b76d1aa8ba9277ac3512e6d4fd0bc40e29fdff4054192de6f94709ee27a
+  metadata.gz: eeb6a5b08aafdc142ff2fa07c8dcf1859ca4993a2e2749c44aec12bc4bd2488a
+  data.tar.gz: 4d9a1b2f4dd5364b344f2e80f2e0e886698105734121a466e378a7710631f96e
 SHA512:
-  metadata.gz: 2b99881822e2e345d1dc7c227806f7df202af50d51fef1d3bc4dd16563dd58e3e01b95249aab6cb910ba7209e78fc0bad04ad39613895c9bc7ad1d1e070d749a
-  data.tar.gz: ddb9e9db898df0849150849d75fae4d848bc0d5305f6605ca881a3e5ae2c1c6498af3ac4c8f7d3370f81a278b7d41b6990853a94cf4e3dcf4e275df5cddc46c1
+  metadata.gz: a9f89726f11a5c925b63e21ed7a6ce9c7acbd3d7af152a1d80aae41afb1ceaa0cde4cee27ee0ccc50ebc7b787152a515b06157fbbe73f4536218759d5d47fb90
+  data.tar.gz: 6cd80c617bb13cdf72e7720811f83632eaa4865c33181e43ea764a68a7a84b3ad3dc158d04de870b75a97d397010846248eb8bc962ef006acf8c11fc1dd4b83a

data/README.md

@@ -29,27 +29,27 @@ If you use the `rusdc find` command with `--format mlr` option then you need `ml
 
 Place the `mlr`-binary in a path, which is in your PATH-Environment.
 
-# funktions from the commandline-tool `rusdc`
+# functions from the commandline-tool `rusdc`
 
 ```
 rusdc
 Commands:
-  rusdc chg_add_nr              # <CO> <CI> - fügt einer CO ein CI hinzu
-  rusdc chg_list_nr             # <CO> - listet alle CIs einer CO
+  rusdc chg_add_nr              # <CO> <CI> - add a CI to a changeorder
+  rusdc chg_list_nr             # <CO> - list all CIs of one changeorder
   rusdc create                  # pipe json-data to create object
-  rusdc field_names             # field_names <object> , listet die Attribute und Beziehungen eines Objektes auf.
-  rusdc find                    # find <object> <where-clause> [fields - Komma getrennt (id,name)] - findet alle Objecte die die wc erfüllen.
-  rusdc get                     # get <object> <cn>
-  rusdc get_attachment_of_ci    # <ci_name> <filename>
-  rusdc get_attachment_of_co    # <co_name> <filename>
+  rusdc field_names             # <object-type> list all fields of an object including its format
+  rusdc find                    # <object-type> <where-clause> [fields - Komma getrennt (id,name)] - finds each object which meets the wc-condition
+  rusdc get                     # <object-type> <common_name> shows one object
+  rusdc get_attachment_of_ci    # <ci_name> <filename>, download an attachment of a CI and print it out on stdout
+  rusdc get_attachment_of_co    # <co_name> <filename>, download an attachment of a changeorder and print it out on stdout
   rusdc help [COMMAND]          # Describe available commands or one specific command
-  rusdc list_attachments_of_ci  # <ci_name>
-  rusdc list_attachments_of_co  # <co_name>
-  rusdc nr_add_child            # <nr-name> <child-name>
-  rusdc nr_changes              # <nr> [inactive-too] - listet alle offenen Change eines nr, bei Bedarf auch inaktive
-  rusdc nr_childs               # nr_childs <ci-name> , listet alle Childs eines CI
-  rusdc nr_incidents            # <nr> [inactive-too] - listet alle offenen Incidents eines nr, bei Bedarf auch inaktive
-  rusdc nr_parents              # nr_parents <ci-name> , listet alle Parents eines CI
+  rusdc list_attachments_of_ci  # <ci_name>, list all attachments of a CI
+  rusdc list_attachments_of_co  # <co_name>, list all attachments of a changeorder
+  rusdc nr_add_child            # <nr-name> <child-name>, add one child CI to another CI
+  rusdc nr_changes              # <nr> [inactive-too] - list all open changeorders of one CI
+  rusdc nr_childs               # <ci-name> , lists all childs CIs of a specific CI
+  rusdc nr_incidents            # <nr> [inactive-too] - lists all incident of a specific CI
+  rusdc nr_parents              # nr_parents <ci-name> , lists all parent CIs of a specific CI
   rusdc update                  # pipe json-data to update object
 ```
 

data/bin/rusdc

@@ -7,7 +7,7 @@ require "usd"
 
 class Rusdc < Thor
 
-  desc "chg_add_nr", "<CO> <CI> - fügt einer CO ein CI hinzu"
+  desc "chg_add_nr", "<CO> <CI> - add a CI to a changeorder"
   def chg_add_nr(co, ci)
     template = ERB.new <<-EOF
       {
@@ -25,7 +25,7 @@ class Rusdc < Thor
     puts loadcon.create({:type => "json", :data => json})
   end
 
-  desc "chg_list_nr", "<CO> - listet alle CIs einer CO"
+  desc "chg_list_nr", "<CO> - list all CIs of one changeorder"
   def chg_list_nr(co)
     invoke 'find', ['lrel_asset_chgnr', %(chg.chg_ref_num = '#{co}'), "nr"], {:format => "mlr", :mlr_format => "xtab"}
   end
@@ -35,7 +35,7 @@ class Rusdc < Thor
     puts loadcon.create({:type => "json", :data => STDIN.read})
   end
 
-  desc "field_names","field_names <object> , listet die Attribute und Beziehungen eines Objektes auf."
+  desc "field_names","<object-type> list all fields of an object including its format"
   def field_names(object)
     e = loadcon.search(object,{'fields' => "*","start" => "1", "size" => "1"})[0]
     e.keys.sort.each do |k|
@@ -46,7 +46,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "find", "find <object> <where-clause> [fields - Komma getrennt (id,name)] - findet alle Objecte die die wc erfüllen."
+  desc "find", "<object-type> <where-clause> [fields - Komma getrennt (id,name)] - finds each object which meets the wc-condition"
   long_desc <<-LONGDESC
 
 
@@ -138,7 +138,7 @@ class Rusdc < Thor
     end # fields check
   end
 
-  desc "get", "get <object> <cn>"
+  desc "get", "<object-type> <common_name> shows one object"
   option :yaml, :type => :boolean, :default => false
   def get(object, cn)
     e = loadcon.request("/caisd-rest/#{object}/COMMON_NAME-#{cn}")
@@ -151,7 +151,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "get_attachment_of_ci", "<ci_name> <filename>"
+  desc "get_attachment_of_ci", "<ci_name> <filename>, download an attachment of a CI and print it out on stdout"
   def get_attachment_of_ci(ciname, filename)
     att_nr = loadcon.search("lrel_attachments_nr",{'fields' => "attmnt","wc" => "nr.name = '#{ciname}'"})
     att_nr.each do |att|
@@ -162,7 +162,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "get_attachment_of_co", "<co_name> <filename>"
+  desc "get_attachment_of_co", "<co_name> <filename>, download an attachment of a changeorder and print it out on stdout"
   def get_attachment_of_co(coname, filename)
     chg_id=loadcon.request("/caisd-rest/chg/COMMON_NAME-#{coname}")["chg"]["@id"]
     att_nr = loadcon.search("lrel_attachments_changes",{'fields' => "attmnt","wc" => "chg = #{chg_id}"})
@@ -174,7 +174,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "list_attachments_of_ci", "<ci_name>"
+  desc "list_attachments_of_ci", "<ci_name>, list all attachments of a CI"
   def list_attachments_of_ci(ciname)
     att_nr = loadcon.search("lrel_attachments_nr",{'fields' => "attmnt","wc" => "nr.name = '#{ciname}'"})
     att_nr.each do |att|
@@ -182,7 +182,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "list_attachments_of_co", "<co_name>"
+  desc "list_attachments_of_co", "<co_name>, list all attachments of a changeorder"
   def list_attachments_of_co(coname)
     chg_id=loadcon.request("/caisd-rest/chg/COMMON_NAME-#{coname}")["chg"]["@id"]
     att_nr = loadcon.search("lrel_attachments_changes",{'fields' => "attmnt","wc" => "chg = #{chg_id}"})
@@ -191,7 +191,7 @@ class Rusdc < Thor
     end
   end
 
-  desc "nr_add_child", "<nr-name> <child-name>"
+  desc "nr_add_child", "<nr-name> <child-name>, add one child CI to another CI"
   def nr_add_child(nr, child)
     template = ERB.new <<-EOF
       {
@@ -209,7 +209,7 @@ class Rusdc < Thor
     puts loadcon.create({:type => "json", :data => json})
   end
 
-  desc "nr_changes", "<nr> [inactive-too] - listet alle offenen Change eines nr, bei Bedarf auch inaktive"
+  desc "nr_changes", "<nr> [inactive-too] - list all open changeorders of one CI"
   option :inactive_too, :type => :boolean, :default => false
   def nr_changes(nr)
     wc_add = (options[:inactive_too] ? "" : " and status.sym in ('Service pending','Work in progress','Customer Pending','Open','Hold')")
@@ -217,20 +217,20 @@ class Rusdc < Thor
     invoke 'find', ['chg', wc, 'chg_ref_num,summary,status'], {:format => "mlr"}
   end
 
-  desc "nr_childs", "nr_childs <ci-name> , listet alle Childs eines CI"
+  desc "nr_childs", "<ci-name> , lists all childs CIs of a specific CI"
   def nr_childs(name)
     loadcon.search("hier",{'fields' => "*","wc" => "parent.name = '#{name}'"}).each do |c|
       puts c["child"]["@COMMON_NAME"]
     end
   end
 
-  desc "nr_incidents", "<nr> [inactive-too] - listet alle offenen Incidents eines nr, bei Bedarf auch inaktive"
+  desc "nr_incidents", "<nr> [inactive-too] -  lists all incident of a specific CI"
   option :inactive_too, :type => :boolean, :default => false
   def nr_incidents(nr)
     invoke 'find', ['in', %(affected_resource.name = '#{nr}'#{options[:inactive_too] ? "" : " and not status.sym in ('Cancelled','Closed')"}), "ref_num,summary,status"], {:format => "mlr"}
   end
 
-  desc "nr_parents", "nr_parents <ci-name> , listet alle Parents eines CI"
+  desc "nr_parents", "nr_parents <ci-name> , lists all parent CIs of a specific CI"
   def nr_parents(name)
     loadcon.search("hier",{'fields' => "*","wc" => "child.name = '#{name}'"}).each do |c|
       puts c["parent"]["@COMMON_NAME"]

data/usd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = 'usd'
-  spec.version = '0.1.4'
+  spec.version = '0.1.5'
   spec.date = '2019-10-31'
   spec.summary = "SDM REST-API-Calls"
   spec.description = "a Ruby class and a commandlinetool for SDM REST-API-Calls"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usd
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Oliver Gaida