usd 1.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d2a11346d32e1cd5810370fb50b4dbb4d4da9f36375a27cb26cf39325142b9
-  data.tar.gz: 00c0893c1b33408e16619aeaaeae67f6396da165d30aefc85bd6b645cbf11482
+  metadata.gz: 8341a6edac193e671ccde850088a693d452bd571e7685bdba3ed59b6a10dc9c7
+  data.tar.gz: f9688b4546873b2b0d1ae35555080d0c965a2897e69823dc633131df4f6ecd63
 SHA512:
-  metadata.gz: 4da79eee6164891fe192dd639d83a28d89593b81f1c816942964991587308299bd1d28a6ced8755c203f8750354ba192615babba1861374bad25b47d0e3bf2b5
-  data.tar.gz: 193d05f6931a377fe1cd8fd3d5cd3a8cb65296719b58ab2717a7711599c005700bd83d5116d434be68232f90d85b13a84931ef087394fb4e723f4802e0ee6a91
+  metadata.gz: ab1cede636c31e94a3b5d4834c894db2d655638c5582e737e00c372617620dce66dc11839ff5d9ce22da4c378b5a91b027591a68d59ef41e0898fe1d1a6961ef
+  data.tar.gz: ea878deaa14d2ed86591b67b54851584055e11e80b46bf104572f4784b90f16616e154ef779da4d10fdf339cab5550f53a8f48e0165a75396bc128a2097ae807

data/README.md

@@ -3,6 +3,8 @@
 
 There is a ruby class and a commandline tool rusdc.
 
