kinetic_sdk 5.0.21 → 5.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e7c5cf73667fd11bb6466e4d0c3b5f842c1161a2e40c4c5c8af07ea6bf7556a
-  data.tar.gz: 5b7164109481530ca4fa328b49dffd53467b61e04e54428ba9a34bf1fcaff131
+  metadata.gz: b17c766fc56a33bded34c6f5bdae883e79ffd9348ed9afd78fc6b43401f84640
+  data.tar.gz: 3eb7e0ec3f5cd65e45d00528e950a2c16cd3acf7b53bb264c8edb2fd7ed41df1
 SHA512:
-  metadata.gz: acc1eb80818fd700da274f056a26a4a0c5fa9da69f3bac3cb6b8dc0573fe4155431e8887dca25deed1e093160af4502bf0e42e6ee7f14e3ec33963e1cea2920f
-  data.tar.gz: 2aaf712d145b520150d6d722538262fd571d361442b8d3d1e4cb7b99ab3465875c80c97069361c9b9392fe998e190eae405e848bfa8f1853608a907fd0bcab8b
+  metadata.gz: 1a3b3db31c8cd917681b38a07c9fb37e6ee4339d7e772059c3452f6843284d74d28d9808ad726a05554d662f5e0ad469ab7caf8b9777b8b917cd9a11b5238f80
+  data.tar.gz: b101040d5f1fc3fecdced915cecb4886b140d8eb71d5638132d6a016c047311a6d98e7383357f15bca53a323cdefe39354ca9502618bee274040d32a69533380

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [5.0.22](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.22) (2023-08-24)
+
+**Implemented enhancements:**
+
+- Kinetic Core integrated workflow import / export enhancements and bug fixes
+- Added export option flag to include Kinetic Core workflows when exporting trees
+- Skip Kinetic Core workflows when exporting trees unless explicitly included
+
 ## [5.0.21](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.21) (2023-06-30)
 
 **Implemented enhancements:**

data/lib/kinetic_sdk/core/lib/space.rb

@@ -85,11 +85,65 @@ module KineticSdk
         "space.webApis.{slug}",
         "space.webhooks.{name}",
       )
-      core_data = get("#{@api_url}/space", { 'export' => true}, headers).content
+      core_data = find_space({ 'export' => true }, headers).content
       process_export(@options[:export_directory], export_shape, core_data)
+      export_workflows(headers)
       @logger.info("Finished exporting space definition to #{@options[:export_directory]}.")
     end
 
+    # Exports linked workflows for the space, kapps, and forms. This method is automatically called from `KineticSdk.Core.export_space()`.
+    #
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return nil
+    def export_workflows(headers=default_headers)
+      # Workflows were introduced in core v6
+      version = app_version(headers).content["version"]
+      if version && version["version"] < "6"
+        @logger.info("Skip exporting workflows because the Core server version doesn't support workflows.")
+        return
+      end
+
+      raise StandardError.new "An export directory must be defined to export workflows." if @options[:export_directory].nil?
+      @logger.info("Exporting workflows to #{@options[:export_directory]}.")
+
+      # space workflows
+      space_workflows = find_space_workflows({ "include" => "details" }, headers).content["workflows"] || []
+      space_workflows.select { |wf| !wf["event"].nil? }.each do |workflow|
+        @logger.info(workflow) unless workflow["name"]
+        evt = workflow["event"].slugify
+        name = workflow["name"].slugify
+        filename = "#{File.join(@options[:export_directory], "space", "workflows", evt, name)}.json"
+        workflow_json = find_space_workflow(workflow["id"], {}, headers).content["treeJson"]
+        write_object_to_file(filename, workflow_json)
+      end
+
+      space_content = find_space({ 'include' => "kapps.details,kapps.forms.details" }).content["space"]
+
+      # kapp workflows
+      space_content["kapps"].each do |kapp|
+        kapp_workflows = find_kapp_workflows(kapp["slug"], {}, headers).content["workflows"] || []
+        kapp_workflows.select { |wf| !wf["event"].nil? }.each do |workflow|
+          evt = workflow["event"].slugify
+          name = workflow["name"].slugify
+          filename = "#{File.join(@options[:export_directory], "space", "kapps", kapp["slug"], "workflows", evt, name)}.json"
+          workflow_json = find_kapp_workflow(kapp["slug"], workflow["id"], {}, headers).content["treeJson"]
+          write_object_to_file(filename, workflow_json)
+        end
+
+        # form workflows
+        kapp["forms"].each do |form|
+          form_workflows = find_form_workflows(kapp["slug"], form["slug"], {}, headers).content["workflows"] || []
+          form_workflows.select { |wf| !wf["event"].nil? }.each do |workflow|
+            evt = workflow["event"].slugify
+            name = workflow["name"].slugify
+            filename = "#{File.join(@options[:export_directory], "space", "kapps", kapp["slug"], "forms", form["slug"], "workflows", evt, name)}.json"
+            workflow_json = find_form_workflow(kapp["slug"], form["slug"], workflow["id"], {}, headers).content["treeJson"]
+            write_object_to_file(filename, workflow_json)
+          end
+        end
+      end
+    end
+
     # Find the space
     #
     # @param params [Hash] Query parameters that are added to the URL, such as +include+
