usd 0.2.3 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 321fb82b164595bcb7c2ff73cb7e9f1ed9fe6306b9517c1c236ae30aaa713aaa
-  data.tar.gz: ea63b6a5116370391d19c4b2c6d9d82768fb0fd9af709dd9a971829fd9a3db74
+  metadata.gz: 01c14a85c19914e885ffd003e8b4584ab7f89a15305866abade4ea4888625940
+  data.tar.gz: e89f3b47d89b9040077400049e91aa0700f4c68d41b19c6cf7fde7a97f8e46c8
 SHA512:
-  metadata.gz: 28255500c9fcee00e8d62361f8ec06a12e4617f653f8c4aa255655d7fd37a76b429440922511d4af9288fd67670c7a5346eceb358514ddaf087bcb73e07a157e
-  data.tar.gz: a726a7585b18c684ce71153b2c964100cd3b52ce62f1d9b0b78581e9b591947951b04a5b6990afbe12daa4ef7c088f6dd17ef99fd0a199b32ce4792d8a15ac6b
+  metadata.gz: 5857ce4ebc1a8b24b59a1ce22e63cdaa9384724401d6aae189a3345c952ce74e22332b2a0a25ec3cf2bc3e3f059f298ca9455e391028f20675cd2069adeb4f3e
+  data.tar.gz: 97a5207333d77ece64e71b7883f8198bdd8fad5f47f772d72d6f438aaebb3e95ff6179bdbfd81d07574a033181a50642a2ede5f155aa6e62e1453e0170bc3770

data/README.md

@@ -21,6 +21,15 @@ yum group install "Development Tools"
 yum install ruby-devel
 ```
 
+# documentation
+
+- see [https://github.com/ogaida/usd/wiki](https://github.com/ogaida/usd/wiki)
+- if you are looking for dependencies in between the objects, objectnames or relational objects, then have a look at [techdocs.broadcom.com](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-enterprise-software/business-management/ca-service-management/14-1/reference/ca-service-desk-manager-reference-commands/objects-and-attributes.html)
+
+## bash-completion
+
+see [https://github.com/ogaida/usd/wiki/bash-completion](https://github.com/ogaida/usd/wiki/bash-completion)
+
 # external tools
 
 If you use the `rusdc find` command with `--format mlr` option then you need `mlr`.
@@ -32,28 +41,31 @@ Place the `mlr`-binary in a path, which is in your PATH-Environment. Download-Ur
 # functions from the commandline-tool `rusdc`
 
 ```
-rusdc
-Commands:
-  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 <object-type>                                              # list all fields of an object including its format
-  rusdc find <object-type> [where-clause] [fields, comma separated] [options]  # 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 in_list_child_ins <in>                                                 # list all child-incidents of one incident
-  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 <ci-name>                                                   # lists all parent CIs of a specific CI
-  rusdc update                                                                 # pipe json-data to update object
-  rusdc update_attr <obj> <common_name> <key> <value>                          # updates a direct (not referenced) attribute of one object.
-  rusdc update_ref_attr <obj> <common_name> <key> <value>                      # updates a referenced attribute of one object.
+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 <object-type> [wc]                                         # list all fields of an object including its format
+rusdc find <object-type> [where-clause] [fields, comma separated] [options]  # finds each object which meets the wc-condition
+rusdc get <object-type> <common_name|id>                                     # shows one object by name or id
+rusdc get_all_attachments_of_co <co_name>                                    # get all attachments of a changeorder and save all th...
+rusdc get_attachment_of_ci <ci_name> <filename>                              # download an attachment of a CI and print it out on s...
+rusdc get_attachment_of_co <co_name> <filename>                              # download an attachment of a changeorder and print it...
+rusdc help [COMMAND]                                                         # Describe available commands or one specific command
+rusdc in_add_2_chg <changeorder> <incident>                                  # add incident to changeorder
+rusdc in_list_child_ins <in>                                                 # list all child-incidents of one incident
+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_add_org <nr> <org>                                                  # add an Organisation to a ConfigurationItem
+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 <ci-name>                                                   # lists all parent CIs of a specific CI
+rusdc update                                                                 # pipe json-data to update object
+rusdc update_attr <obj> <common_name|wc> <key> <value>                       # updates a direct (not referenced) attribute of one o...
+rusdc update_attr_by_id <obj> <id> <key> <value>                             # updates a plain attribute of one object by id, does ...
+rusdc update_ref_attr <obj> <common_name> <key> <value>                      # updates a referenced attribute of one object.
+rusdc update_ref_attr_by_id <obj> <id> <key> <value_id>                      # updates a referenced attribute of one object_id by v...
 ```
 
 # environment-variables
@@ -81,3 +93,14 @@ then
   export usdpass
 fi
 ```