+[![asciicast](https://asciinema.org/a/7zw3RLpikFluqX9XJMxCpMEmS.svg)](https://asciinema.org/a/7zw3RLpikFluqX9XJMxCpMEmS)
+
 # installation
 
 just install the gem:
@@ -30,31 +32,38 @@ yum install ruby-devel
 
 see [https://github.com/ogaida/usd/wiki/bash-completion](https://github.com/ogaida/usd/wiki/bash-completion)
 
-# external tools
+# external tools / requirements
 
 If you use the `rusdc find` command with `--format mlr` option then you need `mlr`.
 
 - [mlr - Miller](http://johnkerl.org/miller/doc/index.html) - a great tool for data-transforming to and from json, csv and many more
 
-Place the `mlr`-binary in a path, which is in your PATH-Environment. Download-Url for mlr-releases: [https://github.com/johnkerl/miller/releases](https://github.com/johnkerl/miller/releases)
+Place the `mlr`-binary in a path, which is in your PATH-Environment. Download-Url for mlr-releases: [https://github.com/johnkerl/miller/releases](https://github.com/johnkerl/miller/releases).
+
+For uloading attachments `unix2dos` and `base64` is used. 
 
 # functions from the commandline-tool `rusdc`
 
 ```
+rusdc chg_add_attachment <co> <file>                                         # attach the file to 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 <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 get_all_attachments_of_co <co_name>                                    # get all attachments of a changeorder and save all these to current folder
+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 get_attachment_of_in <incident> <filename>                             # download an attachment of an Incident and print it out on stdout
 rusdc help [COMMAND]                                                         # Describe available commands or one specific command
 rusdc in_add_2_chg <changeorder> <incident>                                  # add incident to changeorder
+rusdc in_add_attachment <in> <file>                                          # attach the file to incident
 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 list_attachments_of_in <in>                                            # list all attachments of an Incident
+rusdc nr_add_attachment <nr> <file>                                          # attach the file to nr
 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
@@ -62,10 +71,11 @@ rusdc nr_childs <ci-name>                                                    # l
 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...
+rusdc update_attr <obj> <common_name|wc> <key> <value>                       # updates a direct (not referenced) attribute of one or more objects.
+rusdc update_attr_by_id <obj> <id> <key> <value>                             # updates a plain attribute of one object by id, does not work
+rusdc update_ref_attr <obj> <common_name> <key> <value> [ref_obj=nr]         # 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 value-id
+rusdc vcard_via_email <email>                                                # creates a vcard from the given email-address and saves it in the /tmp directory.
 ```
 
 # environment-variables

data/bin/rusdc

@@ -7,6 +7,31 @@ require "usd"
 
 class Rusdc < Thor
 
+  desc "chg_add_attachment <co> <file>", "attach the file to co"
+  def chg_add_attachment(co, file)
+    response = upload_attachment(file, loadcon.base_url, loadcon.access_key)
+    puts response
+    data = JSON.parse(response)
+    template = ERB.new <<-EOF
+      {
+        "lrel_attachments_changes": {
+          "attmnt": {
+            "@id": "<%= id %>"
+          },
+          "chg": {
+            "@COMMON_NAME": "<%= co %>"
+          }
+        }
+      }
+    EOF
+    json = template.result_with_hash({
+        :id => data["attmnt"]["@id"],
+        :co => co
+      })
+    #puts "create relation to chg with json: #{json}"
+    puts loadcon.create({:type => "json", :data => json})
+  end
+
   desc "chg_add_nr <co> <ci>", "add a CI to a changeorder"
   def chg_add_nr(co, ci)
     template = ERB.new <<-EOF
@@ -194,11 +219,10 @@ class Rusdc < Thor
     end
   end
 
-  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}"})
-    att_nr.each do |att|
+  desc "get_attachment_of_in <incident> <filename>", "download an attachment of an Incident and print it out on stdout"
+  def get_attachment_of_in(incident, filename)
+    att_in = loadcon.search("lrel_attachments_requests",{'fields' => "attmnt","wc" => "cr.ref_num = '#{incident}'"})
+    att_in.each do |att|
       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})
@@ -206,6 +230,41 @@ class Rusdc < Thor
     end
   end
 
+  # in: lrel_attachments_requests ?
+
+  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)
+    ids = loadcon.search("lrel_attachments_changes",{'fields' => "*","wc" => "chg.chg_ref_num = 'CO341144' and attmnt.orig_file_name = 'IMAP61A845F524A9D06536_3212.eml'"})
+    puts loadcon.request("/caisd-rest/attmnt/#{ids[0]["@id"]}/file-resource",{:unchanged => true}) if ids.class == Array
+  end
+
+
+  #lrel_attachments_requests",{'fields' => "attmnt","wc" => "cr.ref_num
+  desc "in_add_attachment <in> <file>", "attach the file to incident"
+  def in_add_attachment(incident, file)
+    response = upload_attachment(file, loadcon.base_url, loadcon.access_key)
+    puts response
+    data = JSON.parse(response)
+    template = ERB.new <<-EOF
+      {
+        "lrel_attachments_requests": {
+          "attmnt": {
+            "@id": "<%= id %>"
+          },
+          "cr": {
+            "@COMMON_NAME": "<%= incident %>"
+          }
+        }
+      }
+    EOF
+    json = template.result_with_hash({
+        :id => data["attmnt"]["@id"],
+        :incident => incident
+      })
+    #puts "create relation to chg with json: #{json}"
+    puts loadcon.create({:type => "json", :data => json})
+  end
+
   desc "in_add_2_chg <changeorder> <incident>", "add incident to changeorder"
   def in_add_2_chg(chg, incident)
     invoke('update_ref_attr',['in', incident, 'change', chg])
@@ -227,12 +286,46 @@ class Rusdc < Thor
   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}"})
-    att_nr.each do |att|
+    att_chg = loadcon.search("lrel_attachments_changes",{'fields' => "attmnt","wc" => "chg = #{chg_id}"})
+    att_chg.each do |att|
       puts loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]["orig_file_name"]
     end
   end
 
+  desc "list_attachments_of_in <in>", "list all attachments of an Incident"
+  def list_attachments_of_in(incident)
+    att_in = loadcon.search("lrel_attachments_requests",{'fields' => "attmnt","wc" => "cr.ref_num = '#{incident}'"})
+    att_in.each do |att|
+      puts loadcon.request("/caisd-rest/attmnt/#{att["attmnt"]["@id"]}")["attmnt"]["orig_file_name"]
+    end
+  end
+
+  desc "nr_add_attachment <nr> <file>", "attach the file to nr"
+  def nr_add_attachment(nr, file)
+    response = upload_attachment(file, loadcon.base_url, loadcon.access_key)
+    puts response
+    data = JSON.parse(response)
+    nr_id = loadcon.search("nr",{'fields' => "@id","wc" => "name = '#{nr}'"})[0]["@id"]
+    template = ERB.new <<-EOF
+      {
+        "lrel_attachments_nr": {
+          "attmnt": {
+            "@id": "<%= id %>"
+          },
+          "nr": {
+            "@id": "<%= nr_id %>"
+          }
+        }
+      }
+    EOF
+    json = template.result_with_hash({
+        :id => data["attmnt"]["@id"],
+        :nr_id => nr_id
+      })
+    #puts "create relation to chg with json: #{json}"
+    puts loadcon.create({:type => "json", :data => json})
+  end
+
   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