@@ -100,7 +154,8 @@ module KineticSdk
       get("#{@api_url}/space", params, headers)
     end
 
-    # Imports a full space definition from the export_directory
+    # Imports a full space definition from the export_directory, except for workflows. Those must be imported separately after
+    # the Kinetic Platform source exists in task.
     #
     # @param slug [String] the slug of the space that is being imported
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
@@ -146,6 +201,97 @@ module KineticSdk
       @logger.info("Finished importing space definition to #{@options[:export_directory]}.")
     end
 
+    # Imports the workflows for the space. This method should be called after importing the Kinetic Platform source into task.
+    #
+    # @param slug [String] the slug of the space that is being imported
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return nil
+    def import_workflows(slug, headers=default_headers)
+      # Workflows were introduced in core v6
+      version = app_version(headers).content["version"]
+      if version && version["version"] < "6"
+        @logger.info("Skip importing workflows because the Core server version doesn't support workflows.")
+        return
+      end
+
+      raise StandardError.new "An export directory must be defined to import space." if @options[:export_directory].nil?
+      @logger.info("Importing workflows from #{@options[:export_directory]}.")
+
+      # Map of existing workflows by space, kapp, form
+      existing_workflows_cache = {}
+      # Regular expressions to match workflow paths by space, kapp, or form
+      form_re = /^\/kapps\/(?<kapp_slug>[a-z0-9]+(?:-[a-z0-9]+)*)\/forms\/(?<form_slug>[a-z0-9]+(?:-[a-z0-9]+)*)\/workflows/
+      kapp_re = /^\/kapps\/(?<kapp_slug>[a-z0-9]+(?:-[a-z0-9]+)*)\/workflows/
+      space_re = /^\/workflows/
+
+      # Loop over all provided files sorting files before folders
+      Dir["#{@options[:export_directory]}/space/**/workflows/**/*.json"].map { |file| [file.count("/"), file] }.sort.map { |file| file[1] }.each do |file|
+        rel_path = file.sub("#{@options[:export_directory]}/", '')
+        path_parts = File.dirname(rel_path).split(File::SEPARATOR)
+        api_parts_path = path_parts[0..-1]
+        api_path = "/#{api_parts_path.join("/").sub(/^space\//,'').sub(/\/[^\/]+$/,'')}"
+
+        # populate the existing workflows for the workflowable object
+        matches = form_re.match(api_path)
+        # form workflows
+        if matches
+          form_slug = matches["form_slug"]
+          kapp_slug = matches["kapp_slug"]
+          map_key = self.space_slug + "|" + kapp_slug + "|" + form_slug
+          if !existing_workflows_cache.has_key?(map_key)
+            response = find_form_workflows(kapp_slug, form_slug, { "includes" => "details" }, headers)
+            existing_workflows_cache[map_key] = response.content["workflows"]
+          end
+        else
+          matches = kapp_re.match(api_path)
+          # kapp workflows
+          if matches
+            kapp_slug = matches["kapp_slug"]
+            map_key = self.space_slug + "|" + kapp_slug
+            if !existing_workflows_cache.has_key?(map_key)
+              response = find_kapp_workflows(kapp_slug, { "includes" => "details" }, headers)
+              existing_workflows_cache[map_key] = response.content["workflows"]
+            end
+          else
+            # space workflows
+            map_key = self.space_slug
+            if !existing_workflows_cache.has_key?(map_key)
+              response = find_space_workflows({ "includes" => "details" }, headers)
+              existing_workflows_cache[map_key] = response.content["workflows"]
+            end
+          end
+        end
+
+        tree_json = JSON.parse(File.read(file))
+        event = path_parts.last.split("-").map { |part| part.capitalize }.join(" ")
+        name = tree_json["name"]
+
+        body = {
+          "event" => event,
+          "name" => name,
+          "treeJson" => tree_json
+        }
+
+        # check if the workflow already exists
+        existing_workflow = (existing_workflows_cache[map_key] || []).select { |wf|
+          wf["event"] == event && wf["name"] == name
+        }.first
+
+        if existing_workflow
+          workflow_id = existing_workflow["id"]
+          url = "#{@api_url}#{api_path}/#{workflow_id}"
+          @logger.info("Updating #{event} workflow #{workflow_id} from #{rel_path} to #{url}")
+          resp = put(url, body, headers)
+          @logger.warn("Failed to update workflow (#{resp.code}): #{resp.content}") unless resp.code == "200"
+        else
+          url = "#{@api_url}#{api_path}"
+          @logger.info("Importing #{event} workflow from #{rel_path} to #{url}")
+          resp = post(url, body, headers)
+          @logger.warn("Failed to import workflow (#{resp.code}): #{resp.content}") unless resp.code == "200"
+        end
+      end
+    end
+
     # Checks if the space exists
     #
     # @param slug [String] slug of the space