+
+# example - find records
+
+```bash
+$ rusdc find nr "name like 'foo%'" name,description --format mlr
+name  description
+foo1  foo QS
+foo2  foo TEST
+```
+
+more examples under [find examples-Wikipage](https://github.com/ogaida/usd/wiki/find-examples) or in the [change_log](https://github.com/ogaida/usd/blob/master/change_log.md)

data/bin/rusdc

@@ -89,6 +89,7 @@ class Rusdc < Thor
   option :nice_time, :type => :boolean, :default => true,:banner => "[true|false]"
   option :debug, :type => :boolean, :default => false,:banner => "[true|false]"
   def find(object, wc="", fields="@COMMON_NAME")
+    exitcode=0
     unless (fields =~ /^[\w\_,@]+$/)
       puts "fields-problem: there must be only letters, numbers, comma, the @-sign or underscore, nothing else!"
     else
@@ -96,6 +97,7 @@ class Rusdc < Thor
       mlr_array = []
       con.debug = options[:debug]
       e = con.search(object,{'fields' => fields,"wc" => wc})
+      exitcode=1  if e.count == 0
       fields_array=fields.split(/,/)
       e.each do |elem|
         # init all requested keys with empty strings, better for mlr format and needed for fields-order
@@ -105,7 +107,7 @@ class Rusdc < Thor
         elem.keys.each do |elem_key|
           if options[:nice_time]
             if elem_key =~ /(date|last_mod|warranty_start|warranty_end|time_stamp)$/
-              elem[elem_key]=Time.at(elem[elem_key]).to_s
+              elem[elem_key]=Time.at(elem[elem_key]).to_s if elem[elem_key] != "" # not empty
             end
           end
           if fields_array.include?(elem_key)
@@ -125,9 +127,11 @@ class Rusdc < Thor
       case options[:format]
       when "json"
         puts mlr
+        exit exitcode
       when "yaml"
         # keys not sorted, maybe a todo
         puts e.to_yaml
+        exit exitcode
       when "mlr"
         # hierfuer muss mlr verfuegbar sein
         file = Tempfile.new('json')
@@ -136,8 +140,10 @@ class Rusdc < Thor
         file.close
         puts `#{cmd}`
         file.unlink
+        exit exitcode
       else
         puts "das Format #{options[:format]} ist nicht hinterlegt. Es gibt nur json, yaml oder mlr."
+        exit 2
       end
     end # fields check
   end
@@ -166,7 +172,7 @@ class Rusdc < Thor
     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}"})
     att_nr.each do |att|
-      attmnt = loadcon.request("/caisd-rest/attmnt/COMMON_NAME-#{att["attmnt"]["@COMMON_NAME"]}")["attmnt"]
+      attmnt = loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]
       filename = attmnt["orig_file_name"]
       puts "save #{filename}"
       f = File.open(filename, 'w')
@@ -180,7 +186,7 @@ class Rusdc < Thor
   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|
-      attmnt = loadcon.request("/caisd-rest/attmnt/COMMON_NAME-#{att["attmnt"]["@COMMON_NAME"]}")["attmnt"]
+      attmnt = loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]
       if attmnt["orig_file_name"] == filename
         puts loadcon.request("/caisd-rest/attmnt/#{attmnt["@id"]}/file-resource",{:unchanged => true})
       end
@@ -192,7 +198,7 @@ class Rusdc < Thor
     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}"})
     att_nr.each do |att|
-      attmnt = loadcon.request("/caisd-rest/attmnt/COMMON_NAME-#{att["attmnt"]["@COMMON_NAME"]}")["attmnt"]
+      attmnt = loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]
       if attmnt["orig_file_name"] == filename
         puts loadcon.request("/caisd-rest/attmnt/#{attmnt["@id"]}/file-resource",{:unchanged => true})
       end
@@ -213,7 +219,7 @@ class Rusdc < Thor
   def list_attachments_of_ci(ciname)
     att_nr = loadcon.search("lrel_attachments_nr",{'fields' => "attmnt","wc" => "nr.name = '#{ciname}'"})
     att_nr.each do |att|