@@ -404,9 +497,9 @@ class Rusdc < Thor
       })
     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[obj]}"
+      puts "BadRequest-Response from USD-API, try to update via IDs. be aware to specify a ref_obj if it's not nr."
       cn_id = loadcon.search(obj,{'fields' => "@id","wc" => "#{Usd::CN[obj]} = '#{cn}' and delete_flag = 0"})[0]["@id"]
-      value_id = loadcon.search(ref_obj,{'fields' => "@id","wc" => "#{Usd::CN[obj]} = '#{v}' and delete_flag = 0"})[0]["@id"]
+      value_id = loadcon.search(ref_obj,{'fields' => "@id","wc" => "#{Usd::CN[ref_obj]} = '#{v}' and delete_flag = 0"})[0]["@id"]
       invoke "update_ref_attr_by_id", [obj, cn_id, k, value_id]
     else
       puts data
@@ -434,6 +527,36 @@ class Rusdc < Thor
     puts loadcon.update({:type => "json", :data => json})
   end
 
+  desc "vcard_via_email <email>", "creates a vcard from the given email-address and saves it in the /tmp directory."
+  def vcard_via_email(email)
+    cnt = loadcon.search("cnt",{'fields' => "*","wc" => "email_address = '#{email}' and delete_flag = 0"})[0]
+    template = ERB.new <<-EOF
+BEGIN:VCARD
+VERSION:2.1
+N;LANGUAGE=de:;<%= last_name %>;<%= first_name %>
+FN:<%= last_name %>, <%= first_name %>
+TEL;WORK;VOICE:<%= phone_number %>
+TEL;CELL;VOICE:<%= mobile_phone %>
+EMAIL;PREF;INTERNET:<%= email_address %>
+X-MS-OL-DEFAULT-POSTAL-ADDRESS:0
+X-MS-OL-DESIGN;CHARSET=utf-8:<card xmlns="http://schemas.microsoft.com/office/outlook/12/electronicbusinesscards" ver="1.0" layout="left" bgcolor="ffffff"><img xmlns="" align="fit" area="16" use="cardpicture"/><fld xmlns="" prop="name" align="left" dir="ltr" style="b" color="000000" size="10"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="telwork" align="left" dir="ltr" color="d48d2a" size="8"><label align="right" color="626262">Geschäftlich</label></fld><fld xmlns="" prop="telcell" align="left" dir="ltr" color="d48d2a" size="8"><label align="right" color="626262">Mobiltelefon</label></fld><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/><fld xmlns="" prop="blank" size="8"/></card>
+REV:<%= time %>
+END:VCARD
+    EOF
+    vcard=template.result_with_hash({
+        :last_name => cnt["last_name"],
+        :first_name => cnt["first_name"],
+        :email_address => cnt["email_address"],
+        :phone_number => cnt["phone_number"],
+        :mobile_phone  => cnt["mobile_phone"],
+        :time  => Time.now.strftime("%Y%m%dT%H%M%SZ")
+      })
+    file = `mktemp /tmp/#{cnt["last_name"]}-XXXXX.vcf`.chop
+    f = File.open(file,"w+")
+    f.puts vcard
+    f.close
+    puts "the vcard for #{cnt["first_name"]} #{cnt["last_name"]} was created under: #{file}"
+  end
 
   private
 
@@ -446,6 +569,26 @@ class Rusdc < Thor
     end
   end
 