data/lib/kinetic_sdk/task/lib/export.rb

@@ -15,10 +15,12 @@ module KineticSdk
     # * access keys
     #
     # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @param export_opts [Hash] hash of export options
+    #   - :include_workflows => true|false (default: false)
     # @return nil
-    def export(headers=header_basic_auth)
+    def export(headers=header_basic_auth, export_opts={})
       export_sources(headers)
-      export_trees(nil,headers) # Includes routines when nil passed
+      export_trees(nil,headers,export_opts) # Includes routines when nil passed
       export_handlers(headers)
       export_groups(headers)
       export_policy_rules(headers)

data/lib/kinetic_sdk/task/lib/trees.rb

@@ -213,92 +213,88 @@ module KineticSdk
       get("#{@api_url}/trees/guid/#{tree_id}", params, headers)
     end
 
-    # Export a single tree or routine
+    # Export a single tree or routine. This method will not export Kinetic Core 
+    # workflows unless `export_opts[:include_workflows] => true` export option
+    # is provided.
     #
     # @param title [String] the title of the tree or routine
     # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @param export_opts [Hash] hash of export options
+    #   - :include_workflows => true|false (default: false)
     # @return nil
     #
-    def export_tree(title, headers=header_basic_auth)
+    def export_tree(title, headers=header_basic_auth, export_opts={})
       raise StandardError.new "An export directory must be defined to export a tree." if @options[:export_directory].nil?
       @logger.info("Exporting tree \"#{title}\" to #{@options[:export_directory]}.")
       # Get the tree
-      response = find_tree(title, { "include" => "export" })
+      response = find_tree(title, { "include" => "details,export" })
       # Parse the response and export the tree
       tree = response.content