-      puts loadcon.request("/caisd-rest/attmnt/COMMON_NAME-#{att["attmnt"]["@COMMON_NAME"]}")["attmnt"]["orig_file_name"]
+      puts loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]["orig_file_name"]
     end
   end
 
@@ -222,7 +228,7 @@ class Rusdc < Thor
     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}"})
     att_nr.each do |att|
-      puts loadcon.request("/caisd-rest/attmnt/COMMON_NAME-#{att["attmnt"]["@COMMON_NAME"]}")["attmnt"]["orig_file_name"]
+      puts loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]["orig_file_name"]
     end
   end
 
@@ -244,6 +250,24 @@ class Rusdc < Thor
     puts loadcon.create({:type => "json", :data => json})
   end
 
+  desc "nr_add_org <nr> <org>", "add an Organisation to a ConfigurationItem"
+  def nr_add_org(nr, org)
+    template = ERB.new <<-EOF
+      {
+        "lrel_oenv_orgref": {
+          "nr": {
+            "@id": "<%= uid_nr %>"
+          },
+          "org": {
+            "@id": "<%= uid_org %>"
+          }
+        }
+      }
+    EOF
+    json = template.result_with_hash(:uid_org => loadcon.request("/caisd-rest/org/COMMON_NAME-#{org}")["org"]["@id"], :uid_nr => loadcon.request("/caisd-rest/nr/COMMON_NAME-#{nr}")["nr"]["@id"])
+    puts loadcon.create({:type => "json", :data => json})
+  end
+
   desc "nr_changes <nr> [inactive-too]", "list all open changeorders of one CI"
   option :inactive_too, :type => :boolean, :default => false
   def nr_changes(nr)
@@ -377,7 +401,13 @@ class Rusdc < Thor
         :k => k,
         :v => v
       })
-    puts loadcon.update({:type => "json", :data => json})
+    data = loadcon.update({:type => "json", :data => json})
+    if data.class == RestClient::BadRequest
+      puts "direkte Ausführung bekommt einen BadRequest, versuche Update über IDs. #{Usd::CN["cnt"]}"
+      #find(obj, wc="obj", fields="@COMMON_NAME")
+    else
+      puts data
+    end
   end
 
   desc "update_ref_attr_by_id <obj> <id> <key> <value_id>", "updates a referenced attribute of one object_id by value-id"

data/change_log.md

@@ -1,4 +1,124 @@
-# changelog
+# rusdc changelog
+
+## 0.3
+
+- some common_name resolution
+
+```ruby
+class Usd
+  CN={
+    "chg" => "chg_ref_num",
+    "cnt" => "combo_name",
+    "arcpur_rule" => "name",
+    "ca_tou" => "name",
+    "cost_cntr" => "name",
+    "country" => "name",
+    "dept" => "name",
+    "gl_code" => "name",
+    "job_func" => "name",
+    "loc" => "name",
+    "nr" => "name",
+    "opsys" => "name",
+    "org" => "name",
+    "tab" => "name",
+    "auto_close" => "sym",
+    "aty" => "sym",
+    "act_type_assoc" => "sym",
+    "ca_cmpny" => "sym",
+    "closure_code" => "sym",
+    "cmth" => "sym",
+    "symptom_code" => "sym",
+    "state" => "sym",
+    "crt" => "sym",
+    "ctab" => "sym",
+    "ctp" => "sym",
+    "dcon_typ" => "sym",
+    "dlgsrvr" => "sym",
+    "dmn" => "sym",
+    "doc_rep" => "sym",
+    "fmgrp" => "sym",
+    "ical_alarm" => "sym",
+    "ical_event_template" => "sym",
+    "imp" => "sym",
+    "intfc" => "sym",
+    "kwrd" => "sym",
+    "mfrmod" => "sym",
+    "mgsstat" => "sym",
+    "nrf" => "sym",
+    "options" => "sym",
+    "outage_type" => "sym",
+    "perscnt" => "sym",
+    "position" => "sym",
+    "pr_trans" => "sym",
+    "prod" => "sym",
+    "quick_tpl_types" => "sym",
+    "rc" => "sym",
+    "resocode" => "sym",
+    "resomethod" => "sym",
+    "response" => "sym",
+    "rrf" => "sym",
+    "rss" => "sym",
+    "seq" => "sym",
+    "sev" => "sym",
+    "site" => "sym",
+    "slatpl" => "sym",
+    "special_handling" => "sym",
+    "svc_contract" => "sym",
+    "typecnt" => "sym",
+    "tz" => "sym",
+    "tspan" => "sym",
+    "transition_type" => "sym",
+    "urg" => "sym",
+    "vpt" => "sym",
+    "wrkshft" => "sym",
+    "cr" => "ref_num",
+    "in" => "ref_num",
+    "pr" => "ref_num"
+  }
+end
+```
+
+## 0.2.5.3
+
+- neu function : `rusdc nr_add_org <nr> <org>  # add an Organisation to a ConfigurationItem`
+
+#### fixes:
+
+- rusdc - line 110: more robust when querying date fields
+
+## 0.2.4.2
+
+the same fixes as in 0.2.4.1 for:
+
+```
+rusdc list_attachments_of_ci <ci_name>
+rusdc list_attachments_of_co <co_name>    
+```
+
+## 0.2.4.1
+
+### fixes
+
+- `rusdc get_attachment_of_ci` : attachment with spaces in path could not be downloaded
+
+## 0.2.4
+
+- find function has exitcode > 0 if no records has been found
+
+```
+$ rusdc find nr "name = 'not_here'"  || echo 'i am not here, please create me'
+[]
+i am not here, please create me
+$ rusdc find cnt "last_name = 'Gaida'"  && echo 'i am here, you may update me'
+[{
+  "@COMMON_NAME": "Gaida, Oliver "
+}]
+i am here, you may update me
+```
+
+### fixes
+
+- `rusdc get_all_attachments_of_co` : attachment with spaces in path could not be downloaded
 
 ## 0.2.3
 