+  def upload_attachment(file, baseurl, ak)
+    baseurl =~ /^([^:]+):/
+    server = $1
+    filename = File.basename(file)
+    uri = "/caisd-rest/attmnt?repositoryId=1002&serverName=#{server}&mimeType=Text&description=#{filename}"
+    url = URI("#{baseurl}#{uri}")
+    http = Net::HTTP.new(url.host, url.port);
+    request = Net::HTTP::Post.new(url)
+    request["X-AccessKey"] = ak
+    request["Content-Type"] = "multipart/form-data; BOUNDARY=*****MessageBoundary*****"
+    request["accept"] = "application/json"
+    request["Cache-Control"] = "no-cache"
+    fileObj = File.open(file, "rb")
+    fileContent = fileObj.read
+    fileObj.close
+    request.body = "--*****MessageBoundary*****\r\n \r\nContent-Disposition: form-data; name=\"payload\" \r\nContent-Type: application/xml; CHARACTERSET=UTF-8 \r\n\r\n \r\n<attmnt> \r\n<repository id=\"1002\"></repository> \r\n<orig_file_name>#{filename}</orig_file_name> \r\n<attmnt_name>#{filename}</attmnt_name> \r\n<description>Uploaded with rusdc from rubygem usd</description> \r\n</attmnt> \r\n\r\n \r\n--*****MessageBoundary*****\r\n \r\nContent-Disposition: form-data; name=\"#{filename}\"; filename=\"#{filename}\" \r\nContent-Type: application/octet-stream \r\nContent-Transfer-Encoding: base64\r\n\r\n#{Base64.encode64(fileContent)}\r\n\r\n \r\n--*****MessageBoundary*****--\r\n"
+    response = http.request(request)
+    response.read_body
+  end
+
 end
 
 Rusdc.start(ARGV)

data/change_log.md

@@ -1,6 +1,29 @@
 # rusdc changelog
 
-## 1.0
+## 1.3.3
+
+- private `Usd` Class funktion changed. Instead using `base64` and `unix2dos` binaries, we use Base64-Ruby-Class now. It is already required by usd.
+
+## 1.3.2
+
+- fixed error in Usd.search. which comes with 1.3.1 .
+
+## 1.3.1
+
+- new functions:
+  - `chg_add_attachment`
+  - `nr_add_attachment`
+  - `in_add_attachment`
+  - `vcard_via_email`
+
+with the first three funtions you are able to upload files to changeorders, configurationitems and incidents and it does not matter if it is text or binary. the last new function creates vcards in version 2.1 from a contact via its email as identifier.
+
+## 1.2
+
+- now in Usd.search function:
+  - whereclause is enriched with "common_name like '% wc%'" if it is not a valid whereclause.
+
+## 1.0 and 1.1
 
 - `update_ref_attr` rusdc-function fetches the IDs to update the object by itself.
 

data/lib/usd.rb

@@ -248,6 +248,14 @@ class Usd
     attr.push set_url_parm(params,"start","1")
     attr.push set_url_parm(params,"size","50")
     attr.push set_url_parm(params,"WC","")
+    # if wc contains no sql-compare operater, it will be changed to "COMMON_NAME like '%<wc-before>%'"
+    wc = attr.pop
+    wc.gsub!(/^WC=/,'')
+    if ([" like ","<",">","="," is "," in "].find {|e| wc =~ /#{e}/}).nil?
+      wc = "#{CN[object]} like '%#{wc}%'"
+    end
+    attr.push "WC=#{wc}"
+    # puts attr.jp # debug
     fields = set_param(params,"fields","COMMON_NAME,id")
     query_string=attr.join("&")
     res_rdata = request("/caisd-rest/#{object}?#{query_string}",{:method => "get", :header => header({'X-Obj-Attrs' => fields})})

data/usd.gemspec

@@ -1,16 +1,16 @@
-Gem::Specification.new do |spec|
-  spec.name = 'usd'
-  spec.version = '1.0'
-  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"]
-  spec.email = 'oliver.gaida@sycor.de'
-  #spec.files = ["bin/rusdc", "bin/set_env", "lib/usd.rb"] # Dir["*/*"]
-  spec.files = `git ls-files`.split($/)
-  spec.homepage = 'https://github.com/ogaida/usd'
-  spec.executables = %w(rusdc)
-  spec.add_runtime_dependency 'thor', '~> 0.20', '>= 0.20.3'
-  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
-  spec.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
-end
+Gem::Specification.new do |spec|
+  spec.name = 'usd'
+  spec.version = '1.3.3'
+  spec.date = '2020-09-11'
+  spec.summary = "SDM REST-API-Calls"
+  spec.description = "a Ruby class and a commandlinetool for SDM REST-API-Calls"
+  spec.authors = ["Oliver Gaida"]
+  spec.email = 'oliver.gaida@sycor.de'
+  #spec.files = ["bin/rusdc", "bin/set_env", "lib/usd.rb"] # Dir["*/*"]
+  spec.files = `git ls-files`.split($/)
+  spec.homepage = 'https://github.com/ogaida/usd'
+  spec.executables = %w(rusdc)
+  spec.add_runtime_dependency 'thor', '~> 0.20', '>= 0.20.3'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+  spec.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+end

metadata

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