+      if export_opts[:include_workflows] || (!tree.has_key?("event") || tree["event"].nil?)
+          # determine which directory to write the file to
+        if tree['sourceGroup'] == "-"
+          # Create the directory if it doesn't yet exist
+          routine_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "routines"))
+          tree_file = File.join(routine_dir, "#{tree['name'].slugify}.xml")
+        else
+          # Create the directory if it doesn't yet exist
+          tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory],"sources", tree['sourceName'].slugify , "trees"))
+          tree_file = File.join(tree_dir, "#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
+        end
 
-      # determine which directory to write the file to
-      if tree['sourceGroup'] == "-"
-        # Create the directory if it doesn't yet exist
-        routine_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "routines"))
-        tree_file = File.join(routine_dir, "#{tree['name'].slugify}.xml")
-      else
-        # Create the directory if it doesn't yet exist
-        tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory],"sources", tree['sourceName'].slugify , "trees"))
-        tree_file = File.join(tree_dir, "#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
-      end
-
-      # write the file
-      server_version = server_info(headers).content["version"]
-      if server_version > "04.03.0z"
-        File.write(tree_file, tree['export'])
+        # write the file
+        server_version = server_info(headers).content["version"]
+        if server_version > "04.03.0z"
+          File.write(tree_file, tree['export'])
+        else
+          xml_doc = REXML::Document.new(tree["export"])
+          xml_doc.context[:attribute_quote] = :quote
+          xml_formatter = Prettier.new
+          xml_formatter.write(xml_doc, File.open(tree_file, "w"))
+        end
+        @logger.info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
       else
-        xml_doc = REXML::Document.new(tree["export"])
-        xml_doc.context[:attribute_quote] = :quote
-        xml_formatter = Prettier.new
-        xml_formatter.write(xml_doc, File.open(tree_file, "w"))
+        @logger.info("Did not export #{tree['type']}: #{tree['title']} because it is a Core linked workflow")
       end
-      @logger.info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
     end
 
-    # Export all trees and local routines for a source, and global routines
+    # Export trees and local routines for a source, and global routines. This method will
+    # not export Kinetic Core workflows unless `export_opts[:include_workflows] => true`
+    # export option is provided.
     #
     # @param source_name [String] Name of the source to export trees and local routines
     #   - Leave blank or pass nil to export all trees and global routines
     #   - Pass "-" to export only global routines
     # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @param export_opts [Hash] hash of export options
+    #   - :include_workflows => true|false (default: false)
     # @return nil
-    def export_trees(source_name=nil, headers=header_basic_auth)
+    def export_trees(source_name=nil, headers=header_basic_auth, export_opts={})
       raise StandardError.new "An export directory must be defined to export trees." if @options[:export_directory].nil?
       if source_name.nil?
-        @logger.info("Exporting all trees and routines to #{@options[:export_directory]}.")
+        if export_opts[:include_workflows]
+          @logger.info("Exporting all trees, routines, and workflows to #{@options[:export_directory]}.")
+        else
+          @logger.info("Exporting all trees and routines to #{@options[:export_directory]}.")
+        end
         export_routines(headers)
         (find_sources({}, headers).content["sourceRoots"] || []).each do |sourceRoot|
-          export_trees(sourceRoot['name'])
+          export_trees(sourceRoot['name'], headers, export_opts)
         end
         return
       elsif source_name == "-"
         @logger.info("Exporting global routines to #{@options[:export_directory]}.")
       else
-        @logger.info("Exporting trees and routines for source \"#{source_name}\" to #{@options[:export_directory]}.")
+        @logger.info("Exporting trees and local routines for source \"#{source_name}\" to #{@options[:export_directory]}.")
       end
 
       # Get all the trees and routines for the source
-      response = find_trees({ "source" => source_name, "include" => "export" })
+      response = find_trees({ "source" => source_name, "include" => "details" }, headers)
       # Parse the response and export each tree
       (response.content["trees"] || []).each do |tree|
-        # determine which directory to write the file to
-        if tree['sourceGroup'] == "-"
-          # create the directory if it doesn't yet exist
-          routine_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "routines"))
-          tree_file = File.join(routine_dir, "#{tree['name'].slugify}.xml")
-        else
-          # create the directory if it doesn't yet exist
-          tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "sources", source_name.slugify ,"trees"))
-          tree_file = File.join(tree_dir, "#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
+        if export_opts[:include_workflows] || (!tree.has_key?("event") || tree["event"].nil?)
+          export_tree(tree['title'], headers, export_opts)
         end
-
-        # write the file
-        server_version = server_info(headers).content["version"]
-        if server_version > "04.03.0z"
-          File.write(tree_file, tree['export'])
-        else
-          xml_doc = REXML::Document.new(tree["export"])
-          xml_doc.context[:attribute_quote] = :quote
-          xml_formatter = Prettier.new
-          xml_formatter.write(xml_doc, File.open(tree_file, "w"))
-        end
-        @logger.info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
       end
     end
 

data/lib/kinetic_sdk/version.rb

@@ -3,5 +3,5 @@ module KineticSdk
   # Version of Kinetic SDK
   #
   # @return [String] Version of the SDK
-  VERSION = "5.0.21"
+  VERSION = "5.0.22"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.21
+  version: 5.0.22
 platform: ruby
 authors:
 - Kinetic Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slugify
@@ -745,7 +745,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Ruby SDK for Kinetic Data application APIs