data/lib/usd.rb

@@ -10,6 +10,76 @@ require 'tempfile'
 
 class Usd
 
+  CN={
+    "chg" => "chg_ref_num",
+    "cnt" => "combo_name",
+    "arcpur_rule" => "name",
+    "ca_tou" => "name",
+    "cost_cntr" => "name",
+    "country" => "name",
+    "dept" => "name",
+    "gl_code" => "name",
+    "job_func" => "name",
+    "loc" => "name",
+    "nr" => "name",
+    "opsys" => "name",
+    "org" => "name",
+    "tab" => "name",
+    "auto_close" => "sym",
+    "aty" => "sym",
+    "act_type_assoc" => "sym",
+    "ca_cmpny" => "sym",
+    "closure_code" => "sym",
+    "cmth" => "sym",
+    "symptom_code" => "sym",
+    "state" => "sym",
+    "crt" => "sym",
+    "ctab" => "sym",
+    "ctp" => "sym",
+    "dcon_typ" => "sym",
+    "dlgsrvr" => "sym",
+    "dmn" => "sym",
+    "doc_rep" => "sym",
+    "fmgrp" => "sym",
+    "ical_alarm" => "sym",
+    "ical_event_template" => "sym",
+    "imp" => "sym",
+    "intfc" => "sym",
+    "kwrd" => "sym",
+    "mfrmod" => "sym",
+    "mgsstat" => "sym",
+    "nrf" => "sym",
+    "options" => "sym",
+    "outage_type" => "sym",
+    "perscnt" => "sym",
+    "position" => "sym",
+    "pr_trans" => "sym",
+    "prod" => "sym",
+    "quick_tpl_types" => "sym",
+    "rc" => "sym",
+    "resocode" => "sym",
+    "resomethod" => "sym",
+    "response" => "sym",
+    "rrf" => "sym",
+    "rss" => "sym",
+    "seq" => "sym",
+    "sev" => "sym",
+    "site" => "sym",
+    "slatpl" => "sym",
+    "special_handling" => "sym",
+    "svc_contract" => "sym",
+    "typecnt" => "sym",
+    "tz" => "sym",
+    "tspan" => "sym",
+    "transition_type" => "sym",
+    "urg" => "sym",
+    "vpt" => "sym",
+    "wrkshft" => "sym",
+    "cr" => "ref_num",
+    "in" => "ref_num",
+    "pr" => "ref_num"
+  }
+
   RestClient.proxy = ""
 
   attr_reader :base_url, :user, :access_key, :expiration_date, :debug

data/usd.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name = 'usd'
-  spec.version = '0.2.3'
-  spec.date = '2019-12-06'
+  spec.version = '0.3'
+  spec.date = '2020-08-31'
   spec.summary = "SDM REST-API-Calls"
   spec.description = "a Ruby class and a commandlinetool for SDM REST-API-Calls"
   spec.authors = ["Oliver Gaida"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usd
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.3'
 platform: ruby
 authors:
 - Oliver Gaida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor